Installation Guide-Record Manager

Workforce Record Manager
Installation Guide
An installers guide for Workforce Record Manager and

Workforce Record Manager - Setup Data Manager.
Kronos Workforce Central Suite
Document Revision: A
The information in this document is subject to change without notice and should not be construed as a commitment
by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this
manual. This document or any part thereof may not be reproduced in any form without the written permission of
Kronos Incorporated. All rights reserved. Copyright 2011.
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 InTouch, 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, TeleStaff, Timekeeper Decisions, Timekeeper Web,
VisionPlus, Winstar Elite, WIP Plus, Workforce Absence Manager, Workforce Acquisition, Workforce Activities,
Workforce Analytics, Workforce Attendance, Workforce Central Portal, Workforce Connect, Workforce Employee,
Workforce ESP, Workforce Forecast Manager, Workforce HR, Workforce Leave, Workforce Manager, Workforce
MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce Recruiter,
Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, Workforce View,
and Workforce Worksheet are trademarks of Kronos Incorporated or a related company.
The source code for Equinox is available for free download at www.eclipse.org.
All other trademarks or registered trademarks used herein are the property of their respective owners and are used
for identification purposes only.
When using and applying the information generated by Kronos products, customers should ensure that they comply
with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this
Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws.
Published by Kronos Incorporated
297 Billerica Road, Chelmsford, Massachusetts 01824-4119 USA
Phone: 978-250-9800, Fax: 978-367-5900
Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357)
For links to information about international subsidiaries of Kronos Incorporated, go to
http://www.kronos.com
Document Revision History

Document Revision
Product Version
Release Date
6.3
December 2011
Contents
Chapter 1: Overview
Installation and configuration overview ........................................................ 6
Step 1: Install the Record Manager license ............................................. 6
Step 2: Create non-production Workforce Central databases ................. 6
Step 3: Install non-production Workforce Central servers ...................... 7
Step 4: Configure non-production Workforce Central databases ........... 8
Step 5: Enter the path to the bulk loader utility ...................................... 8
Step 6: Install the Setup Data Manager software (optional) ................... 8
Installation diagram ....................................................................................... 9
System requirements ................................................................................... 11
Record Manager requirements .............................................................. 11
Setup Data Manager requirements ........................................................ 14
Database Support .................................................................................. 14
Workforce Central Compatibility with Record Manager v6.3 ............. 16
Workforce Central requirements ........................................................... 18
Disk space requirements ....................................................................... 18
Chapter 2: Licensing and Installation
Installing the Record Manager license ........................................................ 22
Installing Setup Data Manager .................................................................... 24
Moving data from older versions to v6.3 .................................................... 26
Upgrade transfer definition files ........................................................... 26
Transfer setup data ................................................................................ 26
Chapter 3: Creating Non-Production Databases
Before You Begin ........................................................................................ 30
Creating a Non-Production Database for SQL Server ................................ 31
Creating a Non-Production Database for Oracle ......................................... 32
Chapter 4: Configuring databases

Running Database Manager .........................................................................34
Configuring Database Connections .............................................................35
For SQL Server ......................................................................................36
For Oracle ..............................................................................................37
Recommended configurations ...............................................................37
Chapter 5: Installing Non-Production Servers
Preventing a non-production application server from updating the Archive
Database ......................................................................................41
Chapter 6: Uninstalling
Appendix A: Reconfiguring a server to point
to a different database
Reconfiguring a Windows server .................................................................46
Reconfiguring a UNIX server ......................................................................47
Chapter 1
Overview
Workforce Record Manager (Record Manager) includes the following

components:
Archiving data Copying people and transaction data from the production
database to an archive database.
Managing setup data Moving setup data from one database to another.
For example, from a test database to your production database.
The archiving functionality of Record Manager is installed with Workforce

Central and is activated by installing a Record Manager license on the Workforce
Central server. Archiving also requires the installation of additional Workforce
Central databases and, optionally, new Workforce Central servers.
Workforce Record Manager Setup Data Manager (Setup Data Manager) is a
separately installed utility of Record Manager that allows you to manage setup
data. Setup Data Manager requires a Record Manager license and typically
involves the installation of a test database and server.
This chapter contains the following sections:
Installation diagram on page 9
System requirements on page 11
Chapter 1
Overview
Installation and configuration overview

The major steps required to install and configure Record Managerand its
components are:
1. Install the Record Manager license (required).
2. Create non-production Workforce Central databases (if necessary).
3. Install non-production Workforce Central servers (optional).
4. Configure non-production Workforce Central databases for use with Record
Manager.
5. Enter the path to your databases bulk loader utility (required if you plan to
archive data).
6. Install the Setup Data Manager software, if you plan to copy setup data.
Note: Before you begin any type of installation in your production environment,
back up your production database.
Step 1: Install the Record Manager license

The Record Manager license is required to use all components of Workforce
Record Manager: Record Manager and Setup Data Manager. You must generate
the license on the Kronos Licensing Web site, and install it on all servers where
you plan to use any of the components. Setup Data Manager also requires access
to a Workforce Central server where the license is installed.
Chapter 2, Licensing and Installation, on page 21 contains detailed information
for performing this step.
Step 2: Create non-production Workforce Central databases

When you archive data using Record Manager, you copy data to a non-production
Workforce Central database. When you copy setup data, you are often copying
data from a non-production database to some other database. Either way, you are
connecting to a non-production database. If you have non-production databases
Installation and configuration overview
installed, the database for archiving with Record Manager must be empty; the
database for Setup Data Manager can be populated with setup data.
.
If you have not installed a non-production database, then you need to create at
least one new database before you can use Record Manager:
For Record Manager archiving Create a new, empty Workforce Central

