System Administrator’s
Guide
Altitude, Altitude Dream, Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper,
Gatekeeper Central, Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My
Genies, PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShiftLogic, ShopTrac, ShopTrac
Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Unicru,
Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie,
and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Altitude MPP,
Altitude MPPXpress, Altitude Pairing, Altitude PBS, Comm.Mgr, CommLink, DKC/Datalink, eDiagnostics, Experts at
Improving the Performance of People and Business, FasTrack, Hireport, HR and Payroll Answerforce, HyperFind,
Kronos 4500 Touch ID, Kronos 4500, Kronos 4510, Kronos Acquisition, Kronos e-Central, Kronos KnowledgePass,
Kronos TechKnowledgy, KronosWorks, KVC OnDemand, Labor Plus, Momentum Essentials, Momentum Online,
Momentum, MPPXpress, Overall Labor Effectiveness, Schedule Assistant, Smart Scheduler, Smart View, Start
Quality, Start WIP, Starter Series, StartLabor, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite,
WIP Plus, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce
Central Portal, Workforce Connect, Workforce Employee, Workforce HR, Workforce Leave, Workforce Manager,
Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce
Recruiter, Workforce Scheduler with Optimization, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax
Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos Incorporated or a related company.
Mozilla.org is a registered trademark of the Mozilla Foundation. All other trademarks or registered trademarks used
herein are the property of their respective owners and are used for identification purposes only.
When using and applying the information generated by Kronos products, customers should ensure that they comply
with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this
Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws.
Chapter 1: Introduction
Workforce Central infrastructure ................................................................ 22
System configuration overview ................................................................... 23
Logging on to Workforce Central ................................................................ 24
Logging on with Single Sign-on ........................................................... 24
Enabling Active X controls and plugins ............................................... 25
Offline mode ......................................................................................... 25
Managing an instance remotely ........................................................... 26
Configure a visual theme ............................................................................ 27
Working with passwords ............................................................................. 28
Change user passwords ......................................................................... 28
Use the single sign-on feature ............................................................... 28
Set users’ browsers to remember passwords ........................................ 28
Change the SuperUser Password .......................................................... 29
Changing the Relogon session timeout ....................................................... 31
Changing the JBoss Session timeout setting ......................................... 32
Changing the Workforce Central session timeout grace period ............ 32
Working with property files ........................................................................ 34
Modifying properties ............................................................................ 34
Contents
4 Kronos Incorporated
Contents
6 Kronos Incorporated
Contents
Change colors in the image files to match the custom theme ............. 189
Test the custom theme ........................................................................ 194
Deploy the custom theme ................................................................... 195
Extend the custom theme to the portal ................................................ 196
Chapter 7: Reports
Overview .................................................................................................. 198
Terminology ........................................................................................ 199
Setting up reports for totalization ....................................................... 200
Enabling a report to export to Microsoft Excel .................................. 200
Installing fonts for Workforce Activities reports ................................ 201
Managing reporting environments ............................................................ 202
Basic reporting .................................................................................... 202
Advanced Reporting ........................................................................... 205
Customizing reports ................................................................................... 211
Customizing RDL reports ................................................................... 211
Customizing RPT reports .................................................................... 221
Customizing reports that use stored procedures ................................. 240
8 Kronos Incorporated
Contents
Index
10 Kronos Incorporated
About This Guide
12 Kronos Incorporated
Organization of this guide
• Appendix D, “Registry Keys,” on page 341 describes the registry keys that
were set up when your Workforce Central system was installed.
• Appendix E, “Single Sign-On,” on page 345 provides information about using
single sign-on, which allows users to log on to Workforce Central
automatically, without having to re-enter a username or password after they
have logged onto their browser.
• Appendix F, “Diagnostic Tools,” on page 349 contains an overview of the
diagnostic tools and describes how to use the different tools.
Abbreviation/Terms Meaning
ADSI Microsoft Active Directory Service Interface
API Application Programming Interface
BGP Background Processor. A platform on which a Background
Totalizer application runs.
daemon A process that runs in the background and performs a specified
operation at predefined times or in response to certain events.
DCM Data Collection Manager. A set of functions that deals with data
from data collection devices. In a multiserver environment,
DCM can run on a dedicated server.
DNS Domain Naming Service
DSN Data Source Name
GUI Graphical User Interface
HTTP HyperText Transfer Protocol. A communication protocol
between a client and a server.
HTTPS HyperText Transfer Protocol Secure. A communication protocol
with encryption security, using a Secure Sockets Layer.
IE Microsoft Internet Explorer
IP Internet Protocol address
ISO International Standards Organization
JDBC Java Database Connectivity
JRE Java Runtime Environment
JSP Java Server Page
JVM Java Virtual Machine
LDAP Lightweight Directory Access Protocol
ODBC Open Database Connectivity
PDF Portable Document Format
RSA A public-key cryptosystem developed by RSA, Inc.
14 Kronos Incorporated
Abbreviations and Terminology
Abbreviation/Terms Meaning
SMTP Simple Mail Transfer Protocol
SSL Secure Sockets Layer
16 Kronos Incorporated
Workforce Central suite documentation
18 Kronos Incorporated
Workforce Central suite documentation
Other documentation
• The Guide to Translating and Customizing Workforce Central that is available
on the separate Translation and Customization Toolkit CD, provides
instructions for editing the browser-based graphical user interface and the
associated browser-based Help files for Workforce Central.
• Online Help for the Workforce Central suite is installed automatically with the
product.
• Release notes that are available on the Workforce Central suite product CD
provide additional information about the Workforce Central suite, including a
list of new features, resolved issues, and late-breaking changes.
20 Kronos Incorporated
Chapter 1
Introduction
This chapter introduces the Workforce Central system architecture and discusses
its implementation in single-instance and multi-instance environments.
This chapter contains the following sections:
• “Workforce Central infrastructure” on page 22
• “System configuration overview” on page 23
• “Logging on to Workforce Central” on page 24
• “Configure a visual theme” on page 27
• “Working with passwords” on page 28
• “Changing the Relogon session timeout” on page 31
• “Working with property files” on page 34
• “Configuring a multi-instance environment” on page 36
• “Working with Workflow Notifications” on page 39
• “Configuring Process Manager and Process Designer” on page 44
• “Setting up Delegate Authority” on page 50
Chapter 1 Introduction
22 Kronos Incorporated
System configuration overview
Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your
communication protocol on the Web & App Server tab, you must use https://
rather than http:// for the logon URLs. For more information, see “Web &
App Server settings” on page 173.
24 Kronos Incorporated
Logging on to Workforce Central
Note: Optionally, you can add your server(s) name(s) as a trusted server to
launch Active X controls.
Offline mode
As system administrator, you may 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 this 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, which is wfc by default.
Note that this URL is case-sensitive.
When the system starts in offline mode, the system configuration components are
the only part of the system that are accessible.
Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your
communication protocol on the Web & App Server tab, you must use https://
rather than http:// for the logon URLs. For more information, see “Web &
App Server settings” on page 173.
If the database is offline, the Database tab in System Configuration > System
Information indicates that the database is offline and that no information is
currently available.
Specify the offline mode user name and password using the following settings on
the Security settings tab:
• site.security.authentication.offline.username
• site.security.authentication.offline.password keys
The system encrypts the value of this password.
26 Kronos Incorporated
Configure a visual theme
28 Kronos Incorporated
Working with passwords
• Setting Password Save From User Desktops — If the browsers are already
on your users' desktops, you need to change this setting at each browser. You
cannot prevent users from altering the setting.
Online mode
Offline mode
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, which is
wfc by default. Note that this URL is case-sensitive.
2. Enter the default logon with the user name, superuser, and default
password, kronites.
3. In the Setup workspace, select System Configuration > System Settings.
4. Click the Security tab.
5. Change the site.security.authentication.offline. password value.
6. Click Save.
Make subsequent logins as superuser, using the new password.
Client security
You can set your users’ browsers to remember passwords so that they can log on
more quickly. You can also disable the Password Save. Use the following methods
to enable or disable Password Save:
• 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.
– For Microsoft Internet Explorer browsers, turn on or off the
AutoComplete function using the Microsoft Internet Explorer
Administration Kit Customization Wizard; then deploy the browsers to
your users’ desktops.
• Setting Password Save From User Desktops — If the browsers are already
on your users' desktops, you need to 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 the browser’s Tools > Internet Options > Content tab.
30 Kronos Incorporated
Changing the Relogon session timeout
Session timeouts for user inactivity are governed by the application server session
timeout parameter and the Session Timeout grace period. The Session Timeout
grace period represents the number of minutes prior to the application server
session timeout that the Relogon dialog box will appear. The Relogon dialog box
informs the user that the session is about to time out, and prompts for relogin in
order to prevent a time-out. If the user does not respond to the relogin request in
time, the application server session times out, the application closes, and the user
must relogin through the logon screen.
Example 1:
Application server Session Timeout = 30
Session Timeout Grace Period = 1
The Relogon 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 Relogon dialog window appears after 50 minutes of inactivity; the application
server session closes after 60 minutes.
Note: Changing the parameter will affect all clients that attach to the web/
application server.
5. Delete the comment characters (<!-- and --!>) that are located before and
after the line of code.
6. Save the file with the original name that it had before you edited it.
7. Restart using the Start Workforce Central icon.
32 Kronos Incorporated
Changing the Relogon session timeout
Caution: Do this at a time when no one is logged on to the system. Restarting the
server ends all user sessions immediately.
Modifying properties
Modify properties using the System Settings option in the Setup component of the
Workforce Central 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 this 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, if 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 is
started, the value INFO overrides the value of ERROR.
If you want to restore the initial values associated with a particular System
Settings tab, use the Restore Defaults menu item on that tab. For example, using
the Database tab, you could set up values for your production database in the
initial property file and values for your archived database in a custom property
file. Then, if you use the archived database, you can use the custom property file.
To return to your production database, use the Restore Defaults menu item on the
System Settings Database tab.
Groups of properties
Properties are grouped by subject matter. Each tab in System Settings deals with
one group of properties. Properties are maintained in property files or in database
tables. The following list shows the property group that is associated with each
34 Kronos Incorporated
Working with property files
System Settings tab. You may have additional tabs depending on what products
you have installed.
System Settings Tab Property Group
Audit site.audit
Business automation site.processengine
Clock Synchronize site.clocksync
Database site.database
Data Source dsnname
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 Databases WrmSetting
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
Note: In Workforce Timekeeper v6.0, the term application server is only used in
reference to the third-party application server software, such as JBoss, not the
Workforce Timekeeper application.
36 Kronos Incorporated
Configuring a multi-instance environment
Note: Before you designate an instance as the primary Scheduler, you must ensure
that Microsoft Task Scheduler is running by checking Administrative Tools >
Services in the Windows Control Panel.
38 Kronos Incorporated
Working with Workflow Notifications
Notification types
Several types of notifications are available. Each type is a template that you use to
set up a specific notification request. There are two categories of notification
types: automatic, and those initiated by an event.
• Automatic notification types are activated at a predefined period of time
before or after the end of a pay period. They provide a mechanism for sending
an automatic reminder to a manager or an employee. These types include pay
period based for managers and employees.
For these notification types, select a HyperFind query from the Recipients
drop-down list to obtain a list of e-mail recipients.
To notify managers, select the employees listed in the notification by selecting
a HyperFind query from the Employees drop-down list. Because the recipient
list and the list of people returned from the HyperFind query can be large and
unstable, you can modify the lists returned in either HyperFind query.
• Event-initiated notification types include the following:
– Approved, signed off, and edited, which all relate to employees and are
associated with timecards. These are initiated by a person who takes an
action, such as a manager who signs a timecard.
For some types, such as group edit completion and event status, you
cannot specify the e-mail recipients, which are determined by the function
access profile that contains access control points for the notification type.
Available notification
Several types of notifications are available.
• For managers, pay period based — Sent to managers based on the number
of days and/or hours before or after the end of a pay period for various
reasons, such as all employees whose timecards contain missed punches.
• For employees, pay period based — Sent to employees based on the number
of days and/or hours before or after the end of a pay period for various
reasons, such as all employees whose timecards contain missed punches.
• Server Notification — Sent when a user-selected event occurs on a user-
selected Workforce Central service.
• Event status — Sent whenever a change in status is recorded for a Workforce
Central event.
• Database server unavailable — Sent when the database server becomes
unavailable.
• Application server booted — Sent whenever the Workforce Central
application server is started or restarted.
• Group edit failed — Sent when a group edit fails before completion.
• Group edit completed — Sent when a group edit has completed.
• Timecard signed off by manager — Sent to employees after their timecards
have been signed off by a manager.
• Timecard approved by manager — Sent to employees after their timecards
have been approved by a manager.
40 Kronos Incorporated
Working with Workflow Notifications
Access
42 Kronos Incorporated
Working with Workflow Notifications
• Event Status
• Timecard signed off by manager
• Timecard approved by manager
• Timecard edited by manager after employee approval
To determine whether a Workforce Employee qualifies to receive a notification, in
the Setup workspace, select Access Profiles > Function Access Profiles. Click
the New button, select Workforce Employee > E-mail Notifications to
Employees:
• Process Engine — The underlying software on the server that executes the
automated business processes created with Process Designer.
• Cluster Manager — The Workforce Central tool that you use to allow
multiple Process Engine instances to simultaneously access and monitor the
same set of processes.
• Process Templates editor — The Workforce Central tool that you use to
activate business process templates in the system.
44 Kronos Incorporated
Configuring Process Manager and Process Designer
• Process Profiles editor — The Workforce Central 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.
• Process Administrator — The Workforce Central tool that you use to
monitor and manage all business processes running in the system, as
described in Appendix B, “System Administration of Process Manager,” on
page 305.
For additional information, see the Workforce Central Process Manager
Programmer’s Guide.
Note: Be sure that you make a backup copy of your process template files.
Certain global system settings (System Configuration > System Settings >
Global Values) have been replaced by application server system settings (System
Configuration > System Settings > Business Automation):
Any changes that you made to global system settings on your 5.0 system, must be
reapplied to the application server system settings after Process Manager is
installed as part of your installation.
For more information about system settings, see “Specify system settings” on
page 46.
Note: If you save a change to a system setting in Global Values but the system
displays an error message stating that you cannot change that setting, select
Refresh on the System Settings toolbar to restore the previous setting for that
property. If you do not refresh that display, the system may save the invalid
setting that generated the error message.
46 Kronos Incorporated
Configuring Process Manager and Process Designer
Note: If you do not set the Shift Builder to run daily, several vacation bidding
application functions will not work correctly.
Messaging
Everyone View the Inbox
Everyone Messaging Access:
• Create a new message
• Reply to a message
• Open a message
The process templates that you implement on your system use certain predefined
attributes that automatically direct tasks or messages to an employee’s manager or
a manager’s manager, 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 in the organization who will participate in any process 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 will fail and a failure notification message will be sent to the process
administrator.
Using 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:
1. In the Setup workspace, select Common Setup > HyperFind Queries.
2. Click Edit on the menu bar in the HyperFind workspace.
3. On the Select Conditions tab, under Filters, select Process Manager >
Reports To.
4. Select the exclude option.
5. Click Add Condition.
48 Kronos Incorporated
Configuring Process Manager and Process Designer
50 Kronos Incorporated
Setting up Delegate Authority
52 Kronos Incorporated
Chapter 2
System Information
Note: You cannot update the workspace using your browser’s Refresh button.
Caution: Clicking the Restart Server button causes the system to shut down
immediately. Users receive no advance warning.
• Delete instances that are no longer connected to the database in the All
Servers tab.
• Generate database reports on the Database tab, if you have a SQL Server or
ORACLE database.
54 Kronos Incorporated
All Servers information
• The server named Server1 contains two instances — wfc and wfc1 —
and both instances are currently connected to the database.
• The server named Server2 contains one instance, wfc, and is not currently
connected to the database
You can click on a application server hostname to open up a workspace with
information specific for the application server/Workforce Central instance
combination. The following information appears:
• Application Server Hostname — Identifies the name of the application
server machine.
• Application Server IP Address — Identifies the IP address of the
application server machine.
• Inter Process Connection URL — Identifies the URL of the instance.
• Web Server Hostname — Identifies the web server for the application server
machine.
• Status — Shows whether the instance is connected to the database and
whether the instance is online.
• Application Context — Identifies the context of the instance.
• Application Name — Identifies the name of the application.
• Application Description — (Optional) A description of the application
appears if you entered a descriptive name with the Instance Manager.
• Logon URL — Identifies the URL used to log on to the instance.
• Event Manager — Identifies if the instance is the Event Manager server.
• Language — Shows the language of the instance.
• Reports Engine — Shows whether the reports engine is enabled for the
instance.
Click Remove from Database to remove an application server/instance that is
disconnected from the database and is no longer part of Workforce Central.
56 Kronos Incorporated
Applications information
Applications information
The Applications workspace displays the names and version numbers of the
products that are currently installed on the specific instance. This list of products
can also be found in:
WFC.rootdir\instance\applications
Note: Submitting one or more employees for totalization means that they become
eligible for retotalization. The retotalization does not occur until a background
processor is available.
58 Kronos Incorporated
Background Processors information
Database information
The Database information tab has the following workspaces:
• “Database” on page 60 — Displays the status and details about the database
to which the Workforce Central server is currently connected; enables you to
run and view various database reports.
• “Database Report Status” on page 61 — Displays the current list of
database reports.
• “Database Report Display” on page 62 — Displays a database report that
you selected in the Database Report Status workspace.
Database
The Database workspace displays status and details about the database to which
the Workforce Central server is currently connected, and provides information
about how to run and to view various database reports.
The following information appears in the workspace:
• Database Name — The database shown is the one to which the instance is
currently connected. (Your instance can connect to different databases.)
• Status — Shows whether the database is online.
• Version — Shows the version of the database.
• Database Server — Shows the name of the database server.
• Server Time — The time of day shown 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. For more information, see “Clock
Synchronize settings” on page 105.
– If the database and the application server are in the same time zone, the
Workforce Central system uses this value.
– If the database and the application server are in different time zones, the
system accommodates the different time zone.
60 Kronos Incorporated
Database information
– 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.
• Database Product — Shows the type of database.
• Product Version — Shows the version of the database type.
• Available Database Reports — Shows the available database reports.
If you have an SQLServer or ORACLE database, you can run database reports
that provide statistical and diagnostic information. The Available Database
Reports list box contains four predefined reports (Space allocation, Schema
Reconciliation Information, Tuning Parameters, and Object Reconciliation
Information).
You can create and list custom reports here by building your own Database Report
Definition (DRD) files. For more information, see “Creating Database Report
Definition files” on page 63.
You can use these reports to view information such as:
• How much space is left
• Number of extents available
• Table space definitions
• Grants and permissions
• Performance tuning parameters
Click View Report Status to access the Database Report Status workspace. The
View Report Status link is active even if there are no reports listed in the Database
Report Status workspace. When there are no reports, an empty list appears.
To run a report, select a report from the list and then click Run Report. When you
run a report, the Database Report Status workspace appears automatically.
• A check box that indicates whether the report has been selected for deletion
• Report Name
• Status
• Start Date and Time
• Finish Date and Time
• Requested By User
The following menu items are available:
• Refresh Status — Updates the workspace with any new or updated data
• Select All — Selects all of the reports
• Deselect All — Deselects all of the reports
• Delete — Deletes all selected reports from the list
Click on a report name of a completed or failed report to view the report.
Click the Database tab or the Database link to return to the Database Information
workspace.
Click Refresh to update the workspace with any new or updated data.
Note: You cannot update the workspace using your browser's Refresh button.
The system periodically deletes reports from this workspace if you do not
manually delete them. You can configure the length of time that it takes for a
report to be automatically deleted using the
site.database.all.dbreport.Report.RepTimeToLive key on the
Database settings tab in System Settings. The value is expressed in hours and the
default is 72 hours.
62 Kronos Incorporated
Database information
64 Kronos Incorporated
Database information
• SQL String
– The first component is the same as the first key component for the report
name attribute.
– The second component is the same as the second key component for the
report name attribute.
– The third key component must be sqlString.
The key must be followed by the “ = ” string., followed by the executable
SQL or the name of the stored procedure.
66 Kronos Incorporated
Licenses information
Licenses information
The Licenses workspace displays the current licensing information for Workforce
Central instance. You can view your license limit, licenses in use, and the
resulting license availability for each product.
Click Reread License Files to update the workspace with any new or updated
data based on the files contained in the
\Kronos\instance_name\licensing and \Kronos\wfc\lm folders.
The notification threshold at the top of the workspace specifies the number of
licenses left available before a notification is sent warning that the number of
available licenses is getting low. The threshold value is a percentage of the total
number of licenses. For example, if you have licenses for 1000 employees, and
the percent is set to 90, an e-mail notification is sent out when the number of
licenses in use reaches 900. You can edit the notification threshold by changing
the value in site.email.license.percent in E-mail Settings. You define
the notification e-mail address during the notification configuration process.
If you have multiple servers, you must install WPKLicense update files on each
server and each server's license workspace must be refreshed for the additional
licenses to be available for that server.
Meters information
The Meters workspace lists the performance utilities that are installed on the
application server or instance. By studying the results of running these meters,
you can assess the performance of your system and analyze peak usage periods.
To view the results for a specific meter, click the blue triangle to the left of 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.
68 Kronos Incorporated
Primary Labor Account Update information
70 Kronos Incorporated
Threads information
Threads information
The Threads workspace lists the long-running daemons that are currently running
on the instance. Keep track of these daemons to see that they run as expected. You
can stop and restart the daemons.
Each row shows the following information:
• Restart — Click to restart a thread that is Stalled or Stopped, which is
specified in the State column.
– Restarting a Controller thread restarts all the Worker threads that are
associated with it.
– Restarting a Worker thread has no effect on any other thread.
• Stop — Click to stop a daemon that is currently running, to prevent a process
from running out of control or looping.
– Stopping a Controller thread also stops all the Worker threads associated
with it.
– Stopping a Worker thread has no effect on any other thread.
• Thread — Each thread has a unique name.
• Type — Identifies the thread as a Controller or Worker.
– A Controller is a parent thread, and can have one or more Worker threads
associated with it.
– A Worker can be a child thread that is associated with one Controller
thread, or it can be launched independently.
• State — Identifies the current status of a thread:
– Running; the thread is currently performing work.
– Stopped; the thread is not currently running.
– 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.
72 Kronos Incorporated
User information
User information
The User workspace identifies users who are currently logged on to the instance.
Information for each user appears in a separate row.
You can use this workspace to see who has logged on to the instance. Users should
have a separate system ID and should not all use superuser as a login.
In addition to the logon time, the following information appears for each user:
• The Last Access column shows the last time that each user took an action in
the session. It also identifies users whose sessions have remained inactive for
a period of time.
• The Elapsed Time column shows how long a user session has lasted. This
column can also identify unusually long-running sessions.
• The Remote User column identifies the Internet Protocol (IP) address of the
user’s PC. If multiple users have the same User Name, the Remote User
column distinguishes between them.
Click Refresh to receive up-to-date values for Last Access and Elapsed Time.
74 Kronos Incorporated
Chapter 3
Log Report
This chapter explains the Log Report section of the System Configuration
component and describes the tasks that you use to work with log reports. This
chapter contains the following sections:
• “Log reports” on page 76
• “Log files” on page 79
• “Log file report” on page 81
• “Filtering and running log reports” on page 82
• “Archiving system log reports” on page 83
Chapter 3 Log Report
Log reports
Use the Log Report workspace to specify parameters for a log report based on
information in the system log files. You can:
• Arrange this information into customized reports.
• Generate reports by using the default values or by specifying a log filter to
produce a more concise report.
• Distribute the reports by e-mail, by 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:
• Windows: WFC.rootdir\logs
• UNIX: WFC.rootdir/wfc/logs
The Workforce Central 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.
Click Run Report to run a log report after you have selected filter criteria.
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
might be useful for analysis and troubleshooting.
• In Internet Explorer, click Print or right-click on the report page and select
Print.
76 Kronos Incorporated
Log reports
server_name/instance_name
where the default is server_name/wfc. 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.
If you select a subset, you will need to run the log report several times, with
different server/instance combinations each time, to ensure 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.
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.
Context — Context classifies log messages by the Workforce Central instance
that generated them. You can filter your 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. Kronos recommends that
you use the Context option when requested to do so by Kronos Global Support.
Most of the time, select All.
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.
Priority — This value determines the severity level display of the system log.
Severity levels are not inclusive, so you can request one level, several levels, or
all. The default value is All. Specifying All includes all available log levels. You
set the value of the site.log.loglevel property in the Log File tab of the
System Settings component.
The available severity levels are:
• All = All messages
• ERROR = The most serious messages
• WARNING = Cautions that might indicate future problems on the server
• INFORMATION = Informational messages
• DEBUG = Entries you will report to Kronos support personnel (not intended
for general use)
78 Kronos Incorporated
Log files
Log files
Workforce Central contains multiple log files. The most commonly used log file is
the system log file.
Note: Do not modify a log file using a text editor. The log report expects a certain
format, and changes may prevent the report from displaying properly.
80 Kronos Incorporated
Log file report
Note: These log report facilities are only available for the system log and they do
not include information recorded in specialized logs for the Event Manager or
Reports.
You might see an Event Manager or a Reports exception in the system log.
However, you should examine the logs for those components, rather than relying
on the system log to inform you of a problem.
82 Kronos Incorporated
Archiving system log reports
84 Kronos Incorporated
Chapter 4
Log File Gathering
Use the Log File Gathering tool to gather all the log files in your Workforce
Central 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.
This section contains the following:
• “Listing the log files to be gathered” on page 86
• “Gathering log information” on page 88
• “Opening gathered log files” on page 89
Chapter 4 Log File Gathering
Note: 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.
If IIS is installed and the IIS log files are not in the default location, add the
appropriate path to site.log.file.gather.list. The default location for
IIS logs is C:\Windows/system32/LogFiles/HTTPEERR/* and
C:\Windows/system32/LogFiles/W3SVC1/*.
Note the following:
• When the web server and application server are separated on different
machines, only application log files are collected unless you map the web
server log directories and add them to site.log.file.gather.list.
• If reports are stored and rendered by SQL Server Reporting Services (not
RDLC), you should map to the SQL Server directory and add the log files to
site.log.file.gather.list.
• Dedicated servers such as BGP, reports, DCM, and so on do not accept remote
work. Map to the network directories and add the log files to
site.log.file.gather.list.
• IIS logs will be collected regardless of the fact that Workforce Central might
not be deployed under IIS.
If the log files to be gathered are very large, there are three properties that can be
adjusted. These properties are in WFC.rootdir\Kronos\wfc\
applications\wpk\properties\custom_wpksite.properties.
Change these settings only upon the direction of a Kronos Service Representative
• site.zip.manager.lock.retries.max — Indicates the number of retries in case
of file locking. The default is 3.
86 Kronos Incorporated
Listing the log files to be gathered
88 Kronos Incorporated
Opening gathered log files
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.
90 Kronos Incorporated
Chapter 5
System Settings
This chapter explains the System Settings section of the System Configuration
component and describes the tasks that you use to work with system settings. This
chapter contains the following sections:
• “Overview” on page 93
• “Working with System Settings” on page 94
It also contains descriptions of the following System Settings tabs:
• “Audit Settings” on page 98 • “Logging Context settings” on page 148
• “Background Processor settings” on page 102 • “Messaging settings” on page 149
• “Business Automation settings” on page 99 • “Printers settings” on page 150
• “Clock Synchronize settings” on page 105 • “Reports settings” on page 157
• “Database settings” on page 109 • “Record Retention - Affected Databases
settings” on page 152
• “Data Source settings” on page 107 • “Record Retention - Database Setup settings”
on page 153
• “Display settings” on page 116 • “Record Retention - Options & Tuning
settings” on page 154
• “E-mail settings” on page 117 • “Security settings” on page 160
• “Event Manager settings” on page 120 • “Service settings” on page 167
• “Global Values settings” on page 126 • “SQL Coverage settings” on page 169
• “Group Edits settings” on page 136 • “Startup settings” on page 171
• “Java Plug-in settings” on page 139 • “Transformation settings” on page 172
• “Locale settings” on page 140 • “Web & App Server settings” on page 173
• “Log file settings” on page 145
Note: The settings described in this chapter are a representative sampling of the
most common settings. The actual settings that appear on your system may vary,
depending on the add-on applications that you have installed. For information
Chapter 5 System Settings
about system settings that are not described in this chapter, refer to the
documentation for the products that you have installed.
92 Kronos Incorporated
Overview
Overview
The System Settings workspace displays a set of tabs representing different
characteristics of the system that relate to your environment. The exact System
Settings tabs that appear depend on the combination of applications from the
Kronos suite that have been installed. Clicking each tab displays properties for
that area that can be edited, and an action menu. When you change and save the
values of system properties, your changes are stored in a custom property file.
System Settings are derived from the configuration files that contain the
properties and parameters for configuring your system. Typically, your system is
configured during or shortly after installation.
If you have an administrator access profile, you can edit the system settings. After
the initial configuration, avoid editing settings except to fine-tune or adjust the
system for a different environment.
When you modify a property using System Settings, the system automatically
writes to the appropriate custom property file. You cannot inadvertently modify
the wrong file.
There are two types of properties:
• Site-specific — Properties that pertain to a single Workforce Central instance.
These properties are maintained in property files within the specific instance.
• Global — Properties that pertain to all instances in the system. These
properties are maintained in the database.
94 Kronos Incorporated
Working with System Settings
Note: Restoring defaults has no effect on global properties that are maintained
in the database. Modified database values remain modified.
• Restart Server — Click Restart Server to start the instance again so that
site-specific property changes can take effect. Restart Server causes the
Workforce Central instance to shut down immediately. Then, the instance
restarts.
• Add — The Printers and Data Source tabs allow you to add printers and data
source names.
When you click Add on these tabs, 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, you can add another printer
on the Printers tab. If printer.1 through printer.6 are already in use, click Add
to get the new property, printer.7, and enter the qualified name for the seventh
printer.
You can 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.
Some property instances are described by multiple properties. If you click
Add for an instance that requires multiple properties, you receive multiple
new properties for the new instance. For example, if you click Add on the
Data Source tab, you get new property names for dsnname.n.name,
dsnname.n.pwd.rsa, and dsnname.n.usr, where n is the next sequential object.
To add a new dsnname instance, you must provide values for all three
properties.
• Refresh — Click Refresh to update the workspace with any new or 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.
96 Kronos Incorporated
Working with System Settings
Audit Settings
The Audit Settings control the settings for all items that you can choose to audit.
You can enable or disable whether items can be audited on a site-by-site basis.
Depending on what applications you have installed, different keys may appear.
98 Kronos Incorporated
Business Automation settings
• 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.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.wf.tasklist.defaulttaskdays — The default number of days in the past for
which tasks are displayed in the task list.
Value: required; minimum=0; installed default=30
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,
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
Note: For SQL Server databases, the data source name must match exactly the
data source name in the computer’s ODBC setting.
Note: All DSN names must be unique. There is no validation on DSN names;
therefore, you must verify that there are no duplicate DSN names. If you find a
duplicate DSN name, edit the name and click Save.
Do not modify any properties in this setting unless you want the change to be
applied to all of the instances in the system that are connected to the same
database.
After you click Save, any changes that you made are permanent. There is no way
to restore or reload the previous settings.
Note: All DSN names must be unique. There is no validation on DSN names;
therefore, you must verify that there are no duplicate DSN names.
dsnname.dsn_number.usr — The user name associated with the DSN used for
database access.
dsnname.dsn_number.pwd.rsa — The password for the DSN and user.
Passwords are stored encrypted.
Note: All DSNs must be unique. There is no validation on DSNs; therefore, you
must verify that there are no duplicate data source names.
When you click Add, the system adds the three property names, and you enter the
values. When you click Save, the three new properties are added to the
WPKDsnname table. There is no limit to the number of DSN entries that you can
add. The Data Source tab lists all the dsnnames in your system.
All dsnname password properties are encrypted with RSA encryption standards.
The system automatically handles this type of encryption. If you add or modify a
dsnname password, you must enter the value using this tab and let the system
encrypt it. Do not modify any properties in this tab unless you want the change
applied to all instances in the system.
Note: Properties with a global scope across instances of Workforce Central are
maintained in database tables. If you switch databases, you must copy the
appropriate properties to the new database. Properties with global scope belong to
the property groups global, printer, servers, and dsnname.
Database settings
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.
Various Workforce Central 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.
site.database.url — The database name with .url is the jdbc connection string
used to connect to the database.
Value: required
site.database.usr — The database name with .usr is the user name of your
database.
site.database.pwd — The database name with .pwd is the password associated
with the specified user name.
site.database.drv — The database name with .drv is the jdbc driver to use.
site.database.dsn — The database name with .dsn is the data source name for
that connection.
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=50
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=0
Switching databases
You may need to switch databases at times; for example, from production to
test.
The database that was identified when your system was installed is probably your
production database. Configuration settings for this database appear in the
WPKSite.properties property file.
Note: Use the database name in the URL when referring to a SQL Server
database, and the database SID when referring to an Oracle database.
Note: Remember to reconfigure the instance after you are done accessing the
archive database.
For example, if the database has a driver inetdae7, a port value of 1433,
an SID of arch4, and is on a server named server_1, the property value
would be: jdbc.inetdae7:server_1:1433?database=arch4
3. Set the site.database.dbname.usr property to the user account name
of the database to which you want to switch.
4. Set the site.database.dbname.pwd property to the password for the
above user account.
5. Click Save.
6. Stop the Workforce Central server using the Stop Workforce Central icon.
7. Open the odbc.ini file.
8. For the database to which the Workforce Central instance is currently
pointing, change the SID and host database information to that of the database
to which you want to switch.
9. Save the file.
10. Restart the Workforce Central server using the Start Workforce Central
icon.
11. In the Setup workspace, select System Configuration. On the Data Source
System Settings tab, change the values of the dsnname.1.usr and
dsnname.1.pwd.rsa properties to the user account name and the
associated password for the new database.
Note: Remember to reconfigure the instance after you are done accessing the
archive database.
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?database=database_
name. Note that the property specifies the same database_name in its
name and its value.
In most cases, you only need to change the database_server and the
database_name values. For example, if the driver has a value of
inetdae7, a port value of 1433, a database named summary, and a
database server named server_1, then your property file contains the
following line:
site.database.summary.url=jdbc:inetdae7:server_1:14
33?database=summary
• site.database.drv — Identifies the name of the JDBC driver. Only the name
of the property should change to match the name of your database. The
property value should remain unchanged. For example, if your current
database is named prod and you are switching to a database named integ,
then change the current property to site.database.integ.drv =
com.inet.tds.TdsDriver
• site.database.usr — Identifies the database logon user ID that was set up
during the initial configuration. If you use the same logon user ID for the new
database, change only the property name.
• site.database.pwd — Specifies the value of the encrypted password that was
set up during the initial configuration. If you use the same password, change
only the property name.
• site.database.dsn — Identifies the data source name (DSN) associated with
the database. To switch databases, include the name of the database in the
property name and its value. The DSN is needed for components that access
the database through an ODBC connection. For example:
site.database.integ.dsn = integ
• site.database.min — Only the name should change to match the name of
your database. The value should remain unchanged. For example:
site.database.integ.min = 10
Note: Properties with global scope across instances are maintained in database
tables. If you switch databases, you must copy these properties to the new
database.
Display settings
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. For instructions about designing
a theme, refer to “Configure a visual theme” on page 27.
Note: Enabling this setting increases the load on the system. In a production
environment, it is recommended that this value is set to false.
E-mail settings
E-mail (also known as Workflow Notifications) settings enable you to establish
parameters for all notification e-mails that Workforce Central generates. For more
information, see “Working with Workflow Notifications” on page 39.
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.
Note: If you use Windows Code Page 1252 for your character set, you must
change the character set for e-mail to ISO-8859-x.
Note: During installation, you were prompted to enter a Windows user name and
password that have permission to run Microsoft Task Scheduler, which is used to
launch events. If you did not enter values, you can enter the values into
site.eventmanager.NT.user and site.eventmanager.NT.pwd.
• The Event Manager log — The Event Manager and the Microsoft Task
Scheduler do not use the system log. If an exception occurs, the event might
be reported to the system log. Event Manager exceptions are always reported
in the Event Manager log.
Specify properties for the Event Manager log in the Event Manager tab as
follows:
Note: You should keep the Event Manager log enabled most of the time. If Event
Manager is running normally, little information is written to this log. However, if
a problem develops, the initial log entries are invaluable in diagnosing and
correcting the problem. The recommended severity level is ERROR; that is,
site.eventmanager.logPriority = 1. Kronos Global Support might
ask you to set a different level for a short time.
Caution: Do not modify any properties in this setting 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.
After you click Save, any changes that you made are permanent. There is no way
to restore or reload the previous settings.
time zones are not an issue, set the property to the default value.
Value: required; installed default=DEFAULT
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.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 Genie.
Value: required; minimum=1; installed default=1000
global.LongList.ScheduleSummaryEmployeeThreshold — Maximum number
of employees that can be displayed in a Scheduling Genie.
Value: required; minimum=1; installed default=200
global.m8m.login.password — The password for logging in the URL Dispatcher
Service that is used by the 4500 Terminals.
Value: required; installed default=4500User
global.m8m.login.username — The user name for logging in the URL
Dispatcher Service used by the 4500 Terminals.
Value: required
global.OvertimeEqualization.enabled — Set to true to enable overtime
equalization. When this is set to true, the Overtime menu appears on Time and
Attendance Genies menus.
Value: required; installed default=False
Note: If you change this setting, you must restart the Workforce Central instance
for the change to take effect.
global.ProductivityMonitor.excludeTodayFromWeekToDateTotals —
Excludes the current day from weekly totals.
Value=required; installed default=False.
global.Reporting.Engine — Specifies the reporting engine used to generate
reports.
Value: required; installed default=Crystal 10
global.reporting.totalizer.threshold —
Value: required; installed default=100
global.reporting.totalizer.threshold.megaproblem —
Value: required; installed default=10000
global.security.termination.effectiveatmidnight — If true, users who have been
terminated will be allowed to access the system until midnight on the date of
termination.
Value: required; installed default=True
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.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.wba.login.password — The Process Manager password, WBAUser. Note
that this setting does not change the password. You can change the password by
logging in to Workforce Central as WBAUser and then using the Change
Password function.The value for this setting must match the new password.
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 Workforce Scheduler is installed.
Choices are unavailable, unknown, or available.
Value: required; installed default=unknown
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
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.ScheduleGroups.api.DefaultEditLevel — Determines
whether actions taken at the Schedule Group level through an API will be treated
as a group edit or an employee edit.
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.
Possible values are:
0 = off
1 = on
Value: required; installed default=0
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
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.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 Group Level
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.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.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.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=Yes
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.)
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
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.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.
This setting works with the Store Scheduled and Projected Totals check box in
pay rules. The Background Processor calculates scheduled and projected totals for
employees. The global.WtkTotalizer.MinimumDaysInFutureForScheduledTotals
setting specifies how far out in the future that totalization is performed.
Value: required; minimum=1; maximum=366; installed default=3
global.WtkTotalizer.MinimumInactiveDaysWithoutTotalingActuals —
Minimum number of days that the 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.PaycodeMovesAreContributingShifts — Determines
whether pay code moves contribute to holiday calculations; specifies whether
moving hours from one pay code to another affects the shift history for holidays
with Work History Qualifiers. Set to yes to have pay code moves contribute to
holiday calculations.
Value: required; installed default=no
global.WtkTotalizer.ProcessScheduledPayCodeEditComments — Indicates
whether comments entered in Scheduled Pay Code Edits can be linked to
timesheet items.
Value: installed default=No
global.WtkTotalizer.ResetProbationOnProfileChange —
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=1
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.
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 Workforce Central
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=0, guaranteed time is included in previous work
span; value of 1 indicates guaranteed time appears as separate work span.
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
Note: If you change either global.xmlservice.login.password or
global.xmlservice.login.username in the Global Values tab workspace, you must
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.
Locale settings
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 Workforce Central
icons in order for new values of any language or country keys to take effect.
Note: The order of the day and month must match that of the browser locale.
Note: If you change the default language/country, and the long date format of the
language/country you specified is different from the system default, you must also
change the Long Date value to the long date format of the specified language/
country.
Note: The order of the day and month must match that of the browser locale.
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.
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.
Note: You must specify the same value for this property on every instance
associated with one database.
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 Workforce
Central pages.
Caution: When you save the value, the instance shuts down immediately. All user
sessions are terminated with no warning.
Caution: Do not change any parameters on this page without direction from
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.
Messaging settings
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.
Note: Many process templates contain a K-mail 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 Workforce Central Inbox, employees will not
receive the external e-mail message. For more information, see the K-mail
descriptions in the Workforce Central Process Manager Programmer’s Guide.
Printers settings
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:
• Printers are a global resource for the system. In a multi-instance environment,
all instances have the same list of printers.
• Printer properties are maintained in the database.
• 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 = WFC Printer 1;\\\\APOGEE\\LochNess;Group 1
where WFC Printer 1 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. See “Working with property files” on page 34 for more information.
Caution: Do not modify any properties in this setting unless you want the change
applied to all of the instances in your environment.
After you click Save, any changes that you made are permanent. There is no way
to restore or reload the previous settings.
Note: Do not leave any fields blank. Failure to fill in all fields will result in
database offline errors.
Reports settings
The Reports settings establish the reporting properties. Before users can create
and schedule reports, you must establish the reporting properties using this
information.
See Chapter 7, “Reports,” for information about creating reports.
Note: For UNIX platforms, reports are on the companion Windows server.
Security settings
Security settings establish an offline environment and specify the authentication
mode that your Workforce Central 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 Workforce
Central’s records.
See “Understanding authentication” on page 163 for more information about the
different authentication types.
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.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.logoffurl — Specifies the logoff URL if single sign-on
is enabled.
Value: required; installed default={WFC.context}/logon/
logonWFC.html
site.security.singlesignon.module — The name of the module, such as Java class
file, that implements single sign-on for Workforce Central. This is only used when
Workforce Central integrates with a third-party single sign-on solution.
Value: installed default =
com.kronos.wfc.platform.security.business.authenticati
on.ssoplugin.SSOSiteMinderSubject
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 Workforce Central integrates with a third-party single sign-on
solution.
Value: installed default={WFC.externaldir}/applications/wcb/
properties/SSOSiteMinder.properties
site.security.external.product.HRMS.enabled — Set to true to specify that
Workforce HR™ and Workforce Payroll™ (Workforce HR/Payroll) are installed
and configured.
Value: required; installed default=false
site.security.external.product.HRMS.ServerName — The server where the
Workforce HR/Payroll application is installed.
site.security.external.product.HRMS.VirtualPath — The virtual path where
the Workforce HR/Payroll server is installed for the IIS server.
wfc.wfp.urldispatcher.security.AnyBrowser
Authentication
Understanding authentication
Authentication is the validation of a user name and password by a trusted
authority. The system makes different kinds of authentication modules available.
Note: Regardless of the type of authentication that you specify here, the following
accounts always use Kronos authentication: SuperUser, Totalizer, TaskRunner,
and DCM’s user accounts.
Note: This is the local and default authentication scheme. The user must exist
in the database to which the server is attached. Changing databases when
using PROPRIETARY authentication may cause authentication problems.
The authentication source must be the same across domains.
• WinNT
If you use a WinNT value without specifying a domain, Workforce Central
proxies the authentication request to a Windows domain server, as specified
as part of the user name at logon. Windows validates the user ID and
password.
This setting is used for supporting authentication against multiple Windows
NT domains. Workforce Central user names must be specified as domain
name\user id—for example, CORPORATE_DOMAIN\dgormley. This entire
value is the full user name value stored in the Workforce Central user account
table and shown in all views, Genies, and reports. When users log on to
Workforce Central, they enter their full user names in the logon screen—for
2. Set site.security.authentication.logoff.
restartTimer.seconds to the appropriate number of seconds.
3. Click Save.
Service settings
Service settings establish properties related to the Workforce Central 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.x where x 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.
Startup settings
The Startup setting controls the system startup.
Transformation settings
The Transformation settings control the data transformation service for any
services, such as reports.
Value Definition
http Standard mode
https Secure mode
system Applets will use the protocol determined from the HTTP
request, which is the protocol used to request the applet.
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).
site.webserver.appserver.IpcPort — The port through which the application
server receives communication requests.
Value:required; installed default=8080
site.webserver.webServerHostName — The name of the computer where the
web server resides.
Value: required; installed default=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=false
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.
Note: If you change any of the configurable terms, make sure you restart your
server before continuing.
Configurable terms
The six configurable terms settings are listed here.
Note: If you change any of these configurable terms, make sure you restart your
server before continuing.
– 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”)
– The label of the configuration and calculation settings of the weight sets.
• site.workload.configurableterms.addvolume —
• 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.
• 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:
– The Generate Workload dialog box (accessed by selecting
Actions > Generate Workload from the Calendar tab in the Workload
Planner)
– The View option under the third tab in the Workload Planner
– 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:
– The Generate Workload dialog box (accessed by selecting
Actions > Generate Workload from the Calendar tab in the Workload
Planner)
– The View option under the third tab in the Workload Planner
– 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:
– The View option under the third tab in the Workload Planner
– A data label in the grid under the third tab in the Workload Planner
Color Group 1
100% of Primary color 1
RGB(127,185,143)
Primary color 1 Color Group 2
70% of Primary color 1
Lightest color RGB(165,206,176)
Color Group 3
40% of Primary color 1
RGB(203,227,210)
Color Group 4
100% of Primary color 2
RGB(21,91,156)
Primary color 2 Color Group 5
70% of Primary color 2
Medium color RGB(91,140,185)
Color Group 6
40% of Primary color 2
RGB(161,189,215)
Color Group 7
100% of Primary color 3
Primary color 3
RGB(52,73,93)
Darkest color Color Group 8
25% of Primary color 3
RGB(204,209,214)
These colors are displayed on the following sample page. Each number on the
sample page corresponds to one of the eight color groups.
Hide/show
button
Complete these steps to select the eight colors and their values:
1. Choose three primary colors that the organization uses most frequently; for
example, the main colors on its web site, in its logo, or in its marketing
collateral:
– Primary color 1 should be the lightest color of the three primary colors.
– Primary color 3 should be the darkest color of the three primary colors.
– Primary color 2 should be in between the light Primary color 1 and the
dark Primary color 3.
2. Start a graphics tool and open the color palette.
3. Import an image file with the primary colors; for example, a logo.
4. Use a color eyedropper tool to pick up Primary color 1 and add it to the color
swatches.
5. In the color palette, select Primary color 1; its color definitions appear. Write
down the Red, Green, and Blue values (RGB values).
6. Repeat step 4 and step 5 for Primary color 2 and Primary color 3.
7. Derive two secondary colors from Primary color 1:
a. In the graphics tools, create a new object with Primary color 1.
b. Change the value to 70% of Primary color 1, so that it is lighter than
Primary color 1.
c. Use the eyedropper to pick up the 70% color and add it to the swatch
library.
d. In the color palette, select the 70% color, and write down the RGB values.
e. Repeat step a through step d to create another secondary color from
Primary color 1 at 40% of Primary color 1.
8. Derive two secondary colors from Primary color 2:
a. In the graphics tools, create a new object with Primary color 2.
b. Change the value to 70% of Primary color 2, so that it is lighter than
Primary color 2.
c. Use the eyedropper to pick up the 70% color and add it to the swatch
library.
d. In the color palette, select the 70% color, and write down the RGB values.
e. Repeat step a through step d to create another secondary color from
Primary color 2 at 25% of Primary color 2.
9. Derive one secondary color from Primary color 3:
a. In the graphics tools, create a new object with Primary color 3.
b. Change the value to 25% of Primary color 3, so that it is lighter than
Primary color 3.
c. Use the eyedropper to pick up the 25% color and add it to the swatch
library.
d. In the color palette, select the 25% color, and write down the RGB values.
10. Assign the eight colors to color groups and write down the RGB values. You
will use these values in “Specify custom property values in theme.css” on
page 185 and “Change colors in the image files to match the custom theme”
on page 189.
For example, this table lists the RGB values for the example eight color
groups in “Select colors for the theme” on page 180:
Requirements
Change theme.css
3. Change the default RGB color values for the eight color groups, using the
values that you selected in “Select colors for the theme” on page 180. Note the
following:
– Symbolic color names (for example, red) and hexadecimal color values
(for example, FF0000) are not supported. You must use RGB color
values.
– Other selector attributes are not supported. For example, if you specify
line-height or font-variant values, they are ignored.
– Do not change the background color (background-color) value in
the kronos base class:
/**
* Overall default values.
*/
#kronos{
background-color:rgb(255,255,255);
color:rgb(0,0,0);
font-family:Arial,Verdana,sans-serif;
font-size:11px;
font-weight:normal;
font-style:normal;
}
If you change the background color from white, several items in the pages
might not appear as you expected.
Search in theme.css for the selectors listed in the following table and
specify the new RGB color values. If the property listed in the table for the
selector does not exist in theme.css (there are some properties that do not
exist in the default theme.css), add the specified property to the selector.
Property to add or
Color group Selector change
1 #kronos .NavBar background
2 #kronos .ActionBar background-color
#kronos .ActionBar .Action background-color
#kronos .ActionBar .Action.Hover background-color
#kronos .TabBar background-color
Property to add or
Color group Selector change
3 #kronos .TabBar .Tab.Selected background-color
#kronos .TabBar .Tab.Selected.Hover background-color
#kronos .Tabular TH background-color
#kronos .Tabular TD.Selected background-color
#kronos .TabBar .Tab.Selected background-color
#kronos .WorkArea .Panel background-color
4 #kronos .TabBar .Tab.Selected color
#kronos .TabBar .Tab.Selected.Hover color
#kronos .NavBar .TabMenuSelected background-color
#kronos .WorkArea .Button.Hover background-color
#kronos .WorkArea .Button background-color
#kronos .SuiteBar .ActionSelected color
#kronos .SuiteBar .ActionSelected:Hover color
5 No changes required. No changes required.
6 #kronos .Tabular TR.Selected background-color
#kronos .Tabular TR.Active background-color
7 #kronos .NavBar .TabMenu background-color
#kronos .NavBar .TabMenu:Hover color
#kronos .NavBar .TabMenuLinks background-color
#kronos .NavBar .UtilityLinks color
#kronos .WorkArea .ContentPanel .HeaderBar color
#kronos .WorkArea .Heading color
#kronos .ActionBar .Action color
#kronos .ActionBar .Action.Hover color
#kronos .TabBar color
Property to add or
Color group Selector change
8 #kronos .Tabular TR background-color
#kronos .SuiteBar .Action:Hover background-color
#kronos .SuiteBar .ActionSelected background-color
#kronos .Dialog background-color
to
#kronos .NavBar{
background: rgb(127,185,143);
4. Change the default font specification in the main style class, #kronos; when
you make changes to this class, the changes are inherited by its subclasses for
use throughout the user interface. Use a san-serif font (for example, Arial) for
best results.
Search for this class in theme.css and specify the new font definitions. For
example:
#kronos{
background-color:rgb(255,255,255);
color:rgb(0,0,0);
font-family:Arial,Verdana,sans-serif;
font-size:11px;
font-weight:normal;
font-style:normal;
}
This specification changes the font to Gill Sans and the font size to 10 pixels:
#kronos{
background-color:rgb(255,255,255);
color:rgb(0,0,0);
font-family:Gill Sans, Arial,sans-serif;
font-size:10px;
font-weight:normal;
font-style:normal;
}
You need a graphics editing tool to work with the image files; for example,
Adobe® Fireworks or Adobe Photoshop®; Adobe Fireworks is recommended.
To correctly display application pages in all browsers, export most of the image
files as 8-bit, PNG files with alpha transparency. Export the tab image files as 24-
bit PNG files to ensure that they appear correctly against the header background.
The table in step 4 in “Procedure” on page 189 specifies how to save each file.
Procedure
1. On the web server system where you are creating the custom theme, go to the
install_directory\wfc\applications\wpk\themes\custo
m_theme\icons folder, where custom_theme is the name of the folder
for the theme that you are developing.
2. Send one of these zip files to a graphic artist. The file that you send depends
on the graphics editing tool that you are using:
– Fireworks—SourceFiles_PNGformat.zip
– Photoshop—SourceFiles_PSDformat.zip
3. Make sure the graphic artist is working outside of the custom theme folder.
Instruct the graphic artist to unzip SourceFiles_PNGformat.zip or
SourceFiles_PSDformat.zip.
4. The graphic artist must change the default color values to the RGB values in
“Select colors for the theme” on page 180 in each of these image files and
save the files in the format specified:
5. Instruct the graphic artist to zip all the image files and send the zip file back
to you. Then, copy the zip file to the web server where the custom theme is
being created.
6. Unzip the file to the
install_directory\wfc\applications\wpk\themes\custo
m_theme\icons folder, where custom_theme is the name of the folder
for the theme that you are developing
This chapter contains information about working with reports in the Workforce
Central system. This chapter contains the following sections:
• “Overview” on page 198
• “Managing reporting environments” on page 202
• “Customizing reports” on page 211
Chapter 7 Reports
Overview
The Workforce Central application provides integrated reporting capabilities that
enable you to perform a number of tasks that are not available with other reporting
tools:
• Use the Event Manager component to schedule a report to run at a specific
time or at specified intervals.
• Send your completed report instance to a printer, your browser, or to an e-mail
recipient from within the application.
• Use the HyperFind query to select people or the location chooser to select
locations for a report.
• Browse the report instance online.
• Determine who can access specific information, such as wages data, within a
report.
• Include the most current totalized data from the database.
In addition to these built-in capabilities, Workforce Central supports integration
with Microsoft SQL Server Reporting Services (SSRS). This integration is
referred to as Advanced Reporting. Advanced Reporting provides more options
for viewing and distributing Workforce Central reports.
The two methods for generating reports are described below:
• Basic Reporting — Uses standard RDL and RPT files and a built in Report
Viewer control to provide PDF reports. Requires no additional installation or
configuration.
• Advanced Reporting — Uses standard RDL files and SSRS to deliver HTML
reports. Requires an SSRS server. A subset of Workforce Central reports are
delivered as RDL files. Reports that are delivered as RPT files are not
supported by Advanced Reporting.
Note: For a complete list of RDL and RPT reports, refer to the Workforce
Central Suite Release Notes.
Basic and Advanced Reporting both require a Windows companion server when
used in a UNIX environment.
Terminology
The following terms are used in connection with reports:
Term Description
background Options that control how information displays in the report header. You can set up
options or background options to identify selected option values, display calculated totals,
parameters 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 Workforce Central is used in a UNIX environment, it requires one Windows
companion server, which is needed by Workforce Central Setup, Reports, and Event
Manager.
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 Choices that are selected when users request a report in the Reports component.
options or These options are established in the report definition file and in the Report Setup
parameters component of Workforce Central.
options Settings that indicate viewable items or report selection criteria.
option or A selectable value for an option or a parameter. For example, if the option or
parameter 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 or RPT 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 or RPT file.
standard report A report provided by the system. See the Workforce Central online Help for
descriptions of standard reports.
for all non-optimized reports. The list of reports that cannot be exported to Excel
is stored at the following directory on the Workforce Central application server:
Kronos_Install_Directory\wfc\reporting\
WFCExcelReports.txt
To enable export to Excel for one of the reports contained in the list, delete the
report name from the list and save the file.
To add a report to the list, add the file name of the report, without the file
extension. For example, type TestReport for a file named
TestReport.rdl.
If you are using basic reporting, copy this file to the same location on all your
Workforce Central servers.
If you are using Advanced Reporting, copy this file to the following location on
the SSRS server and then restart IIS and SSRS:
C:\Program Files\Microsoft SQL Server\MSSQL.x\
Reporting Services\ReportServer\bin\
Workforce Central_instance_name\WFCExcelReports.txt
where Workforce Central_instance_name is the name of the Workforce Central
instance, as referenced by SSRS. For example
testServer-kronos-com-wfc.
Basic reporting
Basic reporting uses either RDL or RPT formatted files. RDL files use the built in
Kronos.Reporting.ProduceRDLCReport.exe process. RPT files use
crpe.exe. Report processing occurs on the Workforce Central application
server. There is no additional server installation or configuration required.
Reports servers
The process that Workforce Central uses to generate a report depends on your
selection in the Reports user interface:
• When you run a report to view on the screen, the request is handled by the
reports engine of the instance into which you are logged, if the instance
supports reports.
• When you print, e-mail, or schedule a report, Event Manager processes the
request. Event Manager searches for a list of available report instances,
chooses an instance at random, and submits the report request to that instance
as an HTTP/XML request.
Note: All reports for a UNIX instance are forwarded to a required Windows
companion server that is configured to support reports.
When you run many reports to view on the screen, you can improve system
performance by creating one or more Workforce Central instances that are
dedicated to generating reports. You do this 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 reports to
run.
2. In the Setup workspace, select 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.
If you disable the reports service on the primary instance and enable it on one
reports instance only, the primary instance directs all requests to run reports to the
reports instance.
If you set up more than one reports instance, the primary instance gives every
report instance an equal opportunity of receiving report requests by doing the
following:
• 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.
• When you run a report to view on the screen, the request goes to the instance
to which you are logged on.
– If the instance’s report engine is enabled, it generates the report.
– If the report engine is disabled, the report request is passed to another
instance.
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 goes on 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 requests to view a report, the system automatically copies the
report to the instance that initiated the request to access it. Therefore, the user
can log on to any instance to see the completed report, which always appears
to reside on the local instance.
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:
• 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.
• site.reporting.totalization.retries — The number of times that a report can
use the Totalizer application. The more retries that you allow, the longer a
report can remain on a queue.
• site.reporting.totalizer.threshold — The number of uncalculated rows that
you allow in a report. This value affects the failure rate and the number of
times that reports are resubmitted to the Totalizer application, thereby
increasing the reports load.
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:
site.reporting.MaxNumRepAgents = 2
you have two log files named WFCRportinglog0.log and
WFCRportinglog1.log.
Each log file is 100KB in size and is recycled when completed.
If you are using a Chinese version of Workforce Central, you must perform the
following steps in order to enable RPT reports to appear correctly:
1. On the application server, go to Control Panel > Regional and Language
Options.
2. Click the Advanced tab.
3. Select Chinese (PRC) as the Language for non-Unicode programs.
Note: If Chinese (PRC) is not available in the drop-down list, you need to
install files for East Asian languages via the Languages tab.
Advanced Reporting
Advanced Reporting requires Microsoft Internet Information Services (IIS) and a
SQL Server installation with SQL Server Reporting Services (SSRS) installed. In
addition, you must install Kronos Advanced Reporting Security on the SSRS
server and deploy the reports from Workforce Central. Report processing occurs
within IIS. All reports are defined using the standard RDL file format.
Note: If you suspect authorization is failing because cookies are not being passed
due to firewall or Internet Explorer security configurations, add the SSRS server
to your browser’s “trusted” zone.
Workforce Central Advanced Reporting does not support the ability to run reports
directly through the SSRS Report Manager. Once you install the Kronos
Advanced Reporting security extension on the SSRS server, you must log on to
Workforce Central to run reports.
Note: If you have multiple application servers that are identical in terms of
products installed and language, you do not need to run the Kronos Advanced
Reporting Security installation for each one, since each instance has the same set
of reports and authorized users. You will, however, need to indicate the URL of
the SSRS server in the System Settings > Reports tab on each application server.
Updating the SSRS server after installing new Workforce Central products
Workforce Central add-on products typically add new reports or update existing
ones. If you are using Advanced Reporting, you need to make sure that the SSRS
server stays up to date with any reporting changes on the Workforce Central
server.
Perform the following steps after installing new Workforce Central products:
1. Redeploy all reports to the SSRS server:
a. Log on to Workforce Central and click Setup in the upper right-hand
corner of the screen.
Note: If you do not see the Advanced Reports tab or the Deploy Report Files
button, make sure you have access to these controls.
2. Copy the report labels from the Workforce Central application server to the
SSRS Server, using the following instructions:
a. On the Workforce Central application server, access the following
directory:
Drive:\KronosInstallDirectory\wfc\reporting
b. Copy the following files:
KronosResources.ini
KronosResources.es-MX.ini
KronosResources.fr-FR.ini
KronosResources.zh-CN.ini
c. Save the files you copied to the following directory on the SSRS server:
SSRS_Install_Drive:\Program Files\
Microsoft SQL Server\
MSSQL.x\Reporting Services\ReportServer\
bin\ApplicationServerInstanceName
For example, C:\Program Files\Microsoft SQL Server\
MSSQL.2\Reporting Services\ReportServer\
bin\gromit-kronos-com-wfc
The SSRS server must be able to send communications to the Workforce Central
web server. If the SSRS server and Workforce Central web server are on different
sides of a firewall, you must configure the firewall to allow SSRS to send
communications via port 80 (http) or port 443 (https). These are default settings.
Microsoft SQL Server Reporting Services writes log entries to the following
location: Drive:\Program Files\Microsoft SQL
Server\MSSQL.2\Reporting Services\LogFiles
To view the most recent log entries, find the ReportServer file with the most
recent date and time. For example:
ReportServer__03_26_2007_12_51_34.log contains log information
from 12:51:34 PM on March 26, 2007.
The Report Setup > Advanced Reports workspace under Common Setup
provides a link to the Report Manager user interface on the SSRS server. This is
the best way for the Advanced Reporting administrator to access the Report
Manager.
The Advanced Reports security installation allows you to identify only one
administrator. If you need to add others:
a. Access Report Manager.
b. Click the folder name that corresponds to the name of the Workforce
Central application server instance that you are installing. For example
gromit-kronos-com-wfc.
c. Click the Properties tab and then click Security in the menu bar at the
left side of the screen.
d. Click New Role Assignment.
e. Select Content Manager as the role and type the Workforce Central user
name into the “Group or user name” field.
Customizing reports
You can create custom reports in two ways:
• Use an existing Workforce Central report as a template and make
modifications to the report definition file.
• Create a new report definition file without a template.
The instructions for customizing a report depend on the type of report file you are
customizing. This section contains instructions for customizing RDL and RPT
reports.
Note: To determine which reports are formatted as RDL and which are RPT, refer
to the Workforce Central Suite Release Notes. If you are modifying a custom
report that was created with a pre-6.0 version of Workforce Central, the report is
formatted as RPT.
If you are creating a new report definition file without a template, Kronos
recommends using the RDL format and customization instructions. Only RDL
formatted reports are supported by the Advanced Reporting functionality.
5. If you are using Advanced Reports, use the Report Setup component to
deploy the report to the SSRS server. Refer to “Deploying custom reports” on
page 217 for more information.
6. If necessary, customize report labels and update those labels on the SSRS
server. Refer to “Updating report labels” on page 217 for more information.
7. Give users access to the custom report by modifying Data Access Profiles.
Refer to “Giving users access to a custom report” on page 221 for more
information.
In order to complete these steps, you need:
• Access to Microsoft Visual Studio 2005 with Service Pack 1 installed.
• An understanding of the tables and views in the Workforce Central database.
For detailed information, see the Workforce Timekeeper Database Tables
Reference Guide and the Workforce Timekeeper Database Views Reference
Guide. A Kronos Service Representative can also help you to prepare custom
reports.
• The ability to write to the following directory on the Workforce Central
application server:
Kronos_install_directory\wfc\reports\OtherReports
• Access to the Report Setup and Advanced Reports setup component in
Workforce Central.
Note: This access is granted in your Function Access Profile under Workforce
Manager - Department Manager > Reports > Report Setup > Report Setup
Access and Advanced Reports Deployment.
Note: You must assign unique file names to custom reports. The name cannot be
the same as any other report, custom or standard.
Duplicating a report
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 you want. For example, you may only need to change a single field or
edit a single heading in the report.
The standard report definitions files provided with Workforce Central are installed
in a Reports directory that is associated with each application area of the
Workforce Central Suite. To duplicate a file, open it in Microsoft Visual Studio
and save the file with a new name.
When you open duplicated reports in Microsoft Visual Studio to customize them,
the database and password assignments from the original Kronos development
database are retained. You need to set the data source location to your database in
order to run the report in the Microsoft Visual Studio development application.
Creating a new report
Creating a new report file involves more knowledge of RDL and the Workforce
Central database tables and views. However, you may find it easier to create a new
file if the report you want to create is unlike any of the standard reports provided
with Workforce Central.
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 joined to 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.
You must modify RDL files using Microsoft Visual Studio 2005 with Service
Pack 1 installed. Refer to the following instructions when working with Kronos
reports in Microsoft Visual Studio.
Note: The requirements for custom reports vary depending on whether you are
designing reports for basic reporting or Advanced Reporting (with SSRS). If you
design a report specifically for one type of reporting, the report will not work if
you attempt to run it using the other type. This can be an issue, for example, if you
attempt to schedule a report written for Advanced Reporting, since scheduling is
only available through the basic reporting interface.
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. The settings for the XMLProcessDS dataset are different
depending on whether the report is a list report or an employee report, and the
type of employee report.
Refer to the following requirements and best practices when modifying RDL files:
• 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.
• In order to test and use functions from
Kronos.Reporting.RDLUtilities.dll while writing custom
reports, copy the dll from Kronos_install_dir\reporting to
Program Files\Microsoft Visual Studio 8\Common7\IDE.
• Implement externalized labels uniformly on all RDL files. Make sure labels
are returned even if the query returns no results. The label localization
function 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).
• Subreports should use the following file naming convention:
ReportName_subreportname_subreport.rdl
where subreportname is any readable string that explains the function of the
subreport. It is very important that subreport filenames end with the string
subreport.rdl, since this string indicates that the name of the subreport
should not appear in the user interface.
You can create custom report options for 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 Workforce Central database tables and
views, creating custom report options requires that you know how to create
parameters within Microsoft Visual Studio. Report parameters in Visual Studio
correspond to report options in Workforce Central.
3. In Workforce Central, configure a custom option that has the same properties
as the custom parameter you created in Visual Studio. This step is only
required if you are using basic reporting. If you are using Advanced
Reporting, you can configure custom options however you choose, including
querying the database for values.
If you are using Advanced Reporting, you must deploy the custom RDL file(s) to
the SSRS server before you can access the custom report.
To deploy reports:
1. Make sure the custom RDL files are located at the location specified by the
site.reporting.rpt.otherfiles setting in the Reports tab in
System Settings. The default location is:
Kronos_installation directory/wfc/reports/
OtherReports.
Note: If you access Workforce Central through a load balancer, you must
determine the application server you are logged into in order to know where
to store the custom report(s). The deploy will only work against those files on
the same physical server.
Customizing and updating labels for reports differs depending on whether you are
using basic reporting or Advanced Reporting. Refer to the appropriate section
below.
Basic reporting
1. On the Workforce Central application server, access the external labels file for
the Workforce Central component whose labels you want to customized. For
example, for the Workforce Timekeeper (wtk) component, go to
Kronos_Install_Dir\wfc\applications\wtk\properties\
U2li18n.ini
or U2li18n_fr.ini for French labels, and so on.
2. Make a copy of the file and delete all the labels except the ones you want to
modify.
3. Change the values for the labels that you want to customize.
4. In the same folder, save this new custom labels file with the following prefix:
Override_
For example: Override_U2li18n.ini
5. On the Workforce Central application server, access the following directory:
Kronos_Install_Dir\wfc\reporting
6. From a command line, execute the following file:
Kronos.Reporting.ResourceConverter.exe
with the following arguments:
– root directory to all U2li18n*.ini and Override_U2li18n*.ini files =
Kronos_Install_Directory/wfc/applications
– output file name = KronosResources
– output directory = Kronos_Install_Directory/wfc/reporting
For example:
Kronos.Reporting.ResourceConverter
c:\kronos\wfc\applications KronosResources
c:\kronos\wfc\reporting
Note: You can use absolute or relative paths to the appropriate directories.
1. On the Workforce Central application server, access the external labels file for
the Workforce Central component whose labels you want to customized. For
example, for the Workforce Timekeeper (wtk) component, go to
Kronos_Install_Dir\wfc\applications\wtk\properties\
U2li18n.ini
or U2li18n_fr.ini for French labels, and so on.
2. Make a copy of the file and delete all the labels except the ones you want to
modify.
3. Change the values for the labels that you want to customize.
4. In the same folder, save this new custom labels file with the following prefix:
Override_
For example: Override_U2li18n.ini
5. Update the labels on the SSRS server either using the batch file provided or
by manually generating and copying KronosResources.ini files:
Using a batch file:
a. On the Workforce Central application server where you edited labels,
make the following location accessible using a shared folder or mapped
network drive:
Kronos_Install_Directory\wfc
b. On the SSRS server, open a command prompt and switch to the following
directory:
SQL_Server_Install_Directory\MSSQL.x\
Reporting Services\ReportServer\bin\
application_server_instance_folder
where application_server_instance_folder contains the application server
name and instance name for your Workforce Central application. For
example, testServer-kronos-com-wfc.
c. Execute the following command:
GetResources.bat \\shared_folder_path
where shared_folder_path is the path to the shared folder or mapped drive
you created in step 5. For example, \\appServer\kronos\wfc.
GetResources.bat automatically creates and copies the most up to date
KronosResources.ini files to the SSRS server. You can schedule this
command to run at regular intervals if necessary.
Manually generating and copying KronosResources.ini files:
a. On the Workforce Central application server, access the following
directory:
Kronos_Install_Dir\wfc\reporting
b. From a command line, execute the following file:
Kronos.Reporting.ResourceConverter.exe
with the following arguments:
- root directory to all U2li18n*.ini and Override_U2li18n*.ini files =
Kronos_Install_Directory/wfc/applications
- output file name = KronosResources
- output directory = Kronos_Install_Directory/wfc/reporting
For example:
Kronos.Reporting.ResourceConverter
c:\kronos\wfc\applications KronosResources
c:\kronos\wfc\reporting
Note: You can use absolute or relative paths to the appropriate directories.
Decide which users you want to access the report, then add the report item to the
appropriate report data access profile(s) under Workforce Central Setup >
Access Profiles > Data Access Profiles > Reports.
Note: This access is granted in your Function Access Profile under Workforce
Manager - Department Manager > Reports > Report Setup > Report Setup
Access.
For Crystal Reports and Workforce Central to work together to produce reports
that you can control from within Workforce Central, you must make sure that the
report definition file addresses the following questions:
Note: Some reports access data via stored procedures, and these reports are
handled somewhat differently. For information about customizing these reports,
refer to “Customizing reports that use stored procedures” on page 240.
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, add the standard options (as defined in this section) to the report definition
file, at a minimum. Report options are specified as parameters in the report
definition file.
When you generate a report instance, you can select foreground options values,
but not background option values. Background options are used to display
foreground option values, or 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 Crystal Reports definition. The only allowable difference between the
Workforce Central reports and the Crystal Reports options is that the Crystal
Reports option names can be written in uppercase, lowercase, or mixed case.
Workforce Central report options must be in lowercase.
Standard Options
The following table describes the standard options. Some enable user selections;
others control data display or report behavior:
Background/
Option Name Description Foreground
Absences Select Unexcused, Excused, or both F
Absences hd Displays the selected Absence types B
Actual/Adjusted Select Actual or adjusted amounts F
Actual/Adjusted hd Displays the selected Actual/Adjusted B
choice
Db timezone Displays the timezone of the database B
server
Decimal Format Formats time format to hh:mm or hh.hh B
Employee page break Select No or Yes to page break on each F
employee
Employee page break hd Displays the selected page break choice B
Exceptions Select one, multiple, or all types of F
Exceptions
Exceptions hd Displays the selected Exception Types B
From Timeframe Passes starting date for timeframe F
selection
Function Access Profiles Select one, multiple, or all function access F
profiles
Function Access Profiles hd Displays the function access profiles B
selected
Gmt server offset Returns the time difference, in seconds, B
between the timezones of the database
server and the reporting server
Holiday Credit Type Select Credited, Denied, or both F
Holiday Credit Type hd Displays the selected Holiday Credit B
Types
Import Type Select one, multiple, or all Import Types F
Import Type hd Displays the selected Import Types B
Background/
Option Name Description Foreground
Import Batch Select one import batch or latest F
completed batch
Import Batch hd Displays the selected Import Batch B
Labor level count Displays the number of labor levels B
defined in the database
locale Passed in by the Workforce Central B
framework to determine the locale to be
used for report localization.
location_ini Passed in by the Workforce Central B
framework to identify the location of the
u2li18n.ini file, which stores the
key/value pairs that allow report labels to
be localized.
Not Updated Emp List hd Passes list of employee/person IDs that B
are not up to date
Not Updated Emp Count hd Passes count of employee/person IDs that B
are not up to date
Pay Codes Select one, multiple, or all pay codes F
Pay Codes hd Displays the selected Pay Codes B
Printed For Displays the user name who ran the report B
Query Name Displays Hyperfind Query name B
Request Time hd Displays the time that all calculated totals B
are up to date
Timecard Audit Type Select one, multiple, or all audit types F
Timecard Audit Type hd Displays the Audit Types selected B
Timeframe hd Displays the timeframe selected B
Timeframe Type Passes the selected timeframe type B
To Timeframe Passes ending date for timeframe F
selection
Wage Permission Determines if wages appear on report B
based on function access profiles
The 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 to Crystal Reports for these option choices.
• An entry of the form name:number identifies a named choice and the
internal code that represents it; for example, Unexcused:0.
• An entry of the form name:[..same] identifies entries that have the same
internal and external values; for example, Adjusted:1. Only string or
datetime entries have the same values internally and externally.
• An entry of the form count:name1|2... identifies a count of the number of
choices for that option followed by each option name; for example,
Count:PayCode name 1|PayCode name 2.
• An entry of the form name:n/m identifies an external value of name and an
internal value of n/m. Two internal values are separated by a comma (,).
Multiple/
Discrete Column Available Choice:
Option Name Type Values Typically Linked Internal Value Passed
Absences Number Multiple Excusedsw Unexcused:0
Excused:1
Both:0,1
Absences hd String Discrete -- Unexcused, Excused, Both:[--same]
Actual/ Number Discrete Actual:0
Adjusted Adjusted:1
Actual/ String Discrete -- Actual, Adjusted:[--same]
Adjusted hd
Db timezone String Discrete -- “GMT +/- hrs: DB Timezone Name”:[--
same]
Decimal Number Discrete -- Hh:mm:1
Format Hh.hh:0
Employee page Number Discrete -- No:0
break Yes:1
Multiple/
Discrete Column Available Choice:
Option Name Type Values Typically Linked Internal Value Passed
Employee page String Discrete -- No, Yes:[--same]
break hd
Exceptions String Multiple absentexcepttypeid Cancelled Deduct:0/1,1/1
Early In:1/2
Late In:1/3
Long Break:1/4
Holiday Skipped:0/5
Min. Days Active Violation:0/6
Min. Days Empl. Violation:0/7
Missed In Punch:1/8
Missed Out Punch:0/9
Short Break:1/10
Unscheduled:0/11,1/11
Very Early In:1/12
Late Out:0/3
Work History Violation:0/14
Long Interval:0/4
Short Shift:0/10
Early Out:0/2
Very Late Out:0/13
Exceptions hd String Discrete -- Count:exception name1|2…:[--same]
From Datetime Discrete Any datetime Datetimevalue:[--same]
Timeframe column
Function Number Multiple Vp_accessprofile. Accessprofile.profilenm:
Access Profiles accessprofid accessprofile.accessprofid
or
Accessprofile.
accessprofid
Function String Discrete -- Count:function access profile 1|2….
Access Profiles
hd
Gmt server Number Discrete -- Seconds:[--same]
offset
Multiple/
Discrete Column Available Choice:
Option Name Type Values Typically Linked Internal Value Passed
Holiday Credit Number Discrete Exceptionsw Exceptions Only:0
Type Credits Only:1
Both:2
Holiday Credit String Discrete -- Exceptions Only, Credits Only, Both [--
Type hd same]
Import Type Number Multiple importcntnttypeid Labor Level Entries:1
Labor Level Set:2
People:3
Accrual Dates:4
Accruals:5
Punches:6
Pay Code Edits:7
Sched. Pay Code Edits:8
Schedules:9
Import Type hd String Discrete -- Count:Import Type Name1|2…:--
Import Batch Number Discrete Importbtchstatid Specific batch: importbtchstatid\0
Latest completed batch: importbtchstatid\1
Import Batch String Discrete -- Batch Name and Date:[--same]
hd
Labor level Number Discrete -- Number:[--same]
count
Not Updated Number Multiple employeeid’s:[--same]
Emp List hd
Not Updated Number Discrete Number of employeeid’s:[--same]
Emp Count hd
Pay Codes Number Multiple paycodeid Paycode.name:paycode.paycodeid
Pay Codes hd String Discrete -- Count:Pay Code name1|2…:
Printed For String Discrete -- Logged in user name:[--same]
Query Name String Discrete -- Hyperfind query name:[--same]
Request Time Datetime Discrete Max datetime all employees on report have
hd up to date calculated totals:
[--same]
Multiple/
Discrete Column Available Choice:
Option Name Type Values Typically Linked Internal Value Passed
Timecard String Multiple Vp_timecardaudit. Add Duration:-1/0/30/1/, -1/0/30/0/,
Audit Type audittimesheetid -1//30/0/0
Edit Duration: -1/6/30/0/, -1/6/30/1/
Add Punch: -1/0/-1/0/, -1/0/-1/1/,
-1//-1/0/0,-1/0/4/0/0,-1//4/0/0/,-1/0/2/0/0,
-1/0/1/0/0,-1//2/0/0/
Edit Punch: -1/0/40/0/, -1/6/-1/1/, -1/6/-1/1/
, -1/6/-1/0/, 1/5/-1/1/,-1/5/4/1/1,-1/5/2/1/1
Add Pay Code: -1/0/20/1/, -1/0/20/0/,
-1/0/22/0/, -1/0/21/0/, -1//20/0/0,
-1/0/23/0/,12/-1/-1/-,-1/0/55/0/
Edit Pay Code: -1/6/20/1/, -1/6/20/0/,
-1/1/20/0/
Delete Pay Code: -1/5/20/1/
Timecard String Discrete -- Count:Audit Type 1|2…
Audit Type hd
Timeframe hd String Discrete -- Timeframe Name or Specific Dates:
Wage permissions
The wage permission option 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 as determined
by their 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 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 see
wage data is determined by the person selected in the User Name field in the
Report > Schedule Report tab.
Background options
Most background header options have names ending in hd and are generally
placed on the report as headers for foreground options. Other similar appearing
background options are the Query Name, Printed For, Db timezone, and Labor
level count hd.
• If you use a HyperFind query, the Query name parameter in the report header
displays the name of the HyperFind query.
• The Printed For parameter appears on all standard reports in the header to
indicate the user who requested the report. However, if the report is
scheduled, the User Name that is associated with the scheduled job appears
instead.
The employee group that is associated with the user who is logged on
determines the employees that can be seen on the report.
Decimal format
This option determines if time appears in hh:mm or hh.hh format, and the format
is passed directly to formulas that display time. The function access profile of the
person 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.
Custom options
You can create custom report options for 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 Workforce Central database tables and
views, creating custom report options requires that you know how to create main
and header parameters within Crystal Reports. Report parameters in Crystal are
the equivalent of report options in Workforce Central Reports.
Note: For information about adding custom report items to Workforce Central
Reports, refer to the Workforce Central online Help.
HyperFind queries
If your report contains employee data, using a HyperFind query simplifies your
report request. The HyperFind query selects the employees to include in the
report.
To determine whether an existing report uses a HyperFind query, access the
Report Setup component. On the navigation bar, select Common Setup > Report
Setup and then click a report in the list. If the report uses a HyperFind query, the
Requires HyperFind Query check box is selected.
Use the following instructions to configure a report definition file to use a
HyperFind query:
1. In the Database > Database Expert option, add the MYWTKEMPLOYEE
table to the query, and verify that the remaining joins are correct and
complete.
2. In the Report > Selection Formula > Record option, add a line containing,
“{MYWTKEMPLOYEE.SESSIONID} = {?wtksessionid}”. This must be the
first selection criteria.
3. In the Field Explorer > Parameter Fields, add the WTKSESSIONID
parameter.
When a report instance is run, the employee or person IDs in the HyperFind query
result set replace the {?wtksessionid} 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 Crystal Reports
software and the Workforce Central system, and does not work unless the report is
linked within the Workforce Central system.
Caution: Never enter this Selection Formula directly into the WHERE clause of
the report. Workforce Central does not support any modifications to the SQL
statement made in the Show SQL Query option in Crystal Reports.
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 nonpay periods. Pay periods can be different for each employee
on a report. Nonpay period time periods contain the same date range for all
employees.
Many of the Workforce Central database views include employee pay period
dates. When you request both pay period and non pay period time periods, the
Record Selection Formula uses a special formula.
The following code example illustrates a time period Record Selection Formula
for the report definition:
If you select a time period for any non pay period type, the Timeframe Type that is
passed to the report file is a number between 3 and 11.
If you select a Pay Period, the Time Period Type that is passed is one of the
following:
When you select a pay period time period, the From Timeframe and To
Timeframe parameters receive datetime values. The Workforce Central system
calculates the earliest From Timeframe value and the latest To Timeframe value
for every employee in the report, and passes those values to the report parameters,
thereby providing optimum performance for the report query.
When you select a nonpay period time period, the From Timeframe and To
Timeframe parameters get the dates pertinent to the time period selected. The
system ignores pay period portions of the formula.
Users of Workforce Central who are not employees do not have pay periods
assigned to them.
Labels
If you duplicate and modify a standard Crystal Report and choose not to delete all
references to the GetLocalizedLabel() function, the report will not run in the
Crystal Report Designer until the PC is modified for Crystal Report Designer to
recognize this function. This function is specific to Kronos applications and is not
included in the Crystal Reports Designer software.
To set up the GetLocalizedLabel() function on the PC where you are running the
Crystal Reports software:
1. From a WFC reporting instance, copy U2LI18N.dll from:
WFC.rootdir\instance_name\bin
to:
\\Program Files\Common Files\Business Objects\3.0\bin
This allows the Crystal Reports Designer to see the GetLocalizedLabel()
function.
2. On a WFC reporting instance, copy U2LI18N.ini from:
WFC.rootdir\instance_name\applications\wcb\properties
\U2LI18N
to the destination directory, located on the server where Crystal Designer is
installed. The default installation path is:
\\Program Files\Common Files\Crystal
Decisions\2.5\bin
This allows the GetLocalizedLabel() function to access the strings in the
.ini file.
3. On the PC where Crystal Reports is installed, add a Windows environment
variable named UFLINIFILE to:
\\Program Files\CommonFiles\Business
Objects\3.0\bin\u2li18n.ini
Before saving the Crystal Reports definition file, make sure that you are not using
the Page N of M special field anywhere in the report design. Kronos recommends
that you avoid use of this field.
Make sure that you save the Crystal Report definition file with a unique name and
copy it to the following location on all Workforce Central application servers
running on Windows:
Kronos_install_directory\wfc\reports\OtherReports
Note: If you fail to add the file to each Windows instance of Workforce Central,
the report may fail when run.
Decide which users you want to access the report, then add the report item to the
appropriate report data access profile(s) by selecting Access Profiles > Data
Access Profiles > Reports from the Setup workspace.
There are two design patterns for reports that use HyperFind:
• the -411 placeholder
b. Select Database Expert from the Database Menu and add the
MYWTKEMPLOYEE table to list of selected tables for the data source.
Click on the Links tab and link the table and column from the “-411”
record selection formula to the corresponding column in the
MYWTKEMPLOYEE table
c. Modify the record selection formula. In the Report > Selection Formula
> Record menu, add the following line as the first selection criteria:
{MYWTKEMPLOYEE.SESSIONID} = {?wtksessionid}”
getLocalizedLabel function
The getLabel() function was used previously to perform the runtime localization
of the labels used in the templates. This function has been replaced by the
getLocalizedLabel() function. Reports now must use getLocalizedLabel() instead
of getLabel() to process labels correctly at runtime.
To upgrade to the new getLocalizedLabel() function, perform the following steps:
1. Copy the new version of U2LI18N.dll from:
WFC.rootdir\instance_name\bin
to:
\\ProgramFiles\Common Files\Business Objects\3.0\bin
so that the new function is accessible to Crystal Reports Designer.
2. Add two new parameters to the main report,
– locale
– location_ini
3. Replace all instances of:
getLabel('label')
with
getLocalizedLabel('label', ?locale, ?location_ini)
4. If there are any subreports, add the same parameters to each subreport and
link it to the main report.
5. Repeat the step c with the corresponding subreport parameters.
Stored procedures
In Workforce Central v5.2 the data type of the @key and @sessionid parameters
was changed from string to number. To ensure that custom reports that use these
parameters continue to work properly, reassociate the custom templates against
the stored procedure.
The standard reports in Workforce Timekeeper are stored in the version of the
Crystal Engine installed in that release. Generally, these reports cannot be opened
in a previous version of Crystal Report Designer software. However, Crystal
v10.0 allows you to save v10.0 reports back to v9.0 format, if your report does not
use any of the Crystal Reports Designer v10.0 features.
Several Workforce Central v4.3 reports were defined to directly access standard
database tables instead of report-specific database views. Workforce Central v5.0
introduced some changes to the database tables referenced by these reports.
Standard reports supplied with v5.0 have been modified. However custom reports
created in versions prior to v5.0 from the following standard data reports may
need to be modified in v5.1. The following reports are affected:
Any report that uses the accrualtran database table, such as Accrual Balances and
Projections, Accrual Detail, and Accrual Summary, will fail. The employeeid
column in that table was removed and replaced by the personid column. Custom
reports can be modified to use this new column by using Crystal’s mapping
option.
Any report that uses the SQL query found on the standard Function Access Profile
report will fail, because the Crystal Report Designer has changed how queries
with unions are implemented in version 9.0. Custom reports can be easily
modified to use a new view, vp_accessprofile, which incorporates the union SQL
and is compatible with Workforce Central reporting architecture. Crystal’s
mapping option can be used to change the report SQL to use this new view.
The Timecard Audit Trail report uses the vp_timecardaudit view. Any report that
uses this view will likely fail, because this view was modified to remove columns
that returned audit data for signoffs and approvals. This was necessary to improve
performance and overcome the various DBMS limits on the total number of tables
used in a query. Custom reports can be modified by using Crystal’s mapping
option to identify those columns that have been removed from the view.
If you need 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 Workforce Central database.
Duplicate the stored procedures according to the Oracle or SQL server
instructions and name the stored procedure with a prefix of CUST_. For example,
CUST_Time_details.
Adhere to the following guidelines in order for the custom stored procedure to
work within the Workforce Central environment:
• Stored procedures are supported for use in the top-level report query only, not
in subreports. Subreports that query tables or views can be added to a stored
procedure based report, however.
• Two input parameters are supported. Any other standard or custom report
options can also be used to select the data on the report; however, these are the
only two that are supported to control the results of the stored procedure itself.
– Key — Used for the HyperFind input of employee ID’s.
– Actual_adjusted — Used to select Actual or Adjusted/Historical
totals.
The Key input parameter is the sessionid from the mywtkemployee table, which
is populated with the employeeids for that HyperFind query.
In addition to supplying the employee IDs for a report, the Key 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 Key parameter does not appear in the list of available options in report setup.
It is passed internally by the Workforce Central report engine to the stored
procedure.
The Actual_adjusted parameter also does not appear in the list of available
options in report setup. It is passed internally by the Workforce Central report
engine to the time_details stored procedure. The Actual/adjusted
parameter, visible in the options list, is different. This can be used in the report file
itself, such as on Time Detail, in addition to the stored procedure equivalent.
Important: The Workforce Central Portal does not support Windows Integrated
Authentication.
Important: If you are using Workforce Central Portal version 5.2, and upgrade to
Workforce Timekeeper version 6.0, you can continue to use version 5.2 Web
Parts. However, you cannot use a combination of Web Parts from Workforce
Central Portal versions 5.2 and 6.0. To use Workforce Central Portal version 6.0,
you must replace all pre-configured or custom Kronos Web Parts with 6.0 Web
Parts.
Note: Both Web Parts provide the ability to link to the Workforce Central
application pages to which users have access. Typically, you pick one, depending
on the preferred method of navigation. However, you can use both Web Parts on a
portal page.
Note: You can select only one folder. If you want to add links from another
folder, you must add another instance of the Kronos Navigation Links Web
Part.
Whether you add the Kronos Navigation or Kronos Navigation Links Web
Part, the menu items or links that appear depend on the following conditions:
– Whether you are currently logged on to the Workforce Timekeeper
application. If you are not, no menu items appear.
– The access profile to which you are assigned. Only the items that you can
access, based on your access profile, appear in the tab menus.
Likewise, the items that appear to a user who accesses the portal page depend
on the access profile that is assigned to the user.
Overview
The Workforce Central Portal provides the following pre-configured Kronos retail
and health care Web Parts:
1. Select the Modify Shared Page button at the top, right-hand corner of the
portal page.
2. Select Add Web Parts > Browse to browse for a Web Part to add to the
portal.
3. Click the Virtual Server Gallery link to access the list of Kronos Web Parts.
4. Add any combination of the retail or health care Web Parts to the portal page.
Ensure that you add the appropriate navigator Web Part to the page (Kronos
Productivity Monitor Navigator for retail, Kronos Schedule Navigator for
health care).
After you have added Kronos Web Parts to the portal page, you must connect
them to the navigator Web Part you are using (Kronos Productivity Monitor
Navigator for retail, Kronos Schedule Navigator for health care). You must also
connect Web Parts that require staffing information to the Kronos Staffing
Requirements Web Part.
To connect Kronos Web Parts:
1. Click Modify Shared Web Page in the upper right portion of the page.
2. Select Modify Shared Web Part, and then select the target Web Part.
3. Click the down-facing arrow at the top, right-hand corner of the Kronos Web
Part and select Connections.
4. If the Web Part is a navigator Web Part, select Provides a cell to. A list
appears that shows the Kronos Web Parts that you have added to the page, and
that can be connected to the navigator Web Part.
If the Web Part is not a navigator Web Part, select Consumes a cell from.
5. Select a Web Part from the list that appears. For non-navigator Web Parts, the
only Kronos Web Part in the list is Kronos Staffing Requirements.
6. Repeat this procedure for each Web Part.
You can customize the appearance and labels of any retail or health care Web Part
except the navigator Web Parts.
Configuration
Web Part settings Description
Kronos Process In Box Menu Text Text that shows in the menu for the Kronos Process
Manager Inbox (in the Configuration Manager Inbox Web Part.
portion of the Modify
Shared Web Part dialog
box)
Kronos Forecast Map Levels The number of organizational levels in the forecast map
Productivity (in the Configuration for which volume data is summarized and displayed in
Monitor portion of the Modify the retail Web Parts. For example, if the business
Navigator Shared Web Part dialog organizational structure consists of Site and Department
box) levels, but users need to see data summarized at the site
level, specify 1 for this setting. To see data summarized
by Site and Department, specify 2 for this setting.
The greater the number of locations, the greater the load
on the application server.
The default setting is 4.
Configuration
Web Part settings Description
Kronos Schedule Number of Locations The maximum number of locations that are represented
Navigator (in the Configuration by the data that appears in the Workforce Central Portal
portion of the Modify when a user first logs in.
Shared Web Part dialog Examples:
box) • If the Number of Locations setting is set to 2, and the
user has access to three locations, the Web Part shows
a summary of data for the first two locations in the
drop-down list for that user.
• If the Number of Locations setting is set to 3, and the
user has access to four locations, the Web Part shows
a summary of data for the first three locations in the
drop-down list for that user.
Set this value to 0 to show a summary of all locations.
The greater the number of locations, the greater the load
on the application server.
Users can customize the locations that are summarized in
the portal by selecting multiple locations from the
Kronos Schedule Navigator while holding down the
CTRL key.
The default setting is 3.
Kronos Staffing Span Name Length Limit The maximum number of characters that are allowed in
Requirements (in the Miscellaneous the headings that represent the shift or zone, and in the
Kronos Coverage portion of the Modify Web Part table headings.
Detail Shared Web Part dialog • For the Kronos Staffing Requirements Web Part, the
box) default setting is 3.
Kronos Volume
• For the Kronos Coverage Detail Web Part, the default
setting is 2.
• For the Kronos Volume Web Part, the default setting
is 3.
4. Ensure that the appropriate Employee Rule Sets are assigned to the
appropriate people.
For more information about editing Employee Rule Sets, refer to the Workforce
Central online Help.
Configure the number of days for the Kronos Schedule Navigator Web Part
You can edit the formulas and threshold boundaries for the KPIs. You can also add
a KPI to the Web Part, by defining a custom formula that uses one or more of the
variables that are defined in the KPITable.xsl file. This file is located in the
following directory:
<drive letter>:\Inetpub\wwwroot\wpresources\
Kronos.WebParts.Library
The following section contains instructions to configure the KPIs by editing the
KPITable.xsl file.
In the KPITable.xsl file, the threshold boundaries for a KPI are defined under
the <!-- KPI Formulas and Variables and Thresholds-->
comment line, just after the formula for the KPI.
<xsl:variable
name="actualToForecastSalesGreenIfAbove">105
</xsl:variable>
<xsl:variable
name="actualToForecastSalesRedIfBelow">100
</xsl:variable>
The value that is produced by a KPI formula can be:
• Between the two boundaries
• Greater than the "...IfAbove" boundary
• Lower than the "...IfBelow" boundary
To change the threshold boundaries, edit the boundary values. When the outcome
is between these boundary values, the indicator icon in the output is yellow. When
the outcome is above or below the boundary values, the indicator icon is green or
red, depending on how you configure the KPI output.
</xsl:when>
<xsl:when test="$newKpiVariable <
$newKpiNameRedIfBelow">
<img src="/wpresources/redlight.gif" alt="Red"/>
</td>
</tr>
4. Edit the src attribute for the <img> tags to match the path to the image you
want to use.
$newKpiNameGreenIfAbove">
<img src="/wpresources/greenlight.gif"
alt="Green"/>
</xsl:when>
<xsl:when test="$newKpiVariable <
$newKpiNameRedIfBelow">
<img src="/wpresources/redlight.gif" alt="Red"/>
</td>
</tr>
Removing a KPI
In the HTML Table element of the KPITable.xsl file, delete all the text in the
<tr> element for the KPI that you want to remove, including the opening <tr>
and closing </tr> tags for that row.
Configuring the Web Part charts for compatibility with Office Web
Components
System administrators perform this procedure.
Charts in the SharePoint portal are built by Microsoft’s Office Web Components
(OWC) software. Therefore, the XSLT configuration files must match the format
that the OWC expects. The XSL transform files transform the XML data that is
returned by Workforce Central into viewable output (in this case, chart format).
Note the following information about Kronos Web Part charts:
• Two default XSL transform files are used for Productivity Monitor charts: one
for each chart in the retail portal sample page. One uses SalesChart.xsl
and the other uses LaborChart.xsl.
• Two default XSL transform files are used for health care charts: one for each
chart in the health care portal sample page. One uses
HoursSummaryBarChart.xsl and the other uses
HoursSummaryPieChart.xsl.
To create an OWC-compatible XSL file, Kronos recommends that you start with a
chart template in Microsoft FrontPage. Follow these steps to customize a chart
using this method.
1. Create a chart template in Microsoft FrontPage, using the Microsoft Chart
Wizard.
a. Open a new HTML web page.
b. In Microsoft FrontPage, choose Insert > Web Component.
c. In the Insert Web Component dialog box, select Spreadsheets and charts
as the component type and choose Office Chart as the control. Click
Finish.
d. In the Commands and Options dialog box, indicate that the chart data will
come from Data typed in to a data sheet.
e. In the Data Sheet tab, set up the headings for the chart that you want to
add. Include temporary placeholder data for now. For example:
f. Once you have set up the chart, it appears on the screen. Right-click on
the chart and click Toolbar to show the Chart Toolbar.
g. From the Chart Toolbar, you can select options to add a legend to the
chart and to further customize the Commands and Options for the chart
(for example, to define borders, colors, and fills).
2. Copy the markup of the FrontPage chart template into the appropriate file:
SalesChart.xsl or LaborChart.xsl.
a. While the chart is on the screen in Microsoft FrontPage, click the Code
button in the bottom left-hand corner of the screen to show the code view
of the chart.
b. Locate the following line in the code view:
<x:ChartSpace>
Copy from the beginning of this line down to and including the line:
</x:ChartSpace>
c. Paste the copied text into the SalesChart.xsl or
LaborChart.xsl file, replacing the existing text between the <xml>
tags in that file.
d. In the XSL file, use Find and Replace to replace all occurrences of <
with a less than symbol (<).
e. In the XSL file, use Find and Replace to replace all occurrences of >
with a greater than symbol (>).
3. Link the XSL file to data in the XML response file returned by Workforce
Central.
a. In the SalesChart.xsl or LaborChart.xsl file, look for the first
list of placeholder values that you added to the chart wizard.
b. Replace the list of placeholder values with XSL code that extracts the
appropriate data from the XML response file.
For example, if you want the first set of data in the chart to represent the
Actual Labor Volume for each day of the week, enter the following XSL
code to extract the data from the XML response file:
{ <xsl:for-each select="//LaborData[@Date]">
<xsl:value-of select="./@Actual" /> ,
</xsl:for-each>}
This says that for each <LaborData> element in the XML response file
that has a "Date" attribute, return the value of the "Actual" attribute,
followed by a comma. The result is a list that looks like this: {242.5,
194.25, 178.75, 175.5, 189.25, 220}.
Note: You must understand the structure of the XML response file in order to
write XSL to extract data from it. This example assumes that you are using the
standard Kronos Productivity Monitor Web Parts and the XML request file
that is built into the product. If you have customized your XML request file
for use with the Kronos XML API XSLT Chart Web Part, your XSL may be
different. For more information about the relationship between Workforce
Central XML API requests and responses, refer to the Workforce Central
Developers Toolkit Programmer’s Guide.
c. Save the XSL file and make sure that the chart Web Part refers to the
appropriate configuration file.
The next time you view the portal, the chart that you customized will show the
new data, as interpreted by the OWC software.
Note: Creating and advanced editing of these files is beyond the scope of this
guide.
Note: The Kronos XML API XSLT Chart and Kronos XML API XSLT Table
Web Parts are the only Kronos Web Parts that have XSLT files you can use as a
starting point to create an XSLT file for custom Web Parts. All of the other Kronos
Web Parts consist of a .dwp file which contains the code that creates the Web
Part. The .dwp files cannot be edited.
Any changes that you make to an XML API request file must be reflected in the
XSL transform file, which extracts data from the XML response and formats it for
viewing. You can request data from any part of the Workforce Central suite, as
long as that data is supported by a Workforce Central API. For a complete list of
Workforce Central APIs and information about the relationship between Workforce
Central XML API requests and responses, refer to the Workforce Central Developers
Toolkit Programmer’s Guide.
Note: The WFCGenie API allows you to retrieve data from Workforce Timekeeper
Detail and Rollup Genie types only.
Note: The pay code names are for example purposes. The pay codes can have
different names.
Creating a request file for the Reg and OT Hours Summary example
Create an API request file that loads the Genie and HyperFind query, and specifies
a time period for which to view information. You can base the API request file on
an existing request file. The API request files are located in the following
directory:
<drive letter>:\Inetpub\wwwroot\wpresources\
Kronos.WebParts.Library
Important: Before you edit a configuration file, make a copy of the original file
and give it a new name in case you need to restore the file.
For example, the following illustration shows the default content of the
Genie.xml file that is delivered with the Workforce Central Portal:
<Request action="LOAD">
<WFCGenie GenieName="Pay Period Close"
HyperFindQueryName="All Home">
<Period>
<TimeFramePeriod TimeFrameName="1">
</Period>
</WFCGenie>
</Request>
Note: The Web Parts that you create cannot be connected to the Kronos
Schedule Navigator or Kronos Productivity Monitor Navigator Web Parts that
are supplied by Kronos. Therefore, the information in the new Web Part does
not correspond with the time period in the navigator Web Parts. The time
period is the attribute you specify for TimeFrameName in the XML request
file for the Web Part you create.
4. Save and close the request file with an appropriate, descriptive name. For our
example, you could name the file RegAndOTHoursSummary.xml.
Reading the XML response file for the Reg and OT Hours Summary Web Part
example
Number Description
1 Information about the columns included in the Reg and OT Hours Summary Genie
for this example. The information includes the labels specified for each column.
2 Names and totals data for the pay codes included in the Genie. The HyperFind
query specified in the request file determines which employees are included in the
response file.
3 Timeframe specified in the request file. In this example, the timeframe is “1,”
which represents the current pay period.
This section presents ideas to consider when you create XSL transform files for
Genie-based Web Parts, to make the transform files as efficient and reusable as
possible.
Note: Detailed instructions for creating and editing XSL transform files is beyond
the scope of this guide. Creating and editing XSL transform files requires a
working knowledge of Workforce Central XML APIs, XML, and XSL.
When you create an XSL transform file, consider the following basic guidelines:
• You can use an XSL transform file that is delivered with the Workforce
Central Portal as a starting point, or create a new file. Which method you use
depends on the nature of the Web Part you are creating and how proficient you
are with XSL.
For example, if you are creating a Genie-based Web Part in table format, you
can use Genie.xsl as a starting point for your XSL file. Genie.xsl
shows and formats the maximum number of columns that can be included in a
Genie.
• If you will create multiple Web Parts that contain varying numbers of columns
or types of data, but use the same basic format (table or chart), include logic in
the transform file so that it can be used to format response files for all similar
Web Parts.
For example, the Reg and OT Hours Summary Web Part example is a Genie-
based table that contains four columns of hours totals data. You want to create
another Genie-based Web Part that shows employee exceptions (for example,
missed punches and unexcused absences). Although these Web Parts have a
different number of columns and the response file returns “true” or “false”
values for exceptions, instead of hours totals, the same transform file can be
used for both Web Parts.
The example XSL transform file in this section demonstrates this capability.
Kronos provides three default XSL files that you can use as templates to format
the Genie data. You can either make a copy of the XSL file that best serves as a
starting point for the custom Web Part, or create a new XSL file.
The three default XSL files that Kronos provides are:
• Genie.xsl — Shows all the columns from the specified Genie
• PayPeriodCloseTable.xsl — Shows a select number of columns
from the Pay Period Close Genie
• PayPeriodCloseChart.xsl — Shows a chart that contains the
percentage of excused and unexcused absences from the Pay Period Close
Genie.
To create an XSL file for the Reg and OT Hours Summary example, perform the
following steps:
1. Make a copy of the Genie.xsl file and save it with an appropriate
descriptive name. For example:
– If you are going to create an XSL file that can be used only for the Reg
and OT Hours Summary Web Part, you could name the XSL file
RegAndOTHoursSummary.xsl.
– If you are going to create an XSL file that can be used to format a variety
of Genie-based table Web Parts, you could name the file
GenieTableWebParts.xsl.
2. Edit the content of the file to format the content of the Web Part. For general
guidance, refer to “Considerations when creating a transform file for Genie-
based Web Parts” on page 281
Important: Remember that the XSL file must include logic to handle all data
that appears in the corresponding XML response file. If you make changes to
the XML request file that changes the data returned in the corresponding
response file, you must update the XSL file to handle the changes.
Creating a Web Part using the Kronos XML API XSLT Chart
Note: All changes that you make to the XML request file must be reflected in the
XSL transform file. Refer to the Workforce Central Developers Toolkit
Programmer’s Guide for more information.
The calculation includes dividing the minutes portion of each hours total by 60 to
convert minutes to decimal format. Then, the converted hours total is multiplied
by the employee’s wage rate.
5. Locate the text in the Help file. The text is located near the end of the file and
is enclosed by <span> tags. In the following example, the bold text is the
text that you can change:
<a name="wp585913"> </a><span
class="pPopupAppend">This Web Part enables you to
specify a date and store location for which the
Productivity Monitor Table and Productivity Monitor
Chart Web Parts provide forecasted, scheduled, and
actual sales and labor information.</span>
After you have created the Help topic for the custom Web Part, you must link it to
the Web Part.
1. Add the custom Web Part to the portal page.
2. In the drop-down menu for the Web Part, select Modify Shared Web Part.
3. In the Advanced portion of the dialog box, scroll to the Help Link text box.
4. Enter the path and name of the custom HTML Help topic you created.
5. Close the dialog box.
When you select Help from the drop-down menu for the Web Part, the custom
Help topic you created appears.
Troubleshooting
In general, Workforce Central Portal users can access the same information using
the portal as they can when they use the full Workforce Central application. Refer
to the table below when the availability of data or the appearance and
functionality of the portal does not match your expectations:
General
Issue Description/Solution
The following error message The user is not authorized to access the Workforce
appears: “XML API Error: The Central XML APIs.
user is not authorized to use Make sure that the API > XML access control point is set
the XML service.” to “Allowed” within the user’s Function Access Profile.
The following error message The user has attempted to log in using a user name or
appears: “XML API Error: The password that contains special characters (for example,
reference to entity ... must end &, %, #, or @).
with the ' delimiter.” Ask a Workforce Central system administrator to change
the user name or password, or both.
The following error message The user does not have access to the data requested in the
appears: “XML API Error: The API, or the value could not be found–for example, the
value for the property is not requested volume driver doesn’t exist.
valid - Name: VolumeDriver, Make sure that the user’s Function Access Profile allows
Value: some_value.” access to the Workforce Manager > Scheduling >
Forecasting access control point.
Make sure that the requested volume driver exists in the
Workforce Central database.
The following error message The user is not authorized to access the data requested by
appears: “XML API Error: the API.
This user is not authorized to Make sure that the user’s Function Access Profile allows
perform the action or it is not a access to the Workforce Manager > Scheduling >
valid action name within the Forecasting access control point.
bean - Bean:
ProductivityMonitor, Action:
Load.”
Issue Description/Solution
The following error appears The user entered incorrect values or is not authorized to
after a user attempts to log in: use the APIs.
“An incorrect user name or Make sure that the user’s Function Access Profile allows
password was entered. Please access to the Workforce Central XML APIs.
try again.”
The following error appears The name of the link has changed in Workforce Central
during navigation from the since the link or tab was configured, or the user does not
portal to the Workforce Central have permission to access the component in Workforce
application server: Central.
“You do not have permission Compare the value of the MenuText attribute in the Web
to access the requested Part’s configuration file with the text of the same link in
resource.” the Workforce Central navigation menu. These values
must be the same.
Make sure that the user’s access profile allows access to
the selected Workforce Central component.
A prompt for a user name and The Web browser’s security setting is not allowing the
password appears when the request.
user clicks on a tab. Add the Workforce Central application server URL to
the list of sites in the local intranet zone:
In the Internet Explorer window, select Tools > Internet
Options. In the Security tab, click Sites. If necessary,
click the Advanced button and then enter the Workforce
Central application server URL (for example, http://
application_server_name) and click Add.
Blank or unexpected columns A Genie column number has changed since the Web
appear in a Web Part that Part’s XSL transform file was configured. This results
contains Genie data. from a change to the Genie column set in Workforce
Central Setup.
Modify the XSL transform file to reflect the new Genie
column set.
Issue Description/Solution
The following error message The name of the Genie has changed since the Web Part’s
appears: “XML API Error: The XSL transform file was configured. This results from a
value assigned to the property change to the Genie name in Workforce Central Setup.
could not be found - Name: Modify the XSL transform file to reflect the new Genie
GenieName, Value: name.
some_value.”
The user cannot delete an When Workforce Central Portal is accessed using certain
existing Web Part page. versions of Internet Explorer installed on a Windows
The user cannot edit any Web 2003 Server, security issues can occur. Some versions of
Parts on an existing Web Part Internet Explorer are for use only on server operating
page. systems, and therefore are configured differently from
browsers on desktop operating systems.
Kronos recommends viewing the Workforce Central
Portal from a web browser that is installed on a desktop
operating system.
The count of notifications in The count in the Kronos Process Manager Inbox Web
the Kronos Process Manager Part represents all tasks associated with the user. By
Inbox Web Part is different default, the Workforce Central Inbox in the full
from the count in the application shows only Active tasks from the last 30
Workforce Central Inbox. days. You can modify the number of days included in the
count by editing the following property:
wba.wf.tasklist.defaulttaskdays
The following error appears in If you are upgrading to Workforce Central version 5.2
the Workforce Central Portal and Workforce Central Portal version 5.2, and you have
components: customized any XML calls to the Genie API, you must
“Cannot create the object change the name of the API in the XML request files
Genie.” from Genie to WFCGenie.
SharePoint
Issue Description/Solution
Attempting to navigate to the The XML syntax in the web.config file is invalid.
Workforce Central Portal site Make sure that all the tags in the file are balanced with
URL causes an application opening and closing tags, and that each tag is nested
error that references the properly.
web.config file.
Kronos provides predefined data to simplify the task of configuring your system.
These values help you to configure your system quickly. You can modify some
predefined data, such as the default logon profile. You cannot modify other
predefined data, such as labor levels. See the Workforce Central Setup online
Help for information about working with the predefined data.
This appendix describes the following predefined data:
• “Workforce Genies” on page 298
• “HyperFind query” on page 301
• “Workforce Genie profile” on page 302
• “People” on page 303
• “Logon profiles” on page 304
Appendix A Predefined Data
Workforce Genies
To access Workforce Genies:
1. In the Setup workspace, select Display Preferences > Workforce Genies.
This opens the list of Genies on your system.
Note: The Genies that appear in the list depends on the Workforce Central
suite add-on products installed at your site. For example, if Workforce
Activities is not installed, the Activity Genies do not appear; if Workforce
Attendance is not installs, Attendance Genies do not appear, and so on
3. 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.
HyperFind query
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.
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.
People
The SuperUser person is not accessible. However, to access people other than the
SuperUser:
1. Use QuickFind to select an existing Workforce Employee or Workforce
Manager.
2. With the person selected in the QuickFind workspace, click the People launch
button to access the People Editor.
Kronos Global Support uses the Super Access profile, which provides access
to all settings. You cannot edit the Super Access profile.
Logon profiles
To access Logon profiles, in the Setup workspace, select 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.
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 Kronos Global Support uses the Super Access profile, which
provides access to all settings.
Password
• The password is set to never expire.
• There is no minimum length.
• Reuse monitoring is set to do not keep password history.
Session Restrictions
• A password change is not required at the next logon.
• Account lockout is not used.
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
Tasks more aborted 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
Column Description
ID The ID of the process.
Process Name The name of the process.
Column Description
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. After you examine the process information, you can select a process and then
click one of the following functions (some functions may not be available
depending on the state of the process):
– Abort
– Delete
– Restart
– Process Detail
The following sections describe actions that you can perform on processes from
this tab.
Aborting 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.
Deleting a process
If a process is no longer needed because of some change in your organization’s
business process or if it has been replaced by a revised version, you can use
Process Administrator to delete the unneeded process.
The availability of certain functions depends on the state of the process.
To delete 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 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 or processes. The screen
automatically refreshes to display the change in status for the process or
processes.
To delete a process template:
1. In the Setup workspace, select System Configuration > Process
Management.
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.
Restarting 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.
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.
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. See“Tabular Detail view” on page 312 for
more information.
Graphical Detail A read-only graphical representation based on the process template
in use. See “Graphical Detail view” on page 312 for more
information.
State Analysis A read-only view of the process in plain text. Each line represents a
Detail task and 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 313 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 A read-only list of resources who are participating in the process.
Resources Use the Process Resources view to, for example, identify a
resource to whom you want to send a message about a particular
task.
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.
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.
In the Graphical Detail view, color-coded bars on the tasks indicate the following:
• Blue — The task is ready but a resource has not worked on it.
• Brown/Black — The task is done.
• Red — The task has been aborted.
• Green — The task is active. A resource is currently working on the task.
Use the State Analysis Detail view to, for example, determine why a particular
task has not been completed.
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
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 Details 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.
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 Details tab, select the row that
contains the task that you want to mark as READY.
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.
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.
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.
Problem Solution
User receives the error message “This The user should click Refresh to update his or her
task may no longer be available. Click task list. If the error still appears, an API task has
Refresh to update your task list.” failed. Use Process Administrator to locate the
API failure.
Messages are not being sent to Be sure the E-Mail and Messaging tabs in the
external SMTP e-mail addresses. system settings are configured to send mail to the
SMTP e-mail address.
A process template does not appear in Be sure that you deployed the template from
the Process Templates editor. Process 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.
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.
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.
To set up Cluster Manager, you must configure the Workforce Central 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:
• 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 system failure. If you want to
exclude particular servers from functioning as the Cluster Manager, specify
false for this setting on those servers.
• wba.rmiregistry.port — The port on which to start the Cluster
Manager.
For more information about the Process Manager system settings, see “Business
Automation settings” on page 99.
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 Workforce
Central 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 Workforce Central 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 Workforce Central 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.
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).
5. In the Setup workspace, select System Configuration > System Settings >
Business Automation and then set the default maximum pool size per server
in the wba.processengine.server.maxpoolsize setting.
For more information about the Process Manager system settings, see
“Business Automation settings” on page 99.
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.
By default, Workforce Central regional settings support text, date and time, and
currency formats that are appropriate for most North American English-language
environments. In version 6.0, you no longer select languages during installation,
but install languages using a language pack CD.
This appendix provides information about how to implement other languages and
formats.
This appendix contains the following sections:
• “Workforce Central language packs” on page 324
• “Character set support” on page 325
• “Workforce Central instances and regionalization” on page 326
• “How Workforce Central displays regionalized data and text” on page 327
• “Currency support” on page 332
• “Using and modifying predefined names” on page 333
• “Using site-defined text strings in a multilanguage environment” on page 340
Appendix C Regional Settings
Unicode
Unicode encompasses more than 100,000 characters. The languages and character
sets supported differ, depending on the database. The following table lists the
characters supported by the databases.
SQL Server 2000 Can be set up using Unicode, however they support only Latin
SQL Server 2005 1, Latin 2, and Latin 9 characters sets.
Oracle 10gR1 Setting up these databases in Unicode allows Latin 1, Latin 2,
and Latin 9 character sets to co-exist in the same database.
Browser applications
The sections that follow describe how Workforce Central displays various data
and text elements in browser applications.
Themes — In v6.0, system administrators can create a custom theme to change
the appearance of colors and fonts in Workforce Central application pages. The
default theme is Basic. If you need to display multi-byte characters need to be
displayed, change the site.portal.theme.name setting on the Display tab
in system settings to global. To see the new theme, log off, then log on.
Text Display and Online Help — The English or language pack files are
installed on the application server. The text for the GUI is in properties
files.
The text for online Help is in a set of HTML files in the Help directory and its
subdirectories.
To support a language other than the English default, use the following settings to
set the language and country for the appropriate instances:
• site.local.LANGUAGE
• site.local.COUNTRY
Date and Time Data and Display — Date and time data associated with a punch
that was entered using the web originates from the server. Depending on context,
Workforce Central uses the time zone associated with the user’s People record or
the time zone on the Locale tab in system settings.
Date and time data associated with all other actions (for example, audit trail
information) originate from the regional settings of the application server’s
operating system.
To support date formats in a language other than the English default, set the
following properties on the Locale tab in System Settings:
• site.local.DateFormat
• site.local.SHORT_DATE
• site.local.LONG_DATE
• site.local.DAY_MONTH
Notes:
• The order of the day and month must match that of the browser locale.
• If you change the default language and 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 value to the long date format of the specified
language or country.
If the long date value doesn't match the short date, the calendar displays in
English date format, but the date in each application displays differently than
the long date format. No error message occurs.
For the time display, Workforce Central uses the employee’s Display Profile to
determine whether to display the time in 12-hour or 24-hour format. The default
values for Time and Date display are determined by the country selected in system
settings (site.local.COUNTRY on the Locale tab). You can modify this
information at any time.
Use the 24-hour format or two-letter time markers if the time markers have the
same first letter. For example, in English, you can type 8a to indicate 8 o’clock in
the morning, and 8p to indicate 8 o’clock in the evening. In Hungarian, you must
enter 8de or 8 to indicate 8 o’clock in the morning, and 8du or 20 to indicate 8
o’clock in the evening.
To support time formats in languages other than the English default, you can use
the site.local.TimeFormat setting on the Locale tab in System Settings:
Reports
The sections that follow describe how the system displays various data and text
elements in preconfigured and custom reports.
Text Display — Report file sets are installed in English or the language installed
using the language pack. The language that Workforce Central displays is
determined by the language selected during installation of the language pack for
basic reporting and the browser setting for advance reporting.
Note: All reports use the following font by default: Arial Unicode MS. If this font
is not installed on your system, and you have basic reporting, reports
automatically use a substitute font that is installed, perhaps Arial. If you are using
advance reporting, the browser looks for a Unicode fall-back font on your
machine (minglu). If you have a Unicode font on your machine, it uses that
instead of giving you bad characters.
A substitute font might not provide support for multibyte characters. If you need
to view reports that contain multibyte characters, such as reports in Chinese, make
sure that Arial Unicode MS is installed.
To find out about installing Arial Unicode MS, go to www.microsoft.com and
search “Arial Unicode MS.” Install the font on all client machines and, in the case
of RDLC reports (basic reporting), on the Workforce Central Server.
Date and Time Formats — For displaying time in reports, Workforce Central
uses the format (12-hour or 24-hour) that is specified in the user’s Display Profile.
If no information is available in the user’s Display Profile, the display format is
determined by the settings for time-of-day display in the application server’s
operating system.
The display format for dates in report is depend on report types, if the report is in
RDLC and SSRS report format, the date format base on your browser language
preference of Internet options is displayed. If it is Crystal report, the display
format for dates in reports is determined by the country settings for date display,
in the application server’s operating system.
Currency Format — The format for displaying currency in reports is based on
the report file set that is installed on the instance. The report file set language is
determined by the language that was selected during installation.
Number and Amount Formats — The format for displaying numbers and
amounts (except for currency) in reports is based on the report file set that is
installed on the instance. The report file set is determined by the language that was
selected during installation of the language pack.
The sections that follow describe how the following data collection devices
display various data and text elements:
Currency support
The Workforce Central database supports a single currency. The display format is
determined by the currency, country, and language settings that are specified in
System Settings. If no format is specified in System Settings, the currency settings
are the Workforce Central default settings, English and United States. The
currency settings determine the display format and entry format.
For example, a U.S.-based company with employees in the U.S. and France uses
two instances (one for U.S.-English and one for French-France) that connect to a
common database. Because the database only supports one currency format, the
company has decided to enter all monetary units in U.S. Collars. Users who are
connected to the French-France instance will still view and enter currency in the
U.S. format (for example, $8.50), and not in the French format (for example,
8,50€).
Kronos recommends that all instances be set to support the same currency format.
If instances are set to support different formats, users on different instances may
become confused about the monetary information they view and enter, and the
monetary amounts might be misconstrued.
For example, a Mexican-American company uses two instances (one Spanish, one
English) that connect to a common database, which stores and displays monetary
amounts in U.S. dollars. If the company sets up the English instance to support
U.S. dollars and the Spanish instance to support pesos, monetary amounts entered
by users in each of these countries will be stored in the database as U.S. dollars. If
a US$500 bonus is entered by a Mexican user as the day’s exchange rate amount
of 4,900 pesos, the amount is recorded and displayed as US$4,900 and could be
paid incorrectly.
People SuperUser No
Note: If you want to provide predefined names in multiple languages, provide text
in both languages in the entry. For example, assume that you have a site with
English- and French-language instances, and a labor level that you would call
“Work” in English and “Travail” in French. To accommodate both languages, you
could define the text for this labor level to be “Work - Travail.”
This appendix contains information about the registry keys that were set up when
your Workforce Central system was installed:
• “Windows registry keys” on page 342
• “UNIX registry keys” on page 343
Appendix D Registry Keys
Configuring SiteMinder
This section assumes that you have SiteMinder installed, and that you understand
basic SiteMinder configuration. For more information about configuring
SiteMinder, see the SiteMinder documentation.
To configure SiteMinder:
1. Use the SiteMinder Policy Server to create authentication schemes for
Workforce Central (WTK).
a. Create an anonymous authentication scheme named WFCAnon.
For example, WFCAnon contains “ou=People, dc=Kronos, dc=com” for
the User DN.
b. Create a basic or form authentication scheme named
WFCFormAuthentication
2. Use the SiteMinder Policy Server to create realms for Workforce Central, in
your policy domain.
a. Create a realm for Workforce Central non-logon URLs named
WFCRealm
Set the resource Filter to /wfc/ and the authentication scheme to
WFCAnon
b. Create a realm for Workforce Central logon URLs named
WFCLogonRealm
The WFCLogonRealm should be a sub-realm of WFCRealm. Set the
resource Filter to logonWithUID and the authentication scheme to
WFCFormAuthentication
3. Use the SiteMinder Policy Server to create rules for Workforce Central.
a. Create a rule that will handle all non-logon WFC URLs in the WFCRealm
named WFCAllowAllRule
Set the effective resource to the wildcard character *, select the Perform
regular expression pattern matches check box, set the Actions button to
Web Agent actions, and select all types of HTTP methods (Get, Post, and
Put).
This rule activates for all non-logon WFC URLs accessed by the HTTP
methods Get, Post, and Put. Since this rule is part of the WFCRealm, it
uses anonymous authentication. Therefore, all WFC URLs are passed
through WFC without an authentication check by Siteminder. WFC only
allows access to protected non-logon URLs by previously authenticated
users.
b. Create a rule that will handle all logon WFC URLs in the
WFCLogonRealm named logonWithUIDRule
Set the effective resource to the wildcard character *, select the Perform
regular expression pattern matches check box, set the Actions button to
Web Agent actions, and select all types of HTTP methods (Get, Post, and
Put).
This rule activates for all logon WFC URLs accessed by the HTTP
methods Get, Post and Put. Since this rule is part of the
WFCLogonRealm, it uses basic or form authentication. Therefore, access
to all logon URLs are redirected to the form identified in
WFCFormAuthentication. All users are prompted for their credentials,
username, and password.
If SiteMinder authenticates a user accessing this logon URL, it informs
WFC that this user has been authenticated.
4. Use the SiteMinder Policy Server to create policies for Workforce Central.
a. Create a policy for Workforce Central non-logon URLs named
WFCAllowAllPolicy
Configure this policy to contain the WFCAllowRule and your LDAP
users that you want to access Workforce Central.
b. Create a policy for Workforce Central logon URLs named
AllowLogonWithUIDPolicy
Configure this policy to contain the logonWithUIDRule and your
LDAP users that you want to access Workforce Central.
The diagnostic tools are designed to assist in diagnosing run time, Workforce
Central Web server, and services errors.
Note: Some of the diagnostic tools require you to have the JRE Plug-in installed
on the application server.
applications launch the customer’s e-mail client using the W3C3 e-mail to url
syntax. Some e-mail client software packages, such as Novell, do not support the
latest W3C e-mail to url format and do not work correctly with the Workforce
Central product.
Note: This tool can only be run if the Diagnostic Tools client setup is installed at
the Workforce Central server.
A clustering
monitoring resources 317
access control points
Process Engine 317
Messaging system 47
color
Process Manager 47
select for custom theme 181
Active X
specify custom colors in images 189
enabling 25
configuration settings
All Servers system information 55
before editing 94
Applications system information 57
editing 95
archiving system log reports 83
creating 317
Audit system settings 98
custom Web Parts 274 to 286
authentication
considerations for transform files 281
LDAP default method 164
creating non-QuickNav-based Web Parts 284
OTHER 165
creating QuickNav-based Web Parts 277 to
proprietary 163
283
Windows Integrated authentication 164
creating with the XML API XSLT Chart 285
WinNT, multiple domains 163
examples 275
WinNT, single domains 164
including calculation logic in Web Parts 286
strategy for creating 276
B customization
Background Processor create custom theme 179
employees excluded 58, 59
workspace 58 D
Business Automation system settings 99
data access profiles
delegates 51
C Data Source system settings
Clock Synchronize system settings 105 adding 108
Cluster Manager 44 overview 107
about 319 database
setting up 320 deleting a report 63
displaying a report 63
Index
report display 62 E
report status 61
e-mail
running a report 63
available notifications 40
switching databases 110
diagnostics 351
system information 60
multi-instance environment configuration 37
system settings 109
notification types 39
viewing a report 63
system settings 117
working with reports 63
employees excluded
database reports
retroactive pay calculation 59
available reports 60
totals calculation 58
creating DRD files 63
Engines tab
deleting 63
Process Administrator 317
Display workspace 62
Enterprise eTIME
displaying 63
software components 36
DRD creation guidelines 65
Enterprise eTIME Portal
running 63
adding and connecting Web Parts 249 to 254
viewing 63
changing ADP-specific Web Part
delegate authority
settings 258
data access profile 51
changing Web Part labels 260
using 50
changing Web Part titles and appearance 257
deleting a logically deleted process
configuring charts for OWC
template 309
compatibility 270 to 272
deleting a profile 317
configuring health care Web Parts 262 to 264
deploy
configuring KPIs 264 to 269
custom theme 195
creating a visual theme 287
diagnosis
creating custom Web Parts 274 to 286
run time 349
creating Help for custom Web Parts 290
service 349
customizing ADP Web Parts 257 to 273
Web server 349
customizing sample portal pages 255
diagnostic tools
customizing Web Part Help topics 288
Shift-Builder Diagnostic tool 352
linking Help to custom Web Parts 291
SMTP Mail Server Diagnostic tool 351
match suite custom theme 196
SMTP Mail to Launcher Diagnostic tool 351
page configuration options 245
starting 350
purpose 244
Display system settings 116
sample portal pages 245, 247
DRD files
troubleshooting 292
creating 63
using the ADP Web Part page template 256
guidelines for creating 65
Web Parts 245 to 247
duplicating a profile 317
environments
multi-instance 36
Event Manager L
multi-instance environment configuration 37
LDAP authentication
system settings 120
default method 164
working with system settings 122
Licenses system information 67
Locale system settings 140
F log file gathering
function access profiles collecting files 88
Messaging system 47 gathering files 88
Process Manager 47, 305 listing files to be gathered 86
opening gathered files 89
G overview 85
Global Values system settings 126 log files
Global Values tab archiving system log reports 83
Process Manager settings 46 system settings 145
vacation bidding application settings 46 log on
group edits changing the relogon session timeout 31
clearing results screen 138 enabling Active X 25
multi-instance environment configuration 37 overview 24
system settings 136 single sign-on 24
Log Reports
H filtering 82
overview 76
HyperFind queries
running 82
and Reports To field 48
log reports
archiving 83
I Logging Context system settings 148
images logo
specify colors for custom theme 189 prepare for custom theme 184
logoff timer, changing 165
J logs
Java Plug-in system settings 139 Event Manager 123
K M
key performance indicators Messaging system
configuring 264 to 269 access control points 47
K-mail task system settings 149
and system settings 149 Meters system information 68
KPIs multi-instance environments
configuring 264 to 269 configuration overview 36
R S
registry keys security
UNIX 343 client 28, 30
Windows 342 overview 28
relogon session timeout password 28
changing Enterprise eTIME session 32 single sign-on 28, 346
changing JBoss session 32 system settings 160
overview 31 server
renaming a profile 317 All Servers system information 55
report terminology 199 logging on and off 24
reports managing remotely 26
concept overview 198 Web and App Server system settings 173
for processes 310 Service system settings
system settings 157 overview 167
terminology 199 settings
Reports tab system configuration 22
Process Administrator 310 severity levels
Reports To field Event Manager log 124
Process Manager configuration 48 single sign-on
updating with People Editor 49 configuring Enterprise eTIME 346
reports, system configuring SiteMinder 347
database report display 62 logging on 24
deleting a database report 63 SMTP connectivity
displaying a database report 63 validating 351
Log Reports 75, 76 SQL Coverage system settings
running a database report 63 overview 169
viewing a database report 63 SQL tracing, enabling 170
resources Startup system settings 171
counts 310 status
viewing workload 317 of processes 310
response file (XML) of tasks 310
reading 280 SuperUser account
Retention Policy Affected Databases changing 29
system settings 152 system administration
Retention Policy Database Setup adding data source names 108
system settings 153 adding printers 151
Retention Policy Options and Tuning changing logoff timer 165
system settings 154 clearing Group Edit Results 138
enabling printers 151
enabling SQL tracing 170
T U
tasks UNIX registry keys 343
changing status 313, 314, 315 User system information 73
marking as done 314
reassigning 313 V
status 310 vacation bidding application
viewing properties 315 Global Values settings 46
viewing statistics 315 validate
viewing status 311 SMTP connectivity 351
template categories 317 validation, system settings 97
templates visual theme
activating 317 creating for the Enterprise eTIME Portal 287
categorizing 317
deactivating 317 W
Web Part page for Enterprise eTIME
Portal 256 Web and App Server system settings 173
theme Web Part Help
create custom theme overview 27 customizing 288
create new theme folder for custom Web Part Help topics
theme 180 creating 290
deploy 195 linking to custom Web Parts 291
edit theme style sheet 185 Web Part page template 256
extend to Enterprise eTIME Portal 196 Web Parts
select colors for 180 adding and connecting 249 to 254
specify custom colors in images 189 changing ADP-specific settings 258
test 194 changing labels 260
use custom logo 184 changing titles and appearance 257
theme.css file 185 configuring charts for OWC
Threads system information 71 compatibility 270 to 272
tools configuring health care Web Parts 262 to 264
diagnostic 349 considerations for transform files 281
transform file (XSL file) 282 creating custom Web Parts 274 to 286
Transformation system settings 172 creating non-QuickNav-based Web Parts 284
troubleshooting creating QuickNav-based Web Parts 277 to
Enterprise eTIME Portal 292 283
SQL tracing 170 creating with the XML API XSLT Chart 285
customizing 257 to 273
examples of custom Web Parts 275
how they work 274
X
XML response file
reading 280
XSL transform file 282