database with the appropriate user accounts and preliminary Workforce
Central-specific settings. Later, you will build the database using the Database
Manager. Chapter 3, Creating Non-Production Databases, on page 29
contains detailed information for performing this step.
For Setup Data Manager Create a new, empty Workforce Central

database as you would for archiving, or back up a production database and
restore it as the non-production database.
Step 3: Install non-production Workforce Central servers

Setup Data Manager requires that the source and the target database are connected
to Workforce Central servers. Therefore, you must install a non-production server,
or server instance, to point to your test database if you dont already have one.
Although the archiving component of Record Manager does not require nonproduction servers, using them makes it easier to:
Access archived data.
Test and configure setup data before copying the data to another database.
In addition, running Record Manager from a non-production server can reduce the
demands on your production server.
The number of non-production servers or instances of servers recommended
depends on how you will use Record Manager. For example, if you plan to create
multiple archive databases and test rules databases, you may want to install
multiple non-production Workforce Central servers, or multiple instances of
servers.
Chapter 5, Installing Non-Production Servers, on page 39 contains detailed
information for performing this step.
Workforce Record Manager Installation Guide
Chapter 1
Overview
Step 4: Configure non-production Workforce Central databases

In Step 2, you create empty, non-production databases. This step involves
completing the build of newly created non-production databases, and enabling
Record Manager and Setup Data Manager to access all non-production databases.
Any database that Record Manager is going to access must be listed as an
Affected database.
Chapter 4, Configuring databases, on page 33 contains detailed information for
performing these steps.
Step 5: Enter the path to the bulk loader utility

Using Record Manager to archive Copy data requires database middleware, and
the bulk loader utility for the middleware, in particular. The bulk loader utility
copies the table data from one database to another. You must install the
appropriate version of the middleware and enter the path to the bulk loader utility
before you can run an archive job. On the Workforce Centralserver where you
installed the license, select Setup > System Configuration > System Settings
and click Record Retention - Options & Tuning. Enter the full path to the bulk
loader utility (bcp.exe for SQL Server; SQL*Loader.exe for Oracle) as the
value for the WrmSetting.Tuning.BulkCopySoftwarePath key.
Enter the path to the correct version of the middleware. If you have multiple
versions of Oracle installed, or SQL Server 2005 and 2008, the bulk loader utility
is preserved for all versions.
Step 6: Install the Setup Data Manager software (optional)

Setup Data Manager is a separately installed component of Record Manager that
enables you to select and copy categories of setup data from one Workforce
Central database to another. You can install Setup Data Manager on any Windows
machine that is able to access a Workforce Central server over your network.
Setup Data Manager does not need to be installed on a Workforce Central server.
Chapter 2, Licensing and Installation, on page 21 contains detailed information
for performing this step.
Installation diagram
Installation diagram
The following diagram illustrates a Record Manager environment, including
Setup Data Manager. The specifics of your setup depend on your requirements,
available resources, and existing Workforce Central environment.
Workforce Central
server
Production Database
Server
Instance
Archive Database
Workforce Central
server
(non-production)
Server
Instance 2
Setup Data
Manager
Test Database
Note: If you are using Workforce HR/Payroll, the wfc instance must be connected
to the production database.
In this diagram, the production database is the live database where employee
and transaction data is originally stored. The server instance that points to the
production database is the instance where you log in to view current information
or to perform work-related transactions. From this instance, you can copy data and
archive it to the archive database. Then use another server instance to view the
archive database contents.
Using Setup Data Manager, you can copy setup data between any Workforce
Central databases. For example, in the scenario above, you might move setup data
from the test database to the production database.
For archiving purposes, you can use Record Manager from a production or a nonproduction server or server instance. The following table shows the advantages
and disadvantages of using Record Manager on the two types. The type of server
Chapter 1
Overview
from which you plan to use Record Manager affects the installation of the nonproduction servers.
Use Record
Manager...
on a
production
server
Advantages
on a nonproduction
server
Disadvantages
A non-production server is not The performance of the production

system is reduced when a Record
required for archiving data.
Manager process is running.
(You will still need a nonproduction server to view
archived data.)
When you view archived data,
historical data is locked and
cannot be edited.
When you install Record
Manager on only the
production server, you only
have to purchase and install one
license.
The performance of the
production system is less
affected.
When you are installing the

application server in an archive
environment, you should install
with a non-database user. If the
application server is installed with
the database owner user, it is
possible that the application server
may update the historical data on
the non-production database. This
applies to both SQL Server and
Oracle.
Note: If you use SQL Server databases, Kronos recommends licensing and
running Record Manager processes from a non-production server.
Regardless of whether you run Record Manager from a production or
non-production server, you must apply the Record Manager license to the server
from which you are running Record Manager.
10
System requirements
System requirements
Installing Record Manager or Setup Data Manager often means the installation of
new databases and servers. For this reason, this section contains requirements for
Record Manager and the additional Workforce Central database and servers.
Record Manager requirements

The following requirements must be met to archive data using Record Manager:
All requirements for using Workforce Central must be met. See Workforce
Central requirements on page 18.
The source and target databases must have exactly the same Workforce
Central applications installed and they must be at the same version.
Note: Before you install a Record Manager service pack, check the minimum
requirements of the service pack against the installed version of Workforce
Central. You can find the minimum requirements of the service pack in the
Service Pack Release Notes.
For Oracle databases:
The source and target database must exist on separate database instances.
The database domain names are case-sensitive and must be exactly the
same for the source and target databases.
All Workforce Central databases must use the same RDBMS platform and
version.
Each Workforce Central database must have a unique database name (for SQL
Server) or TNS name (for Oracle).
All new Workforce Central components (non-production databases and nonproduction servers) must exist on the same network as the production
database and must support Transmission Control Protocol/Internet Protocol
(TCP/IP) as a transport protocol.
11
Chapter 1
Overview
All Workforce Central databases (production and non-production) and the

server(s) upon which you run Record Manager processes must use the same
character set.
Note: On a UNIX server, the character set is stored as part of a locale. Three
main variables are used to change the locale:
LC_ALLDefine the complete locale here
LANGDefine the language variable here
NLSPATHSet this to the path where the locales are stored
These variables can be set at the shell or the user level. If these variables are
defined at the user level in your environment, make sure that the user running
Workforce Central (root, by default) has the appropriate settings to match the
character set of the Workforce Central databases.
All Workforce Central servers from which you plan to run Record Manager
must have the appropriate SQL Server or Oracle database middleware
installed. As part of the middleware installation, be sure to install the database
loader utilities (bcp.exe for SQL Server; SQL*Loader.exe for Oracle).
Enter the full path to the bulk loader utility
Note: If you install Record Manager and the Oracle database middleware on a
UNIX server, the following Oracle middleware-related parameters must be set
on the server:
ORACLE_HOMESet this to the directory structure where the Oracle
software is installed.
PATHSet this to ORACLE_HOME/bin
SHLIB_PATHSet this to ORACLE_HOME/lib
LIBPATHSet this to ORACLE_HOME/lib
LD_LIBRARY_PATHSet this to ORACLE_HOME/lib:ORACLE_HOME/
network/lib
Set these parameters at the user level for the user who runs Workforce Central
(root, by default). ORACLE_HOME = the directory path where the Oracle
software is installed.
12
System requirements
All Workforce Central servers from which you plan to run Record Manager
require at least 10 GB of disk space, in addition to that required for the
installation of the Workforce Central and Record Manager software. This
additional space is for the Bulk Copy (SQLServer) or SQLLDR (Oracle) data
files populated in
<Drive>:\Kronos\wfc\applications\wrmea\DBArchive
during the Copy process containing the Workforce Central data to be
uploaded to the target database.
Note: The Record Manager installation uses approximately 8 MB of disk
space.
13
Chapter 1
Overview
Setup Data Manager requirements

The following requirements are necessary to install Setup Data Manager:
Item
Requirement
Processor
Pentium processor (minimum recommended)
Memory
Display resolution
800 x 600 (minimum)
CD-ROM drive
Required for installation
Operating system
2 GB (minimum recommended)
1 GB (minimum)
Microsoft Windows XP SP2

Microsoft Windows Server 2003 SP1 (32-bit)
Microsoft Windows Server 2003 SP2 (32-bit)
Microsoft Windows Vista
Microsoft Windows 7 (32-bit & 64-bit)
Microsoft Windows 2008 Server (32-bit & 64-bit)
Microsoft Windows 2008 Server R2 (64-bit)
Web Browser (for

HTML
documentation)
Internet Explorer 6 and higher.
Database Support
Record Manager supports the following set of databases for each specific version
of Workforce Central, as follows:
Version
Microsoft SQL Server
5.2
Microsoft SQL Server 2000 SP3
Oracle
Oracle 10g (10.1.0.2)
Oracle 10g R2 (10.1.2.0)
6.0
14
Oracle 10g (10.1.0.2)
Oracle 10g R2 (10.1.2.0)
System requirements
Version
Microsoft SQL Server
Oracle
6.1
Microsoft SQL Server 2005
Oracle 10g R2 (10.1.2.0)
Oracle 11g R1 (11.1.0)
6.2 and 6.3 Microsoft SQL Server 2005
Oracle 10g R2 (10.1.2.0)
Oracle 11g R1 (11.1.0)
Microsoft SQL Server 2008 R2
Oracle 11g R2 (11.2.0)
15
Chapter 1
Overview
Workforce Central Compatibility with Record Manager v6.3

Record Manager 6.3 Compatibility
Product/Application
Workforce Absence Manager
Archive
(Copy/Purge)
Version
6.3
Copy
(Attendance only)
Setup Data
Manager
Yes
Purge (Attendance &

Leave) a
Workforce Activities
6.3
Yes
Yes
Workforce Analytics
6.3
No
No
Workforce Connect
6.0
No
No
Workforce ESP
3.6.14; 6.2 No
No
Workforce Forecast Manager
6.3
Yes
Yes
Workforce HR
6.3
No
No
b
Workforce Integration Manager
6.3
Copy only
Yes
Mobile Server Applications
6.3
No
No
Mobile Client Applications
2.0
No
No
Navigator (Next Generation User Interface)
6.3
Yes
Yes
Workforce Operations Planner
6.3
No
Yes
Workforce Payroll
6.3
No
No
Workforce Central Portal
6.3
No
No
Workforce Scheduler
6.3
Yes
Yes
Workforce Timekeeper
6.3
Yes
Yes
a. Attendance data is non-historical and, therefore, can be copied but not purged. Workforce
Leave data is both copied and purged.
b. Only non-historical setup data is copied for Workforce Device Manager and Workforce
Integration Manager, and therefore cannot be purged.
16
System requirements
Record Manager
6.3 Compatibility
Archive
(Copy/Purge)
Setup Data
Manager
Data Collection Product/Terminal
Version
Data Collection Manager
Not
No
compatible
Workforce Device Manager
6.3
Copy onlya
Yes
Kronos InTouch
1.0+
No
No
Kronos 4500 terminal
2.1+
No
No
No
a. Only non-historical setup data is copied for Workforce Device Manager and Workforce
Integration Manager, and therefore cannot be purged.
17
Chapter 1
Overview
Workforce Central requirements

Refer to Guide to Planning a Workforce Central Installation for information
about Workforce Central requirements.
Disk space requirements

Disk space requirements for your production and non-production databases are
important considerations when you plan to use Record Manager. Once you
determine how much data you plan to copy and how often, you should be able to
determine how much space you need on each database.
Note: For Setup Data Manager, the only disk space requirement is that the target
database is large enough to store whatever amount of setup data you are copying.
Setup data occupies relatively little space compared with the other data on the
database.
Production database
Record Manager audit information is stored on the production database. The audit
trail is updated every time a Record Manager process runs. Audit information
includes the status, results, and included dates of each Record Manager process.
This information takes up very little space in relation to the entire database.
Therefore, the disk space requirement for your production database is unaffected
by Record Manager. However, the production database is often the source
database as well, and Record Manager does impact the disk space requirement for
a source database.
Source database
During both Copy and Purge processing, temporary table structures, whose names
have a prefix of T_, are created. They contain primary key data mapping of either
the data that will be processed from the base table, or mapping used by children
tables to determine what data to process. To ensure optimal functionality and
avoid error with insufficient space, it is recommended that each tablespace
(Oracle) or Filegroup (SQLServer) is configured to allow at least 1 Gigabyte of
additional growth to account for these tables, because the tables stay resident in
18
System requirements
the database until the process completes. These structures are created on the
tablespace and/or filegroup in which the base table resides.
The source database for a Record Manager process can be your production
database or a non-production database that contains data that you want to copy or
purge.
Target database
When you archive or copy setup data, the size of your target database is directly
related to the size of your source database and the amount of data that you are
copying. For archiving data, your source database is most often your production
database. Therefore, you need to estimate how much information is produced on
your production database, for a given period of time, in order to plan for your
target database. Kronos Service Representatives have tools that can help you
determine how much space you will need for a given amount of employee and
transaction data.
Note: Allocating too little disk space for a target database causes Record Manager
processes to fail. For target databases on Oracle servers, the size of the undo
tablespaces is also very important.
For more information about allocating disk space and setting up undo tablespaces
for a target database, refer to Creating a Non-Production Database for Oracle on
page 32.
If you begin to run out of disk space on your non-production database, for
example, you can copy a segment of the data to another database, and then back
up that database to a file; or, keep databases with smaller date ranges on separate,
smaller disks.
19
Chapter 1
20
Overview
Chapter 2
Licensing and Installation
This chapter describes how to obtain and install Record Manager licenses and
software.
Installing the Record Manager license on page 22
Installing Setup Data Manager on page 24
Chapter 2
Installing the Record Manager license

Record Manager is installed with Workforce Central. To enable it for use, a
license must be installed. You must install a Record Manager license on all
Workforce Central servers that you will be using with Record Manager. The
software for the archive component is installed along with the Workforce Central
server software. Setup Data Manager must be separately installed.
A license authorization number is required to generate a license file for your
software.You should receive a license authorization number in an e-mail from
Kronos when your licensed software is shipped. Your license authorization
number is also on your packing slip and your invoice.
Note: If Kronos received more than one purchase order from you, you will receive
separate e-mail messages containing unique license authorization numbers. You
must generate these licenses separately.
Generate license file
You can generate your license file immediately after receiving your license
authorization number:
1. Start your browser enter http://klicense.kronos.com to open the
Welcome to Kronos Web Licensing page.
2. In the Welcome to Kronos Web Licensing page, click Instructions on
Generating a License File to open a PDF document that contains step-bystep instructions for generating a license file.
3. Enter your license authorization number and click Submit.
If you receive the message Invalid License Authorization - Please try again,
try entering the license authorization number again. If you are still
unsuccessful, contact klicense@Kronos.com; be sure to include your
license authorization number in the email.
4. Once you have generated the license file, download and save the file to the
following path on the drive where Workforce Central is installed:
Kronos\wfc\licensing
22
Installing the Record Manager license
In the Save As dialog box, the software generates a unique name for the
license file with a .lic extension. Select the All Files type to ensure that
.txt is not appended to the file name when you save the license file.
Enable the license
1. To enable the licenses after copying them to the kronos\wfc\licensing
directory, refresh the license server.
To refresh the server, go to Setup > System Configuration > System
Information and click on the Licenses tab. Select Reread License Files in the
Licenses tab.
2. After refreshing the server, verify the license information in Workforce
Centrals license display screen. Go to Setup > System Configuration >
System Information and click on the Licenses tab.
23
Chapter 2
Installing Setup Data Manager

You can install Setup Data Manager on Windows systems that are able to access a
Workforce Central server over your network. The Workforce Central server must
have the Record Manager license installed.
1. Double-click Launch.exe from the Workforce Central installation kit. (You
can also click install.exe, which opens the Workforce Central installer, as
shown in step 4.)
Note: If you are installing on a Windows Server 2008 machine, you must
right-click Launch.exe and select Run as Administrator.
The Product Installation dialog box appears. This dialog box has the
following buttons:
Install Products Displays the names of the applications that you can
install
Browse Contents Displays the files that the installation programs use
View Kronos Web Site Opens the Kronos web site

(www.kronos.com) in the default browser
Contact Kronos Displays addresses, telephone numbers, and URLs

that you can use to contact Kronos
Exit
2. Click Install Products. The list of products that you can install displays.
3. Select Setup Data Manager.
4. Click Next in the Welcome dialog box to continue the installation.
5. In the Destination Folder dialog box, choose a destination directory for the
installation files. Click Change to search for a different directory in the
Choose Folder dialog box. Click Next when you are satisfied with the
location.
6. In the License Manager dialog box, enter the URL for the Workforce Central
application sever where the Record Manager license is installed. You may
also choose to enter a backup server URL in case the primary server is
unavailable.
24
Installing Setup Data Manager
7. The construction of the URL depends on where Setup Data Manager is

installed relative to the Workforce Central server. Refer to the following
guidelines when entering the URL.
If the Workforce Central web and server are installed on the same
machine, and only one instance of the Workforce Central server is
installed, you can enter the Web Server name instead of the complete
URL.
If Setup Data Manager is installed behind the same firewall as Workforce

Central, the URL is:
http://ApplicationServerName:PortNumber/
ApplicationInstanceName
If Setup Data Manager is installed outside of the firewall used for

Workforce Central, the URL is:
http://WebServerName/ApplicationInstanceName
Note: Multiple instances of Workforce Central may be installed on the server.

The ApplicationInstanceName is the name of the specific Workforce
Central instance to which you want to connect. If only one instance is
installed, the default instance name is wfc.
8. Review your selections in the Information dialog box and click Next.
9. When the Ready to Install the Program dialog box appears, click Install.
A status screen appears as the files are installed. The confirmation screen
appears when the installation is complete. You will see an Installation
Incomplete dialog box if the installation is interrupted for any reason.
10. Click Finish to close the InstallShield Wizard.
25
Chapter 2
Moving data from older versions to v6.3

You cannot use Setup Data Manager v6.3 with mixed versions of Workforce
Central. Setup Data Manager v6.3 can be used only with Workforce Central v6.3
for both the source and target. Also, you cannot directly transfer setup data
between servers that are running different versions of Workforce Central.
However, it is possible to transfer some setup data between earlier versions of
Workforce Central and v6.3 using an XML document. To do so, follow the
procedures in this section.
Upgrade transfer definition files

To upgrade previous versions of transfer definition files (.tdf) to v6.3:
1. Start Setup Data Manager v6.3.
2. Choose File > Open and select the old .tdf file that you want to upgrade.
3. The upgrade dialog box appears. To upgrade to v6.3, click Yes. The old .tdf
file is upgraded to v6.3, and a copy of the older version is made with an
extension to identify it as the previous version. You can now use the upgraded
v6.3 .tdf file with Workforce Central v6.3.
Transfer setup data

1. Start the previous version of Setup Data Manager and create a transfer
definition file that performs an XML Document export of the setup data.
Note: You cannot use Setup Data Manager v6.3 to complete this step.
a. In the General tab, enter a description of the .tdf file.
b. In the Source tab, choose Workforce Central API Export and a previous
version of the Workforce Central server URL as the source.
c. In the Target tab, choose XML Document and specify an empty folder in
the Output path/filename.
d. In the Transfer tab, select the setup data you want to transfer.
26
Moving data from older versions to v6.3
e. Click Start Transfer and the selected setup data is written to XML files
in the folder you specified in Output path.
2. Exit from the older version of Setup Data Manager.
3. Start Setup Data Manager v6.3 and create a transfer definition file to import
the setup data.
a. In the General tab, enter a description of the .tdf file.
b. In the Source tab, choose XML Document. For the Source path/Filename,
choose the folder you specified as the target Output path in step 1.
c. In the Target tab, choose Workforce Central API Import and a v6.3
Workforce Central server URL as the target.
d. In the Transfer tab, click Start Transfer.
Note: Some setup data will be displayed with an X next to the item. This data
has been deprecated in v6.3 and cannot be imported. In addition, setup data
that has dependencies on the deprecated data cannot be imported. To use this
setup data, you will have to manually recreate it in Workforce Central v6.3.
27
Chapter 2
28
Chapter 3
Creating Non-Production Databases
Non-production Workforce Central databases are used to store archive data or for
testing setup data that you will copy into production using Setup Data Manager.
Creating a non-production database is similar to creating any other Workforce
Central databasethere are certain settings and user accounts that all Workforce
Central databases must share.
Before You Begin on page 30
Creating a Non-Production Database for SQL Server on page 31
Creating a Non-Production Database for Oracle on page 32
Note: Instructions for completing the build of the database are included later in
this guide and can be performed only after installing a non-production server or
reconfiguring an existing server to point to the non-production database.
Chapter 3
Before You Begin
Ensure that you have an appropriate number of database servers installed with
a supported Relational Database Management System (RDBMS).
Build your new, non-production databases on these servers. While a nonproduction database can reside on the same database server as the production
database, both databases will perform better if stored on separate database
servers. Kronos recommends that you store a non-production database on a
separate server from the production database; if you have multiple nonproduction databases, store each one on its own server.
Note: The archive component of Record Manager requires that the source and
the target database involved in a process must use the same RDBMS.
Ensure that you have enough disk space available for these databases to grow
and to hold the data that you will copy to them.
Note: For guidelines concerning disk space planning, refer to the Disk space
requirements on page 18.
30
Do not use the same name for any two databases that you plan to use with
Record Manager.
The source and target database must exist on separate database instances (for
Oracle).
Creating a Non-Production Database for SQL Server
Creating a Non-Production Database for SQL Server

Refer to Installing Workforce Timekeeper for instructions on creating a SQL
Server database. The only differences between creating a production database and
a non-production database are:
Kronos recommends that you set all file groups to auto extend.
Use a different name for each database that you create. Also, do not create a
database with the same name as the production database.
Record Manager uses the database names to differentiate between databases
when it performs validation and creates the drop-down lists in the Record
Manager workspace.
31
Chapter 3
Creating a Non-Production Database for Oracle

Refer to Installing Workforce Timekeeper for instructions on creating an Oracle
database. The only differences between creating a production database and a nonproduction database are:
You must create a separate Oracle instance for each Workforce Central
database you plan to use with Record Manager. For example, the production,
source, and target databases must be on a different Oracle instance.
Use a different TNS name for each database that you create. Also, do not
create a database with the same TNS name as the production database.
Record Manager uses the database TNS names to differentiate between
databases when it performs validation and creates the drop-down lists in the
Record Manager workspace.
To prevent the undo tablespace from running out of space and causing an error
during a Record Manager process, set the size of the tablespace to at least 1.5
times the combined size of the Person and ProjectedTotal tables. If the undo
tablespace is already larger than this, leave it as it is.
Note: When you determine the size of these tables, include the indexes.
Example
If the Person table and its index use 110 MB, and the ProjectedTotal table and
its index use 90 MB, you would add 110 to 90 and multiply the result by 1.5 to
find the minimum size for the undo tablespace.
In this case, the minimum size would be (110 MB + 90 MB) x 1.5 = 300 MB.
32
Chapter 4
Configuring databases
This chapter describes how to set up databases so that you can copy Workforce
Central data to and from them using Workforce Record Manager. First, you must
run Workforce Database Manager against any newly installed databases. After
that, you must configure settings that allow Workforce Record Manager to
connect to each non-production database.
Running Database Manager on page 34
Configuring Database Connections on page 35
Chapter 4
Running Database Manager

You must run Workforce Database Manager to build all newly installed databases
before they can be used in a Workforce Record Manager process.
For instructions on running Database Manager, refer to Installing Workforce
Timekeeper, and keep the following points in mind:
If you have a different Workforce Timekeeper server pointing to each of your

non-production databases, you need to run Workforce Database Manager only
once from each server.
If you have non-production databases that do not have Workforce Timekeeper

servers pointing to them, you need to reconfigure an existing server to point to
each database temporarily, one at a time, so that Workforce Database Manager
can be run against those databases.
Appendix A, Reconfiguring a server to point to a different database, on
page 45 includes instructions for reconfiguring a server.
Note: If you are upgrading an existing database, the Drop Foreign Keys and
Recreate Foreign Keys processes may not run. This is not an error.
34
Configuring Database Connections

Before you can select a Workforce Central database as a source or a target in a
Workforce Record Manager process, you must enter information about the
database in the Record Retention - Affected Databases tab on a server that points
to your production database. Every Workforce Record Manager process that you
run, regardless of the server from which you run it, refers to the production
database for information about the affected databases.
Use the following instructions to add a database to the Record Retention Affected Databases tab:
1. On a Workforce Central server that points to the production database, select
Setup > System Configuration > System Settings on the Workforce Central
navigation bar and then select the Record Retention - Affected Databases
tab.
2. Click Add on the action menu to add information for a new database.
The empty text fields that appear correspond to the eight required Java
Database Connectivity (JDBC) connector keys. The name of each key is made
up of three segments. The first segment of every key is jdbcconector, the
second segment is a number that uniquely identifies the database being
described, and the third segment identifies the type of information stored in
the field.
Every time you click Add, a new set of keys is added to the list. Each set of
keys is identified with the same number. All the keys with the same number in
the second segment apply to the same database.
3. Enter the appropriate value for each of the connector keys.
The value that you enter for each key differs slightly, depending on the
platform of the database you are adding. The tables included at the end of this
section include the proper entries for each database platform.
Note: The connector keys appear in alphabetical order. Ensure that you are
entering the appropriate information in each field.
4. Click Save.
Workforce Record Manager - Installation Guide
35
Chapter 4
5. Repeat steps 2 through 4 for all potential source and target databases.
For SQL Server

Key
Value*
jdbcconnector.#.drv
com.microsoft.sqlserver.jdbc.SQLServerDriver
jdbcconnector.#.max
50
jdbcconnector.#.min
10
jdbcconnector.#.name Enter the name of the database. This is the name used in the
source and target drop-down lists within the Workforce Record
Manager workspace.
jdbcconnector.#.pwd
Enter the password that corresponds to the database owner

username.
jdbcconnector.#.url
jdbc:sqlserver://
databaseServerName:1433;databaseName=databaseName.
Note: Port 1433 is the default port. If you use SQL Server named
instances or another port number, you should change the port
number accordingly.
jdbcconnector.#.usr
36
Enter the database owner username (typically tkcsowner).
For Oracle
Key
Value*
jdbcconnector.#.drv
oracle.jdbc.driver.OracleDriver
jdbcconnector.#.max 50
jdbcconnector.#.min
10
jdbcconnector.#.name Enter the TNS name of the database (not the SID, but the symbolic
name). This is the name used in the source and target drop-down
lists within the Workforce Record Manager workspace.
Note: Be sure to enter the appropriate suffix for the Oracle
database if one is used. For example, many Oracle databases are
set up with a .world suffix. You can find the appropriate
database TNS name in the tnsnames.ora file.
jdbcconnector.#.pwd Enter the password that corresponds to the database owner
username.
jdbcconnector.#.url
jdbc:oracle:thin:@databaseServerName:port:databaseSID
jdbcconnector.#.usr
Enter the database owner username (typically tkcsowner).
Recommended configurations
It is recommended that you run Workforce Record Manager from the Workforce
Central target server to reduce the workload on the Workforce Central production
server. You can configure with one of the options described as follows:
Option 1: Workforce Record Manager production database is the

Workforce Central production database
Workforce Record Manager production server is the
Workforce Central production server
Configure the Workforce Record Manager system settings and install the
license on the Workforce Central production serve. Run Workforce Record
Manager from this server.
Option 2: Workforce Record Manager production database is the Workforce

Central production database
Workforce Record Manager - Installation Guide
37
Chapter 4
Workforce Record Manager production server is the Workforce Central target

server
Change the target system settings for the production database to point to the
Workforce Central production database, populate the Affected databases on
the Workforce Central production server, and install the license on Workforce
Central target server. Install middleware on the Workforce Central target
server.
Define the following system settings on Workforce Central that affect Workforce
Record Manager in Setup > System Configuration > System Settings.
System Setting
Key
Record Retention
Database Setup
site.master.url - Enter the url for the production database.

site.master.usr - Enter the production database user. The user
name must be the name of the database owner in SQL Server
or the schema owner in Oracle.
site.master.pwd - Enter the production database password.
The password must be the password of the database owner in
SQL Server or the schema owner in Oracle.
Record Retention
Affected Databasees
Populate manually with all the databases and their connection

information for Workforce Record Manager and Record
Retention processing. For specific settings, see the tables on
page 36 and page 37.
Record Retention
Options and Tuning
Enter the location of the bulk loader utility exe on this server,
if you are running Workforce Record Manager.
Note: After installation, the values in the Record Retention Database Setup tab
may contain defaults that are not correct for your production database. You should
review these values and correct them, if necessary.
38
Chapter 5
Installing Non-Production Servers
The process for installing a Workforce Central server that points to a nonproduction database is the same as the process for installing a Workforce Central
server that points to a production database, as described in Installing Workforce
Timekeeper (Windows) or Installing and Upgrading Workforce Timekeeper on
UNIX.
The non-production database can be one of the new databases that you created for
archiving purposes, or it could be a database where you will test setup data before
copying it to your production database using Setup Data Manager. You can also
install the non-production server as an instance on the same system where you are
running your production server. Refer to the Installing Workforce Timekeeper for
more information about working with multiple instances of servers.
Note: Installing a non-production server is not required. If you do not install a
non-production server, you will need to reconfigure existing servers before you
build and access new databases. Refer to Reconfiguring a server to point to a
different database on page 45 for instructions.
Important: The Background Processor (BGP) must not be enabled on
non-production servers. Enabling BGP on a non-production server may
corrupt copy and archive jobs.
The Background Processor is managed through the Workforce Timekeeper system
settings. Refer to the Workforce Central System Administrators Guide and the
Workforce Central System Administrators GuideTimekeeping for more
information about managing the Background Processor.
Chapter 5
When installing a non-production server, keep the following key points in mind:
Ensure that the server that you will use for the installation meets the
requirements of Workforce Central.
If you plan to install and use Workforce Record Manager on this server, make
sure that the appropriate middleware (with loader utilities) for your RDBMS
is installed. Refer to System requirements on page 11 for more information.
Although you can install Workforce Central on the same machine as a SQL
Server database, you should consider installing it on a separate machine,
especially if the database is large. Oracle databases cannot be on the same
machine as other Workforce Central components.
You will use the same Workforce Central version 6.3 installation kit that you
used to install your production server. See Installing Workforce Timekeeper
(Windows) or Installing and Upgrading Workforce Timekeeper on UNIX for
more information.
If you are installing a server on a UNIX machine, you also need a Windows
companion server in order to use Workforce Centrals ability to create reports
on that server. See Installing Workforce Timekeeper (Windows) or Installing
and Upgrading Workforce Timekeeper on UNIX for more information.
Workforce Record Manager does not allow you to copy between two
databases that exist on the same instance.
When the installation procedure prompts for information about the database,
be sure to enter information about the non-production database and not the
production database.
If you are installing a server to point to your test rules databasea database
that is created from a backup of your production databaseit is possible that
the database does not yet exist. In that case, write down the information that
you enter here, and when you restore the test rules database, make sure its
information matches what you entered.
40
Preventing a non-production application server from updating the

Archive Database
Workforce Record Manager has a built-in mechanism to prevent the archive
database from being updated. It revokes database insert, update, and delete access
to all historic tables in the archive database at the end of each copy job. Access is
revoked for the user group kronosgroup in SQL Server and kronosuser in
Oracle. Therefore, to prevent the application server from updating the archive
database, the application server must be configured with a database user that
belongs to the kronosgroup database role. The database user is defined in
Setup > System Settings > Database tab. By default, it is db user suprkron.
The Workforce Record Manager access to both source and target databases must
be configured with the database owner user name, which is defined in Setup >
System Settings > Record RetentionAffected Databases tab and Record
RetentionDatabase Setup tab. This mechanism works for SQL Server
databases and Single Schema Oracle databases, but may not work for a multiple
schema Oracle database. If you have an Oracle multiple schema configuration,
you must turn off the Workforce Central background processes on your archive
application server. However, for all archive databases, it is a good idea to turn off
these background processes, in case the database permissions are reset during
maintenance.
The recommended background processes to turn off are:
Process Manager Engine
Process Manager Cluster Manager
Background Processor
Audit Settings in System Settings
All scheduled events in Event Manager including shift builder
Workforce Device Manager (WDM)
Note: This list is not complete and is subject to change as new features and new
background processes are added to the Workforce Central suite.
41
Chapter 5
42
Chapter 6
Uninstalling
The archiving component of Workforce Record Manager software is installed

with Workforce Central. Therefore, it is not possible to uninstall the archiving
component individually. However, you can deactivate the archiving component
by removing the Workforce Record Manager license from the
\wfc\licensing directory on the server where it is installed.
Note: When you remove the license, it deactivates both Workforce Record
Manager and the Setup Data Manager application.
Uninstalling Setup Data Manager

To fully remove the separately installed Setup Data Manager application:
1. Go to Start > Settings > Control Panel > Add/Remove Programs on the
computer where Setup Data Manager is installed.
2. Select Kronos Workforce Record Manager - Setup Data Manager, and click
Add/Remove.
3. When you are asked if you want to completely remove the selected
application and all of its components, click OK.
Chapter 6
44
Uninstalling
Appendix A
Reconfiguring a server to point

to a different database
This appendix contains procedures for temporarily switching the database that a
system server points to. Reconfiguring a server to point to a different database, or
switching databases, is sometimes necessary if you have fewer system servers
than you do system databases.
You need a server pointing to a non-production database:
To build the database using Database Manager
To access information on the database using the system
To reconfigure and test rules that you will later copy to the production
database using Setup Data Manager
After you build the database or access the information that you need, you can
point the server back to the original database. You do not have to point to the nonproduction database again until the next time you need to access the information it
contains.
The procedure for reconfiguring a server to point to a different database depends
on your operating system. Refer to the appropriate section in this appendix:
Reconfiguring a Windows server on page 46
Reconfiguring a UNIX server on page 47
Appendix A
Reconfiguring a server to point to a different database
Reconfiguring a Windows server

Property changes are implemented in a precise sequence. Do not alter the
procedure for modifying properties. For example, always change the property
settings on the Database Settings tab before changing the properties on the Data
Source Settings tab.
1. Go to Setup > System Configuration > System Settings > Database on the
system server that you want to temporarily reconfigure.
2. Change the following database property settings and then click Save:
Property
Change the value to...
site.database.dbname.url
The URL of the non-production database to which you

want to switch. Use the following format:
For SQL Server:
jdbc:sqlserver://
database_server_name:Port;
databaseName=database_name;
For Oracle:
jdbc:oracle:
thin:@database_server_name:Port:SID
For example, if the SQL Server database has a port
value of 1433, a name of archivedb, and is on a
server named server_1, the property value would
be: jdbc:sqlserver://
server_1:1433;databaseName=
archivedb;
site.database.dbname.usr
A user name for logging into the non-production

database to which you want to switch.
site.database.dbname.pwd
The password for the user name.

If you are not sure of the password to use, contact your
Database Administrator.
Note: Do not change the value of the site.database.names property.
46
Reconfiguring a UNIX server
Reconfiguring a UNIX server

1. Property changes are implemented in a precise sequence. Do not alter the
procedure for modifying properties. For example, always change the property
settings on the Database Settings tab before changing the properties on the
Data Source Settings tab.
2. Go to Setup > System Configuration > System Settings > Database on the
system server that you want to temporarily reconfigure.
3. Change the following database property settings and then click Save:
Property
Change the value to...
site.database.dbname.url
The URL of the non-production database to which you

want to switch. Use the following format:
For SQL Server:
jdbc:sqlserver:/
database_server_name:Port;
databaseName=database_name;
For Oracle:
jdbc:oracle:thin:
@database_server_name:Port:SID
For example, if the Oracle database has a port value of
1521, an SID of arch4, and is on a server named
server_1, the property value would be:
jdbc:oracle:thin:@server_1:1521:
arch4
site.database.dbname.usr
A user name for the non-production database to which

you want to switch.
site.database.dbname.pwd
The password for the user.

If you are not sure of the password to use, contact your
Database Administrator.
Note: Do not change the value of the site.database.names property.

4. Stop the system server.
47
Appendix A
Reconfiguring a server to point to a different database
The system server is now pointing to the non-production database you specified.
Using the server, you can run Database Manager and/or access information on that
database.
Note: Remember to reconfigure the server to point to the original database after
you are finished with the database to which you have switched.
48

Installation Guide-Record Manager

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Installation Guide-Record Manager

Enviado por

Direitos autorais:

Formatos disponíveis

Workforce Record Manager

An installers guide for Workforce Record Manager and

Kronos Workforce Central Suite

Document Revision History

Chapter 4: Configuring databases

Workforce Record Manager (Record Manager) includes the following

The archiving functionality of Record Manager is installed with Workforce

Installation diagram on page 9

System requirements on page 11

Installation and configuration overview

Step 1: Install the Record Manager license

Step 2: Create non-production Workforce Central databases

Installation and configuration overview

For Record Manager archiving Create a new, empty Workforce Central

For Setup Data Manager Create a new, empty Workforce Central

Step 3: Install non-production Workforce Central servers

Access archived data.

Workforce Record Manager Installation Guide

Step 4: Configure non-production Workforce Central databases

Step 5: Enter the path to the bulk loader utility

Step 6: Install the Setup Data Manager software (optional)

Workforce Record Manager Installation Guide

A non-production server is not The performance of the production

When you are installing the

Record Manager requirements

For Oracle databases:

Workforce Record Manager Installation Guide

All Workforce Central databases (production and non-production) and the

Workforce Record Manager Installation Guide

Setup Data Manager requirements

Pentium processor (minimum recommended)

800 x 600 (minimum)

Required for installation

Microsoft Windows XP SP2

Web Browser (for

Internet Explorer 6 and higher.

Microsoft SQL Server

Microsoft SQL Server 2000 SP3

Microsoft SQL Server 2000 SP3

Oracle 10g (10.1.0.2)

Microsoft SQL Server 2005 SP2

Oracle 10g R2 (10.1.2.0)

Microsoft SQL Server

Microsoft SQL Server 2005

Oracle 10g R2 (10.1.2.0)

Microsoft SQL Server 2008

Oracle 11g R1 (11.1.0)

6.2 and 6.3 Microsoft SQL Server 2005

Oracle 10g R2 (10.1.2.0)

Microsoft SQL Server 2008

Oracle 11g R1 (11.1.0)

Microsoft SQL Server 2008 R2

Oracle 11g R2 (11.2.0)

Workforce Record Manager Installation Guide

Workforce Central Compatibility with Record Manager v6.3

Purge (Attendance &

Workforce Forecast Manager

Workforce Integration Manager

Mobile Server Applications

Mobile Client Applications

Navigator (Next Generation User Interface)

Workforce Operations Planner

Workforce Central Portal

Data Collection Product/Terminal