Workforce Central System Administrator’s Guide® An administrator’s guide to the Workforce Central system. Kronos Workforce Central Suite Version 6 Document Part Number: 4703953-001 Document Revision: A The information in this document is subject to change without notice and should not be construed as a commitment by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this manual. This document or any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. All rights reserved. Copyright 2007. Altitude, Altitude Dream, Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper, Gatekeeper Central, Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My Genies, PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShiftLogic, ShopTrac, ShopTrac Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Unicru, Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Altitude MPP, Altitude MPPXpress, Altitude Pairing, Altitude PBS, Comm.Mgr, CommLink, DKC/Datalink, eDiagnostics, Experts at Improving the Performance of People and Business, FasTrack, Hireport, HR and Payroll Answerforce, HyperFind, Kronos 4500 Touch ID, Kronos 4500, Kronos 4510, Kronos Acquisition, Kronos e-Central, Kronos KnowledgePass, Kronos TechKnowledgy, KronosWorks, KVC OnDemand, Labor Plus, Momentum Essentials, Momentum Online, Momentum, MPPXpress, Overall Labor Effectiveness, Schedule Assistant, Smart Scheduler, Smart View, Start Quality, Start WIP, Starter Series, StartLabor, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite, WIP Plus, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce Central Portal, Workforce Connect, Workforce Employee, Workforce HR, Workforce Leave, Workforce Manager, Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler with Optimization, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos Incorporated or a related company. Mozilla.org is a registered trademark of the Mozilla Foundation. All other trademarks or registered trademarks used herein are the property of their respective owners and are used for identification purposes only. When using and applying the information generated by Kronos products, customers should ensure that they comply with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws. Published by Kronos Incorporated 297 Billerica Road, Chelmsford, Massachusetts 01824-4119 USA Phone: 978-250-9800, Fax: 978-367-5900 Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357) For links to information about international subsidiaries of Kronos Incorporated, go to http://www.kronos.com/ Document Revision History Document Revision A Product Version Workforce Central 6.0 Release Date June 2007 Contents About This Guide Organization of this guide ........................................................................... 12 Abbreviations and Terminology .................................................................. 14 Workforce Central suite documentation ...................................................... 16 Workforce Central documentation ........................................................ 16 Workforce Timekeeper documentation ................................................. 17 Workforce Record Manager documentation ......................................... 18 Developers Toolkit documentation ....................................................... 18 Other documentation ............................................................................. 19 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 Configuring a multi-instance environment .................................................36 Configuring Group Edits for a multi-instance environment ..................37 Configuring e-mail for a multi-instance environment ...........................37 Configuring Event Manager for a multi-instance environment ............37 Working with Workflow Notifications ........................................................39 Notification types ..................................................................................39 Available notification ............................................................................40 Setting up a Workflow Notification ......................................................41 Configuring Process Manager and Process Designer ..................................44 Upgrading from an earlier version of Process Manager ........................45 Configuring the Server ..........................................................................46 Setting up Delegate Authority ......................................................................50 Setting up the environment ....................................................................50 Setting up the delegate ...........................................................................50 Creating and assigning a Delegate Data Access Profile ........................51 Chapter 2: System Information Working with System Information ..............................................................54 All Servers information ................................................................................55 Applications information .............................................................................57 Background Processors information ............................................................58 Totals Calculation - Excluded Employees ............................................58 Historical Edits with Retroactive Pay Calculation - Excluded Employees ...................................................................................59 Database information ...................................................................................60 Database ................................................................................................60 Database Report Status ..........................................................................61 Database Report Display .......................................................................62 Working with database reports ..............................................................63 Creating Database Report Definition files ............................................63 Guidelines for creating Database Report Definition files .....................65 Licenses information ....................................................................................67 Meters information .......................................................................................68 Primary Labor Account Update information ...............................................69 Primary Labor Account Update .............................................................69 4 Kronos Incorporated Contents Resubmit All People for Account Update ............................................ 69 Threads information ................................................................................... 71 User information .......................................................................................... 73 Chapter 3: Log Report Log reports ................................................................................................... 76 Log files ....................................................................................................... 79 System log file ...................................................................................... 79 Component log files .............................................................................. 79 Log file report .............................................................................................. 81 Filtering and running log reports ................................................................. 82 Archiving system log reports ....................................................................... 83 Chapter 4: Log File Gathering Listing the log files to be gathered .............................................................. 86 Gathering log information ........................................................................... 88 Opening gathered log files ........................................................................... 89 Chapter 5: System Settings Overview .................................................................................................... 93 Working with System Settings .................................................................... 94 Before editing a configuration setting ................................................... 94 Editing a configuration setting .............................................................. 95 Using system settings ............................................................................ 95 Understanding properties validation ..................................................... 97 Audit Settings .............................................................................................. 98 Business Automation settings ...................................................................... 99 Background Processor settings .................................................................. 102 Clock Synchronize settings ....................................................................... 105 Data Source settings .................................................................................. 107 Adding Data Source Names ................................................................ 108 Database settings ....................................................................................... 109 Switching databases ............................................................................ 110 Display settings ......................................................................................... 116 E-mail settings ........................................................................................... 117 Workforce Central System Administrator’s Guide 5 Contents Event Manager settings ..............................................................................120 Working with Event Manager .............................................................122 Scheduling Event Manager tasks .........................................................125 Global Values settings ...............................................................................126 Group Edits settings ...................................................................................136 Clearing the Group Edit Results in Genies ..........................................138 Java Plug-in settings ...................................................................................139 Locale settings ............................................................................................140 Log file settings ..........................................................................................145 Logging Context settings ...........................................................................148 Messaging settings .....................................................................................149 Printers settings ..........................................................................................150 Enabling a server-based printer ...........................................................151 Record Retention - Affected Databases settings ........................................152 Record Retention - Database Setup settings ..............................................153 Record Retention - Options & Tuning settings ..........................................154 Reports settings ..........................................................................................157 Security settings .........................................................................................160 Understanding authentication ..............................................................163 Changing the logoff timer ...................................................................165 Service settings ..........................................................................................167 SQL Coverage settings ...............................................................................169 Enabling SQL tracing ..........................................................................170 Startup settings ...........................................................................................171 Transformation settings ..............................................................................172 Web & App Server settings .......................................................................173 System Settings for Workload Generator ..................................................175 Configurable terms ..............................................................................175 Additional system settings ...................................................................177 Chapter 6: Create a Custom Theme Create a new theme folder for the custom theme .......................................180 Select colors for the theme ..................................................................180 Prepare the logo file .............................................................................184 Specify custom property values in theme.css ......................................185 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 Chapter 8: Workforce Central Portal Configuration Overview of the Workforce Central Portal ................................................ 244 Purpose of the Workforce Central Portal ............................................ 244 Workforce Central Portal page configuration options ........................ 245 Kronos Web Parts and sample pages provided by the Workforce Central Portal .......................................................... 245 Adding Kronos Web Parts to a new or existing SharePoint portal page ... 249 Adding Kronos navigation Web Parts to a portal page ....................... 250 Adding and connecting Kronos Web Parts to a portal page ............... 252 Customizing a Workforce Central Portal sample page .............................. 255 Using the Kronos Web Part page template to create a portal page ........... 256 Customizing preconfigured Workforce Central Portal Web Parts ............ 257 Using SharePoint to change the title and appearance of a Web Part .. 257 Using SharePoint to change Kronos-specific settings for Web Parts . 258 Changing labels in Kronos Web Parts ................................................ 260 Additional configuration of health care Web Parts ............................. 262 Workforce Central System Administrator’s Guide 7 ...................................306 Aborting a process ..........................................304 Managing processes with Process Administrator ...............311 Changing the status of tasks in a process ..............................................................................................................................................................310 Managing tasks in a process using Process Administrator .................................................................................................................303 Logon profiles .....317 Troubleshooting Process Manager .....................................................................319 8 Kronos Incorporated .......................................................................................................................................................................................295 Workforce Genies ..................................298 HyperFind query ...................................................................................................................275 Basic strategy for creating a Web Part .............277 Visual theme for the Workforce Central Portal and Kronos Web Parts ..308 Deleting a process ..................288 Creating and linking a Help topic to a custom Web Part ....................................315 Monitoring resources using Process Administrator ..................................................................318 Enhancing Process Manager performance ...........................................................................274 Examples of Web Parts to create .....311 Viewing and changing the status of tasks in a process .309 Viewing process reports .......301 Workforce Genie profile ...............................306 Viewing the status of all processes .276 Procedures for creating a Web Part based on a Genie ...................................................................290 Troubleshooting ...............................Contents Configuring the Productivity Monitor KPIs (retail) ....................................292 General .........................................................302 People ......................................................................270 Advanced configuration of Kronos Web Parts ...............................................................................................288 Customizing Kronos Web Part Help topics ......................................287 Customizing and creating Web Part Help topics ..................................................................264 Configuring the Web Part charts for compatibility with Office Web Components ..............................273 Creating custom Workforce Central Web Parts .......................................................................................................................................................................................274 How Web Parts work ..................................................................................................................................................315 Viewing task statistics for a process ........................292 SharePoint ....................313 Viewing the properties of a task ...............................................308 Restarting a process ............................. ............. 346 Configuring SiteMinder ... 325 Workforce Central instances and regionalization ......................... 350 Diagnostic Tools logon screen .................... 332 Using and modifying predefined names ................................................................................................................ 326 How Workforce Central displays regionalized data and text ....................................................................... 343 Configuring Workforce Central to enable single sign-on .......................................... 340 Windows registry keys .................... 347 Diagnostic Tools user interface ............................................................... 350 Launching a specific application ..................................................................... 351 Running the Shift-Builder Diagnostic Tool . 319 Process pooling ............................................................ 321 Workforce Central language packs .. 350 Diagnostics Tools and usage .............................................................................................................. 327 Currency support .......Contents Clustering ................................................................................................................................................................................................................................................. 352 Index Workforce Central System Administrator’s Guide 9 ....... 324 Character set support .......................................................................... 351 Running the SMTP Mail to Launcher Diagnostic Tool ................................................................................................ 342 UNIX registry keys .............. 333 Using site-defined text strings in a multilanguage environment ..................... 327 Browser applications ..................... 351 Running the SMTP Mail Server Diagnostic Tool ........................................................................................................................ Contents 10 Kronos Incorporated . About This Guide This preface contains the following sections: • • • “Organization of this guide” on page 12 “Abbreviations and Terminology” on page 14 “Workforce Central suite documentation” on page 16 . About This Guide Organization of this guide The chapters in this guide provide the following information: • Chapter 1, “Introduction,” on page 21 contains an overview of the Kronos® Workforce Central® system architecture and describes the tasks that you use to administer the system. Chapter 2, “System Information,” on page 53 explains the System Information component of the Workforce Central system and describes the tasks that you use to work with System Information. Chapter 3, “Log Report,” on page 75 explains the Log Report section of the System Configuration component and describes the tasks that you use to work with log reports. Chapter 4, “Log File Gathering,” on page 85 describes the Log Gathering tool, which enables you to gather all the log files in your Workforce Central system into one ZIP file. Chapter 5, “System Settings,” on page 91 explains the System Settings section of the System Configuration component and describes the tasks that you use to work with System Settings. Chapter 6, “Create a Custom Theme,” on page 179 describes how to create a custom theme to change the appearance of colors and fonts in Workforce Central application pages to any set of colors preferred for the site. Chapter 7, “Reports,” on page 197 contains information about working with reports in the Workforce Central system. Chapter 8, “Workforce Central Portal Configuration,” on page 243 describes how to configure the Workforce Central Portal. Appendix A, “Predefined Data,” on page 297 describes predefined data that the Workforce Central system provides to simplify your administration tasks. Appendix B, “System Administration of Process Manager,” on page 305 explains the processes that you implement with Process Designer and Workforce Central across the organization. Appendix C, “Regional Settings,” on page 323 discusses values that need to be set for different countries and languages. • • • • • • • • • • 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. • Workforce Central System Administrator’s Guide 13 About This Guide Abbreviations and Terminology This guide uses the following abbreviations and terms: Abbreviation/Terms Meaning ADSI API BGP daemon DCM Microsoft Active Directory Service Interface Application Programming Interface Background Processor. A platform on which a Background Totalizer application runs. A process that runs in the background and performs a specified operation at predefined times or in response to certain events. 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. Domain Naming Service Data Source Name Graphical User Interface HyperText Transfer Protocol. A communication protocol between a client and a server. HyperText Transfer Protocol Secure. A communication protocol with encryption security, using a Secure Sockets Layer. Microsoft Internet Explorer Internet Protocol address International Standards Organization Java Database Connectivity Java Runtime Environment Java Server Page Java Virtual Machine Lightweight Directory Access Protocol Open Database Connectivity Portable Document Format A public-key cryptosystem developed by RSA, Inc. DNS DSN GUI HTTP HTTPS IE IP ISO JDBC JRE JSP JVM LDAP ODBC PDF RSA 14 Kronos Incorporated Abbreviations and Terminology Abbreviation/Terms Meaning SMTP SSL Simple Mail Transfer Protocol Secure Sockets Layer Workforce Central System Administrator’s Guide 15 About This Guide Workforce Central suite documentation The following documentation is available in PDF and HTML format on the Workforce Central documentation CD to help you install, use, and maintain the database and associated software. Workforce Central documentation • Guide to Planning a Workforce Central Installation provides an overview of the Workforce Central architecture, outlines the system requirements, explains how to prepare to install the server and client components for Workforce Timekeeper and other products in the suite, and includes the corresponding licensing and upgrade requirements. The Workforce Central documentation CD includes several installation and upgrade guides that describe how to install or upgrade Workforce Timekeeper and other Workforce Central suite products based on the product combinations and versions in use at your site. Workforce Central System Administrator’s Guide provides an overview of the system architecture, explains system administration tasks, describes how to work with logs and reports, and provides instructions for creating a custom theme for the browser interface. Workforce Central Process Manager/Messaging Database Tables Reference Guide supplements the Workforce Timekeeper Database Tables Reference Guide with information about the database tables that are used specifically by Process Manager and the Kronos Messaging System. Workforce Central Process Manager Programmer’s Guide describes how to use Process Manager to configure, implement, and maintain automated business processes across an organization. Workforce Central Database Administrator’s Guide explains how to maintain the Oracle and SQL Server databases for Workforce Timekeeper. This guide includes procedures for backing up databases, restoring and recovering databases, adjusting performance, and using maintenance utilities. • • • • • 16 Kronos Incorporated Workforce Central suite documentation • Workforce Central Import User’s Guide provides information about setting up and running XML and table imports for labor management systems. It describes the Transaction Assistant, which you use to correct failed XML import data. Workforce Timekeeper documentation • Getting Started with Workforce Timekeeper—A Manager’s Guide for Power Users summarizes the most common manager tasks, which include using Workforce Genies, Timecards, Reports, and the People Editor. Getting Started with Workforce Timekeeper—A Guide for Managers summarizes key product features for people who access employee time and attendance information. The book also explains the various Workforce Timekeeper components and the most common tasks that managers are likely to perform with each component. Getting Started with Workforce Timekeeper—An Employee Guide for Power Users explains some of the most common employee tasks, which include using the Timecard and Time Stamp components, as well as viewing personal schedules and reports. Getting Started with Workforce Timekeeper—A Guide for Employees explains some of the most common employee tasks in Workforce Employee - HTML Client, which includes using the Timecard, Time Stamp, and Quick Time Stamp components, as well as viewing personal reports. Workforce Timekeeper Database Tables Reference Guide contains details about the Workforce Central database tables. Workforce Timekeeper Database Views Reference Guide provides information and details about Views and how they are used as virtual tables in Workforce Central. Workforce Central System Administrator’s Guide—Timekeeping describes the administrator’s activities, such as system configuration and setup, and working with log reports, predefined data, and diagnostic tools. Workforce Timekeeper Table Format Import Programmer’s Guide provides instructions and table data for Workforce Timekeeper Import tables. • • • • • • • Workforce Central System Administrator’s Guide 17 About This Guide • Workforce Central Process Manager Programmer’s Guide—Timekeeping and Scheduling provides information on how to configure the Workforce Timekeeper and Workforce Scheduler process templates. Workforce Record Manager documentation • Workforce Record Manager Installation Guide includes installation and configuration instructions for Workforce Record Manager, the Setup Data Manager, and the non-production databases and application servers that make up the Workforce Record Manager environment. Workforce Record Manager User’s Guide provides instructions and guidelines for customers and service personnel who use Workforce Record Manager and the Setup Data Manager to copy data from one Workforce Central database to another. It describes how to create, run, and schedule Workforce Record Manager jobs and how to administer the Workforce Record Manager environment. • Developers Toolkit documentation Workforce Central includes an Application Program Interface (API) that you can use to access certain Workforce Central features from application programs. The separate Developers Toolkit documentation CD contains the information that you need to use the API. • The Workforce Central Developers Toolkit Programmer’s Guide includes annotated sample programs that show how to use the API, provides information that specifically addresses XML import and export issues, and includes descriptions of all of the tags, actions, and properties used by import transactions. The Workforce Central Developers Toolkit Reference Guides provide detailed information about each element of the API for each product in the Workforce Central suite. • 18 Kronos Incorporated Online Help for the Workforce Central suite is installed automatically with the product. • • Workforce Central System Administrator’s Guide 19 . 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. provides instructions for editing the browser-based graphical user interface and the associated browser-based Help files for Workforce Central.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. and late-breaking changes. About This Guide 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 . For example. Multiple instances of one or more Workforce Central applications can be installed on the same machine. • • Earlier versions of Workforce Timekeeper used the term application server to describe the entire Workforce Timekeeper application. most also support an Oracle database. or more instances of Workforce Timekeeper can be installed on a machine supported by one application server. the following important distinctions are made: • The term application server is only used in reference to the third-party application server software. Application server — Workforce Timekeeper requires a J2EE-compatible application server: JBoss (delivered by the Workforce Timekeeper installation program). most can also run on UNIX. in Workforce Timekeeper v6. which included third-party application server software and web server software. The term instance is used to refer to a single copy of a running Workforce Central application. • 22 Kronos Incorporated . Each instance can be independent and does not share code. two. it also now supports the following configurations: • • Workforce Timekeeper and application server software can reside on one machine and web server software can reside on a different machine. or Oracle HTTP Server. one. Although Workforce Timekeeper v6. or temporary files. Database — All Workforce Central applications support an SQL Server database. such as JBoss. all installed on one machine. not the Workforce Timekeeper application.0. runtime information. Web server — All Workforce Central applications can use Microsoft IIS web server software. Most applications can use Apache (delivered by the Workforce Timekeeper installation program). IBM HTTP Web Server.Chapter 1 Introduction Workforce Central infrastructure Workforce Central applications require the following infrastructure: • • Operating system — All Workforce Central applications run on Windows.0 continues to support this configuration. This means that. As system administrator. • • When the system starts in offline mode. see “Offline mode” on page 25. and an action menu. Log Report — Displays a workspace that can be edited. enabling you to determine the information to be detailed in the log. Clicking each tab displays properties for that area. you do not need direct access to the system console and property files to administer the system. you can administer the system from a remote location through System Configuration. System Settings — Displays a set of tabs representing different characteristics of the system and a workspace that can be edited. and an action menu.System configuration overview System configuration overview Use the System Configuration component to manage and configure the system. This component is used primarily for viewing the current state of the system. diagnose and correct problems. The System Configuration component in Setup contains the following components that deal with administering the system (these are accessible only with administrative rights): • System Information — Displays a set of tabs representing different characteristics of the system. Clicking each tab displays that area’s parameters. Workforce Central System Administrator’s Guide 23 . Because you can access the system through a web browser. This component allows you to change the values for system properties and to save the changes in a custom property file. For information about offline mode. the system configuration components are the only part of the system that are accessible. and establish database and networking parameters. Instead. This component allows you to create a customized log report. although actions are possible from several areas. you can configure various aspects of a Workforce Central instance. Users of Workforce Employee . you can access Workforce Central using the following URL: http://web_server/instance/logonWithUID For more information about single sign-on. 24 Kronos Incorporated . For more information.jsp Users of Workforce Employee . Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your communication protocol on the Web & App Server tab.HTML Client access the Workforce Timekeeper system through: http://web_server/instance/applications/wtk/html/ess/ logon.HTML Client using Quick Time Stamp access the system through: http://web_server/instance/applications/wtk/html/ess/ quick-ts.jsp For more details about HTML Client logons. Logging on with Single Sign-on If you have single sign-on enabled using SiteMinder. see the Workforce Central installation documentation. Note that this URL is case-sensitive. see “Web & App Server settings” on page 173. see “Configuring Workforce Central to enable single sign-on” on page 346.Chapter 1 Introduction Logging on to Workforce Central Users normally access the system through the web logon page specified for the instance: http://web_server/instance/logon where web_server is the name of the machine where the web server software is installed and instance is the name of the instance. which is wfc by default. you must use https:// rather than http:// for the logon URLs. 1. Offline mode As system administrator. you may need access to the administration functions of the system. 2. To access the system in offline mode. you need to set the Download Active X control to enabled. click OK. In the Security Settings dialog box. you must use https:// Workforce Central System Administrator’s Guide 25 . When you finish. In your Internet Explorer Security Internet Options. the system configuration components are the only part of the system that are accessible. This will prompt the user for a given server the first time. even if the database is offline. which is wfc by default. At minimum. 3. you can access the system via a special offline logon URL for system administrators. set ActiveX controls and plug-ins to settings in keeping with security policies at your site.Logging on to Workforce Central Enabling Active X controls and plugins The Download ActiveX controls and plugins is triggered every time you log on. The first time you log on after installing. and provide a choice to add the server to a list and avoid future prompts. select Custom Level. you can add your server(s) name(s) as a trusted server to launch Active X controls. 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. When the system starts in offline mode. You can also use this offline logon URL if you have single sign-on enabled using Netegrity SiteMinder. Note that this URL is case-sensitive. Note: Optionally. set the Run Active X controls and plug-ins to Prompt. When the system starts in offline mode. Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your communication protocol on the Web & App Server tab. the Database tab in System Configuration > System Information indicates that the database is offline and that no information is currently available.security.offline.offline. Managing an instance remotely You can perform the following tasks remotely using any Web browser: • • • Access log reports Change system configuration settings Restart a server 26 Kronos Incorporated .authentication.security. see “Web & App Server settings” on page 173.password keys The system encrypts the value of this password. Specify the offline mode user name and password using the following settings on the Security settings tab: • • site.Chapter 1 Introduction rather than http:// for the logon URLs.authentication.username site. If the database is offline. For more information. css and the graphics in a theme folder.Configure a visual theme Configure a visual theme You can create a custom theme by changing visual properties. Workforce Central System Administrator’s Guide 27 . For detailed information and procedures about creating a custom theme. All Workforce Central products that are installed with a Workforce Central application server instance use theme. and the graphics are stored in a theme folder.css. theme. and by changing logos and graphics. The properties are defined in a style sheet. including colors and fonts. see “Create a Custom Theme” on page 179. along with the style sheet. see “Configuring Workforce Central to enable single sign-on” on page 346 Set users’ browsers to remember passwords You can set your users’ browsers to remember passwords so that they can log on more quickly. This process is called single sign-on. Within the Workforce Central system. Use the single sign-on feature You can set authentication so that a user who logs on to the browser can automatically log on to Workforce Central without having to re-enter a username or password. For information about configuring your system to use single sign-on. Users cannot change this setting. 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. Caution: Use discretion if you decide to use this capability. you can simultaneously enable or disable this capability for all the browsers that use your site. 28 Kronos Incorporated . you can perform the following tasks to manage passwords: “Change user passwords” on page 28 “Use the single sign-on feature” on page 28 “Set users’ browsers to remember passwords” on page 28 “Change the SuperUser Password” on page 29 Change user passwords Users can change their password by clicking the Change Password link and entering the new password in the dialog box.Chapter 1 Introduction Working with passwords Passwords maintain system security. Change the SuperUser Password The Super User system user account. Note: For an SQL Server 2000 database. SuperUser. which is wfc by default. 3. you need to change this setting at each browser. SuperUser name is case-sensitive in offline mode only. and the new password. Log on to the offline page at: Workforce Central System Administrator’s Guide 29 . using the new password. Click the Change Password link. Online mode is case-insensitive. SuperUser. the old password. and default password. Make subsequent logins as SuperUser. enter the user name.Working with passwords • Setting Password Save From User Desktops — If the browsers are already on your users' desktops. Log on to Workforce Central at: http://web_server/instance/logon where web_server is the name of the machine where the web server software is installed and instance is the name of the instance. Enter the default logon with the user name. Offline mode To change the superuser password in offline mode: 1. You cannot prevent users from altering the setting. 2. Note that this URL is case-sensitive. for example: Online mode: SuperUser Offline mode: superuser Online mode To change the SuperUser password in online mode: 1. kronites. is the highest-priority system user account that the Workforce Central system administrator uses. A limited number of users should know of and use this account. password value. you can simultaneously enable or disable this capability for all the browsers that use your site. – For Microsoft Internet Explorer browsers.security.Chapter 1 Introduction 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. and default password. Client security You can set your users’ browsers to remember passwords so that they can log on more quickly. Make subsequent logins as superuser. 4. superuser. Click the Security tab. which is wfc by default. Use the following methods to enable or disable Password Save: • Setting Password Save With a Deployment Tool — Using this method. 30 Kronos Incorporated . – For Microsoft Internet Explorer browsers.authentication. 3. using the new password. • Setting Password Save From User Desktops — If the browsers are already on your users' desktops. Click Save. turn on or off AutoComplete through the browser’s Tools > Internet Options > Content tab. In the Setup workspace. Enter the default logon with the user name. then deploy the browsers to your users’ desktops. Change the site. You can also disable the Password Save. 6. turn on or off the AutoComplete function using the Microsoft Internet Explorer Administration Kit Customization Wizard. Note that this URL is case-sensitive.offline. kronites. select System Configuration > System Settings. You cannot prevent users from altering the setting. Users cannot change this setting. you need to change this setting at each browser. 2. 5. Upon entry of a valid password. the system logs the user back into the application. 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 60 minutes. Changing data on a page without saving it is not considered activity and will not reset the Workforce Central timer.Changing the Relogon session timeout Changing the Relogon session timeout After a set amount of inactivity. and the user must relogin through the logon screen. The Relogon dialog box informs the user that the session is about to time out. refreshing. the system times out and prompts the user for the password. and prompts for relogin in order to prevent a time-out. Example 2: Application server session Timeout = 60 Session Timeout Grace Period = 10 The Relogon dialog window appears after 50 minutes of inactivity. or searching. the application closes. such as saving. Note: Inactivity is defined as any action that results in direct communication to the server. If the user does not respond to the relogin request in time. The Session Timeout grace period represents the number of minutes prior to the application server session timeout that the Relogon dialog box will appear. Workforce Central System Administrator’s Guide 31 . the application server session closes after 30 minutes. the application server session times out. Session timeouts for user inactivity are governed by the application server session timeout parameter and the Session Timeout grace period. 5. 3. Changing the Workforce Central session timeout grace period To change the WFC Session Timeout Grace Period: 1. 2. Delete the comment characters (<!-. Find the following line.xml file in a text editor (WFC. Select Setup > System Configuration > System Settings > Web & App Server. Do not change this value to a zero (0) or a negative integer. The default value is 30 minutes. 7. Enter a new value for the session timeout.rootdir/Kronos/jboss/ server/instance/deploy/jbossweb-tomcat50. Save the file with the original name that it had before you edited it. Restart using the Start Workforce Central icon.sar) to a backup directory before you change the relogon session timeout.Chapter 1 Introduction Changing the JBoss Session timeout setting Note: You should copy the web. Stop the application by using the Stop Workforce Central icon.sar).xml file (WFC. To change the session timeout for the Relogon screen: 1.and --!>) that are located before and after the line of code.rootdir/kronos/jboss/ server/instance/deploy/jbossweb-tomcat50. 6. where xxx is the number of minutes until session timeout: <session-config><session-timeout>xxx</sessiontimeout></session-config> 4. Open the web. 32 Kronos Incorporated . Note: Changing the parameter will affect all clients that attach to the web/ application server. 3.session.timeout. Enter a new value for the following key: site. Workforce Central System Administrator’s Guide 33 . Click Save to save the changes. Click Restart Server to restart the Workforce Central application.graceperiod.minutes This value is the number of minutes that the Relogon warning screen should display prior to the application server session timing out.webserver. Caution: Do this at a time when no one is logged on to the system. The default value is 1 minute.Changing the Relogon session timeout 2. 4. Restarting the server ends all user sessions immediately. If you change information on the tabs in System Settings. if on the Log File tab in System Settings. For example. if you use the archived database. Modifying properties Modify properties using the System Settings option in the Setup component of the Workforce Central system. you can use the custom property file. the value INFO overrides the value of ERROR.Chapter 1 Introduction Working with property files Property files contain specifications that enable you to configure your system. Then. To return to your production database. When the system is started. 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. The system automatically copies this property name and the value that you typed to a custom property file. At startup time. and click Save. the system creates custom files. where each tab specifies a particular set of properties. use the Restore Defaults menu item on that tab. the system overrides the values in the property files with values in the custom property files. Each tab in System Settings deals with one group of properties. Groups of properties Properties are grouped by subject matter. using the Database tab. you change the value for site. If you want to restore the initial values associated with a particular System Settings tab. You can access properties through the System Settings component in System Configuration. For example. access the appropriate tab. Properties are maintained in property files or in database tables.loglevel from ERROR to INFO.log. To change the value of a property. use the Restore Defaults menu item on the System Settings Database tab. The following list shows the property group that is associated with each 34 Kronos Incorporated . the existing properties file contains the value ERROR and the custom properties file contains INFO. Do not modify the properties files directly. enter the new value in the Value box. portal printer WrmSetting WrmSetting WrmSetting site.reporting site.log site.loggingContext messaging site. System Settings Tab Audit Business automation Clock Synchronize Database Data Source E-mail Event Manager Global Values Group Edits Java Plugin Locale Log File Logging Context Messaging Portal Printers Record Retention Policy Setup Record Retention Policy Affected Databases Record Retention Policy Options & Tuning Reports Security Service SQL Coverage Startup Timekeeping Web & App Server Property Group site.local site.groupedit site.processengine site.java site.transformation site.service site.webserver Workforce Central System Administrator’s Guide 35 .startup site.security site. You may have additional tabs depending on what products you have installed.SQLCoverage test.clocksync site.database dsnname site.audit site.Working with property files System Settings tab.email site.eventmanager global site. If you use load-balancing software. each user must specify the URL for a specific instance. In addition. The user specifies a Uniform Resource Locator (URL) to connect to the system. for information about setting up multiple instances.000 employees. all users typically specify the same URL. This URL depends on whether your system uses load-balancing software from a third party to balance the load of incoming requests and determine which application server receives any specific request. with HTTP or HTTPS communication protocol. refer to the Guide to Planning a Workforce Central Installation and Installing Workforce Timekeeper. a user can connect to any instance. If you set up multiple instances.0. not the Workforce Timekeeper application. For more information about multiserver envrionments and load balancing. Application server software — JBoss Web server software — Apache or Microsoft IIS. or Workforce Leave. • If load balancing is not used. These instances can be set up on the same physical machine or on separate machines. refer to the Guide to Planning a Workforce Central Installation. • • Note: In Workforce Timekeeper v6. especially if your organization has more than 2. 36 Kronos Incorporated . the term application server is only used in reference to the third-party application server software. Workforce Attendance. The software determines which application server handles user requests. such as JBoss. You can set up multiple instances of the timekeeping product to improve performance.Chapter 1 Introduction Configuring a multi-instance environment A Workforce Central installation includes the following software: • Kronos product software — Workforce Timekeeper as well as optional Kronos products such as Workforce Scheduler. This instance is the only one authorized to run the Group Edit Recovery and Delete threads. Notifications can be configured on any instance. Determine which is your primary Notification server and set this property to false for all other application servers. You must reconfigure other keys on the E-mail settings tab.email. • • • Configuring Event Manager for a multi-instance environment For Event Manager.primary_server value is set to true for all application servers.com. You must set this value to true on all application servers.sender value to an e-mail address. if e-mail is supported.url value to the URL of your e-mail server. the site. you can set up events on any instance. one instance of Workforce Central acts as the primary Group Edit server.smtp.primaryServer setting.
[email protected] a multi-instance environment Configuring Group Edits for a multi-instance environment For Group Edits. For the primary Notification server. or it can be a dedicated server. This instance can be the same one that runs other applications. you must configure the e-mail function: • By default. By default.enable value is set to false.email. Workforce Central System Administrator’s Guide 37 . If you have a multi-instance environment.groupedit. This instance can also be used for other purposes. Designate one instance as the primary Group Edit server.email. using the site. Configuring e-mail for a multi-instance environment For Workflow Notifications. You must designate one instance as the primary scheduler. the primary Notification server monitors conditions for which the notification is requested. or it can be a dedicated server. You must designate one instance as the primary notification server. but only the primary notification server can initiate notification processing. the site. and initiates the preparation of e-mails when the condition is met. For the primary Notification server.email. set the site. but only the primary Scheduler server can schedule the event processing. set the site. for example. the first instance that comes up that has been configured to be an event manager. If the current event manager instance goes down. In a multi-instance environment. UNIX platforms: Set the value of site. configure the Event Manager function.eventmanager. • Windows platforms: By default. You can configure every instance as the primary scheduler to manage events created through the Event Manager function. you must ensure that Microsoft Task Scheduler is running by checking Administrative Tools > Services in the Windows Control Panel. the site. By default. it unmarks itself as the Event Manager server so that the next instance that comes up will be the Event Manager. only the primary Scheduler can initiate the processing of these events.eventmanager. All other instances that come up afterward do not start up as the event manager. is the default Event Manager server. The system automatically determines which is your primary Scheduler. Although an event can be scheduled from any instance in the system. • 38 Kronos Incorporated .Chapter 1 Introduction Note: Before you designate an instance as the primary Scheduler.enabled setting is set to true for all instances.hostname to true. select a HyperFind query from the Recipients drop-down list to obtain a list of e-mail recipients. In a single-server environment. select the employees listed in the notification by selecting a HyperFind query from the Employees drop-down list. such as group edit completion and event status. you cannot specify the e-mail recipients. In a multi-instance or multiserver environment. and edited. signed off. These types include pay period based for managers and employees. Because the recipient list and the list of people returned from the HyperFind query can be large and unstable. • Automatic notification types are activated at a predefined period of time before or after the end of a pay period. you can notify a manager if people have not completed their timecards by a specific time in the pay period. Workforce Central System Administrator’s Guide 39 . There are two categories of notification types: automatic. Each type is a template that you use to set up a specific notification request. you can modify the lists returned in either HyperFind query. which all relate to employees and are associated with timecards. the notification server generates the notification and e-mails it to the specified recipients. These are initiated by a person who takes an action. • Event-initiated notification types include the following: – Approved. For these notification types. which are determined by the function access profile that contains access control points for the notification type. the notification server is the same as the application server. Notification types Several types of notifications are available. For example. one instance acts as the primary notification server and monitors all notifications that were created at any instance. At the appropriate time. such as a manager who signs a timecard. To notify managers. They provide a mechanism for sending an automatic reminder to a manager or an employee.Working with Workflow Notifications Working with Workflow Notifications Workflow Notifications allows you to notify users about changes in the system and conditions such as database status. For some types. and those initiated by an event. • • • • • • • • • 40 Kronos Incorporated . Group edit failed — Sent when a group edit fails before completion. Application server booted — Sent whenever the Workforce Central application server is started or restarted.Chapter 1 Introduction – Group-edit failures. Timecard signed off by manager — Sent to employees after their timecards have been signed off by a manager. The recipients are determined by the function access profile that contains an access control point for this notification type. such as all employees whose timecards contain missed punches. Event status — Sent whenever a change in status is recorded for a Workforce Central event. For employees. Timecard approved by manager — Sent to employees after their timecards have been approved by a manager. Database unavailable and application server rebooted. You can specify the recipients. see the online Help for Workflow Notifications. Database server unavailable — Sent when the database server becomes unavailable. • For managers. 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. Server Notification — Sent when a user-selected event occurs on a userselected Workforce Central service. Available notification Several types of notifications are available. 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. – For more information about notification types. such as all employees whose timecards contain missed punches. both of which require administrative intervention. Group edit completed — Sent when a group edit has completed. though you can also specify additional recipients. be sure to update each Person record accordingly as new people are added to or deleted from the list of recipients. using the People Editor. name the sender of the Workflow Notifications. you must first establish the notification properties to enable the process. Depending on the notification type. Specify attributes such as the URL of your Simple Mail Transfer Protocol (SMTP) server. as described in “Notification types” on page 39. If you set up a recurring notification. Complete the template with your specific requirements. and do not usually change. as explained in the following section. and enable batch delivery. For example. • Determine access. You can find records of people who are candidate e-mail recipients and determine whether e-mail addresses are present for these people. to configure a workflow notification that would notify a supervisor on the last day of their pay period if any of his/her employees had missed punches for the current pay period: • • Workforce Central System Administrator’s Guide 41 . see the online Help for the notification that you are setting up. complete the Name and Message entries. using the e-mail function described in “E-mail settings” on page 117. Setting up a Workflow Notification To set up a Workflow Notification.Working with Workflow Notifications • Timecard edited by manager after employee approval — Sent to an employee whose timecard is edited by a manager after the employee has approved the timecard. After establishing the properties. identify the recipients of the notification. To customize an e-mail message and name it. You do this once. you can also do the following: • Select the notification type that matches your needs by using the Workflow Notifications component. Most of the properties in the e-mail function are established during installation or initial configuration. The recipients for different notification types are determined differently. For more details and specific configuration instructions. You can add any addresses not present. you must also set the E-mail on Completed Group Edit access control point to Allowed. Recipients (select the Workforce Manager Only HyperFind). Pay Period Based notification. The following notifications types rely on access control points to determine recipients: • • Group Edit completed Group Edit failed • 42 Kronos Incorporated . An access control point. In the Setup workspace. which identifies a Workforce Central system component to which a group of users has access. Access Notification depends upon access. and can be set for Workforce Employees or Workforce Managers. indicate how many days/hours before/after the pay period end. Description. for example. 4.Chapter 1 Introduction 1. For specified recipients to receive notification. 3. create an appropriate function access profile in Workforce Central. to set up a notification for a group edit completion. Employees (select the Employee's with Missed Punches HyperFind). select System Configuration > Workflow Notifications. the notification has to be initiated and the recipients must have the appropriate access control point settings in their function access profiles. For example. add a new For Manager's. Fill in the Workflow Notification. 2. which identifies a specific function that can be accessed. select the pay period they want to reference (lists their Fixed Rules). Create two HyperFind queries—One HyperFind query to look for employees with the missed punch exception. selecting Access Profiles > Function Access Profiles in the Setup workspace. Fill in the Name.If necessary. using the Workforce Manager Only condition. and the other query to look for just Workforce Managers. HyperFind. and define a Subject and Message. which is determined by the following: • A function access profile. Save the notification. 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. Notify an employee when his or her timecard is signed off after approval. access Setup > Access Profiles > Function Access Profiles > New > Workforce Manager . Workforce Central System Administrator’s Guide 43 . Notify a user of a change in status for a scheduled event. select Access Profiles > Function Access Profiles. Click the New button. To determine whether a Workforce Manager qualifies to receive a Workflow Notification. in the Setup workspace. Notify an employee if a manager approves his or her timecard.Department Manager > E-mail Notification: Access Control Point E-mail a completed group edit E-mail an incomplete group edit E-mail event status Description Notify a manager when a group edit has been completed. Notify a manager when a group edit fails. select Workforce Employee > E-mail Notifications to Employees: Access Control Point E-mail when timecard edit occurs after employee’s approval E-mail when timecard is approved E-mail when timecard is signed off Description Notify an employee if a manager edits a timecard after an employee approves it. You perform the maintenance and tuning tasks described in Appendix B. Note about Microsoft Windows Vista users: To log on to Process Designer on a Windows Vista™ client machine. Process Templates editor — The Workforce Central tool that you use to activate business process templates in the system.: • Process Designer — The visual process design tool installed on client systems. or have an administrator account. All components except Process Designer. “System Administration of Process Manager. and business analysts to use and implement online. To assist a Windows Vista user who cannot log on to Process Designer. you perform the configuration tasks described in this section to ensure that all authorized individuals at your site have access to Process Manager and Process Designer components. Business analysts and IS professionals use this tool to modify and deploy preconfigured process templates supplied by Kronos. Scheduling.” on page 305 to ensure that the business processes run efficiently in the system. • • Process Engine — The underlying software on the server that executes the automated business processes created with Process Designer. managers. see the Process Designer chapter in the Workforce Central Process Manager Programmer’s Guide. automated business processes in areas such as Time and Labor. 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. and Human Resources. users must have write/modify rights for certain Process Designer folders. Process Manager consists of the following components. IS professionals.Chapter 1 Introduction Configuring Process Manager and Process Designer The Process Manager feature in Workforce Central provides software components and XML-based templates that enable employees. the Process Designer section in the Workforce Central installation documentation. As the system administrator. which can be installed on a client system. administrators. Attendance. • 44 Kronos Incorporated . are installed on the server. and the release notes. initialdbconnections global.processengine.Configuring Process Manager and Process Designer • Process Profiles editor — The Workforce Central tool that you use to add process templates to process profiles.wba. “System Administration of Process Manager.maxdbconnections wba.wba.threadpoolsize Process Manager 5. Note: Be sure that you make a backup copy of your process template files. use Start > Settings > Control Panel >Add or Remove Programs to uninstall that old version.processengine.interval wba.wba.processengine.mrucachecapacity global. Process Administrator — The Workforce Central tool that you use to monitor and manage all business processes running in the system.wba.” on page 305.5 version of Process Manager. must be reapplied to the application server system settings after Process Manager is installed as part of your installation.wba.enabled wba.0 system.interval global.processengine.0. • For additional information.heartbeat. Upgrading from an earlier version of Process Manager If your system has a pre-5.heartbeat.wba.initialdbconnections wba.0. as described in Appendix B. see the Workforce Central Process Manager Programmer’s Guide.processengine.processengine.processengine.mrucachecapacity wba. Certain global system settings (System Configuration > System Settings > Global Values) have been replaced by application server system settings (System Configuration > System Settings > Business Automation): Process Manager Pre-5.1 and later wba.processengine.processengine.processengine. Workforce Central System Administrator’s Guide 45 .processengine.threadpoolsize Any changes that you made to global system settings on your 5. You can then use the People Editor to assign those profiles to appropriate employees and managers in your organization.enabled global.5 global.maxdbconnections global.processengine. select System Configuration > System Settings.Chapter 1 Introduction For more information about system settings. see “Specify system settings” on page 46. select Refresh on the System Settings toolbar to restore the previous setting for that property. Set the global.login. Specify the following Global Values setting for Process Manager: – global.email.smtp_url—The URL of your SMTP e-mail server. you must configure the server to support those features. • • • Messaging Business Automation Global Values 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.password Specify the following Global Values setting for the vacation bidding application.ShiftBuilderGovernor. the system may save the invalid setting that generated the error message. 46 Kronos Incorporated . Specify system settings In the Setup workspace. Configuring the Server After you install the application on your server. If you do not refresh that display.WtkScheduler.wba.Days property to 0 to ensure that shifts are created daily instead of weekly. Specify system settings on the following tabs: • E-mail Be sure standard e-mail settings are enabled for your site. including: site. Specify access control points To allow access to Process Manager. and vacation bidding functions. you must specify access control points for Everyone. select Access Profiles > Function Access Profiles.Configuring Process Manager and Process Designer Note: If you do not set the Shift Builder to run daily. and Managers.Common Setup Workforce Manager .Common Setup People Editor > Person Tab API’s > API Beans Add Edit View Delete Workforce Manager . Messaging. In the Setup workspace. Allow access to functions based on guidelines in the following table: Process Manager Everyone Everyone Everyone Everyone Workforce Employee Workforce Manager.Department Manager Manager access to Actions list Activate process templates Assign process profiles Access to Process Manager data (required for Process Designer) Workforce Central System Administrator’s Guide 47 .Common Setup Workforce Manager . Employees. 2.Common Setup Workforce Manager . several vacation bidding application functions will not work correctly.Common Setup Open an online form Start a business process View the Inbox Access to Task List Employee access to Actions list Process Manager setup Process Administrator access Add templates to process profiles: • • • • Workforce Manager . Complete the following steps: 1. 4. 2. under Filters. 48 Kronos Incorporated .Chapter 1 Introduction Messaging Everyone Everyone View the Inbox Messaging Access: • • • Create a new message Reply to a message Open a message 3. or resource. as defined in the database. Repeat for other profiles as necessary and then click OK. This feature reduces the need to manually specify individual managers in the templates. 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. select Common Setup > HyperFind Queries. select Process Manager > Reports To. 5. If a participant. 3. Set up the “Reports To” field in primary accounts 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. 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 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. Click Add Condition. On the Select Conditions tab. Click Edit on the menu bar in the HyperFind workspace. To ensure that these attributes work correctly. In the Setup workspace. Select the exclude option. b. Select a name and open the People Editor. d. Use the People Editor in Workforce Timekeeper to update the “Reports To” information individually: a. Click the Job Assignment tab. select an appropriate name. c. Click Primary Account. Workforce Central System Administrator’s Guide 49 . In the Reports To field.Configuring Process Manager and Process Designer Updating the “Reports To” Information You can update the Reports To information in two ways: • • Import the “Reports To” information for a group of people. See the Workforce Central Process Manager Programmer’s Guide—Timekeeping and Scheduling for information about configuring process templates. the delegate can switch roles and perform the manager’s tasks. Specifies a time period when that delegate would be authorized to act in the manager’s role. access the manager’s Inbox (Tasks and Messages). 2.Chapter 1 Introduction Setting up Delegate Authority When a manager expects to be unavailable (for example. 2. the designated delegate must accept the request. Assign the appropriate Delegate Data Access Profile to the manager using the Access Profiles workspace in the People Editor. To enable a manager to authorize a delegate. After accepting a delegation request. the system administrator must perform the following setup tasks: 1. Setting up the environment Use Process Manager to deploy and activate a Delegate Authority template and to assign Process Profiles. Create a Delegate Data Access Profile that includes the name of the delegate (that is. After a manager has requested that an individual be a delegate (step 2). Setting up the delegate After the setup steps have been completed. the individual who will act in the manager’s role). the manager does the following: 1. 50 Kronos Incorporated . Identifies a delegate (who already is listed on the manager’s Delegates Data Access Profile) who would be authorized to act in the manager’s role. on vacation). and use the manager’s Actions list during the delegation period. a delegate can be authorized to perform the manager’s Workforce Timekeeper tasks during the manager’s absence. The delegate can also access the manager’s Inbox (Tasks and Messages) and use the manager’s Actions list. For more information. You can do any of the following tasks on this page: • • • • Create a new Delegate Data Access Profile by clicking New. For example. A delegate’s data access profile can include as many names of potential delegates as you want. To assign a Delegates Data Access Profile to a manager. Delete a profile by selecting the profile and clicking Delete.Setting up Delegate Authority System administrator information (step 1) is included in this book. This lets you configure a delegate authority plan according to the needs of your site. the system administrator must include the delegate’s name in a Delegates Data Access Profile. Information about step 2 is available in online help. you could have an individual Delegates Data Access Profiles for each manager in your organization. To create or modify a Delegates Data Access Profile. The Delegates Data Access Profiles page appears. Another option would be to list all of the managers in a particular organization in a single Delegates Data Access Profile. Duplicate an existing profile (which you can then edit) by selecting the profile and clicking Duplicate. see the Workforce Central Process Manager Programmer’s Guide. Add or remove the names of potential delegates from an existing Delegate Data Access Profile by selecting the profile and clicking Edit. Workforce Central System Administrator’s Guide 51 . use the Access Profiles workspace in the People Editor. Creating and assigning a Delegate Data Access Profile To identify an individual as a potential delegate who would act in a manager’s role during the manager’s absence. select Common Setup > Delegate Profiles in the Setup workspace. then assign that profile to each of the managers in the group. Chapter 1 Introduction 52 Kronos Incorporated . Chapter 2 System Information This chapter explains the System Information component of the Workforce Central system and describes the tasks that you use to administer the system. This chapter contains the following sections: • • • • • • • • • • “Working with System Information” on page 54 “All Servers information” on page 55 “Applications information” on page 57 “Background Processors information” on page 58 “Database information” on page 60 “Licenses information” on page 67 “Meters information” on page 68 “Primary Labor Account Update information” on page 69 “Threads information” on page 71 “User information” on page 73 . Although System Information functions are primarily for viewing only. Stop and restart threads listed in the Threads tab. You can access System Information by selecting Setup > System Configuration > System Information. by clicking Refresh in the Workforce Central header. Users receive no advance warning. if you have a SQL Server or ORACLE database. 54 Kronos Incorporated . Note: You cannot update the workspace using your browser’s Refresh button. Click Restart Server on the Local Server tab. • • • Print the display. using your browser’s print function. you can do the following: • Update the display with the most current information. Generate database reports on the Database tab. to restart the server. By selecting System Information options in the Setup workspace. Caution: Clicking the Restart Server button causes the system to shut down immediately. you can click a tab to see the information for that area displayed in a workspace.Chapter 2 System Information Working with System Information System Information contains a set of tabs that display information about the current state and configuration of all physical servers and instances in your Workforce Central environment. • • Delete instances that are no longer connected to the database in the All Servers tab. the following shows that Workforce Central has been installed on two servers—Server1 and Server2—using the same database. Status — Indicates whether the instance is connected to the database. The workspace is split into Current Instance and Other Instances in Database. Workforce Central System Administrator’s Guide 55 . • The server named Server1 contains two instances — wfc and wfc1 — and both instances are currently connected to the database. Web Server Hostname — Identifies the name of the web server machine. Event Manager learns which server is the Event Manager server by looking at the database. whether they are on the same or different machines. • For example. Event Manager — Identifies the instance that is the Event Manager server.All Servers information All Servers information The All Servers workspace displays information about all instances of Workforce Central that are connected to the database. Instance — Identifies the Workforce Central instances on the application server. The following information appears: • • • • Application Server Hostname — Identifies the machine name of each application server that is connected to the database. Language — Shows the language of the instance. Application Name — Identifies the name of the application. 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. Status — Shows whether the instance is connected to the database and whether the instance is online. Application Server IP Address — Identifies the IP address of the application server machine. Web Server Hostname — Identifies the web server for the application server machine. Event Manager — Identifies if the instance is the Event Manager server. Logon URL — Identifies the URL used to log on to the instance. wfc. Reports Engine — Shows whether the reports engine is enabled for the instance. Application Description — (Optional) A description of the application appears if you entered a descriptive name with the Instance Manager. 56 Kronos Incorporated . Inter Process Connection URL — Identifies the URL of the instance. The following information appears: • • • • • • • • • • • • Application Server Hostname — Identifies the name of the application server machine.Chapter 2 System Information • The server named Server2 contains one 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. Application Context — Identifies the context of the instance. rootdir\instance\applications Workforce Central System Administrator’s Guide 57 . This list of products can also be found in: WFC.Applications information Applications information The Applications workspace displays the names and version numbers of the products that are currently installed on the specific instance. the number appears as a link to the Totals Calculation . Click Resubmit All Employees for Historical Edits to resubmit all of the employees that qualify for retroactive totalization without going to the Historical Edits with Retroactive Pay Calculation . Note: Submitting one or more employees for totalization means that they become eligible for retotalization. • • If there are employees with untotalized Totals Calculations. The list appears in table format and contains the following information for each employee: • • • • • A check box that indicates whether the employee has been selected for submittal to totals calculation Name Person ID from Database ID Field from People Editor Last Totals Update You can perform the following actions: 58 Kronos Incorporated .Excluded Employees.Chapter 2 System Information Background Processors information The Background Processors workspace provides access to lists of employees who have been excluded from totals calculation or have untotalized Historical edits. Totals Calculation . the number appears as a link to the Historical Edits with Retroactive Pay Calculation . Click Resubmit All Employees for Totals Calculation to submit all of the employees that qualify for totalization without going to the Totals Calculation Excluded Employees workspace.Excluded Employees The Totals Calculation . If there are employees with untotalized Historical edits. The retotalization does not occur until a background processor is available.Excluded Employees.Excluded Employees workspace lists employees who have been excluded from totals calculation.Excluded Employees workspace. Background Processors information • • • • Select All — Selects all of the viewable employees Deselect All — Deselects all of the viewable employees Resubmit — Submits selected employees that qualify for totalization Click Background Processors to return to the Background Processors workspace.Excluded Employees workspace lists employees who have been excluded from historical edits with retroactive pay calculation. Workforce Central System Administrator’s Guide 59 . The list appears in a table format and contains the following information for each employee: • • • • • • • A check box that indicates whether the employee has been selected for submittal to totals calculation Name Person ID from Database ID Field from People Editor Select All — Selects all of the viewable employees Deselect All — Deselects all of the viewable employees Resubmit Employees — Submits selected employees that qualify for totalization You can perform the following actions: Click Background Processors to return to the Background Processors workspace. Historical Edits with Retroactive Pay Calculation .Excluded Employees The Historical Edits with Retroactive Pay Calculation . the Workforce Central system uses this value.Chapter 2 System 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. Database Server — Shows the name of the database server. “Database Report Display” on page 62 — Displays a database report that you selected in the Database Report Status workspace. Synchronize your application server’s time of day with that of the database using the Clock Synchronize tab. Version — Shows the version of the database. the system accommodates the different time zone. and provides information about how to run and to view various database reports. Server Time — The time of day shown is the time used for all time-specific data.) Status — Shows whether the database is online. “Database Report Status” on page 61 — Displays the current list of database reports. see “Clock Synchronize settings” on page 105. 60 Kronos Incorporated . If the database and the application server are in different time zones. – – If the database and the application server are in the same time zone. • • Database The Database workspace displays status and details about the database to which the Workforce Central server is currently connected. The following information appears in the workspace: • • • • • Database Name — The database shown is the one to which the instance is currently connected. enables you to run and view various database reports. (Your instance can connect to different databases. For more information. You can create and list custom reports here by building your own Database Report Definition (DRD) files. To run a report. the Database Report Status workspace appears automatically. The View Report Status link is active even if there are no reports listed in the Database Report Status workspace. For more information. Available Database Reports — Shows the available database reports. you can run database reports that provide statistical and diagnostic information. • • • Database Product — Shows the type of database. Product Version — Shows the version of the database type. Schema Reconciliation Information. an empty list appears. see “Creating Database Report Definition files” on page 63. When there are no reports. Database Report Status The Database Report Status workspace displays the current list of database reports. the server should be configured in a time zone that does not observe Daylight Saving Time. The list appears in format and contains the following information for each report: Workforce Central System Administrator’s Guide 61 . and Object Reconciliation Information). Tuning Parameters. If you have an SQLServer or ORACLE database. 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 Available Database Reports list box contains four predefined reports (Space allocation. select a report from the list and then click Run Report.Database information – If employees are in time zones that do not observe Daylight Saving Time. When you run a report. The value is expressed in hours and the default is 72 hours.Chapter 2 System Information • • • • • • • • • • 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 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 The following menu items are available: Click on a report name of a completed or failed report to view the report.RepTimeToLive key on the Database settings tab in System Settings. Click the Database tab or the Database link to return to the Database Information workspace.Report.dbreport. Note: You cannot update the workspace using your browser's Refresh button. Click Report Status to access the Database Report Status workspace.database. Click the Database link to return to the Database information workspace.all. Click Refresh to update the workspace with any new or updated data. Database Report Display The Database Report Display workspace displays a database report that you selected in the Database Report Status workspace. 62 Kronos Incorporated . 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. Click View Report Status. In the Available Database Reports box.Database information Working with database reports You can run. Click Run Report. select System Configuration > System Information > Database. In the Database Report Status workspace. select System Configuration > System Information > Database. SQL type. 5. click the report name. 4. select the report by clicking the check box next to the Report Name. Click Delete. The DRD file must contain all four attributes that the database reporting framework needs to execute the report: name of the report. and delete database reports using the Database tab in System Information. To delete a database report: 1. The attributes are expressed using Key and Value pairs. Click OK in the confirmation dialog box. In the Setup workspace. database platform ID. select System Configuration > System Information > Database. To run a database report: 1. highlight the report. In the Setup workspace. In the Setup workspace. 3. Creating Database Report Definition files You can create custom reports that will appear in the Available Database Reports list box by building your own Database Report Definition (DRD) files. 2. 2. display. The Key and Value pairs are: Workforce Central System Administrator’s Guide 63 . 2. In the Database Report Status workspace. Click View Report Status. To display a database report: 1. and SQL string. 3. 3. then only the first DRD file is displayed in the report list and any duplicates are ignored. It must be unique among other DRD files. The key must be followed by the “ = ” string. such as Person Report.Chapter 2 System Information • Name of the report – – The first key component can be anything.drd. but you must use it as the second component for each of the four keys that comprise the DRD file. The third key component must be dbPlatformID. followed by either of the valid values SQLSERVER or ORACLE. The second component is the same as the second key component for the report name attribute. The second component is the same as the second key component for the report name attribute. followed by any value as the reportName. The key must be followed by the “ = ” string. Kronos recommends that you name the DRD file using the same name as the report to easily associate a report with its DRD file. The third key component must be sqlType. but you must use it as the first component for each of the four keys that comprise the DRD file. The second key component can be anything. 64 Kronos Incorporated . sqlServerPersonReport. • SQL Type – – – The first component is the same as the first key component for the report name attribute. – The entire key must be followed by the “ = ” string. not a stored procedure. followed by either of the valid values STANDARD or STORED. • Database platform ID – – – The first component is the same as the first key component for the report name attribute. The third key component must be reportName. the value paired with this key is STANDARD. For example. If the system detects a duplicate value in more than one DRD file. Since our hypothetical example uses SQL. A stored procedure against a SQL Server database will likely return a result set. so it does not produce a report at all. you must ensure that the compiled procedure resides in the database..Database information • SQL String – – – The first component is the same as the first key component for the report name attribute. or you can pass a script file containing the Create Procedure statement to an Open Workforce Central System Administrator’s Guide 65 . Kronos recommends that you use SELECT statements only. but will not return report column headers. especially when SELECT statements can be used instead. If you specify a stored procedure (as opposed to actual SQL) to produce the report. The DRD files must reside in the folder WFC Installation\wfc\reports\DBReports\DRD The extension of a DRD file must be . followed by the executable SQL or the name of the stored procedure. As stored procedures become more complex. Kronos recommends that you not use stored procedures. The third key component must be sqlString. The key must be followed by the “ = ” string. the result set(s) become less predictable. To ensure that customized database reports execute correctly. The second component is the same as the second key component for the report name attribute. SELECT statements usually return results sets. A stored procedure against an Oracle database does not even return a result set. Guidelines for creating Database Report Definition files A customized Database Report Definition (DRD) file must conform to the DRD file format. The contents of a DRD file must comply with the key and value format. You can create an SQL Server stored procedure through Query Analyzer (SQL Server 2000) or Management Studio (SQL Server 2005).drd (must be lowercase). follow these rules: • • • • • • The contents of a DRD file must be entirely in ASCII text. Chapter 2 System Information Database Connectivity (ODBC) or Java Database Connectivity (JDBC) connection to build the procedure. In either case, you must have the appropriate permissions to create objects in the database. Stored procedures are compiled by issuing the Create Procedure command. Once compiled, they reside in the database. • If your Create Procedure statement has no syntax problems and is correctly referencing existing DB objects, then the statement creates and compiles the procedure. If there are problems that will not let the procedure be created in a valid state, note that the procedure gets created but is in an INVALID (uncompiled) state. You should test your SQL or stored procedure prior to executing it from the feature. The application is not responsible for the correctness of the SQL, so you must ensure that the SQL works as intended. Executing a bad DRD file may or may not return anything in the way of a results set. Therefore, there is no guarantee that you will see anything that will be helpful if you view the report. The report appears in the Report Status page with a status of Failed. The application does not check to ensure that there is adequate disk space for the report results file since there is no way to know in advance what the size of the results file will be. You must be logged on as a user who has access rights to the System Configuration features as well as full-access rights to the database. This logon includes the user name that was specified at installation time, as well as the username “SuperUser” and the usual password associated with that username. The purpose of the feature is to generate reports, not to perform updates (such as inserts, changes, and deletes). • • • • 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. Workforce Central System Administrator’s Guide 67 Chapter 2 System Information 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 Primary Labor Account Update information The Primary Labor Account Update Information tab contains the following workspaces: • “Primary Labor Account Update” on page 69 — Displays the number of people who have changes in their primary labor account that need to be updated after the organizational mapping process occurs. “Resubmit All People for Account Update” on page 69 — Displays the people who have changes in their primary labor account after the organization map process occurs that needs to be updated. • Primary Labor Account Update The Primary Labor Account Update workspace lists the number of people who have changes in their primary labor accounts that need to be updated after the organizational mapping process occurs. The primary labor account consists of a job and a labor account. If a change occurs in the job hierarchy and the organizational mapping process cannot determine the logical primary labor account, the primary labor account needs to be manually updated. After you manually update any employee’s primary labor accounts, click Resubmit All People for Account Update to submit all employees that qualify for primary labor account updates. For information about updating employees primary labor accounts in People Editor, see the online Help. Resubmit All People for Account Update The Resubmit All People for Account Update workspace lists the people who have changes in their primary labor accounts that need to be updated after the organizational mapping process occurs. The list of employees appears in a table format that contains the following information for each employee: • • A check box that indicates if the employee has been selected for primary labor account updates Name Workforce Central System Administrator’s Guide 69 Chapter 2 System Information • • • • • Person ID from Database ID Field from People Editor Select All — Selects all of the viewable employees. Deselect All — Deselects all of the viewable employees. Resubmit People — Submits any selected employees that qualify for totalization. The following actions are available: After you manually update any employee’s primary labor accounts, submit it for primary labor account updates. For information about updating employees’ primary labor accounts in the People Editor, see the Help topic “Changing a person’s profile.” Click Primary Labor Account Update to return to the Primary Labor Account Update workspace. 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. 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. • State — Identifies the current status of a thread: – – – Workforce Central System Administrator’s Guide 71 Chapter 2 System Information – • – – • • Ready and waiting for work. For a Worker thread, this column identifies its parent Controller thread. For a Controller thread, this column has a blank value. Controller — Identifies if the thread is a Controller or Worker. User Name — Identifies the user who started the thread. If the system started the thread, the value of User Name is blank. Description — Contains short definitions of each thread. 72 Kronos Incorporated It also identifies users whose sessions have remained inactive for a period of time. In addition to the logon time. The Remote User column identifies the Internet Protocol (IP) address of the user’s PC. Information for each user appears in a separate row. This column can also identify unusually long-running sessions. the following information appears for each user: • The Last Access column shows the last time that each user took an action in the session. You can use this workspace to see who has logged on to the instance. the Remote User column distinguishes between them. The Elapsed Time column shows how long a user session has lasted. Workforce Central System Administrator’s Guide 73 .User information User information The User workspace identifies users who are currently logged on to the instance. • • Click Refresh to receive up-to-date values for Last Access and Elapsed Time. If multiple users have the same User Name. Users should have a separate system ID and should not all use superuser as a login. Chapter 2 System Information 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 . use Shift+Click to select adjacent items. Generate reports by using the default values or by specifying a log filter to produce a more concise report. log files can be large and unwieldy. by highlighting. Key and value details Servers — All server-instance combinations that are connected to the same database are listed. • In Internet Explorer. Distribute the reports by e-mail.rootdir/wfc/logs The Workforce Central system records system events for each instance in one or more system log files. Click Refresh to restore the report defaults and update the instance list with any new instances attached to the same database. To specify multiple items in a drop-down list. The default location for log reports is: • • Windows: WFC. or use Ctrl+Click to select random items. click Print or right-click on the report page and select Print. The printout might be useful for analysis and troubleshooting. copying and pasting the log report output to a file. each instance has its own set of log files. then e-mailing the log report file as an attachment. such as Wordpad. You can create a customized log report using the Log Report workspace.rootdir\logs UNIX: WFC. You can: • • • Arrange this information into customized reports. If you have a multi-instance environment.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. The format is: 76 Kronos Incorporated . Although you can access any log file with a text editor. You can print the report using the print function in your browser. Click Run Report to run a log report after you have selected filter criteria. Log reports server_name/instance_name where the default is server_name/wfc. If you select multiple contexts. such as the amount of memory on the host machine. Set this variable to a specific user name to find all log entries associated with this user. Times are optional. If you select a subset. The default is All. select that function from the list to see only records related to that context. Context — Context classifies log messages by the Workforce Central instance that generated them. you will need to run the log report several times. The purpose of this entry is to reduce the amount of information that is mined and retrieved for a report. The default setting is All. If you know that a specific context is involved with a problem. The report includes messages that were generated during the specified date and time ranges. the report includes messages from each context in the order in which you selected them. Select one or more server/instance combinations or select All. and the filtering criteria supplied for the log report. You can filter your report based on the context categories that you need. A log report can span multiple server/instance combinations. To enter Workforce Central System Administrator’s Guide 77 . The decision to select a subset depends on multiple factors.WFP. Most of the time. consider selecting a subset to lessen the possibility of memory errors. the number of servers or instances connected to the same database. For example.DAEMON. with different server/instance combinations each time. Kronos recommends that you use the Context option when requested to do so by Kronos Global Support. Start Date and End Date — The Start Date and End Date specify a range of dates. if your problem involves WFC. The first value is always the Start Date. Note: If you have multiple servers or multiple instances attached to your database. 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. to ensure that you get data from all of the instances. specify that context to significantly reduce the amount of data that you read. You set the value of the site. A space is not required between the comma and the next user name. priority. Specifying All includes all available log levels. 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) Note: Use DEBUG only if requested by Kronos Global Support.) between each user name. so you can request one level. DEBUG) Selected context groups The default sort order is date. Severity levels are not inclusive. 78 Kronos Incorporated .log. INFO. The default value is All. the messages in the report are ordered as follows: • • • Date Priority (ERROR. or context. The default is all message text.loglevel property in the Log File tab of the System Settings component. Message Contains — (Optional) The Message Contains value is a text string typically found in messages. WARN. several levels. you can specify any text string that occurs in the message portion of the log record to get only records containing that text. or all. put a comma (. In the text box. Sort By — The Sort By filter arranges the report in the order of the selected criteria. You cannot use the percent sign (%) or the single quote (‘) in the text string. If a report is sorted by date.Chapter 3 Log Report multiple user names. Priority — This value determines the severity level display of the system log. file. the value of the property site.log file is created. Component log files Other log files that record system activity are: • IIS web server – \Windows\system32\LogFiles\W3SVC1\ex<date>.log.log. When that file is completed. This property is available in the Log File tab of the System Settings component.log.name was set to WFC.log. The log report expects a certain format. the oldest one is recycled. If you specified a number other than zero.Log files Log files Workforce Central contains multiple log files. When the maximum number of log files is reached. The WFC. you can have as many completed log files as that number specifies. the file is renamed to WFC.maxlogs property. and changes may prevent the report from displaying properly.log file is the file currently being written.log is used for the first log file name in the drop-down list. The number of log files available depends on the number of log files that you specified in the site.log reaches its maximum size.rollover. and a new WFC. the only log file written is WFC. The most commonly used log file is the system log file. the names of other log files are incremented by 1.log.1. System log file When your system was installed.log Workforce Central System Administrator’s Guide 79 . it is emptied and rewritten. When WFC. The oldest log file has the highest number. Note: Do not modify a log file using a text editor.file. The name WFC. • • If you specified 0 (zero). log \Kronos\Apache\Logs\mod_jk.log Kronos\jboss\server\instance_name\log\server.vls \Kronos\instance_name\logs\WFCReporting<#>.log \Kronos\instance_name\logs\WFCEvtMgr.log \Kronos\Apache\Logs\error.log \Kronos\Apache\Logs\ssl.log \Kronos\instance_name\logs\StartupInfo.log /usr/local/apache2/logs (UNIX) Kronos\jboss\server\instance_name\log\boot.log \Kronos\instance_name\logs\StartupError.log \Kronos\processdesigner\kpe\kpe.log Kronos\instance_name\licensing\LicenseConversion.log • JBoss application server – – • • • • Workforce Central license – – – – – Reports Event Manager Workforce Central start up • Process Manager – 80 Kronos Incorporated .Chapter 3 Log Report • Apache web server – – – – – \Kronos\Apache\Logs\access<#>. for example. The following example illustrates a system log file: Workforce Central System Administrator’s Guide 81 . you should examine the logs for those components. 20020207040816. for example. The log level (or severity) encountered. The name of the context for which the message was recorded. for example. The line contains information in the following order and format: • • • • • A time stamp of the form yyyymmddhhmmss. WFC. 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.. The user ID of the user who caused the message to be written. rather than relying on the system log to inform you of a problem. The text of the message. Initializing WFC properties. INFO.Log file report Log file report A log file report contains one system log message per line.STARTUP. However. for example... Note: If you have multiple servers or instances attached to your database. Enter the end date. 5. Limit the report content by specifying content that can help you analyze server activity. In the Setup workspace. – – – – – Enter the start date. 2. All criteria are optional. If you select a subset. Separate multiple user names with a comma and no space before the next user name. and the filtering criteria supplied for the log report. Select the filter criteria from the following options: – Select a server/instance from the Servers box. The decision to select a subset depends on multiple factors. select System Configuration > Log Report. Select one or more priorities from the Priority box. 82 Kronos Incorporated . 3.Chapter 3 Log Report Filtering and running log reports You can filter log reports to include only certain log messages. 4. Click Run Report. Enter one or more user names. Enter a [single] text string in Message Contains. Results are always in alphabetical order. the number of servers connected to the same database. based on the sort order that you specified in the Sort By selection boxes. with different servers each time. such as the amount of memory on the host server. To filter and run a log report: 1. to obtain data from all of the servers. Select one or more context categories from the Log Context box. you will need to run the log report several times. Choose a method for sorting the results. consider selecting a subset of the server list to lessen the possibility of memory errors. 4.maxsize key. In the site. 2. The oldest log file has the highest number. the oldest one is recycled.Archiving system log reports Archiving system log reports Log files are automatically created in the WFC.file. specify the maximum size of the log file before rollover occurs. In the site. When the maximum number of log files is reached. To set your own archiving schedule. Up to 10 logs are kept.log.rootdir\instance_name\logs directory using the following default criteria: • • A new log file is created when the current log file is greater than 500KB.rollover. do the following: 1. 3.log.rollover. select System Configuration > System Settings > Log File. Workforce Central System Administrator’s Guide 83 . Click Save.maxlogs key.file. In the Setup workspace. specify the maximum number of logs to save. Chapter 3 Log Report 84 Kronos Incorporated . and ZIP files from each server instance. This information is invaluable for troubleshooting.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. 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 . rootdir\Kronos\wfc\ applications\wpk\properties\custom_wpksite. you should map to the SQL Server directory and add the log files to site.file.zip.gather. reports.list.list.list. Note the following: • When the web server and application server are separated on different machines.file.properties.max — Indicates the number of retries in case of file locking.log. Map to the network directories and add the log files to site. Change these settings only upon the direction of a Kronos Service Representative • site. only application log files are collected unless you map the web server log directories and add them to site. there are three properties that can be adjusted. add the log file names to site. If reports are stored and rendered by SQL Server Reporting Services (not RDLC). and so on do not accept remote work. Dedicated servers such as BGP. add the appropriate path to site.list. This list is in comma-delimited format. IIS logs will be collected regardless of the fact that Workforce Central might not be deployed under IIS.gather.log.lock. DCM. it skips over files that are not listed correctly. • • • If the log files to be gathered are very large. When the Log File Gathering tool runs.Chapter 4 Log File Gathering Listing the log files to be gathered You can list additional log files to be gathered when you run the Log File Gathering tool. including commas.gather.list.gather.log. The default location for IIS logs is C:\Windows/system32/LogFiles/HTTPEERR/* and C:\Windows/system32/LogFiles/W3SVC1/*. 86 Kronos Incorporated .file. These properties are in WFC. select System configuration > System Settings > Log File. If IIS is installed and the IIS log files are not in the default location.gather. The default is 3.log.retries. In the Setup workspace.file.log. Removing any parts of the original list could cause the tool to generate an incomplete list of log files.file.manager. Note: Do not remove any parts of the original list of files. timeout — Indicates the timeout of the remote zip transfer (in seconds).interval — Indicates the wait time between the retries in case of file locking. The default is 500.zip.sleep.manager.log.lock. site.file. Workforce Central System Administrator’s Guide 87 . The default is 1200.gathering.Listing the log files to be gathered • • site. The Log File Gathering workspace appears. click the servers from which you want to gather log files or click All. 3. You can specify a destination that is on another server. Some of the log files may be on different machines. select System Configuration > Log File Gathering. The Log File Gathering workspace changes to a table that shows the application server hostname instance for the ZIP file that you are creating. Request done appears at the end of the file. 5. In the Log Archive Destination field. When the log files have been gathered into the ZIP file. all logs except the web server logs will be collected. 2. Click View Gather Log Status. In the Servers field. 88 Kronos Incorporated . as long as you have access to that server. 4. If you gather log files for web and application servers that are on different machines. update the path of the ZIP file’s location. The name of the server in the list of Servers includes the machine name.Chapter 4 Log File Gathering Gathering log information Use the Log File Gathering tool to gather all the log files in your Workforce Central system into one ZIP file. Click Gather Logs. Click Refresh. To gather the logs into one ZIP file: 1. to get back to the status of the current accumulation in progress. the Status column shows Success. In the Setup workspace. Click Refresh to update the Servers list with any new servers. This is the location of the zip file on the server. and the Log Archive Destination field shows the server and path where the ZIP file is located. to update the Status field. 3. Extract the text file and all ZIP files within the master ZIP file to the current directory you are in. The server name and the instance name are also included in the paths of the log files that are gathered. and whether the gathering was successful. Copy the master ZIP file to a new directory. clear Overwrite existing files and select Use folder names. Workforce Central System Administrator’s Guide 89 . These zip files contain in their names the server name and instance name. Open each ZIP file and extract the contents into the current folder. Note: In the Extract dialog box. Open the master ZIP file. 4.Opening gathered log files Opening gathered log files The ZIP file that is created when you run the Log File Gathering tool contains ZIP files that come from each server/instance. To open the gathered log files: 1. 2. There is also a text file in the master ZIP file that lists each server name and instance name combination. The Readme file contains information about what logs were gathered for the particular server and instance. Chapter 4 Log File Gathering 90 Kronos Incorporated . Affected Databases settings” on page 152 “Record Retention . The actual settings that appear on your system may vary.Database Setup settings” on page 153 “Record Retention .Options & Tuning settings” on page 154 “Security settings” on page 160 “Service settings” on page 167 “SQL Coverage settings” on page 169 “Startup settings” on page 171 “Transformation settings” on page 172 “Web & App Server settings” on page 173 It also contains descriptions of the following System Settings tabs: • “Data Source settings” on page 107 • “Display settings” on page 116 • • • • • • • “E-mail settings” on page 117 “Event Manager settings” on page 120 “Global Values settings” on page 126 “Group Edits settings” on page 136 “Java Plug-in settings” on page 139 “Locale settings” on page 140 “Log file settings” on page 145 Note: The settings described in this chapter are a representative sampling of the most common settings.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 “Audit Settings” on page 98 “Background Processor settings” on page 102 “Business Automation settings” on page 99 “Clock Synchronize settings” on page 105 “Database settings” on page 109 • • • • • • • • • • • • • “Logging Context settings” on page 148 “Messaging settings” on page 149 “Printers settings” on page 150 “Reports settings” on page 157 “Record Retention . depending on the add-on applications that you have installed. For information . 92 Kronos Incorporated .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. and an action menu. There are two types of properties: • • Site-specific — Properties that pertain to a single Workforce Central instance. Typically. you can edit the system settings. You cannot inadvertently modify the wrong file. After the initial configuration. Workforce Central System Administrator’s Guide 93 . Accessing the properties files directly could lead to errors that could render your system unusable. Global — Properties that pertain to all instances in the system. These properties are maintained in property files within the specific instance. which creates custom files. the system automatically writes to the appropriate custom property file.Overview Overview The System Settings workspace displays a set of tabs representing different characteristics of the system that relate to your environment. If you have an administrator access profile. These properties are maintained in the database. When you modify a property using System Settings. your changes are stored in a custom property file. Caution: Always access properties through System Settings in the System Configuration component. System Settings are derived from the configuration files that contain the properties and parameters for configuring your system. Clicking each tab displays properties for that area that can be edited. your system is configured during or shortly after installation. When you change and save the values of system properties. avoid editing settings except to fine-tune or adjust the system for a different environment. The exact System Settings tabs that appear depend on the combination of applications from the Kronos suite that have been installed. • • • • “Before editing a configuration setting” on page 94 “Editing a configuration setting” on page 95 “Using system settings” on page 95 “Understanding properties validation” on page 97 Before editing a configuration setting For your convenience and for your system’s protection. Changes that you make to site-specific properties do not take effect until you restart the instance. Click Restart Server on each system settings tab to restart the Workforce Central application. Note that settings that are not stored in properties files (for example. the custom_filename. All user sessions are terminated with no warning. you do not need to restart the server. Global Values) are not recorded or backed up in this manner.nn. After editing a configuration setting.properties. You receive a confirmation message before the restart occurs. This verification is important because the values that you enter are not verified for appropriateness of the entry. the changes that you make to the configuration settings are recorded in custom_filename. Further changes that you make to configuration settings are backed up using custom_filename. or the number or type of characters. Caution: Clicking Restart Server causes the Workforce Central application to shut down immediately. where nn is the next lowest available number between 1 and 999.properties file will contain only comments. If you return the configuration settings to their default values.Chapter 5 System Settings Working with System Settings Use the System Configuration component to manage and configure the system. verify that your changes return the correct results.properties is the name of the associated properties file containing the default settings. 94 Kronos Incorporated . Changes to global properties take effect when you save your edit. spelling. where filename.properties. (Site-specific properties pertain to a single Workforce Central instance and are maintained in property files within the specific instance.Working with System Settings Editing a configuration setting 1. 3. you can do the following: • Save — When you click Save. the system modifies the value in the database immediately. In the value section of the setting. Tips for editing configuration settings: • • • You can change more than one property value on a setting tab before you click Save. 2. 4. Click Save. The system behaves differently. click Restore Defaults. (Global properties pertain to all instances in the system and are maintained in the database. click Refresh. To return to the last saved settings. the system archives all site-specific custom properties that are visible and restores all of the original properties for this tab. select a new setting or type the new entry over the current setting. Click the tab for the configuration setting to edit.) – • Restore Defaults — When you click Restore Defaults. (You cannot restore defaults to global properties. In the Setup workspace. however. the system saves the change. but the change does not take effect until you restart the instance. To return the default configuration settings of site-specific properties.) Using system settings From a System Settings tab. Workforce Central System Administrator’s Guide 95 . select System Configuration > System Settings. the system looks for modifications to properties in the tab that is currently visible.) When you save a change to a site-specific property. depending on the type of property that you are saving: – When you save a change to a global property. If printer. For example. Restart Server causes the Workforce Central instance to shut down immediately. Then. you can delete the value and leave printer. • Restart Server — Click Restart Server to start the instance again so that site-specific property changes can take effect.name. you must restart the application for the changes to take effect.n.1 through printer. You can then enter the value of the new property.8 empty.\\printer\print. where n is the next sequential object.n. you receive multiple new properties for the new instance. if you click Add on the Data Source tab. you get new property names for dsnname. 96 Kronos Incorporated . If it has no value. if your list included a property instance. For example. Note: If you make changes to any of the site-specific system settings.Chapter 5 System Settings Note: Restoring defaults has no effect on global properties that are maintained in the database. and dsnname. and enter the qualified name for the seventh printer. a new empty instance of the property name appears. Caution: Clicking Restart Server causes the system to shut down immediately. click Add to get the new property.rsa.usr. with the next sequential number attached to the name.7.pwd.n. dsnname. and you remove this printer. You can property instances empty. • Refresh — Click Refresh to update the workspace with any new or changed data. Some property instances are described by multiple properties. All user sessions are terminated with no warning. the instance restarts. Modified database values remain modified. For example. you must provide values for all three properties.6 are already in use. To add a new dsnname instance.8. When you click Add on these tabs. • Add — The Printers and Data Source tabs allow you to add printers and data source names. If you click Add for an instance that requires multiple properties. with the value MyPrinter. you can add another printer on the Printers tab. printer. the system ignores this property instance. printer. Keys in each of the settings’ key and value details contain the following information. If you enter an invalid value. where applicable: • • • • Whether the key is required A minimum value A maximum value A default value The default value is the default at initial installation. A text value is within a minimum and maximum string length. where appropriate: • • • • • • Required fields have a value entered.Working with System Settings Understanding properties validation Validation is performed on most properties settings when you click Save or Restore Defaults. A numerical entry is equal to or above a minimum value. no property changes are saved for the page. A numerical entry is equal to or below a maximum value. Many keys contain an option button or drop-down lists. The following validations occur. Because all entries are saved at the same time. if even a single entry fails. A numerical key has a numerical value entered. Workforce Central System Administrator’s Guide 97 . The error message identifies the key and provides a general description of what is wrong. All errors must be corrected and the page must be saved again. A text value has uppercase or lowercase letters where needed. you receive an error message when you click Save. audit. different keys may appear.audit. Value: installed default=false site.audit. whether or not their login attempt was successful.Accrual_Profile_Assignment.logon. Value: installed default=true 98 Kronos Incorporated . Key and value details site. You can enable or disable whether items can be audited on a site-by-site basis.enabled — Set to true to audit each time a user changes an accrual profile.enabled — Set to true to audit each time a user accesses any URL in the system.session.audit.Chapter 5 System Settings Audit Settings The Audit Settings control the settings for all items that you can choose to audit. Depending on what applications you have installed. Value: installed default=false site.enabled — Set to true to audit each user who logs in to the system.security.enabled — Set to true to audit each time a user accessess any URL in the system. Value: installed default=true site. minimum=1. installed default=20 wba.eligible — Set to true to enable the system as the Cluster Manager host.enabled — Set to true to enable Process Engine on your system. installed default=5 wba. in separate threads.initialdbconnections — The number of database connections to be created at startup.processengine. Value: required. You cannot save a process template on the Process Templates page whose Max Pool Size value is greater than this Max Pool Size value on the instance.heartbeat. If the Max Pool Size value on the Process Templates page and this Max Pool Size system setting are not the same.processengine. Value: required. minimum=0. installed default=120 wba. Separate tasks can run concurrently.interval — The interval (in seconds) when the status of the Process Engine is checked. Value: required. Key and value details wba.clustermanager. installed default=21 wba. installed default=true wba. Value: required.threadpoolsize — The maximum number of threads the Process Engine should generate for use in working with processes.maxstatements — The number of cached. minimum=5. installed default=50 wba. prepared statements per Process Engine database connection. Value: required. Value: required.server. platform=Windows. installed default=true wba. minimum=1. Value: required.processengine.processengine.maxdbconnections — The maximum number of database connections to be created.processengine.maxpoolsize — The default maximum pool size per instance.processengine. the Pool Manager will create template Workforce Central System Administrator’s Guide 99 . minimum=1.Business Automation settings Business Automation settings The Business Automation settings contain settings for Process Manager.processengine. site. installed default=WARNING wba. ERROR. Value: required. Valid entries are WARNING.Chapter 5 System Settings pools whose size is the lesser of the values.processengine. see the logging level entries table in “Log file settings” on page 145.to — A comma-separated list of people to be notified when a business process encounters errors. so that other administrators can act on these messages if the primary administrator is unavailable. minimum=0.mrucachecapacity — The maximum number of processes to be held in memory. If you do not enter a value.WFC. Value: required.loggingContext. wba.WBAP. For more information about the logging level entries.PROCESSENGINE — The default logging level for the Process Engine. Value: required.site. installed default=100 wba.email.sender} wba.exception. The wba. minimum=1. minimum=0 wba. Value: required.email. 100 Kronos Incorporated .enginelog.sender — The Sender field (specific to your organization) for e-mail messages generated from the Process Engine.personnum value is the person whom you specified to receive a message if a business process encounters errors.port — The port on which to start the rmiregistry and Cluster Manager. INFO.processengine.processengine. Value: required. installed default={site. If you change this setting.email.personnum — The Workforce Timekeeper person number of the individual.processengine. installed default=false wba. installed default=11111 wba.taskmaster. Note the following: • • The “originator” is the person who started the business process. or DEBUG. Kronos recommends that you assign more than one person. who will receive a message if a business process encounters errors. you must restart Workforce Central. usually an administrator.rmiregistry. Value: required. only the person who initiated the process (the originator) will receive a message.processengine.active — Set to true to activate logging for Process Engine on your system.taskmaster. minimum=0. for example: wba.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.timeout. installed default=10000 wba.wait.wf. installed default=200 wba. minimum=1.timeout.webform.timeout. minimum=1. wba. Value: required. Value: required.wait — The total amount of time (in milliseconds) that Process Manager will wait for a web form.retrydelay wba. installed default=30 Workforce Central System Administrator’s Guide 101 .tasklist. Value: required.webform.webform.retrydelay — The total time interval (in milliseconds) that Process Manager will wait before checking if the requested web form is active.webform.timeout.defaulttaskdays — The default number of days in the past for which tasks are displayed in the task list. which marks employees out of date if their scheduled totals or actual totals are too old. Value: required. A user may stop or restart a thread. installed default=true site. the process begins at startup Value: required.futurePayPeriods. If True. Value: required.period.updateStaleTimeStamps. installed default=30 days site. When the server starts. Key and value details site.createPayPeriods.maximumThreads — The maximum number of BGP threads allocated for this application server.wtbgp.days — Future pay periods will be created if existing pay periods do not exist at least this number of days in the future.wtbgp.createPayPeriods.days — The time the BGP waits between checks to create new pay periods. use the default settings.period. If the BGP is performing acceptably.enabled — Controls the startup of the Pay Period Creation process.hours — The Update Stale Time Stamp process marks employees out of date when their scheduled totals or actual totals are greater than this value. this process begins at startup. installed default=24 hours site.wtbgp.createPayPeriods. which creates new periods if pay periods do not exist far enough into the future.totalizer. this many BGP threads will be running.wtbgp. Value: required. installed default=true site.Chapter 5 System Settings Background Processor settings Use the settings on the Background Processor tab to make subtle tweaks to the performance of a BGP.wtbgp. If True. Value: required.wtbgp.enabled — Controls the start up of the Update Stale Time Stamps process.updateStaleTimeStamps. Value: required. installed default=1 site. but cannot create more. installed default=60 days 102 Kronos Incorporated . employees.idleTimeBeforeRetro. Value: required.wtbgp.queue.totalizer. the BGP controller adds new employees to the queue. before starting retrototalization. Value: required. Value: required. installed default=20 site.max — The maximum number of employees allowed in the totalization queue. The wait is designed to ensure that retro-totalization does not interfere with normal totalization. If false. the BGP always reads the number of employees specified in site.totalizer.redundantExceptionsToLog.fixedReadSize.max. the BGP reads this many employees at a time for totalization.queue. after completing totalization. the queue contains the number of employees specified in site.fixedReadSize.employees.wtbgp.fixed ReadSize — If enabled.totalizer. Value: required.heartbeat.wtbgp.wtbgp. installed default=50 site.employees. installed default=250 site.totalizer.totalizer.seconds — The delay in seconds between reads of retro-totalization rows from the database and from the internal queue.enabled — If True. A negative value causes all exceptions to be logged.queue. installed default=3 Workforce Central System Administrator’s Guide 103 .seconds — The number of seconds that the totalization queue can remain idle before the BGP starts retro-totalization.idleSecondsBetweenRetroQueueReads. Value: required.queue.wtbgp.totalizer.Background Processor settings site. installed default=60 seconds site.wtbgp.totalizer.max — The maximum number of times that each exception should be logged.totalizer.queue. Value: required.totalizer.min — The minimum number of employees allowed in the totalization queue.totalizer.wtbgp. installed default=true site.queue. installed default=60 seconds site.wtbgp.wtbgp. Value: required.seconds — The number of seconds that the BGP will wait. installed default=15 site. When the queue sizes reaches this value or goes below it.wtbgp. Value: required. minutes. installed default=30 site.minutes — The number of minutes the BGP will wait before trying again if totalization did not succeed. installed default=30 site.totalizer.wtbgp.wtbgp.numberOfRulesThreshold — The threshold for the number of pay rules and work rules currently in totalization.lock.retrototalization — The number of minutes between retrototalization attempts.wtbgp.Chapter 5 System Settings site. work rules.totalizer. Value: required. Additional totalizer processing is initiated if the number of rules becomes higher than the threshold. or their building blocks before the Totalizer should mark affected employees out of date. installed default=25 site. Value: required. the Java BGP starts up. Value: required.wtbgp.totalizer.lock. Value: required. installed default=5 site. Value: required.wtbgp.totalizer.timerMarkOutOfDate — The number of seconds to elapse after the last update of pay rules. installed default=true 104 Kronos Incorporated .enabled — Specifies whether the Java BGP starts up If True. Possible values are 0 to 23. The Clock Synchronize daemon keeps an internal delta between the instance and the database server times. When services start up. Since clocks time can change as time passes. Value: required. the delta is applied to the current instance’s time.clocksync. installed default=1 site. If the Workforce Central instance and the database server are in different time zones. and the instance uses its own clock. The delta is calculated as if both servers are in the same time zone. the instance retrieves the date and time from the database server. you can specify this synchronization process to occur at multiple intervals throughout a day.clocksync. Using the Clock Synchronize settings tab. the system ignores the difference in the time zones. A zero value disables the clock synchronization process.number_of_daily_syncs — Determine how many times a day that the instance’s clock should synchronize to the database server clock. you can: • • • Enable a clock synchronization to occur throughout the day Specify synchronization intervals Specify the times of the day that the synchronization should occur You can also synchronize the instance’s time and the database server times by restarting the Clock Synchronize daemon on the Threads tab. The Clock Synchronize settings control the Clock Synchronize daemon. which is a service that runs and keeps the instance’s time synchronized with the database server time. Key and value details site. with 0 being Workforce Central System Administrator’s Guide 105 .Clock Synchronize settings Clock Synchronize settings The Clock Synchronize settings establish the general parameters for synchronizing the Workforce Central instance’s date and time (which may be drawn from the physical server’s machine time) with that of the database server.hour_of_sync — Specifies what hour of the day the clock synchronization process should occur. When an application requests the current time. For example.Chapter 5 System Settings midnight. and site. and site. You can specify a non-critical time in a day for the synchronization process to occur. the hour and minute specified in site. site. and 6:23.clocksync.number_of_daily_syncs set to 4. Value: required.clocksync.number_of_daily_syncs set to synchronize multiple times a day.clocksync.minute_of_sync will be one of the daily synchronizations.number_of_daily_syncs set to synchronize multiple times a day.minute_of_sync set to 23 synchronizations will occur at 9:23. If you have site. 12:23. 3:00 and 6:00. If you have site.clocksync.hour_of_sync and site. Possible values are 0 to 59.hour_of_sync set to 9.hour_of_sync will be one of the daily synchronizations. 12:00. minimum=0.clocksync. maximum=23. the hour specified in site. Value: required.hour_of_sync set to 9. installed default=0 106 Kronos Incorporated .clocksync. minimum=0.clocksync.minute_of_sync — Specifies what minute of the hour the clock synchronization process should occur. 3:23. maximum=59.clocksync. For example.clocksync. if you have site. installed default=1 site. synchronizations will occur at 9:00.clocksync. 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 4. usr Dsnname. After you click Save. If you find a duplicate DSN name. which is located and accessed through the System Settings.1. There is no way to restore or reload the previous settings. the data source name must match exactly the data source name in the computer’s ODBC setting. edit the name and click Save. but uses Open Database Connectivity (ODBC) for selected components.name. SiteDsnname. These properties were written to a temporary property file.name Dsnname. such as Data Collection Manager and Workforce Connect.pwd. This information was captured in the following properties: • • • Dsnname. user ID. therefore. as well as to the SiteDsnname.properties. dsnname.rsa. Note: All DSN names must be unique.Data Source settings Data Source settings Workforce Central uses Java Database Connectivity (JDBC) most of the time. There is no validation on DSN names. and dsnname. When the system was started for the first time. these three properties were written to the WPKDsnname table in the database as dsnname.rsa Note: For SQL Server databases.1.usr.1. 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.pwd. any changes that you made are permanent. you must verify that there are no duplicate DSN names.1 file.properties. and password for an ODBC connection to the database. The person who installed your Workforce Central system provided the data source name. Workforce Central System Administrator’s Guide 107 . dsn_number. Note: All DSN names must be unique. dsnname. you must enter the value using this tab and let the system encrypt it.Chapter 5 System Settings Key and value details dsnname. the system adds the three property names. and you enter the values. Passwords are stored encrypted. Note: All DSNs must be unique. Adding Data Source Names You must add data source name (DSN) properties for other ODBC connections. dsnname. printer.usr — The user name associated with the DSN used for database access. The system automatically handles this type of encryption. There is no validation on DSNs. the three new properties are added to the WPKDsnname table. you must verify that there are no duplicate DSN names. you must copy the appropriate properties to the new database. by using the Add action on this tab. All dsnname password properties are encrypted with RSA encryption standards. When you click Save.name — The data source name (DSN) that is submitted during client logon. servers. This name is associated with the user and password used to access the database. If you add or modify a dsnname password.rsa — The password for the DSN and user. The Data Source tab lists all the dsnnames in your system. 108 Kronos Incorporated . therefore. you must verify that there are no duplicate data source names. and dsnname. There is no validation on DSN names. therefore. Note: Properties with a global scope across instances of Workforce Central are maintained in database tables.dsn_number.dsn_number.pwd. There is no limit to the number of DSN entries that you can add. Do not modify any properties in this tab unless you want the change applied to all instances in the system. When you click Add. If you switch databases. Properties with global scope belong to the property groups global. loginTimeout — The number of seconds before the connection process will abort when the instance connects to the database. These values are not likely to change unless you switch databases or upgrade your system. one instance can connect to a test database.dbreport. minimum=0. minimum=1. An instance can only be connected to one database at a time. you can do so while the database is running. Various Workforce Central instances can access different databases for different purposes.RepTimeToLive — Defines the amount of time (in hours) that database report files stay in the Workforce Central system before being automatically deleted. Value: required. For example. This tab only reflects the database to which this instance is connected. Value: required Workforce Central System Administrator’s Guide 109 .all. while other instances can connect to a production database. When you are restarting the instance and the database is extremely busy. Unless you switch databases. installed default=72 site. your modification does not take effect until the instance is shut down and restarted. installed default=5 site.names — The name of the database. you are not likely to modify any of the database properties in this tab. If you do need to modify a value.database. However.database. set this key to a higher number to give the system extra time to make the connection. multiple instances can be connected to the same database.all. 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. The Database Report Status workspace lists the available database reports.database. Key and value details site. maximum=30. Value: required.Database settings Database settings The Database settings show values that are established during installation or configured immediately after installation. However. 110 Kronos Incorporated . increase this value in increments of 10.Chapter 5 System Settings site. in seconds.dsn is the data source name for that connection.database. site.url — The database name with . site. Value required.url is the jdbc connection string used to connect to the database.drv is the jdbc driver to use.dbutility. Value required. Value required.min is the minimum database pool size.pwd — The database name with . for example. installed default=50 site. installed default=10 site.pwd is the password associated with the specified user name.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. A value of 0 indicates never. Value required.max is the maximum database pool size. installed default=0 Switching databases You may need to switch databases at times.all. from production to test. site.database. when the DB Utility Clean Up Worker thread should wake up to check for outdated records in the database utility temp tables. installed default=24 site.database.all. Value required.usr — The database name with . If you get messages in your log files that the pool size is exceeded.database.drv — The database name with .database.min — The database name with . site.dsn — The database name with .database.cleanUpThreadWakeUpInterval — The interval.database.usr is the user name of your database.database.database. Value: required site. installed default=60 site.database.DeadThreadCleanInterval — The number of minutes between cleaning of dead threads in persistence.max — The database name with .dbutility. database. and is on a server named server_1. the property value would be: jdbc. In the Setup workspace. Use the following format: jdbc:driver:database_server:port?database=database_ name or database_SID For example.properties property file. Note: The system implements properties changes in a precise sequence. 2. Do not alter the procedure for modifying properties. select System Configuration > System Settings > Database. a name of archivedb. 3. do the following: 1. 5.database.Database settings The database that was identified when your system was installed is probably your production database. Click Save.database.usr property to the user account name of the database to which you want to switch. Workforce Central System Administrator’s Guide 111 . Stop the server using the Stop Workforce Central icon. and the database SID when referring to an Oracle database. Set the site.dbname. Set the site.pwd property to the password for the user account. Set the site. a port value of 1433. always change the property settings on the Database Settings tab before changing the properties on the Data Source Settings tab.url property to the URL of the database to which you want to switch. 6. Switching Windows databases To switch Windows databases.inetdae7:server_1:1433?database=archivedb Note: Use the database name in the URL when referring to a SQL Server database.dbname.dbname. if the database has a driver inetdae7. For example. 4. Configuration settings for this database appear in the WPKSite. Note: Remember to reconfigure the instance after you are done accessing the archive database.1. In the Setup workspace. 11. 10. select System Configuration > System Settings > Data Source and change the values of the dsnname.pwd. Set the site. In the ODBC Data Source Administrator dialog box.url property to the URL of the archive database to which you want to switch. 14. Change the information in the Database Name and Database Server boxes (for SQL Server) or the SID and Host boxes (for Oracle) in the General tab of the SQL Server Wire Protocol Driver Setup dialog box to match the information for the database to which you want to switch. In the Setup workspace. 13. Select Start > Settings > Administrative Tools. select System Configuration > System Settings > Master Database. 2.usr and dsnname. and click Configure.dbname. 12. Restart the Workforce Central server using the Start Workforce Central icon. Highlight the name of the database to which the instance is currently pointing. Click OK.database. click the System DSN tab.rsa properties to the user account name and the associated password for the new database. do the following: 1.Chapter 5 System Settings 7. Switching UNIX databases To switch UNIX databases. Use the following format: jdbc:driver:database_server:port?database=database_ SID 112 Kronos Incorporated . 8. Select DataSource (ODBC).1. 9. Set the site.database. Workforce Central System Administrator’s Guide 113 . database is the value that you specify for the site.names property. 10. the property value would be: jdbc.ini file. if you specify a value of product. 8. Stop the Workforce Central server using the Stop Workforce Central icon. 4. Restart the Workforce Central server using the Start Workforce Central icon. 9.database. if the database has a driver inetdae7. Set the site. an SID of arch4. Click Save.database. For the database to which the Workforce Central instance is currently pointing.product.pwd. a port value of 1433.usr property to the user account name of the database to which you want to switch. then change the name of the URL property to site. change the values of the dsnname.database. change the SID and host database information to that of the database to which you want to switch.database.dbname. For example. Open the odbc. Save the file.1.pwd property to the password for the above user account.url — In this property.url. Note: Remember to reconfigure the instance after you are done accessing the archive database. 5.rsa properties to the user account name and the associated password for the new database. select System Configuration.inetdae7:server_1:1433?database=arch4 3. and is on a server named server_1. In the Setup workspace. Properties affected by switching databases The following properties are affected by switching databases: • site. On the Data Source System Settings tab.1.dbname.Database settings For example. 7.usr and dsnname. 6. 11. integ.database. For example.database.url=jdbc:inetdae7:server_1:14 33?database=summary • site. a database named summary. For example: site. The format is jdbc:driver:database_server:port?database=database_ name.inet.drv = com. a port value of 1433. The DSN is needed for components that access the database through an ODBC connection.dsn — Identifies the data source name (DSN) associated with the database. The property value should remain unchanged. then your property file contains the following line: site. site. For example. If you use the same logon user ID for the new database. Note that the property specifies the same database_name in its name and its value. include the name of the database in the property name and its value.database. change only the property name.min — Only the name should change to match the name of your database.tds.pwd — Specifies the value of the encrypted password that was set up during the initial configuration.usr — Identifies the database logon user ID that was set up during the initial configuration. change only the property name. If you use the same password. if the driver has a value of inetdae7. site. and a database server named server_1. For example: site.database.database. Only the name of the property should change to match the name of your database.drv — Identifies the name of the JDBC driver. To switch databases.database.integ. if your current database is named prod and you are switching to a database named integ. then change the current property to site.database.database.summary.integ.min = 10 • • • 114 Kronos Incorporated . In most cases. The value should remain unchanged.dsn = integ • site.TdsDriver site.Chapter 5 System Settings The value assigned to this property identifies the JDBC connection string that connects the instance to the database.database. you only need to change the database_server and the database_name values. If you switch databases.max = 50 Note: Properties with global scope across instances are maintained in database tables. For example: site.Database settings • site.database. The value should remain unchanged. Workforce Central System Administrator’s Guide 115 .database. you must copy these properties to the new database.integ.max — Only the name should change to match the name of your database. include — Set to true to force the communication protocol to be included in custom URLs.name setting determines the theme to apply to the site.communication. installed default=false Note: Enabling this setting increases the load on the system. The site. installed default=7 site. Value:required.portal.portal.theme. Key and value details site. maximum=8. The default is to load the theme once at application startup.protocol — The default communication protocol used when invoking custom URLs.mode — Specifies whether the theme reloads every time the page is refreshed. Value: required. icons.name — Specifies the visual theme to apply to the site. it is recommended that this value is set to false.external. and logos.portal. 116 Kronos Incorporated .protocol.Chapter 5 System Settings 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. Value:required.theme. Value: required. minimum=1.systemconfiguration.portal. icons. In a production environment.MaxTabsInRow — The number of tabs to display on a single menu row for System Information and System Settings. The theme name comes from the name of the folder that contains the stylesheet.portal.external. installed default=true site. installed default=basic site. For instructions about designing a theme.communication. Value: required. refer to “Configure a visual theme” on page 27.theme.development. and logos that make up the theme. installed default=http site. A theme includes a style sheet.portal. see “Working with Workflow Notifications” on page 39. The Simple Mail Transfer Protocol (SMTP) e-mail application program interface (API) is always available.email. In a multiinstance environment.email. For more information. This setting refers to the notification engine only. Value: required. Only one primary instance exists in a multi-instance environment.availability. Value: required. messages are added to it until the notification server is triggered to send the e-mail.email. if you import data or the system performs multiple pay code edits.primary_server — Set to true to indicate that this instance is the primary notification server. In cases where multiple notifications to the same recipient result from a single function. When the system begins an email. With the next message. You can enable batch delivery using the site. installed default=false site. This instance keeps track of all notifications and generates the appropriate e-mail when a notification condition is initiated. Key and value details site.enable — This indicates whether to enable or disable email when an employee changes his or her availability pattern. the batched e-mail includes multiple messages. Value: required. Any instance can create notifications. one instance is designated as the primary notification server.E-mail settings 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. another e-mail is started. For example.email.batchDelivery property.enable — This indicates whether the notification is enabled or disabled in this instance. In a single-server environment. installed default=true site. installed default=true Workforce Central System Administrator’s Guide 117 . but only the notification instance can process them. the notification server is the local host. batch delivery consolidates these notifications into one e-mail. Set to true to enable e-mail. The e-mail must appear in the format
[email protected] site. Value: installed default=00:00:60 site. installed default=true site.includeStartupInfoLog — Set to true to attach the StartupInfo.email.com.language.email.charset.charset — The character set used in encoding the subject and message body.msg_queue_time_between_purges — The interval between the message queue purges.com site. that the message delivery engine should wait for the SMTP server connection before timing out. Value: required.email.htmlxml.Chapter 5 System Settings site. installed default=60 site.company. installed default=true site. even if it is not a valid address.max_attempts — Maximum number of attempts for the system to send a message via e-mail. Value: installed default=3 site.sender — The Sender field for e-mail. and sent out as one e-mail. Value: required. site. The format is dd:hh:mm. Value: minimum=1.log to the instance booted notification. you must change the character set for e-mail to ISO-8859-x. Value: minimum=1.email.email.email.smtp_server_timeout — The time. Value: installed
[email protected]. Value: required. in seconds. installed default=true 118 Kronos Incorporated .msg_queue_sleep_time — The time interval when the message delivery engine is idle if the queue contains no messages.codepageid Note: If you use Windows Code Page 1252 for your character set.includeStartupErrorLog — Set to true to attach the StartupError.batchDelivery — Set to true to specify batch delivery: all messages in the queue to the same recipient will be grouped. maximum=60. installed default=120 site. installed default=site.email.smtp_url — The URL of the SMTP mail server.email.email. Value: installed default=mail1. Value: required.log to the instance booted notification. The maximum is 60 minutes. For example.percent — The number of licenses left available before a notification is sent to a specified e-mail address. Value: maximum=1.E-mail settings site. Zero indicates no limit.percent — Indicates the threshold for notification of the percent of used e-mail licenses.license. the number of e-mail records that can be processed at one time.addresses.addresses.email.chunkSize — Set to zero.email. The value is a percentage of the total number of licenses. warning that the number of available licenses is getting low.delimiter — The character used to separate recipient names in an e-mail address site.delimiter — The character that separates e-mail addresses when multiple e-mail addresses are used. Value: installed default=90 site.email. The notification is sent to the e-mail address that was specified during the notification configuration process. and the percent is set to 90.email. Workforce Central System Administrator’s Guide 119 . an e-mail notification is sent out when the number of licenses in use reaches 900.license. if you have licenses for 1000 employees.email. site. installed default=. site. Value: required.Chapter 5 System Settings Event Manager settings The Event Manager settings are used on Windows systems to establish the general parameters for handling events. Only one instance per installation can be marked true. If this value is true.startup — If this value is true.hostname — Specifies the name of the Event Manager host machine. installed default=false site.pwd. This key is not used on UNIX servers. when the instance is started.eventmanager. If you did not enter values. Value: required.NT.NT. you can enter the values into site.user and site. platform=Windows.eventmanager. Value: platform=Windows. Key and value details site. The configuration of the Event Manager settings includes identifying: • • The instances available in the installation The user names and passwords necessary to allow all components to execute and communicate Note: During installation. This key is not used on UNIX servers.enabled — Indicates whether this instance is the Event Manager scheduler server. platform=Windows. Examples of events are importing data or generating a report.eventmanager. A Workforce Central system event is task automated and scheduled to run at a predetermined time or periodically. the synchronization is not done. which is used to launch events.eventmanager. this instance is responsible for reading events from the database and scheduling them on the Microsoft Task Scheduler. This key is not used on UNIX servers. the Event Manager enters a startup process that synchronizes the database and the jobs on the Microsoft Task Scheduler. installed default=true 120 Kronos Incorporated . installed default=localhost site.eventmanager. If this value is false. you were prompted to enter a Windows user name and password that have permission to run Microsoft Task Scheduler. A higher log priority number causes a larger log.recovery — If the events on the Microsoft Task Scheduler are seriously out of sync with the database.eventmanager.Event Manager settings site. platform=Windows. This setting is the Workforce Central user that is used for that logon. the Event Manager will enter a more aggressive startup process that rewrites all of the jobs on the Microsoft Task Scheduler.NT. This key is not used on UNIX servers. platform=Windows.logEnabled — Specifies whether logging is enabled for the EXE and DLL components. These components do not have access to the Java logging methods on the instance. when the Workforce Central instance is started.eventmanager. 1 = Error 2 = Warning 3 = Debug Value: minimum=1. Then. The NT user password is stored encrypted.log site. Value: platform=Windows site.NT. set this property to true. This user must have NT administration rights on the Event Manager instance. maximum=3.logEnabled setting is marked true. This key is not used on UNIX servers.user — Specifies the NT user name for running events.user — When an event is run. installed default=false site. This key is not used on UNIX servers. you must enter a path and log name in this setting.eventmanager. Value: required.logEnabled setting is marked true. installed default=false site. This key is not used on UNIX servers.wfc.logPriority — If the site. installed default=C:\WFCEvtMgr. Value: platform=Windows. platform=Windows.eventmanager.eventmanager. you must enter a priority in this setting. Value: required. This user must have NT administration rights on the Event Manager instance.logName — If the site. A user for this purpose must Workforce Central System Administrator’s Guide 121 .eventmanager. This key is not used on UNIX servers. This key is not used on UNIX servers. Event Manager logs on to a instance to submit the event (XML) to the API interface.eventmanager. Value: platform=Windows site.eventmanager. which are used for event management.eventmanager.pwd — The NT user password. installed default=1 site. • Executing Events — Executing a Microsoft Task Scheduler event means running the TaskRunner utility. This key is not used on UNIX servers. installed default=TaskRunner site. Value: minimum=1. platform=Windows. it instructs Workforce Central that the event should be run. Value: platform=Windows. maximum=100. TaskRunner calls the Microsoft Task Scheduler. The system notifies the Microsoft Task Scheduler of an event’s existence. but the Task Scheduler is on the primary Event Manager instance which is located in Pacific Standard Time (PST). When the Microsoft Task Scheduler executes an event in a multi-instance environment. The implications of this are especially important when using multiple instances.Chapter 5 System Settings have the TASK_RUNNER ACP as well as any application program interface (API) bean ACPs for the events that will be run. regardless of the number of steps required to process it. which is the time on the primary Event Manager instance. installed default=100 Working with Event Manager Note the following information about this workspace: • Scheduling events — When an event is scheduled. the system takes the following actions: – – The system places the event in the database and handles it as a single unit. For example. It is the master clock. the events that you schedule are based on PST time. The time base for a scheduled event is the primary Event Manager instance. The value of the password is stored encrypted.pwd — Contains the Workforce Central logon user. 122 Kronos Incorporated .maxUserListSize — Specifies the largest list that may be returned by an Event Manager user search. The Microsoft Task Scheduler places the event in an internal queue. This key is not used on UNIX servers.eventmanager. This key is not used on UNIX servers.wfc.eventmanager. if the instance that you are using is in Eastern Standard Time (EST). Value: platform=Windows site. the new instance does not start Event Manager. The location of the Event Manager log is specified in: site. UNIX platforms: Set this value to true. it can necessitate many additional cycles. • The Event Manager log — The Event Manager and the Microsoft Task Scheduler do not use the system log. the new instance assumes the Event Manager role.eventmanager. causing a large number of errors to appear in the Event Manager log. Note: Although recovery can be valuable. If an exception occurs.logName – UNIX platforms: Set this value to false. – • – Recovery — Values vary depending on your platform. If an Event Manager instance exists. All events are rescheduled.Event Manager settings Event Manager may delegate the work to different instances in the environment in a round robin fashion.eventmanager. queries the database for events. • Redundancy — When an instance starts. the system synchronizes aggressively. If an Event Manager instance does not exist. Take this action only if the event process appears to be seriously corrupted. Windows platforms: If site.eventmanager. A mismatch can occur if you modify or delete a job in the database. Specify properties for the Event Manager log in the Event Manager tab as follows: Workforce Central System Administrator’s Guide 123 .recovery is true. and submits the events to Microsoft Task Scheduler. The values you provide vary depending on your platform.startup property is true. Decide whether synchronization or cycles are more important to your system and enable or disable this property on that basis. the event might be reported to the system log. – Windows platforms: If the site. it checks to see if the Event Manager role has been taken by another instance connected to the database. Event Manager exceptions are always reported in the Event Manager log. then Event Manager synchronizes the notifications in its queue with jobs in the database that are waiting to be executed. site. You must browse the complete log using a text editor. the initial log entries are invaluable in diagnosing and correcting the problem.eventmanager. little information is written to this log. if a problem develops. The Event Manager writes log messages to a single file with no size limit.logPriority — Enter a priority.eventmanager. However. (For UNIX platforms. If a problem develops. Values are described in the next bullet.” site. the Event Manager log file can grow quickly. Kronos Global Support might ask you to set a different level for a short time. If Event Manager is running normally. Report facilities are not available for the Event Manager log. 124 Kronos Incorporated .Chapter 5 System Settings – – – site. Monitor this file on a regular basis to determine if you need to delete information.) site.eventmanager.logEnabled — Set to true.logName — Enter a log and path name. 2. where the levels are equivalent to system severity levels of ERROR.eventmanager. The Event Manager log does not use parameters that are set for the system log. or 3. Unlike the system log.logPriority = 1. respectively.logPriority property as 1. set this value to false. See “Log file settings” on page 145 for a description of the severity levels in the system log.eventmanager. • Severity level — The value of the severity level for the Event Manager log is set in the site. Note: You should keep the Event Manager log enabled most of the time. you must manage the Event Manager log directly. WARNING. The recommended severity level is ERROR. “Severity level. or DEBUG. that is. wait for 10 to 15 minutes. set site. Stop the server using the Stop Workforce Central icon. the buffer puts a limit on the number of jobs that you can schedule with user credentials. select System Configuration > System Settings > Event Manager. To remove disabled Workforce Central events on the Microsoft Task Scheduler: 1. when you try to schedule a job with user credentials in order to make the task run as if it were started by the user. remove it from the Microsoft Task Scheduler.eventmanager. Start the Workforce Central server using the Start Workforce Central icon. 5. 4.recovery to false. and then schedule jobs. To work around this behavior. 2. According to Microsoft. There is no limit on the number of jobs that you can schedule without user credentials. This error occurs when the buffer that stores the account information for all scheduled tasks is limited. Open the Microsoft Task Scheduler by clicking Start > Settings > Control Panel > Scheduled Tasks. Workforce Central System Administrator’s Guide 125 . stop and start the Task Scheduler service.eventmanager. you may receive an error message. 3.Event Manager settings Scheduling Event Manager tasks Sometimes Microsoft Task Scheduler generates error messages when you have a large number of tasks scheduled. In the Setup workspace. If a Workforce Central event is set to DISABLED.startup to true and site. as early or late. then the employee might be considered absent an hour too early. installed default=7 global. Value=required. Caution: Do not modify any properties in this setting unless you want the change applied to all of the instances in the system. If the database server and instance are located in a different time zone from the employees’ time zone. • • If your database server and instance are located in different time zones from some or all of your employees. For example. you get the global value settings that relate to that database. After you click Save. For example: • Absence reporting in the Timecard Editor and in Reports may be incorrect by the number of hours equal to the difference between the time zone of the database server and the time zone of the employee. Missed Out exceptions might be reported inappropriately as early or late.BatchService. some Workforce Central features could be reported or generated incorrectly. There is no way to restore or reload the previous settings. set this property to the database server’s time zone. Properties with global scope across instances are maintained in database tables. If you switch to a new database.BatchRecordsTimeToLive — Specifies how many days batch service records stay in the system before they are purged.Chapter 5 System Settings Global Values settings The Global Values settings specify properties that remain constant for all instances in the system. and the employee is in the Central time zone. Key and value details global. You can copy properties settings to a new database.timezoneid — The time zone ID of the database server.database. Global properties are maintained in the WtkGlobalSettings table in the database. if the database server is in the Eastern time zone. any changes that you made are permanent. If 126 Kronos Incorporated . System-generated persistent events might be generated inappropriately as early or late. login. Value: required. installed default=10 global. the Overtime menu appears on Time and Attendance Genies menus. Value: required. Value: required. minimum=1. installed default=1000 global.framework. Value: required.m8m.ScheduleSummaryEmployeeThreshold — Maximum number of employees that can be displayed in a Scheduling Genie. When this is set to true.LongList. installed default=DEFAULT global.login.html. Workforce Central System Administrator’s Guide 127 . Value: required global. you must restart the Workforce Central instance for the change to take effect.LongList. minimum=1. Value: required.username — The user name for logging in the URL Dispatcher Service used by the 4500 Terminals. installed default=25 global.tableNavigatorDefaultPagesize — Defines the number of rows that will display per table selection.framework.tableNavigatorDefaultMaxPages — Defines the number of sections that each table navigation element will display at once.html. set the property to the default value. Value: required. Value: required. minimum=1.LongList.Global Values settings time zones are not an issue.m8m.LLMaintLongListThreshold — The long list warning limit for labor level entry maintenance.ManagerSummaryEmployeeThreshold — Maximum number of employees that can be displayed in a Detail Genie. installed default=4500User global. installed default=False Note: If you change this setting. Value: required. installed default=200 global.enabled — Set to true to enable overtime equalization.OvertimeEqualization. installed default=100 global.password — The password for logging in the URL Dispatcher Service that is used by the 4500 Terminals. minimum=1. Value: required. installed default=365 global. WBAUser.TransactionAssistant. Value: required. Choices are unavailable.Heartbeat. global. minimum=1. Value=required. Value: required.availability.termination. maximum=8784. installed default=True global. minimum=1. users who have been terminated will be allowed to access the system until midnight on the date of termination.WtkScheduler.DefaultNumberOfHours — The number of hours in the past for setting the default start date and time used for displaying errors in the Transaction Assistant. installed default=unknown 128 Kronos Incorporated .ProductivityMonitor. installed default=10000 global.totalizer. Value: required.Chapter 5 System Settings global.threshold. installed default=72 global. installed default=120 global. global.Engine — Specifies the reporting engine used to generate reports.password — The Process Manager password.totalizer.defaultAvailType — The default availability for all the employees in the organization when Workforce Scheduler is installed. installed default=Crystal 10 global.megaproblem — Value: required.Wtk. Note that this setting does not change the password.threshold — Value: required. Value: required.login. installed default=False.excludeTodayFromWeekToDateTotals — Excludes the current day from weekly totals.security. or available.reporting. maximum=86400.Interval — The heartbeat interval (in seconds) for each instance to notify the database that the instance is active.wba.ServerInfo. You can change the password by logging in to Workforce Central as WBAUser and then using the Change Password function.reporting. unknown.The value for this setting must match the new password.StartDateTime. Value: required.Reporting.effectiveatmidnight — If true. maximum=365. installed default=100 global.MaxDaysToDisplayPayChecksInEarningHistory — The maximum number of days to display paychecks in earnings history. global.WTKScheduler. Approximately every week. installed default=270 global. installed default=False global. to putting the values into an intermediate table and performing a join.” the system must limit their population and. minimum=1. while decreasing this value decreases the amount of disk space needed to hold all of the shifts.WtkScheduler.threshold — The coverage threshold percentage for non-standard shifts used to calculate open shifts.WtkScheduler. The default value is 270 days. global. populate them further into the future. A value greater than 1.keepRestrictionForDeletingCertificate. maximum=365.Global Values settings global. installed default=600 Workforce Central System Administrator’s Guide 129 . Unless Kronos Global Support requests you to change the value of this key. if you add a shift to an employee 3 months in the future. the system populates these “forever” patterns out to 270 days from that date. Value: required. Because a pattern could be “forever. Value: required. installed default=75 global.hoursBelongTo — Scheduled hours belong to day.MaximumListForHyperfind — The threshold of when to switch from putting values in a SQL ‘in ( )’ list. Value: required.MaximumDaysInFutureToCreateShifts — Scheduled shifts that follow a pattern are populated into the future.CalculateOpenShifts. This value limits how far in the future shifts are created at any one time. This keeps the Background Processor from recalculating totals needlessly. there is no need to inform the Background Processor.flag — If true.WtkScheduler. installed default=31 global. Day actually worked will split hours across midnight day divide.UseNonStandShifts — If true. from time to time. minimum=0. non-standard shifts are used to calculate open shifts. For example.WTKScheduler.WtkScheduler. Increasing this value allows users to see shifts further into the future. Value: required. because the shift addition does not affect any current totals.MaxDaysToMarkScheduleOutOfDate — Identifies for the Background Processor the maximum number of days in the future that schedule changes do not need to be totalized.000 will result in database failures. the users will not be allowed to delete certifications from the database.CalculateOpenShifts. do not change it. Value: required.WtkScheduler. Value: required. However.Chapter 5 System Settings global. in hours.ScheduleGroups. Shift Builder populates shifts for only 30 days each time.MaximumNoOfRuleViolatsionsSentToClient — The maximum number of rule violations sent to the client from the server. this key value limits the building of shifts to prevent system memory issues.WtkScheduler.DefaultEditLevel — Determines whether actions taken at the Schedule Group level through an API will be treated as a group edit or an employee edit. Typically.WtkScheduler. a message appears on the rule violations tab indicating that it exceeded the display limit of x. Value: required. installed default=False global. If the maximum is exceeded.WtkScheduler.WTKScheduler. and the start time of a shift that is the subject of a swap. If a threshold is not defined. If you need to change this value temporarily due to the system being shut down for a prolonged length of time. it stops at the maximum defined. Possible values are: 0 = off 1 = on Value: required.Days — Use to limit the number of shifts that the periodic shift builder will stamp out.ShiftBuilderGovernor. minimum=1.WtkScheduler. the Shift Builder populates shifts for the number of days in the future defined by the setting.ShiftBuilderGovernor.Active — Use to activate the Shift Builder Governor. or you want to lengthen the number of days in the future that the shifts should be stamped out.WtkScheduler.MinimumHoursInFutureToSwapShifts — Indicates the minimum time gap. When the governor is on. global.WtkScheduler.notifyWarningRuleViolations — Indicates if the user should get a warning when saving the schedule with warnings involved. Value: required. increasing this value can cause system errors 130 Kronos Incorporated . When the rule violation translator attempts to get the rule violations. maximum=100000 global. global.api. the system uses 50 as the maximum number of rule violations.MaximumDaysInFutureToCreateShifts. such as when the relevant API is invoked. installed default=0 global. that must exist between now. When the governor is off. installed default=72 global. the periodic Shift Builder runs once a week and stamps out shifts for a week. Error messages that are older than this number of days will be purged by the purge process. minimum=0. In both cases. Value: required.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. unless you specify a number.ShiftCoverageCounting. installed value = false global. To mark all employees out of date in one query. If set to false. installed default = At Group Level global. only matching shifts are included in the scheduled shifts. Value: required.Global Values settings due to the system trying to build shifts for too large a time.RequireExactMatch — Indicates whether coverage includes only those shifts that exactly match start and end times of the planned shifts. installed default=30 global. installed default = 0 Workforce Central System Administrator’s Guide 131 .ShiftBuilderResultsTimeToLive — Used to purge the data from the SHIFTBUILDERDTL table.WtkScheduler. only employees assigned (directly or indirectly) to that rule are marked out of date. accrual rule.WTKScheduler.ScheduleGroups. Value: required. installed default = 7 global.MarkEmployeesToBeTotalizedChunkSize — Specifies the number of employees in a query that are marked as out of date. If a work rule or work rule building block is modified. the update is done in one large query. 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.api. accrual rule building block or wage profile is modified. coverage also counts any combination of schedule shifts that provide coverage for the complete planned shifts. If set to true. pay rule building block. When operating on a group (such as adding a shift to a day). all active employees are marked out of date. 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. set this to zero (0).WtkSetup. Value: required.WTKScheduler. When a pay rule. Value: required. affect the range of totalization.BalanceLimitsPostAtBeginningOfNextDay — Indicates that the limit transactions are processed at the beginning of the next day instead of at the end of the limiting day. The Background Processor ignores timecard or scheduled events that are greater than this number of days in the future. If you need to project certain data far into the future.WtkTotalizer. As a result.WtkTotalizer. installed default=365 global. global.WtkTotalizer.MaxDaysInFutureEventAffectsTotalization — The maximum number of days in the future that events.Chapter 5 System Settings global. on days for which Pay-From-Schedule is not in effect. minimum=0. 1 = Apply scheduled transfers to Worked Amounts in Project View. such as punches. This minimizes the load to the Background Processor. Value: installed default=Yes Note: Changing this setting to No does not mark employees out of date. global.) global. Value: default=True.WtkTotalizer. The 132 Kronos Incorporated . or enough time elapses that the BGP automatically retotalizes.MaxDaysInFutureForAccrualProjections — The maximum number of days into the future that accruals will be totaled. or the employees are signed off. Value: required. Possible values are: 0 = Do not apply scheduled transfers to Worked Amounts in Project View.Extensibility Enabled — Enables the use of extensible features. Set to 0 to indicate that the entire callback shift is deducted from on-call pay. such as accrual balances. set this key high enough to accommodate the desired window. such as a punch.ApplyScheduledAccountsInNonPfsWorkedAmounts — Controls whether or not scheduled transfers are applied to Worked Amounts in Project View. which improves system performance. or set to 1 to indicate that only the portion that overlaps the on-call shift should be deducted. 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.DeductOverlappingOnCallOnly — Indicates whether the worked time is deducted from the on-call pay.WtkTotalizer. Value: installed default=0 global.WtkTotalizer. The Accruer will always compute at least to this value. Value: installed default=365. installed default=no Workforce Central System Administrator’s Guide 133 . Value: required.PaycodeMovesAreContributingShifts — Determines whether pay code moves contribute to holiday calculations. maximum=366. installed default = 365 global.WtkTotalizer. maximum=60.MinimumInactiveDaysWithoutTotalingActuals — Minimum number of days that the Totalizer can view without retotaling an employee with no activity. Value: required.MinimumDaysInFutureForScheduledTotals — Minimum number of days in the future that the database contains scheduled totals.WtkTotalizer. Value: required. This setting specifies how far out in the future the Background Processor will totalize actual data for an employee.WtkTotalizer. specifies whether moving hours from one pay code to another affects the shift history for holidays with Work History Qualifiers.MinimumDaysInFutureForActualTotals — Minimum number of days in the future that the database contains actual totals.MinimumDaysInFutureForScheduledTotals setting specifies how far out in the future that totalization is performed. minimum=1.MinDaysInFutureForAccrualProjections — The minimum number of days into the future that accruals will be totaled. maximum=60. such as resets.WtkTotalizer. Set to yes to have pay code moves contribute to holiday calculations. installed default=3 global. The global. installed default=7 global. This setting works with the Store Scheduled and Projected Totals check box in pay rules. maximum=731 global.WtkTotalizer. installed default=3 global. installed default=7 global. Value: required.Global Values settings Accruer will not compute beyond this value. The Background Processor calculates scheduled and projected totals for employees. minimum=1. It is possible that grant expiration transactions and user edits.MinimumInactiveDaysWithoutTotalingSchedule — Minimum number of days that the Totalizer can view without retotaling the schedule for an employee who has no schedule changes. minimum=1. updates.WtkTotalizer.WtkTotalizer. minimum=1. Value: required. and transfers. maximum=366. may appear in an employee’s accrual detail report for some date or dates beyond the end of the maximum date specified. Value: required. a scheduled transfer is delayed if the same transfer occurs explicitly at a later time within the shift. guaranteed time is included in previous work span. global.password or global.ShowGuarantees — Indicates whether guaranteed time appears as a separate workspan in the timecard.login. In version 5.password — XML service password used by one server to communicate with another server.WtkTotalizer. value of 1 indicates guaranteed time appears as separate work span. This interaction can affect how worked time is paid.0. Value: installed default=No global.login.WtkTotalizer. via LimitCombination rules. you must 134 Kronos Incorporated .username in the Global Values tab workspace.WtkTotalizer. Value: required global.0. Value: installed default=5.login. and the order in which worked time is processed. installed default=1 global. Value: required. installed default=XMLUSER Note: If you change either global. Value: required.ProcessScheduledPayCodeEditComments — Indicates whether comments entered in Scheduled Pay Code Edits can be linked to timesheet items.xmlservice.ResetProbationOnProfileChange — global. If set to 1. installed default=0.xmlservice.SequencerVersionBehavior — Controls the interaction between combining limit rules.WtkTotalizer.WtkTotalizer.Chapter 5 System Settings global. If set to 0.ScheduledTransfersCanBeDelayed — Controls handling of scheduled transfers. you can chose to revert to the sequencing behavior exhibited by version 4. global.WtkTotalizer.5 global.xmlservice.3 or 5. via Sequencer rules.login.5 and beyond.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. The value indicates the version of Workforce Central whose sequencing behavior is desired. a scheduled transfer is not delayed.username — XML service user name used by one server to communicate with another server.xmlservice.0. Workforce Central System Administrator’s Guide 135 .Global Values settings make the same change in the properties file.properties. WPKGlobalSetting. groupedit. Value: required. minimum=0.Chapter 5 System Settings Group Edits settings The Group Edits settings enables you to optimize the Group Edit Results component in the Workforce Central system.primaryServer — Set to true to specify that this instance is the primary Workforce Central instance used to run the persistent threads. installed default=true site. The default value for the site. any instance can perform the delete and recovery functions.primaryServer setting is automatically set to true for all instances in your system. If you have a multiinstance environment.primaryServer key set to true is the one specified to run the Delete and Recover threads. Note: A system error occurs if you do not configure your multi-instance environment properly. The instance with the site. Value: required. Because Group Edit data is maintained in the database.DaysCleanup — Number of days until items are deleted from group edit history. Value: required. The Delete thread is activated periodically and removes any editing threads beyond the specified time period. installed default=true site. installed default=7 136 Kronos Incorporated .groupedit.enabled — Set to true for enabling Group Edit functionality. you must determine which instance functions as the primary server and set this property to false for all other instances in your system.groupedit. Several editing threads run in the background on the primary instance. The Recover thread restarts any editing thread that has stalled.groupedit. Key and value details site.groupedit. The Recover thread is activated periodically to poll the editing threads. groupedit. installed default=500 site. Value: required. minimum=0. minimum=0.deletethread. installed default=30 site. in minutes.RequestHandler. installed default=30 site. This interval must be less than the polling interval for ReusableGroupThread.numberOfGroupEditThreads — Number of Groupedit Threads used for processing (in numbers). for the Recover thread.pollingInterval — Polling interval for ReusableGroupThread (in minutes). Value: required. in minutes.groupedit.pollingInterval — Polling interval for RequestHandler to wait until a thread is available from the Group thread pool (in seconds). installed default=20 site. Value: required.employeeCountThreshold — Specifies the number of employees that will be accumulated before the entries appear in the Groupedit log. minimum=0. minimum=0. installed default=5 site. for the Delete thread.RequestHandler.groupedit.ReusableGroupThread.pollingInterval — Polling interval.pollingInterval — Polling interval.groupedit. Value: required.recoverthread. This interval must be longer than the recovery execution time.RequestHandler. This interval must be longer than the delete execution time. Value: required. for ReusableHandlerController thread.groupEditLogFailureCountThreshold — Defines the number of Group Edit log failures that will be accumulated before the entries appear in the Group Edit log. Value: required. minimum=0. minimum=0.RequestHandler. Value: required.groupedit.groupedit. Value: required.ReusableHandlerController.pollingInterval — Polling interval. minimum=0.Group Edits settings site. installed default=300 site. minimum=0. installed default=500 Workforce Central System Administrator’s Guide 137 . in minutes.groupedit.groupedit. installed default=60 site. DaysCleanup to a specific number of days. 1. 2. Click Save. 138 Kronos Incorporated .groupedit. The default is 7 days. select System Configuration > System Settings > Group Edits. In the Setup workspace. 3. Set site.Chapter 5 System Settings Clearing the Group Edit Results in Genies You can specify how often the system should clear the Group Edit Results. familyVersion — The minimal versions of the CLSID.installVersion — The version of the Java plug-in this is installed.version.plugin.type.external}/plugins site.plugin.plugin.plugin. Value: required site.java.minimalVersion — The lowest supported version of a JRE plug-in patch.java. Value: Default = True. These settings only affect Kronos Workforce Central applets.java.java.Java Plug-in settings Java Plug-in settings The Java plug-in settings control the version of the Java Runtime Environment (JRE) to install on client machines. Key and value details site. Value: required to support Internet Explorer site. Value: required site.familyVersion — The minimal family version of the CLSID. based on the selected family version. {WFC. based on the selected family version.context. and the name of the JRE installer.keepAlive—Specifies whether product applets will explicitly set HTTP connections to be persistent.location — The path of the client-side JRE plug-in.java. that supports Workforce Central applets in Internet Explorer.explicitCookie.active—Specifies whether the applets will explicitly set HTTP session cookies.If multiple versions are installed.installer — The version of the Java plug-in installer.java. This value is the exact name of the executable in the path of the client-side JRE plug-in. Workforce Central System Administrator’s Guide 139 .plugin.plugin.http. for all browsers supported by Workforce Central.java. the most recent version is used with Workforce Central.plugin. Value: required site.version. Value: required site.CLSID. Value: required site.java.plugin. that supports Workforce Central applets in Mozilla FireFox. for example. Under typical circumstances. times. 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.local.local.YYYY MEDIUM — abbreviated month DD. such as minimum hours per week. installed default=Yes site.Chapter 5 System Settings Locale settings The Locale settings determine how the date. month DD.local.useWFCSettings — Indicates whether to use the default Workforce Central settings or to use local settings.TimeFormat — The display format for times: FULL — HH:MM:SS AM/PM Time zone LONG — HH:MM:SS AM/PM MEDIUM — HH:MM:SS AM/PM 140 Kronos Incorporated .local. Value: required. Key and value details site. Value: required. These settings are an expansion of the basic regional settings on the web server.local. these settings do not change. installed default=Sunday site. This value is available when Workforce Scheduler is installed.YYYY SHORT — MM/DD/YY. and language appear.YYYY AD LONG — month DD. and is used to define the start of the week for schedule rules. installed default=(GMT -05:00) Eastern Time (USA.DefaultWeekStartDay — The starting day of the scheduling week.TIMEZONE — The time zone of the instance. completely numeric Value: required. Value: required. Canada) site. installed default=LONG site.DateFormat — The display format for dates: FULL — day. yyyy site. you must also change the Long Date value to the long date format of the specified language/ country. E M/dd — displays as Thurs 4/01 [default] E MM/dd — displays as Thurs 04/01 EEEE MM/dd — displays as Thursday 04/01 E M/d — displays as Thurs 4/1 EEEE M/d — displays as Thursday 4/1 EEEE M/dd — displays as Thursday 4/01 E dd/MM — displays as Thurs 01/04 E dd/M — displays as Thurs 01/4 EEEE dd/MM — displays as Thursday 01/04 E d/M — displays as Thurs 1/4 E d/MM — displays as Thurs 1/04 EEEE d/M — displays as Thursday 1/4 Note: The order of the day and month must match that of the browser locale. provided the same character is used throughout the format. Value: required. Value: required. and the long date format of the language/country you specified is different from the system default.local. Workforce Central System Administrator’s Guide 141 .local. A hyphen or period separator can replace the slash separator. Note: If you change the default language/country.LONG_DATE — The display format for the long date.SHORT_DATE — The display format for the short date.local.timestamp.Locale settings SHORT — HH:MM AM/PM Value: required.ServerDateFormat — The display format for the Time Stamp server date and time. installed default=SHORT site. installed default=EEEE. MMMM dd. A hyphen or period separator can replace the slash separator. installed default=E M/dd site. Kronos provides text and messages in French.local. Spanish. The country code is stored in the properties file. Identifies the language based on the standard two-letter language codes that the International Standards Organization (ISO) established in ISO 639-1. use the Translation and Customization Toolkit CD.LANGUAGE — The display language of the instance. site. installed default=United States 142 Kronos Incorporated . installed default=English Note: If you change the default language. and the UI displays the ISO 3166 description of the country code. and US for the United States. installed default=M/dd/yyyy site. and English. installed default=M/dd site.COUNTRY — Identifies the country based on the standard two-letter country code established by ISO 3166.local. you must also change the Long Date value (site.Chapter 5 System Settings M/dd/yyyy — displays as 4/01/2001 [system default] MM/dd/yyyy — displays as 04/01/2001 M/d/yyyy — displays as 4/1/2001 M/d/yy — displays as 4/1/01 d/MM/yyyy — displays as 1/04/2001 dd/MM/yyyy — displays as 01/04/2001 d/M/yyyy — displays as 1/4/2001 d/M/yy — displays as 1/4/01 Note: The order of the day and month must match that of the browser locale. For other languages.LONG_DATE) to the long date format of the specified language. Value: required. Value: required.local. CA for Canada. and the long date format of the language you specified is different from the system default. Value: required. Value: required. and the UI displays the ISO 639-1 description of the language code. Examples are MX for Mexico. The language code is stored in the properties file.DAY_MONTH — The display format for the date when only the month and day of the month are displayed.local. LANGUAGE — The currency language on the instance.HourMode — Set to true to display the time mode in the Quick Time Stamp running clock.VARIANT — Indicates if the currency is the Euro or not.quickTimestamp.enable — Adds a field named Phonetic Full Name in People Editor that enables you to add a phonetic spelling to help employees pronounce unfamiliar names in multi-national environments. Valid entries are Euro or blank. site. for example. installed default=en site. you must also change the Long Date value (site. a value of US identifies U.Locale settings Note: If you change the default country. site. Value: required.currency. dollars.currency. Identifies the country based on the standard two-letter country code established by ISO 3166 associated with the currency.currency. Value: required.VARIANT — Indicates if the currency is the Euro or not. Identifies the language based on the standard ISO 639-1 two-letter language codes associated with the currency that your site uses.PhoneticFullNameField. installed default=US Note: You must specify the same value for this property on every instance associated with one database. for example.local. installed default=true site. The country code is stored in the properties file. and the UI displays the ISO 3166 description of the country code. The language code is stored in the properties file.local.local. a value of en identifies English as the language associated with the currency. site.local. Value: required.COUNTRY — The display currency country code of the instance. Valid entries are Euro or blank. Value: installed default=false Workforce Central System Administrator’s Guide 143 . Phonetic Full Name is also available as a column heading to display the phonetic spellings in Genies. site. and the UI displays the ISO 639-1 description of the language code.LONG_DATE) to the long date format of the specified country.local.local.S.local. and the long date format of the country you specified is different from the system default. format — The date and time format for the success indicator. Value: required. there might be unexpected results in the time display in the headings of Workforce Central pages.timestamp.successIndicator. Romanized Full Name is also available as a column heading to display spellings using the Roman alphabet in Genies.COUNTRY and the language specified in site. If the formats differ.local.local. installed default=h:mm a Note: It is recommended that time format match the time format of the locale determined by the application country as specified in site.Chapter 5 System Settings site.RomanizedFullNameField.LANGUAGE. Value: installed default=false site.local.enable — Adds a field in People Editor that enables you to add a name using the Roman alphabet to help employees recognize unfamiliar names in multi-national environments. 144 Kronos Incorporated .local. and so on). WFC. The logged event might compromise system stability or data integrity. When the maximum number of log files is reached.LOG. but is not serious enough to compromise system stability or data integrity. 2. When this level is requested. Each entry in the log files contains: • • • • The event date and time The context in which the event occurred The event priority — numeric and alpha The user session that registered the event The logging levels are: Severity Level Description ERROR Reserved for serious errors. and a maximum log file size for your instance. When this level is requested. WARNING. WARNING and ERROR events are recorded. INFO. This level produces the fewest number of records and is used for normal operations. WFC.log is renamed to WFC. Workforce Central System Administrator’s Guide 145 . If you specify multiple log files. WARNING An unexpected condition has occurred that probably is an error. The log file messages record the instance activities and contain the message priority. If you specify a single log file. where n is the number of the next available log (1. and ERROR events are recorded.Log file settings Log file settings Log files contain all the log information recorded for an instance of Workforce Central.log is rewritten when it reaches its maximum size. the oldest log is deleted to accommodate the new WFC. INFO Records normal events that you or Kronos Global Support may need to see.log.n. You can specify whether to use a single log file or multiple log files. When this level is requested. INFO. DEBUG. then the log file is located relative to the Workforce Central root directory. MB. Kronos recommends that you do not use this log level any longer than necessary to find the needed information.log. site. the instance shuts down immediately. Value: required.active — Set to true to activate logging. Key and value details site. WARNING.rollover.file.log site.file. Value: required. or GB.loglevel — Logging level for all contexts. Value: required.log.log. If the name is a simple file name.maxsize — Maximum size of the log file before rollover occurs. installed default=true site. Caution: When you save the value. installed default=500KB 146 Kronos Incorporated . Use this log level only when Kronos Global Support requests it because it produces a large number of records and can affect system performance. All user sessions are terminated with no warning.log. and ERROR events are recorded.append — Specifies whether to overwrite or append to the existing file when initializing logging: true = appends to the existing file false = overwrites the existing file Value: required. or false to deactivate logging.file. The change takes place when you save the new value. You can use the suffixes KB. or DEBUG.name — Name and path of system log file.log. Value: required. WARNING. installed default=true site. Valid entries are ERROR. INFO.Chapter 5 System Settings Severity Level Description DEBUG Provides information for Kronos Global Support. installed default=ERROR You do not have to click Restart Server to start the server again so that the changes you made can take effect. installed default=WFC. Value: required. minimum=1. flat = write multiline messages as one long line normal = write multiline messages as separate lines Value: required.gathering.max — Maximum number of remote transfer threads in the system. installed default=10 site. site.threads.file.max — Maximum number of gathering request threads in the system. If the value is 0. installed default=normal site.gathering. minimum=1.list — Add new log file names to the end of the commadelimited list that is to be collected when the Log File Gathering tool is run.gathering.transfer.remote.file.log.rollover.log. Change this setting only upon the direction of a Kronos Service Representative.multiline — Specifies how to write messages with embedded new lines to the log file. minimum=0. Value: required.Log file settings site.threads. Value: required.log.maxlogs — Maximum number of saved log files to keep. Workforce Central System Administrator’s Guide 147 . Value: required site. Change this setting only upon the direction of a Kronos Service Representative.file.log.format.file.requests. Change this setting only if you have a non-default IIS installation location or if you are directed to do so by a Kronos Service Representative. the main log file is overwritten when the rollover criteria are satisfied.log. installed default=DEBUG 148 Kronos Incorporated . installed default=INFO site.loggingContext property that you specify here appears in the Context drop-down box of the Log Report component.PERSISTENCE. Value: required.loggingContext.APP.loggingContext. This information represents contexts that you want to make available for the system log. Key and value details site. The parameters are for debugging purposes only. Caution: Do not change any parameters on this page without direction from Kronos Global Support.WFC. The Logging Context settings contains properties for a selected number of applications and enable you to set individual severity levels for them. The Logging Context settings are used for debugging purposes. Value: required.Chapter 5 System Settings Logging Context settings The Logging Context settings provide a filtering mechanism used for logging error messages for specific components.SQLTRACING — SQL Tracing specific logging context values. Any site.WFC.DBMANAGER — DBManager specific logging context values. • • On — Allows Messaging to use the corporate external e-mail server to send messages. Value: required. if you specify “off” for this setting. installed default=enable messaging.Messaging settings Messaging settings The Messaging settings are used to configure and enable the messaging service for your site.global. employees will not receive the external e-mail message. Key and value details messaging. The Messaging system will send messages and notifications only to the Workforce Central Inbox. This is the default.global. For example. For more information.enable — Set to enable to activate the Messaging system. Off — Disallows Messaging from using the corporate external e-mail server to send messages.server. but your organization implements a particular process designed to send messages to external e-mail as well as to the Workforce Central Inbox. Value: required. installed default=on Workforce Central System Administrator’s Guide 149 .SendMessagingByEmail — Controls whether the Messaging system can send messages using the corporate external e-mail server. Process Manager and the vacation bidding application both use Messaging. see the K-mail descriptions in the Workforce Central Process Manager Programmer’s Guide. Note: Many process templates contain a K-mail task that is affected by this setting. updates the database with that information. Each printer must be visible to the server.p1 = WFC Printer 1. Click Add to add a new printer to the current list. You can add or remove a printer from this list. then the printer selection comes from the browser. all instances have the same list of printers. As printers are added to your system. Use a semicolon (. it reads the SitePrinter.properties file with .) to separate the names.Group 1 where WFC Printer 1 is the name that appears in print dialog boxes. If you view a report first. and then renames the SitePrinter. it is printed to the printer that is associated with your PC. As part of the installation process. Note the following information regarding printers: • • • Printers are a global resource for the system. 150 Kronos Incorporated . enter its virtual name. not from this list. such as reports scheduled in Event Manager. Properties with global scope across instances are maintained in database tables.1 appended to the name so that it does not get processed again. The system captures this information and writes it to a temporary property file SitePrinter. and a comment. their names are added to the WFCPrinters table. See “Working with property files” on page 34 for more information. path. There is no limit to the number of printers that can be defined.Chapter 5 System Settings Printers settings The Printers settings identify all the printers that are defined for your system. Instead.properties.\\\\APOGEE\\LochNess. The system uses these printers when you select Print when running reports. Printer properties are maintained in the database. When the system is started for the first time. In a multi-instance environment. If you switch databases. you must copy the appropriate properties to the new database.properties file. Anything that you print using your browser’s Print command is not printed to a server-based printer. for example: printer. When you add a server-based printer. the installer provided the name of one printer to be used for server-based printing. When you add a printer to the system. for example) user account with access to the printer.<printer number> — This string represents the Workforce Central server printer information. Seeing it on the list indicates its availability to the system. • • • The first part is the printer name that appears in the printer selection list. any changes that you made are permanent. This information is in three parts. Define the printer in the System Settings component in the Printers tab. The third part is the printer group. 2. Example: WFC Printer 1. The second part is the path to the printer driver.\\printserver\printer. After you click Save. follow these steps: 1. If the printer appears in the list of printers available for selection. This user must have access rights to all printers listed in the Printers tab. log on to Windows NT using the JBoss user account. Provide the server with access to the printer. Provide the default application server (JBoss. Now use standard Windows NT facilities to add a printer. someone with Full Control access rights for the print server must log onto Windows NT to make the printer accessible to the user account. You do not need to actually add the printer. Workforce Central System Administrator’s Guide 151 .Printers settings Caution: Do not modify any properties in this setting unless you want the change applied to all of the instances in your environment. separated by semicolons. To determine if a printer is accessible from the server. 3. it is accessible from your server. Group1 Enabling a server-based printer To add a server-based printer to the Workforce Central system. There is no way to restore or reload the previous settings. Key and value detail printer. The default application server—JBoss—is installed under a Windows NT user account. The value is 50.x.x. Value: required jdbcconnector. Value: required 152 Kronos Incorporated . Key and value detail jdbcconnector.x.Affected Databases settings provide connection information for all databases for which you want to define retention policies and all source and target databases that are used by Workforce Record Manager. The value is 10.x. Do not change this setting.Affected Databases settings The Record Retention .min — The minimum database pool size. Value: required jdbcconnector.url — The JDBC connection string to be used to connect to the database.x. Note: Do not leave any fields blank. Value: required jdbcconnector. Failure to fill in all fields will result in database offline errors.dsn — The data source name specified for your database.max — The maximum database pool size. Do not change this setting.pwd — The password associated with the specified user name.Chapter 5 System Settings Record Retention . Value: required jdbcconnector.x. Value: required jdbcconnector.x.name — The fully qualified name of the database.usr — The user name to be used to connect to the database.drv — The JDBC driver to use with your respective Relational Database Management System (RDBMS).x. Value: required jdbcconnector. Value: required jdbcconnector. The value is 10. Value: required Workforce Central System Administrator’s Guide 153 . The value is 50. Value: required site.dsn — The name of the ODBC data source for the production database. Do not change this setting.master. Do not change this setting. such as a test database or an archive database. use the default values.drv — The JDBC driver to use with your respective Relational Database Management System (RDBMS).min — The minimum database pool size. edit the values to match your production database. If the instance points to a non-production database.master.master.master. Value: required site. • • If the instance points to your production database.master.master.Record Retention .Database Setup settings Record Retention .master. Value: required site.Database Setup settings The Retention Policy Database Setup settings contain information that the Record Retention Policy component uses to connect to your production database. Value: required site.usr — The name of the user account that is used to access the production database.url — The JDBC connection string used to connect to the production database.max — The maximum database pool size.pwd — The password of the user account that is used to access the production database. Key and value detail site. Value: required site. Value: required site. MaxThreads — The maximum number of worker threads that can be applied to a Workforce Record Manager and record retention processes. minimum=1000. maximum=4. installed default=2000 WrmSetting. Reduce this value to resolve out-of-memory issues. Value: required. Value: required.Chapter 5 System Settings Record Retention .Options & Tuning settings The Record Retention . minimum=1.Tuning. maximum=5000.CopyFileChunkSize — The number of rows in a file to copy. maximum=2000.Tuning. Value: required. or chunk. Value: required. Value: required.Option.PurgeTableChunkSize — The number of rows in a table that are included in a single unit of work for a purge job.CopyTableChunkSize — The number of rows in a table that are included in a single unit of work for a Copy job. to be used to copy data from the source database to the target database. SQL*Loader.Tuning.DiscardBulkCopyOutputFiles — Set to true to specify that bulk copy output files will be automatically deleted from the instance when a 154 Kronos Incorporated . maximum=10000.Tuning. minimum=1000.Tuning. installed default=5000 WrmSetting.exe for Oracle databases). Applicable tables with row ID values in excess of this value will be copied in chunks (multiple units-of-work). installed default=4 WrmSetting.BulkCopySoftwarePath — The path of the bulk loader software (bcp. minimum=1000.CopyChunkRowIdThreshold — The row count threshold above which a non-historical table is copied as more than one unit of work.exe for SQL Server databases. installed default=10000 WrmSetting. Key and value detail WrmSetting. Value: required for Workforce Record Manager processes only WrmSetting. installed default=10000 WrmSetting. minimum=500.Options & Tuning settings are used to configure and control the performance of limited retention policies and Workforce Record Manager processes. maximum=10000. All other applicable tables will be copied as a single unit-of-work.Tuning. FK2_0213. FK3_0088. X6_TIMESHEETITEM.Option. FK3_0327. X6_WFCTOTAL WrmSetting.Option. FK4_0258.Record Retention .ForeignKeyViolationLoggingLevel — The severity level at which Workforce Record Manager reports foreign key constraint violations to the Workforce Central log (WFC.Option. FK2_0327. X5_WFCTOTAL. FK2_0340.DropTargetIndexes setting is set to true. FK1_0327. X3_WFCTOTAL.ForeignKeyViolationExceptions — The list of foreign keys for which foreign key constraints violations are acceptable. Value: required. FK2_0254. FK1_0284.IndexList are dropped from the target database before performing a Workforce Record Manager copy or archive job.Options & Tuning settings copy job completes. Do not make changes to this list unless directed to do so by Kronos Global Support. FK1_0254.Option. FK2_0088. Foreign keys=list of foreign keys: FK1_0213.DropTargetIndexes — Set to true to specify that the table indexes identified in WrmSetting. X1_WFCTOTAL.Option. Value: required when WrmSetting. FK3_0255.log). X8_TIMESHEETITEM.Option. X4_TIMESHEETITEM. X2_PUNCHEVENT.RebuildTargetIndexes — Set to true to specify that dropped table indexes are rebuilt after the Workforce Record Manager job completes. X2_WFCTOTAL.DropTargetIndexes setting is true. FK2_0255. FK1_0213. X7_TIMESHEETITEM. FK2_0284 Workforce Central System Administrator’s Guide 155 . Value: required. 5_TIMESHEETITEM. installed default=true WrmSetting.Option. installed default=false WrmSetting.IndexList — The list of table indexes that are dropped and optionally rebuilt when the WrmSetting.Option. installed default=ERROR WrmSetting. installed default=true WrmSetting. Value: required. FK2_0258. installed default= 1_TIMESHEETITEM. FK1_0088. FK3_0258. installed default=true WrmSetting. Value: required.DiscardTempTables — Set to true to specify that temporary tables will be automatically deleted when a copy job completes. 2_TIMESHEETITEM. Value: required. X3_TIMESHEETITEM. X4_WFCTOTAL.Option. FK1_0340. X1_PUNCHEVENT. Changing this setting is typically not required.Tuning.Option.LineTerminatorSize – The number of bytes at the end of each line of a metadata file that are associated with the line termination characters.JobReallyRunningMaxTrys – The maximum number of times an attempt is made to determine if a job is running. Do not make changes to this list. and Cancel actions are issued.Metadata. This is used in conjunction with the sleep duration value to establish the maximum polling period for such a determination when Pause. Installed default=false WrmSetting. Do not change this setting. Changing this setting is typically not required.Chapter 5 System Settings WrmSetting.DoNotHaltWhenMissingMetadataFile – Identifies whether processing will continue if a product-specific metadata file cannot be found.Tuning. Resume. WrmSetting.File.Option.JobReallyRunningSleepDuration – The number of seconds between each attempt to determine if a job is running.Option. 156 Kronos Incorporated . Do not change this setting. WrmSetting. WrmSetting.MetadataLoadProductExclusions – The list of products for which no metadata is provided. files — Specifies the location where the report files are stored. reports are on the companion Windows server.executable. platform=Windows.log — Specifies the location where the ProduceReport log is stored. Value: required. “Reports. platform=Windows.Reports settings Reports settings The Reports settings establish the reporting properties. platform=Windows.reporting.rootdir/reports/ site.otherfiles — Specifies the location where custom report definitions are stored. Value: required.” for information about creating reports. installed default=WFC.rootdir/reports/ OtherReports site. installed default=WFC.GenerateRepsToDir — Specifies the location where the generated reports are stored.LANGUAGE/reportoutput site.rootdir/logs/ WFCReporting site. Value: required. See Chapter 7.rootdir/applications/ ext_name/reports/ site. Key and value detail site. platform=Windows. installed default=WFC.reporting. you must establish the reporting properties using this information. minimum=0. Before users can create and schedule reports.RepTimeToLive — The number of hours before the generated reports are cleaned up from the disk.rpt.local.reporting. installed default=WFC.reporting.reporting. Value: required. installed default=72 Workforce Central System Administrator’s Guide 157 . Value: required. platform=Windows.rpt. Note: For UNIX platforms. installed default=true site.megaproblem — If the total number of nontotalized persons exceeds this value. Value: required. installed default=true site. the report sends a status value that generates a generic totalization failure message. The deletion is based on the report’s request date and time and the length of time designated in the site.reporting. Value: required.MaxNumRepAgents — Defines the maximum number of the Report Agents that are running in the background. Value: required. the report sends a list of failed person IDs.reporting.totalizer. If the number exceeds this value. minimum=0. platform=Windows.reporting.pdf file generated by the Crystal Reports engine. minimum=0. installed default=7 site.reporting. minimum=0. installed default=100 site. installed default=2 site.reporting.totalizer.Chapter 5 System Settings site.reporting. Value: required.enable — Set to true to enable the report server’s cleanup process. platform=Windows.retries — Specifies the number of attempts that the report engine makes when running a SQL query. Reports never directly call or run the Background Processor. platform=Windows.RepTimeToLive key. installed default=30 site. the totalization sequence is terminated. Value: required.threshold — Specifies to the report engine how to report a list of persons who failed to totalize. platform=Windows. platform=Windows.RepCleanUpDaemon. If the number is less than or equal to this value.enable — Set to true to include SQL errors in the .totalization. which deletes both the reports entry from the Check Run Status tab and the report file. platform=Windows.threshold.interval — Specifies the interval of time that a report waits in a queue.diagnoseRptSqlOnError. but verify a column value that is set to the person’s current totalization status.reporting. which returns a list of people who have been totalized by the Background Processor. installed default=10000 158 Kronos Incorporated . minimum=0. Value: required. platform=Windows. Set to false only if the report engine performance is severely affected. minimum=0.reporting.totalization. and a failure report is run. These errors enable detailed troubleshooting for SQL errors within a failed Crystal Reports file. Value: required. when this is set to true. server. platform=Windows. Value: required. The range starts from today and goes backward for the specified number of days. installed default=none Workforce Central System Administrator’s Guide 159 . Value: required.server.protocol — Protocol used to access the SSRS Server used for Workforce Analytics. Value: required.reporting.name — Fully qualified domain name of the SSRS Server used for Workforce Analytics.enable — Set to true to enable the report engine in this instance. platform=Windows. Value: required. installed default=http site.reporting.Reports settings site. platform=Windows. minimum=0.analytic. Value: required.protocol — Protocol used to access the SSRS Server for Advanced Reporting.server. installed default=true site.reporting.reporting. platform=Windows. platform=Windows. that is used as a filter to search the database for import batches that have been run. Value: required.reporting. installed default=7 site. platform=Windows.reporting.analytic.name — Fully qualified domain name of the SSRS Server for Advanced Reporting.server. platform=Windows.reporting.preprocesswebservice.engine. in days.importbatchrange — Specifies the range. installed default=http site. installed default=90 site. installed default=localhost site. Value: required.timeout — Number of minutes that report pre-processing will run before timing out. the user must log on using the offline URL.security.restartTimer.authentiction.password — Logon password for offline mode. When the system is in offline mode and the database is not accessible. Passwords are stored encrypted.seconds — Specifies the number of seconds allotted for the server to restart.property=Authentication Module property file 160 Kronos Incorporated . before the user is redirected back to the logon page after logging off of Workforce Central. Value: required.com. The user ID and password must match those in Workforce Central’s records.FQDN — Fully-qualified domain name of the local server used for SSL-enabled connections. installed default=superuser site.offline. Value: required site.security. o=your organization name WinNT — support for multiple Windows NT domains WinNT://your NT Domain name — support for a single Windows NT domain OTHER://provider=Authentication Module.Chapter 5 System Settings Security settings Security settings establish an offline environment and specify the authentication mode that your Workforce Central instance uses.authentication.logoff. Key and value detail site. Value: required. installed default=120 site. Examples: • • • • LDAP://your LDAP server name/ou=your organizational unit. site.security.security. minimum=0.SSL.offline.authsrc — Authentication type: The definition of your server security method. myserver.kronos. An authentication of the user name and password occurs.security.username — Logon user name for offline mode. For example.authentication. This is only used when Workforce Central integrates with a third-party single sign-on solution.singlesignon — Set to true to enable single sign-on.product.HRMS. Value: installed default={WFC.security. Value: required.product. installed default=false site.external.properties site. site.security.security.security. such as Java class file.ssoplugin. Value: required.singlesignon.html site.winnt — Specifies the provider of NT authentication.HRMS.SSOSiteMinderSubject site.Security settings See “Understanding authentication” on page 163 for more information about the different authentication types.VirtualPath — The virtual path where the Workforce HR/Payroll server is installed for the IIS server.security.authsrc.external.ldap — Specifies the provider of LDAP authentication.wfc.platform.singlesignon.security.business.logoffurl — Specifies the logoff URL if single sign-on is enabled.module — The name of the module.ServerName — The server where the Workforce HR/Payroll application is installed.other — Specifies the provider of customized authentication.authsrc.security. Value: installed default = com.security.security.module. Value: installed default=PROPRIETARY site.properties — The name of the property file that contains configuration information used in the single sign-on module.externaldir}/applications/wcb/ properties/SSOSiteMinder. site. Workforce Central System Administrator’s Guide 161 .context}/logon/ logonWFC.security.security. installed default={WFC. This is only used when Workforce Central integrates with a third-party single sign-on solution.HRMS. Value: required. installed default=false site.authsrc.enabled — Set to true to specify that Workforce HR™ and Workforce Payroll™ (Workforce HR/Payroll) are installed and configured. site.singlesignon.product.external.kronos.authenticati on. site. that implements single sign-on for Workforce Central. product.Chapter 5 System Settings site. maximum=60. minimum=1. This value determines the display length of the results page prior to redirection back to the Quick Time Stamp page. Value: minimum=1. Value: required.interval — The time interval that Workforce Central (WFC) or Workforce Employee .QTS.urldispatcher — The name of the module that implements authentication for the URL Dispatcher Service that is used by the 4500 terminal. This value determines the inactivity time period each user has prior to automatic logoff. If you want the URLDispatcherServlet to default to accept requests from any browser.HTML Client.HTML Client.security.product.security.global.ess. installed default=5 site.QTS.external.security.security. This value is either http (standard mode) or https (secure mode).kronos.global. This value should be less than the Workforce HR/ Payroll session timeout value.HeartBeat.HTML Client. The default authentication model for the URLDispatcher is device-only requests. maximum=30. installed default=http site.ess. substitute DeviceOnlyAuthentication with AnyBrowserAuthentication.authentication.HRMS. This value determines the inactivity time period that triggers automatic logoff for users who logged in via Quick Time Stamp Value: required.HTML Client should wait before refreshing the Workforce HR/Payroll session.authentication. maximum=30.confirmationTimeout.ess. Value: required.html. 162 Kronos Incorporated . installed default=25 site.HRMS.urldispatcher=com. maximum=25.external.html. installed default=10 site. For example: site.Seconds — Sets the redirect timer on the Quick Time Stamp . This ensures that the Workforce HR/Payroll session is active as long as the Workforce Employee HTML Client session is active.Minutes — Sets the Quick Time Stamp logoff timer for all the pages within Workforce Employee .securityTimeout. not just the browser on the 4500 Terminal.Minutes — Sets the logoff timer on all the pages within Workforce Employee .html.security.protocol — The protocol used by the Workforce HR/Payroll server for all communication. installed default=10 site. minimum=1. minimum=1.Time Recorded page within Workforce Employee . Value: required.security.securityTimeout.security.global. wfp. The authentication source must be the same across domains. The system makes different kinds of authentication modules available. The user must exist in the database to which the server is attached.authsrc.AnyBrowser Authentication Understanding authentication Authentication is the validation of a user name and password by a trusted authority. Totalizer. the system validates the user ID and password associated with a user in the Kronos database. they enter their full user names in the logon screen—for Workforce Central System Administrator’s Guide 163 .urldispatcher. This setting is used for supporting authentication against multiple Windows NT domains. and DCM’s user accounts. CORPORATE_DOMAIN\dgormley.security. Your authentication type is established during the initial configuration of the system. Changing databases when using PROPRIETARY authentication may cause authentication problems. and reports. Genies. Note: This is the local and default authentication scheme. When users log on to Workforce Central. and is the value of the property site. Note: Regardless of the type of authentication that you specify here. The following are available property values: • PROPRIETARY If you specify this value. as specified as part of the user name at logon. Windows validates the user ID and password. Workforce Central proxies the authentication request to a Windows domain server. • WinNT If you use a WinNT value without specifying a domain.security. TaskRunner.Security settings wfc. This entire value is the full user name value stored in the Workforce Central user account table and shown in all views. Workforce Central user names must be specified as domain name\user id—for example. the following accounts always use Kronos authentication: SuperUser. Chapter 5 System Settings example. • WinNT://your_NT_domain (not available for UNIX platforms) For example. This setting is used for supporting authentication against a single Windows NT domain where all the Workforce Central users have Windows accounts in one domain. CORPORATE_DOMAIN\dgormley. Workforce Central proxies the authentication request to a domain server. Some additional Windows domain configuration may also be required. the LDAP user id (uid) attribute must match the Kronos user name recorded in the Workforce Central database. To implement WIA. The Windows user “dgormley” must exist in the “CORPORATE_DOMAIN” domain. do the following: 164 Kronos Incorporated . If the server needs to authenticate users who are defined in domains B and C. LDAP://tdyernt/ou=people. the user ID must match the recorded ones in the system’s database tables. Workforce Central proxies the authentication request to a Lightweight Directory Access Protocol (LDAP) server. For LDAP authentication. then domains B and C must be configured to be trusted by domain A. • LDAP://your_LDAP_server_name/ou=your_organizational_unit. • Windows Integrated Authentication Windows Integrated Authentication (WIA) enables users who are already logged into their Windows desktop to enter Workforce Central without providing their user ID or password.com If you specify LDAP. o=kronos. See your WinNT or LDAP documentation for information about these processes. For WinNT authentication. Regardless of which process you use. the A domain. the user name must match the Kronos user name recorded in the Workforce Central database. o=your_organization_name For example. LDAP validates the user ID and password. The server machine is defined as a member of some domain—for example. WinNT://CORPORATE_DOMAIN If you use a WinNT value. Windows validates the user ID and password. This custom LDAP authentication module can accommodate a wide range of LDAP configurations.property=Authentication Module property file This uses a custom authentication method. Workforce Central System Administrator’s Guide 165 . and can be used as an alternative to the default Workforce Central LDAP authentication method. Changing the logoff timer You can change the length of time delay when you are logging off Workforce Central. – Set Security settings as follows: site. To do this: Access the Authentication Methods dialog box from jakarta properties.module=com.singlesignon.platform.singlesignon=true site. These users can then log on to a Windows machine and navigate to http://<machineName>/wfc/logonWithUID to access Workforce Central. – In People Editor.authentication.SSOWIA Subject Restart Workforce Central. Deselect the Anonymous access check box Select the Integrated Windows authentication check box. Select System Configuration > System Settings > Security.Security settings – Set jakarta connector security to use WIA.business. which is usually a username and password.security. This module is configured using the Authentication Module property file properties file. 1. select NT authentication for users who are using WIA. This custom authentication method uses the module identified by Authentication Module to validate the user’s credentials.wfc.security. Note that this URL is for Internet Explorer.kronos. security. This is implemented in a module installed with Workforce Central. • OTHER://provider=Authentication Module. One use of custom authentication is for custom LDAP authentication.ssoplugin. seconds to the appropriate number of seconds.security. 3.authentication. restartTimer. Click Save.logoff.Chapter 5 System Settings 2. 166 Kronos Incorporated . Set site. SQL is added to the log.file. minimum=1.trace.off with a setting in the SQL Coverage tab to enable SQL tracing.file.PERSISTENCE.service.sql.x where x is first. installed default=off site. such as labor level entries.service.properties site. files containing SQL statements that conform to your requirements were selected.file. • • Set this to off to disable SQL tracing. Value: required.second — Second SQL Strings properties file.service. Value: required.sql. minimum=1.log.sql.strings.fourth — Fourth SQL Strings properties file. site.SQLTRACING key must be set to DEBUG.MAX_LABOR_LEVEL_ENTRIES — The maximum number of named entities that are displayed at the client. non-organizational jobs.service.on.file.sql. These files do not change and are specified as site. site.on. When your system was initially configured.business. second. A number of property files contain templates for SQL statements that the system uses. fourth. Use the property site. Value: required.file.LL. third. or fifth. installed default=5 site.sql.first — First SQL Strings properties file.service. installed default=1000 Workforce Central System Administrator’s Guide 167 .third — Third SQL Strings properties file.service.sql.strings.strings. installed default=WPKSQLStrings.strings.off — This setting works with the new logging package. which means the site. Key and value detail site. site.service. When this setting is set to on.sql.Service settings Service settings Service settings establish properties related to the Workforce Central instance. labor level sets.strings.WFC.strings.trace.MAX_MOST_RECENT_USED_ITEMS — The number of most recently used transfer settings that are available for reuse.file. site.business.sql.service.fifth — Fifth SQL Strings properties file.service.LL. Value: required.service. and HyperFind queries. MAX_DAILY — The maximum standard hours for daily time period. installed default=24 site.type.TimePeriodType. installed default=744 168 Kronos Incorporated .Chapter 5 System Settings site. maximum=24. maximum=168.business.TimePeriodType.MAX_WEEKLY — The maximum standard hours for weekly time period.type. minimum=0. installed default=168 site. Value: required.service.TimePeriodType.service.type. minimum=0.MAX_PAY_PERIOD — The maximum standard hours for pay period time period. minimum=0.business. Value: required.business. Value: required.service. properties file.writebackcount — The number of changes to the SQL Coverage properties entries between rewriting the file. You should need this information only for debugging. installed default=false test.enabled — Set to true to perform SQL coverage tracking. separated by spaces. test. Value: required. installed default=false test. A complete traceback is written to the log.SQLCoverage.SQL Coverage settings SQL Coverage settings The SQL Coverage settings provide a debugging tool that tracks the number of times each SQL statement is executed.refresh — Set to true to re-create the SQL Coverage properties from the WPKSQLStrings*. You can find out where a SQL statement is invoked by entering its name in this field.driverLogging — Set to true to create a log of all JDBC driver communications. maximum=100.SQLCoverage.log file contains the output. installed default=false Workforce Central System Administrator’s Guide 169 . Value: required.traceback — The list of statements to be backtraced. Value: required. minimum=1. Value: required. The JDBCdriver.SQLCoverage. You can add multiple statements.SQLCoverage. installed default=25 test. This can be helpful when you debug driver problems. Key and value detail test.SQLCoverage. 8.on.sql. 7. Select System Configuration > System Settings > Service. Set site.trace. 6.log.loglevel to DEBUG. 9.Chapter 5 System Settings Enabling SQL tracing To enable SQL tracing: 1. 2.service. 5.off to on. Click Save. Click Save. 170 Kronos Incorporated . 3. Set site.enabled to true. 4. Set test. Click Save.SQLCoverage. Select System Configuration > System Settings > Log File. Select System Configuration > System Settings > SQL Coverage. no online services are started. the offline services are started (ExtensionDiscoveryService. PlatformManagerService. and ApplicationInstaller).startup. the system starts in online mode. No online services are started. and attempts to start the online services.offline is set to false. PreLoadServletsService. PluginService. no database connection is attempted. which attempts a database connection.offline is set to true. and the offline services are started.startup. the system becomes unavailable. Key and value detail test. False is the normal startup mode that attempts to start the online services and a database connection. If test.startup. the system starts in offline mode. Users must then log on using the offline logon mode. including ServiceSphere.Startup settings Startup settings The Startup setting controls the system startup. installed default=false Workforce Central System Administrator’s Guide 171 .offline — The system will not attempt a database connection when the value of this key is set to true. • If test. If any of these offline services fails to start. and users must log on using the offline logon mode. • Value: required. If this setting is marked as true. PropertiesExtensionLoaderService. installed default=5000 172 Kronos Incorporated . minimum=1.MaxNumTransformerThreads — The maximum number of transformer threads that can be run simultaneously.transformation. Value: required. Value: required. minimum=1. Value: required.transformation.transformation. installed default=2000 site.transformerManagerSleepInterval — The sleep interval (in milliseconds) for the TransformerManager thread before it checks the transformation queue for requests.controllerPollingInterval — The polling interval for the TranformerController thread (in milliseconds). minimum=1. Key and value detail site.Chapter 5 System Settings Transformation settings The Transformation settings control the data transformation service for any services. such as reports. installed default=2 site. installed default=system Value http https system Definition Standard mode Secure mode Applets will use the protocol determined from the HTTP request.maxRoundTripNetworkLatency.webserver.communication. therefore.webserver. Value: required.timeout. which uses a Secure Sockets Layer (SSL) to encrypt the data with a digital certificate technique. If you require a more secure protocol. Key and value detail site. easily readable.seconds — The maximum network latency time for the Quick Time Stamp (QTS) result page requests. you can configure your Web server to use HTTPS instead.Web & App Server settings Web & App Server settings The Web & App Server settings control the communication component that receives requests from users and returns responses to them.QTS. Value: required. minimum=1.webserver.communication. site.webserver. site. The clientside “Logon again Timer” is calculated on the client.port — The port used for applet communication. installed default=1 site.protocol — The protocol used by applets for communication with the application server. However. You can select an alternate network latency time for the QTS in the event Workforce Central System Administrator’s Guide 173 . based on the web server’s own session timeout interval and this grace period value. which is the protocol used to request the applet.applet.minutes — The length of time that the user has to respond between the time that the Timeout Logon Again dialog box appears and the time that the web server session timeout occurs. Specify only if also you are also specifying the protocol and it is using a non-standard port (standard ports are 80 for http and 443 for https).applet. much of the data between users and the system is text-based and. The default communication protocol is HTTP.session.graceperiod. webServerHostName — The name of the computer where the web server resides. Value: required. Value: required. installed default=3 site.communication. 2.webserver. and 5.Chapter 5 System Settings that the round trip from client to server exceeds 1 second. 174 Kronos Incorporated .webserver/messaging. Value:required. installed default=false site.protocol – The protocol used by the application server for all communication. 3. Possible values for this key are 1.protocol — The protocol used by the web server for all communication.appserver. site. installed default=name of the computer that was specified at installation site. Value: required. installed default=8080 site.webserver. installed default=http site.appserver. This value can be either http (standard mode) or https (secure mode). Value:required.webserver. when the one-way transfer time is equal to or greater than 500 milliseconds. You might use this setting in situations such as using the QTS application across a satellite connection.url. Value:required. installed default=user-defined prefix.communication. This value is either http (standard mode) or https (secure mode). 4.appserver.webserver.server — Replacement prefix used for URLs that are included in external e-mail messages in employee messaging service.IpcPort — The port through which the application server receives communication requests.jspcompression — Set to true to turn on HTTP compression for all JSPs system wide.webserver. volume — The number used by the staffing matrix to generate workload.workload. volume is often referred to as Census.workload.System Settings for Workload Generator System Settings for Workload Generator There are eight settings under the Workload tab in System Settings that affect the Workload Generator. • site. Configurable terms The six configurable terms settings are listed here. Six settings customize Workload Generator terms to better describe your business. Note: If you change any of these configurable terms.” In a health care operation. Note: If you change any of the configurable terms. This number is referred to as “patient census. make sure you restart your server before continuing. In a health care operation. This tab is used to define the volumes that drive the Workload Generator. make sure you restart your server before continuing. An example of a customized (or configurable) Workload Generator term is volume. “Add Volume” or “Add Census”) Workforce Central System Administrator’s Guide 175 .configurableterms. and another setting defines the decimal rounding mode.configurableterms. The Workload Generator enables a third tab in the Workload Planner. The third tab in the Workload Planner will then be labeled Census. you could define the system setting site. In a health care operation. the volume is the number of patients needing care. the number of patients needing care. Two additional settings are specific to the staffing matrix: one setting enables a warning dialog box to display when a gap exists.volume as Census. The definition defined in this setting appears in the following places in the user interface: – – The label of the third tab in the Workload Planner The label of the Add option under the Actions menu item in the Workload Planner (for example. projected — The term used to refer to a workload generated for the current day.actual — The term used to refer to actual workload. – • • site. This term is used in the following areas in the user interface: 176 Kronos Incorporated .workload.workload. which is used for reports and will be used in future features.configurableterms. “Add Volume Range” or “Add Census Range”) The label of the configuration and calculation settings of the weight sets.configurableterms.workload. In a health care operation.addvolume — site.workload. site.budgeted — The term used to refer to a workload generated in advance.weight — The factor that modifies the volume number.configurableterms. creating the baseline staffing plan.configurableterms. weight is often referred to as acuity. 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.Chapter 5 System Settings – The label of the Add/Remove Range menu options used in the staffing matrix portion of workload setup (for example. which is the level of care needed by patients in different areas.configurableterms. creating the adjusted staffing plan. The definition defined in this setting appears as the label of the factoring set in Workload Setup (for example “Acuity Set” or “Weight Set”). 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.configurableterms.weightedvolume — The label of the view option in the Workload Planner which reflects a modified volume (or census) number. site.workload. site.5 or higher = round up).System Settings for Workload Generator – – 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 Additional system settings The two additional settings are: • site. Valid settings are: – – – Round.generation.roundingmode — This sets the rounding mode used during workload generation for decimal headcount values in the staffing matrix.gapwarning — Setting this to True will cause a warning dialog box to be displayed if you are creating gaps when setting up a staffing matrix volume range. which means use standard rounding conventions (less than . Always Round Up Always Round Down • Workforce Central System Administrator’s Guide 177 .workload.5 = round down.staffingmatrix. .workload. Chapter 5 System Settings 178 Kronos Incorporated . “Test the custom theme” on page 194 7. (Optional) “Extend the custom theme to the portal” on page 196. and deploy the custom theme. 2. 3. “Deploy the custom theme” on page 195. specify the new colors in style sheets and images. (Optional) “Change colors in the image files to match the custom theme” on page 189.css” on page 185.Chapter 6 Create a Custom Theme A system administrator can create a custom theme to change the appearance of colors and fonts in Workforce Central application pages to any set of colors preferred for the site. 5. “Prepare the logo file” on page 184 4. This chapter describes how to select colors. Complete these steps to create and deploy a custom theme: 1. “Create a new theme folder for the custom theme” on page 180. . “Select colors for the theme” on page 180. 8. 6. “Specify custom property values in theme. • Complete these steps to create the custom theme folder: 1. 2. dash (-). Use 16 characters or less. Find the custom theme folder in the services folder on the Workforce Central installation disc. 3.Chapter 6 Create a Custom Theme Create a new theme folder for the custom theme Before you create a custom theme. these eight colors make up an elementary theme: 180 Kronos Incorporated . three primary colors and five additional colors derived from the primary colors. use a number as part of the folder name. Do not delete the basic theme folder even when you have completed and deployed your own custom theme. and underscore (_) characters. copy the entire custom theme folder and store it in install_directory\WFC\applications\wpk\themes. using the following guidelines: – – – Use only alphanumeric. You can then use the original folder to revert to the original settings. or on the Kronos Global Support web site. Select colors for the theme An elementary theme uses eight colors. if necessary. (Optional) Rename the custom folder. For example. If you are using multiple instances and want a different theme for each instance. note the following: • Be sure you use a copy of the custom theme folder (not the custom theme folder itself) for developing the custom theme. On the system that is running the web server where you will develop the custom theme. 140.227.93) Color Group 8 25% of Primary color 3 RGB(204.176) Color Group 3 40% of Primary color 1 RGB(203.185) Color Group 6 40% of Primary color 2 RGB(161. Workforce Central System Administrator’s Guide 181 .206.215) Color Group 7 100% of Primary color 3 RGB(52.143) Color Group 2 70% of Primary color 1 RGB(165.189.214) Primary color 2 Medium color Primary color 3 Darkest color These colors are displayed on the following sample page.156) Color Group 5 70% of Primary color 2 RGB(91.91.185.209.210) Color Group 4 100% of Primary color 2 RGB(21.73. Each number on the sample page corresponds to one of the eight color groups.Create a new theme folder for the custom theme Primary color 1 Primary color 2 Primary color 3 Primary color 1 Lightest color Color Group 1 100% of Primary color 1 RGB(127. Primary color 2 should be in between the light Primary color 1 and the dark Primary color 3. 4. 182 Kronos Incorporated . Choose three primary colors that the organization uses most frequently. in its logo. 3. Import an image file with the primary colors. for example. Primary color 3 should be the darkest color of the three primary colors. for example. Start a graphics tool and open the color palette. the main colors on its web site. 2.Chapter 6 Create a Custom Theme Navigation bar Tab menu Selected tab menu Utility links Hide/show button Tab menu links Selected row Row stripe Selected tab menu link Selected tab in tab bar Complete these steps to select the eight colors and their values: 1. Use a color eyedropper tool to pick up Primary color 1 and add it to the color swatches. a logo. or in its marketing collateral: – – – Primary color 1 should be the lightest color of the three primary colors. select the 25% color. In the graphics tools. its color definitions appear. c. In the color palette. b. In the color palette. d. so that it is lighter than Primary color 2. c. select the 70% color. e.Create a new theme folder for the custom theme 5. Change the value to 70% of Primary color 2. In the color palette. and write down the RGB values. Derive two secondary colors from Primary color 1: a. Assign the eight colors to color groups and write down the RGB values. so that it is lighter than Primary color 3. 6. and write down the RGB values. Use the eyedropper to pick up the 70% color and add it to the swatch library. b. In the graphics tools. In the color palette. c. Use the eyedropper to pick up the 70% color and add it to the swatch library. and write down the RGB values. Repeat step 4 and step 5 for Primary color 2 and Primary color 3. Green. Derive one secondary color from Primary color 3: a. You will use these values in “Specify custom property values in theme.css” on Workforce Central System Administrator’s Guide 183 . Change the value to 70% of Primary color 1. select Primary color 1. In the graphics tools. 9. d. Derive two secondary colors from Primary color 2: a. Use the eyedropper to pick up the 25% color and add it to the swatch library. create a new object with Primary color 1. d. Write down the Red. select the 70% color. and Blue values (RGB values). so that it is lighter than Primary color 1. Repeat step a through step d to create another secondary color from Primary color 1 at 40% of Primary color 1. Change the value to 25% of Primary color 3. Repeat step a through step d to create another secondary color from Primary color 2 at 25% of Primary color 2. b. e. create a new object with Primary color 3. 8. 10. 7. create a new object with Primary color 2. png in the custom theme folder that you copied to install_directory\WFC\applications\wpk\themes. Use a graphics tool and make sure the logo graphic file meets these requirements: • • • • • Maximum size: 128 pixels wide.210 21. 5 pixels on top Transparency: transparent Justification: left Format: PNG Store the logo file as logo.206.185 161. this table lists the RGB values for the example eight color groups in “Select colors for the theme” on page 180: Color Primary color 1 70% of Primary color 1 40% of Primary color 1 Primary color 2 70% of Primary color 2 25% of Primary color 2 Primary color 3 25% of Primary color 3 Color group Color Group 1 Color Group 2 Color Group 3 Color Group 4 Color Group 5 Color Group 6 Color Group 7 Color Group 8 RGB values 127. For example.91.189.73. the graphic image must meet certain requirements to ensure that it fits in the space allocated for the logo and appears in the correct place on the page.215 52.227.156 91. 50 pixels high Minimum padding: 10 pixels on the left.176 203.185.214 Prepare the logo file If you are replacing the Kronos logo file.209.93 204.143 165. 184 Kronos Incorporated .Chapter 6 Create a Custom Theme page 185 and “Change colors in the image files to match the custom theme” on page 189.140. the theme changes are visible across the suite whenever users refresh a page.portal. 1.mode 2. You can then revert to the original version. b. if necessary.css where custom_theme is the name of the folder for the theme that you are developing. Workforce Central System Administrator’s Guide 185 . which can adversely affect performance. complete these steps: 1. an application server restart is required to pick up the theme changes. That way. Change theme. a.Create a new theme folder for the custom theme Specify custom property values in theme. (Optional) On the computer running the application server.theme. 2. use a text editor to open this file: install_directory\WFC\applications\wpk\themes\custo m_theme\theme. On the web server system where you are developing the custom theme.css If possible.development. If you have not already made a copy of the custom theme folder and renamed it.css Requirements Before changing theme. Log on to Workforce Central with system administrator privileges. switch to development mode.css.css in the theme folder that you copied and renamed in install_directory\WFC\applications\wpk\themes. Change the following Display system setting to true: site. complete the procedure in “Create a new theme folder for the custom theme” on page 180. Make a backup of theme. In standard mode. develop the theme in development mode on a system that is outside of the production system. If you work in development mode on the production system. you can check changes when you refresh a page without disrupting the production system. Note the following: – Symbolic color names (for example. color:rgb(0.ActionBar . add the specified property to the selector.0). */ #kronos{ background-color:rgb(255. font-weight:normal. Do not change the background color (background-color) value in the kronos base class: /** * Overall default values. Change the default RGB color values for the eight color groups. Property to add or change background background-color background-color background-color background-color – – Color group 1 2 Selector #kronos .ActionBar .Action #kronos . they are ignored. For example. several items in the pages might not appear as you expected. You must use RGB color values. font-size:11px. font-style:normal.255. } If you change the background color from white.css for the selectors listed in the following table and specify the new RGB color values. FF0000) are not supported.NavBar #kronos . if you specify line-height or font-variant values. If the property listed in the table for the selector does not exist in theme. Other selector attributes are not supported.0.Hover #kronos . Search in theme.255).Action.ActionBar #kronos .TabBar 186 Kronos Incorporated .Chapter 6 Create a Custom Theme 3.sans-serif. using the values that you selected in “Select colors for the theme” on page 180.css (there are some properties that do not exist in the default theme. red) and hexadecimal color values (for example.css). font-family:Arial.Verdana. Panel Property to add or change background-color background-color background-color background-color background-color background-color color color background-color background-color background-color color color No changes required.SuiteBar .Tabular TR.Tabular TH #kronos .TabMenuSelected #kronos .WorkArea .Hover #kronos .Selected #kronos .TabBar .Action #kronos .Selected #kronos .ContentPanel .TabMenu #kronos .Selected.ActionSelected:Hover 5 6 7 No changes required.TabBar .Tab.UtilityLinks #kronos .TabMenu:Hover #kronos .Heading #kronos .Create a new theme folder for the custom theme Color group 3 Selector #kronos . background-color background-color background-color color background-color color color color color color color 4 #kronos .SuiteBar .WorkArea .NavBar .Selected #kronos .Button #kronos .Selected #kronos .TabBar .WorkArea .Tab.HeaderBar #kronos .TabBar .ActionBar .Tab.TabMenuLinks #kronos .ActionBar .Active #kronos .Selected #kronos .TabBar .Tabular TR.Hover #kronos .Button.Tab. #kronos .Action.Hover #kronos .TabBar Workforce Central System Administrator’s Guide 187 .NavBar .Hover #kronos .Tab.NavBar .Selected.NavBar .WorkArea .Tabular TD.ActionSelected #kronos .WorkArea .NavBar . NavBar{ background: rgb(122.Tabular TR #kronos . font-style:normal.Verdana.sans-serif.NavBar{ background: rgb(127. color:rgb(0. color:rgb(0.185.ActionSelected #kronos .255).0).255. Arial) for best results. Search for this class in theme. } This specification changes the font to Gill Sans and the font size to 10 pixels: #kronos{ background-color:rgb(255. #kronos.133. font-family:Gill Sans. the changes are inherited by its subclasses for use throughout the user interface.sans-serif.SuiteBar . Arial. to change the color values in #kronos . font-size:10px.SuiteBar .143). font-weight:normal. Use a san-serif font (for example. font-family:Arial. For example: #kronos{ background-color:rgb(255.css and specify the new font definitions. 4. font-size:11px.173). Change the default font specification in the main style class.255.Action:Hover #kronos .NavBar to Color group 1.0. to #kronos .255).0).Dialog Property to add or change background-color background-color background-color background-color For example.Chapter 6 Create a Custom Theme Color group 8 Selector #kronos .0. 188 Kronos Incorporated . change this default definition: #kronos . when you make changes to this class. for example. you can change colors in image files that are used in the interface so they match the custom theme colors that you set in theme. The table in step 4 in “Procedure” on page 189 specifies how to save each file.css.zip Photoshop—SourceFiles_PSDformat.zip. Workforce Central System Administrator’s Guide 189 . 2. Change colors in the image files to match the custom theme Optionally.Create a new theme folder for the custom theme font-weight:normal. Adobe Fireworks is recommended. font-style:normal. The file that you send depends on the graphics editing tool that you are using: – – Fireworks—SourceFiles_PNGformat. Instruct the graphic artist to unzip SourceFiles_PNGformat. and you need to use a graphic artist to perform some of the steps. Procedure 1. export most of the image files as 8-bit.css and exit from the text editor.zip 3. Send one of these zip files to a graphic artist. This customization step can take a signficant amount of time because you open and edit several image files. Export the tab image files as 24bit PNG files to ensure that they appear correctly against the header background. where custom_theme is the name of the folder for the theme that you are developing. Save theme.zip or SourceFiles_PSDformat. Requirements You need a graphics editing tool to work with the image files. PNG files with alpha transparency. } 5. Make sure the graphic artist is working outside of the custom theme folder. Adobe® Fireworks or Adobe Photoshop®. To correctly display application pages in all browsers. go to the install_directory\wfc\applications\wpk\themes\custo m_theme\icons folder. On the web server system where you are creating the custom theme. Chapter 6 Create a Custom Theme 4. \suitenav\hide-top-navigation-hover \suitenav\show-top-navigation-hover Save as 8-bit. PNG with alpha transparency 190 Kronos Incorporated . No images to change. 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: Color group 1 2 3 Image file in \themes\custom\icons No images to change. gif \suitenav\hide-top-navigation \suitenav\show-top-navigation \suitenav\submenu-on Save as 8-bit PNG with alpha transparency 4 \suitenav\tab-menu-left (tab stroke only) \suitenav\tab-menu-right (tab stroke only) \suitenav\tab-menu-left-selected \suitenav\tab-menu-right-selected 24-bit PNG Workforce Central System Administrator’s Guide 191 .Create a new theme folder for the custom theme Color group 4 Image file in \themes\custom\icons \actions\action-link-arrow \actions\row-delete-hover \actions\row-insert-hover \actions\row-up-hover \actions\row-down-hover \actions\calendarpanel\next-month \actions\calendarpanel\next-year \actions\calendarpanel\previous-month \actions\calendarpanel\previous-year \actions\vcr\go-back \actions\vcr\go-back-hover \actions\vcr\go-forward \actions\vcr\go-forward-hover \actions\selectpanel\move-all-left \actions\selectpanel\move-all-right \actions\selectpanel\move-selected-left \actions\selectpanel\move-selected-right \actions\selectpanel\move-selected-down \actions\selectpanel\move-selected-up \button\button-background \button\button-bottom-left-corner \button\button-top-right-corner \suitenav\button-go-full. Chapter 6 Create a Custom Theme Color group 5 Image file in \themes\custom\icons \actions\row-delete \actions\row-down \actions\row-insert \actions\row-up \button\button-top-right-corner-disabled Save as 8-bit PNG with alpha transparency 6 \actions\selectpanel\move-all-left-disabled \actions\selectpanel\move-all-right-disabled \actions\selectpanel\move-selected-left-disabled \actions\selectpanel\move-selected-rightdisabled \actions\selectpanel\move-selected-downdisabled \actions\selectpanel\move-selected-up-disabled \actions\vcr\go-back-disabled \actions\vcr\go-forward-disabled \suitenav\takemeto-dropdown-indicatordisabled 8-bit PNG with alpha transparency 192 Kronos Incorporated . gif \suitenav\tab-menu-right.gif \suitenav\tab-menu-left \suitenav\tab-menu-right 24-bit PNG 8 No images to change. Workforce Central System Administrator’s Guide 193 .Create a new theme folder for the custom theme Color group 7 Image file in \themes\custom\icons \actions\panel\condense-horizontal \actions\panel\condense-horizontal-box \actions\panel\condense-vertical \actions\panel\condense-vertical-box \actions\panel\expand-horizontal \actions\panel\expand-horizontal-box \actions\panel\expand-vertical \actions\panel\expand-vertical-box \actions\vcr\vcr-first \actions\vcr\vcr-first-hover \actions\vcr\vcr-last \actions\vcr\vcr-last-hover \actions\vcr\vcr-next \actions\vcr\vcr-next-hover \actions\vcr\vcr-previous \actions\vcr\vcr-previous-hover \button\button-elipses-blue \suitenav\submenu-off-selected \suitenav\takemeto-dropdown-indicator \trees\tree-nav-minus \trees\tree-nav-minus-over \trees\tree-nav-plus \trees\tree-nav-plus-over Save as 8-bit PNG with alpha transparency 7 \suitenav\tab-menu-left. mode 7. test the theme to ensure that all customization steps were completed successfully.portal. Check several pages to make sure that you see each style and image. switch back to standard mode: a.theme.development. Clear the Java cache in the Windows Control Panel. 8. If you switched to development mode. Then. If necessary. 4. On the system where you created the theme.Chapter 6 Create a Custom Theme 5. Log on to the Workforce Central system where you created the custom theme. 3. 194 Kronos Incorporated . and styles will be used. Unzip the file to the install_directory\wfc\applications\wpk\themes\custo m_theme\icons folder. Remove the install_directory\WFC\applications\wpk\lib\ themes. 2.jar file. Clear the browser cache to make sure that the new colors. Change the following Display system setting to false: site. 5. 1. open a browser. Instruct the graphic artist to zip all the image files and send the zip file back to you. images. copy the zip file to the web server where the custom theme is being created. where custom_theme is the name of the folder for the theme that you are developing Test the custom theme Before deployment. Log on to the Workforce Central system on the application server using an account with system administrator privileges. b. make changes to the styles or images as described in “Select colors for the theme” on page 180 and “Change colors in the image files to match the custom theme” on page 189. 6. 6. 10. and click Next. Create this new folder in the installation directory on the production web server system: kronos\deployments\custom\wfp_staging\web_server\ap plications\wpk\themes 2. In the Action lists. For each server and server instance where you deployed the custom themes.Create a new theme folder for the custom theme Deploy the custom theme After testing the custom theme colors. In Configuration Manager. choose Modify an instance and then click Next. 3. From the Select Instance drop-down list. 5. 11. make sure nooptions are selected and then click Next to update the selected instance with the custom themes. log on to Workforce Central using an account with system administrator privileges. click the Configuration Manager desktop icon to start it.name. fonts. logo. On the production web server system. click Next. If you are running the application server on a separate system from the web server.portal. 6. Click Next to exit from the Configuration Manager. click Next and repeat step 4 through step 7. select the instance to apply a custom theme to. 1. Go the Display system settings and specify the new custom theme folder in site. 4. 7. and image files. or you are applying custom themes to multiple instances. Workforce Central System Administrator’s Guide 195 .theme. 8. deploy the new theme. 9. In the Configuration Action window. Copy all custom theme folders that you developed from the development web server system to the new folder you created in step 1. css. 6. and click Apply. This procedure extends the Workforce Central theme to the SharePoint site.jsp where server_name is the name of the application server running Workforce Central.css file. 2. you must change the portal theme settings. 3. 4. The contents of the portal Web Parts are branded according to the Workforce Central theme.css. border. In a browser. Select the Kronos theme from the list of themes and click Apply. font size. choose Site Settings > Customization > Apply Theme to Web site. title. Apply the theme to the Workforce Central Portal site: a. specifically.Chapter 6 Create a Custom Theme Extend the custom theme to the portal If you have a Workforce Central Portal and you want the portal to look like the Workforce Central custom theme (that is. open the Program Files\Common Files\Microsoft Shared\web server extensions\60\TEMPLATE\THEMES\kronos\theme. 1. and so on. navigate to this URL: http://server_name/wfc/applications/wpk/html/theme/ sharepoint-kronos-theme. Select and copy the entire contents of the browser window. Save the updated theme. Paste the contents from the browser window from sharepoint-kronostheme. select a them other than the Kronos theme. On the SharePoint server.css. From the theme list. b. In SharePoint. it applies the custom theme settings to the Web Parts header. c. you are no longer using the basic theme in Workforce Central). font family. Choose Site Settings > Customization > Apply Theme to Web site. 196 Kronos Incorporated .css file.jsp (that you copied in step 2) into theme. d. 5. This chapter contains the following sections: • • • “Overview” on page 198 “Managing reporting environments” on page 202 “Customizing reports” on page 211 .Chapter 7 Reports This chapter contains information about working with reports in the Workforce Central system. Include the most current totalized data from the database. Workforce Central supports integration with Microsoft SQL Server Reporting Services (SSRS). • 198 Kronos Incorporated . within a report.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. Determine who can access specific information. refer to the Workforce Central Suite Release Notes. A subset of Workforce Central reports are delivered as RDL files. or to an e-mail recipient from within the application. your browser. such as wages data. This integration is referred to as Advanced Reporting. Requires an SSRS server. Use the HyperFind query to select people or the location chooser to select locations for a report. Advanced Reporting provides more options for viewing and distributing Workforce Central reports. In addition to these built-in capabilities. Reports that are delivered as RPT files are not supported by Advanced Reporting. Send your completed report instance to a printer. Requires no additional installation or configuration. Advanced Reporting — Uses standard RDL files and SSRS to deliver HTML reports. Note: For a complete list of RDL and RPT reports. Browse the report instance online. Basic and Advanced Reporting both require a Windows companion server when used in a UNIX environment. 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. and other information. For example. report item An object in the database that specifies the report name. with a report item. You can set up background options to identify selected option values. display the name of the person who runs the report. display calculated totals. foreground Choices that are selected when users request a report in the Reports component. option or A selectable value for an option or a parameter. An identifier of a runtime question that allows users to enter values to qualify the results that appear on a report. options Settings that indicate viewable items or report selection criteria. it requires one Windows companion server. and Event Manager. display a HyperFind query name. and format time values. standard report A report provided by the system. then the choices are Unexcused. or Both. and provides a link to the RDL or RPT file. Reports.Overview Terminology The following terms are used in connection with reports: Term background options or parameters Description Options that control how information displays in the report header. creates a report. Workforce Central System Administrator’s Guide 199 . specify security for wages data. report instance Generated by the system when a user requests a report. options or These options are established in the report definition file and in the Report Setup parameters component of Workforce Central. options. report The combination of a report item and a report definition. companion server When Workforce Central is used in a UNIX environment. Excused. custom options Non-standard report options. See the Workforce Central online Help for descriptions of standard reports. if the option or parameter choice parameter is Absences. custom report A report created specifically for your organization. report definition An RDL or RPT file that. which is needed by Workforce Central Setup. reporting.threshold.threshold.interval — A report that requires totals is placed in a queue. site. After the time has elapsed.totalization.reporting.totalization. the values of these properties determine how the system handles the report: – If the number of employees with uncalculated totals is less than or equal to the value of site.reporting. the following properties are involved: • site. the report does not list the failed employees.threshold and site.retries is exhausted and totals for all employees have not been calculated. the reports server checks for the totalization results again. the report is returned to the queue.reporting. the ability to export to Excel is blocked 200 Kronos Incorporated .reporting.threshold.reporting.Chapter 7 Reports Setting up reports for totalization When the system calculates totals for some reports.totalizer.totalizer.threshold. Instead.totalizer.totalizer. the report is not run.reporting.reporting.retries — The value that you specify here determines the maximum number of times that a reports server checks for the totalization results. megaproblem. If the number of employees with uncalculated totals is equal to or greater than the value of site. The value that you specify here is the number of seconds that the report waits in the queue. site. By default. but less than the value of site.totalizer. megaproblem. If totalization is not completed during the first Totalizer session. but simply contains a count of them.totalization.reporting. If the number of employees with uncalculated totals is greater than the value of site.totalizer. the system generates a failure message.threshold. listing the failed employees.megaproblem — If the number of retries specified in site. then the system produces the report. • • – – Enabling a report to export to Microsoft Excel Workforce Central is delivered with a number of reports that are optimized for exporting to Microsoft Excel. type TestReport for a file named TestReport. without the file extension.txt To enable export to Excel for one of the reports contained in the list. copy this file to the following location on the SSRS server and then restart IIS and SSRS: C:\Program Files\Microsoft SQL Server\MSSQL. delete the report name from the list and save the file. This font must be installed on both server (Workforce Central and SSRS) and client machines. If you are using basic reporting. as referenced by SSRS.Overview 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. If you are using Advanced Reporting. Workforce Central System Administrator’s Guide 201 . To add a report to the list.rdl.txt where Workforce Central_instance_name is the name of the Workforce Central instance. For example testServer-kronos-com-wfc. copy this file to the same location on all your Workforce Central servers. For example.x\ Reporting Services\ReportServer\bin\ Workforce Central_instance_name\WFCExcelReports. Installing fonts for Workforce Activities reports Some Workforce Activities reports require the Code 39 Barcode font. add the file name of the report. exe.Reporting. Basic reporting Basic reporting uses either RDL or RPT formatted files.Chapter 7 Reports Managing reporting environments Administering reports is different depending on whether you are using basic reporting or Advanced Reporting. if the instance supports reports. Event Manager processes the request. You do this by disabling the report service on the primary instance that handles user authentication. chooses an instance at random. RPT files use crpe. When you run many reports to view on the screen. or schedule a report. 202 Kronos Incorporated .exe process. and submits the report request to that instance as an HTTP/XML request. e-mail. the request is handled by the reports engine of the instance into which you are logged. you can improve system performance by creating one or more Workforce Central instances that are dedicated to generating reports. Report processing occurs on the Workforce Central application server. When you print. Refer to the appropriate section for more information. Event Manager searches for a list of available report instances. Log on to the primary instance or the instance from which you want reports to run. 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. There is no additional server installation or configuration required. and enabling the report service on the instance where you want to run reports: 1. • Note: All reports for a UNIX instance are forwarded to a required Windows companion server that is configured to support reports.ProduceRDLCReport. RDL files use the built in Kronos. In the Setup workspace.engine. it registers itself in the database. Workforce Central System Administrator’s Guide 203 . the report request is passed to another instance. it generates the report. select System Configuration > System Settings > Reports. Subsequent report requests go to the next available report instance on the list. If you set up more than one reports instance.enable key. the request searches the list of instances in the ServerInfo service and sends the report request to the first report instance on the list. 3. the user can log on to any instance to see the completed report. and the report instance receives that list of instances via the ServerInfo service.reporting. the primary instance directs all requests to run reports to the reports instance. – – If the instance’s report engine is enabled. the system automatically copies the report to the instance that initiated the request to access it. When a user requests to view a report. Two consecutive reports do not go to the same report instance. click true or false according to the type of server that you are setting up. On the site. Therefore. the primary instance gives every report instance an equal opportunity of receiving report requests by doing the following: • When an instance starts. If that instance is not online. For example. If you disable the reports service on the primary instance and enable it on one reports instance only. The instance is added to a list of instances in the ServerInfo service. which always appears to reside on the local instance. click true if you are setting up a dedicated reports server. • When a report request has to go to another instance. the request goes to the instance to which you are logged on. If the report engine is disabled. the request goes to the next instance in the list. and the process goes on until all report instances have run a report.Managing reporting environments 2. When you run a report to view on the screen. unless it is the only report instance. totalization.reporting. The system names each log file WFCReportinglogn. • • Report logs By default. However. This value affects the failure rate and the number of times that reports are resubmitted to the Totalizer application.reporting. Each agent represents a separate thread.reporting.log and WFCRportinglog1.reporting. where n represents an agent. each agent incurs overhead.log.threshold — The number of uncalculated rows that you allow in a report. If you have a long-running report and a single agent.MaxNumRepAgents = 2 you have two log files named WFCRportinglog0.MaxNumRepAgents. Factors that affect the server’s throughput include: • site.log. if you specify the following: site. thereby increasing the reports load. site.reporting. you block other reports that are waiting to be processed. The location of reporting log files is determined by the following property: site.MaxNumRepAgents — The number of agents that you can specify. Each log file is 100KB in size and is recycled when completed.reporting.executable.totalizer. The more retries that you allow. site. the longer a report can remain on a queue.retries — The number of times that a report can use the Totalizer application.Chapter 7 Reports Queue performance considerations A number of properties that you can set in the Reports tab affect how quickly reports can be completed and removed from the queue. 204 Kronos Incorporated . and too many agents can adversely affect the performance of the server. a reports log is generated for each agent that you specify in the following property in the System Settings Reports tab: site. For example.log. Click OK and restart the server. Report processing occurs within IIS. rather than a plug-in. Advanced Reporting Advanced Reporting requires Microsoft Internet Information Services (IIS) and a SQL Server installation with SQL Server Reporting Services (SSRS) installed.pdf format. On the application server. you must perform the following steps in order to enable RPT reports to appear correctly: 1. go to Control Panel > Regional and Language Options. Note: If Chinese (PRC) is not available in the drop-down list. If this occurs.Managing reporting environments Blank reports in the Adobe Reader Due to an interaction problem between some versions of Microsoft Internet Explorer and Adobe Acrobat. 3. RPT reports for Chinese If you are using a Chinese version of Workforce Central. 2. select Refresh after the report runs. you must install Kronos Advanced Reporting Security on the SSRS server and deploy the reports from Workforce Central. one-page reports occasionally appear blank when they are opened in the Adobe Reader. Workforce Central System Administrator’s Guide 205 . To permanently prevent one-page reports from appearing blank. In addition. configure Internet Explorer to use Adobe Acrobat Reader as a helper application. Click the Advanced tab. Select Chinese (PRC) as the Language for non-Unicode programs. 4. you need to install files for East Asian languages via the Languages tab. All reports are defined using the standard RDL file format. The report appears in . in the past you could access Workforce Central on sampleServer using this URL: http://sampleServer/wfc/logon. With Advanced Reporting. contact your system administrator to add the server to the domain.domain_name. open the Command Prompt and enter the following command: nslookup server_name. The requirement for fully qualified domain names means that: • • Each server and client that will access Advanced Reports must be registered in the corporate DNS with its fully qualified domain name. add the SSRS server to your browser’s “trusted” zone. Once you install the Kronos 206 Kronos Incorporated . If you access Workforce Central using the desktop shortcuts that are created during the Workforce Central installation.domainName. Therefore. For example.com where server_name is the name of the server you are checking and domain_name is your corporate domain. To check that a machine is registered in the corporate DNS. Note: If you suspect authorization is failing because cookies are not being passed due to firewall or Internet Explorer security configurations. All application servers and SSRS servers must exist on the same Windows domain. If the server cannot be found. Running Advanced Reports requires Workforce Central Workforce Central Advanced Reporting does not support the ability to run reports directly through the SSRS Report Manager. you must access the same server using this URL: http://sampleServer.com/wfc/logon.Chapter 7 Reports Fully qualified domain names are required Kronos Advanced Reporting uses domain cookies for user authentication. you must use fully qualified domain names to access all servers in an Advanced Reporting environment. be sure to change these shortcuts to reference the fully qualified domain name of the Workforce Central application server. entering different Workforce Central instance information each time. you need to make sure that the SSRS server stays up to date with any reporting changes on the Workforce Central server. Note: If you have multiple application servers that are identical in terms of products installed and language. Log on to Workforce Central and click Setup in the upper right-hand corner of the screen.Managing reporting environments Advanced Reporting security extension on the SSRS server. whether it is multiple instances on the same box. Installing Advanced Reporting on multiple instances Workforce Central Advanced Reporting enables you to point multiple Workforce Central instances at a single SSRS server. you must log on to Workforce Central to run reports. need to indicate the URL of the SSRS server in the System Settings > Reports tab on each application server. since each instance has the same set of reports and authorized users. or multiple language instances on the same box or many boxes. You will. b. To install Advanced Reporting for multiple instances. If you are using Advanced Reporting. Updating the SSRS server after installing new Workforce Central products Workforce Central add-on products typically add new reports or update existing ones. Workforce Central System Administrator’s Guide 207 . or multiple application server installations on many boxes. A Workforce Central instance is any instance of the Workforce Central application server. you do not need to run the Kronos Advanced Reporting Security installation for each one. click Report Setup. run the Kronos Advanced Reporting Security installation multiple times on the same SSRS server. Under Common Setup. however. Redeploy all reports to the SSRS server: a. Perform the following steps after installing new Workforce Central products: 1. Note: The Workforce Central server you log on to must be correctly configured to work with SSRS. access the following directory: Drive:\KronosInstallDirectory\wfc\reporting b. On the Workforce Central application server. 2. Copy the following files: KronosResources. You can use other parts of the application during the deploy.Chapter 7 Reports c.ini c.zh-CN. Click the Advanced Reports tab. Note: If you do not see the Advanced Reports tab or the Deploy Report Files button.es-MX. C:\Program Files\Microsoft SQL Server\ MSSQL. d. Click Deploy Report Files.fr-FR. Deploying reports may take up to ten minutes.ini KronosResources.x\Reporting Services\ReportServer\ bin\ApplicationServerInstanceName For example. This access is granted in your Function Access Profile under Workforce Manager . make sure you have access to these controls.ini KronosResources. Save the files you copied to the following directory on the SSRS server: SSRS_Install_Drive:\Program Files\ Microsoft SQL Server\ MSSQL. using the following instructions: a.Department Manager > Reports > Report Setup > Report Setup Access and Advanced Reports Deployment.ini KronosResources.2\Reporting Services\ReportServer\ bin\gromit-kronos-com-wfc 208 Kronos Incorporated . Copy the report labels from the Workforce Central application server to the SSRS Server. you must configure the firewall to allow SSRS to send communications via port 80 (http) or port 443 (https). Delete objects (files. This is the best way for the Advanced Reporting administrator to access the Report Manager. The Advanced Reporting administrator may need to access Report Manager to perform the following tasks: • • Change settings for datasources. you may want to delete RDL files if you uninstall a product from the Workforce Central suite. If the SSRS server and Workforce Central web server are on different sides of a firewall. Note: The Advanced Reports administrator is identified as part of the Advanced Reports security installation on the SSRS server. For example. Add other Workforce Central users as Advanced Reporting administrators. For example. When to access the SSRS Report Manager directly The Report Setup > Advanced Reports workspace under Common Setup provides a link to the Report Manager user interface on the SSRS server. Advanced Reports logs Microsoft SQL Server Reporting Services writes log entries to the following location: Drive:\Program Files\Microsoft SQL Server\MSSQL.log contains log information from 12:51:34 PM on March 26. find the ReportServer file with the most recent date and time. users.2\Reporting Services\LogFiles To view the most recent log entries. roles) in the repository. • Workforce Central System Administrator’s Guide 209 . if database login information changes. For example: ReportServer__03_26_2007_12_51_34. These are default settings. 2007.Managing reporting environments Allowing SSRS to access the web server through a firewall The SSRS server must be able to send communications to the Workforce Central web server. b. c. Click the folder name that corresponds to the name of the Workforce Central application server instance that you are installing.Chapter 7 Reports The Advanced Reports security installation allows you to identify only one administrator. For example gromit-kronos-com-wfc. Click New Role Assignment. If you need to add others: a. Select Content Manager as the role and type the Workforce Central user name into the “Group or user name” field. 210 Kronos Incorporated . d. Click the Properties tab and then click Security in the menu bar at the left side of the screen. Access Report Manager. e. Refer to “Modifying the RDL file” on page 214 for more information.0 version of Workforce Central. Create a custom report definition language (RDL) file by renaming an existing RDL report or creating a new one in Microsoft Visual Studio. If you are creating a new report definition file without a template. the report is formatted as RPT. 4. Modify the RDL file in accordance with instructions provided by Kronos. Refer to the Workforce Central online help for more information. Refer to “Creating a reports definition file” on page 212 for more information. Customizing RDL reports Customizing RDL files requires the following steps: 1.Customizing reports 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. Only RDL formatted reports are supported by the Advanced Reporting functionality. refer to the Workforce Central Suite Release Notes. 2. Note: To determine which reports are formatted as RDL and which are RPT. If you are modifying a custom report that was created with a pre-6. In the Report Setup component. Create a new report definition file without a template. create a report item that references the RDL file. Kronos recommends using the RDL format and customization instructions. Save the custom RDL file to Kronos_install_directory\wfc\reports\otherReports on all Workforce Central application servers. 3. Workforce Central System Administrator’s Guide 211 . This section contains instructions for customizing RDL and RPT reports. The instructions for customizing a report depend on the type of report file you are customizing. An understanding of the tables and views in the Workforce Central database. Note: This access is granted in your Function Access Profile under Workforce Manager .Chapter 7 Reports 5. 212 Kronos Incorporated . Refer to “Deploying custom reports” on page 217 for more information. use the Report Setup component to deploy the report to the SSRS server. If necessary. 7. Refer to “Giving users access to a custom report” on page 221 for more information. If you are using Advanced Reports. see the Workforce Timekeeper Database Tables Reference Guide and the Workforce Timekeeper Database Views Reference Guide. 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. In order to complete these steps. • Creating a reports definition file There are two ways to create a custom RDL file: • • You can duplicate an existing file by opening the file in Microsoft Visual Studio and saving the file with a new name. Give users access to the custom report by modifying Data Access Profiles. For detailed information. 6. You can create a new file in Microsoft Visual Studio. Refer to “Updating report labels” on page 217 for more information. customize report labels and update those labels on the SSRS server. A Kronos Service Representative can also help you to prepare custom reports.Department Manager > Reports > Report Setup > Report Setup Access and Advanced Reports Deployment. you need: • • Access to Microsoft Visual Studio 2005 with Service Pack 1 installed. 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. you can use as much of the original report design as you want. However. For example. The name cannot be the same as any other report. When you duplicate a report. because it is unavailable. you may only need to change a single field or edit a single heading in the report. You need to set the data source location to your database in order to run the report in the Microsoft Visual Studio development application. report performance could be affected. Duplicating a report Duplicating an existing report definition file is the easiest way to create a custom report. custom or standard. 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.Customizing reports Note: You must assign unique file names to custom reports. 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. Multiple accelerated views used on different reports cannot be combined into one accelerated report. the database and password assignments from the original Kronos development database are retained. When you open duplicated reports in Microsoft Visual Studio to customize them. To duplicate a file. Workforce Central System Administrator’s Guide 213 . However. since this additional information is not an accelerated view. Standard or other views or tables may be joined to the original accelerated report views. Creating a new report Creating a new report file involves more knowledge of RDL and the Workforce Central database tables and views. open it in Microsoft Visual Studio and save the file with a new name. Define the following shared datasources for the project: – The Workforce Central database — This is the datasource from which Workforce Central reports retrieve data. the report will not work if you attempt to run it using the other type. This can be an issue. If you design a report specifically for one type of reporting. Add the report to a Report Server Project in Visual Studio.Chapter 7 Reports Modifying the RDL file You must modify RDL files using Microsoft Visual Studio 2005 with Service Pack 1 installed. regardless of the stated requirements of a specific environment. To write custom reports that work correctly in either reporting environment. 2. Name: kronos Type: Microsoft SQL Server or Oracle Connection Properties: Enter the name or net service name (for Oracle) of the Workforce Central database server and the appropriate logon information. if you attempt to schedule a report written for Advanced Reporting. for example. 1.com/wfc/webservice/ WFCReportingServices 214 Kronos Incorporated .domain_name. – The preprocessing web service — This is the datasource responsible for authentication and preprocessing of reporting data. Name: KronosReportingServices Type: XML Connection String: http(s):// WFC_server_name. This datasource is only required if you are using Advanced Reports. Note: The requirements for custom reports vary depending on whether you are designing reports for basic reporting or Advanced Reporting (with SSRS). perform each of the steps below in their entirety. since scheduling is only available through the basic reporting interface. Refer to the following instructions when working with Kronos reports in Microsoft Visual Studio. Customizing reports Credentials: Use Windows Authentication (Integrated Security) 3.GetLocalizedLabel (String key. It is very important that subreport filenames end with the string subreport.CommonApp. if necessary. rather than modifying an existing report.Framework. using C# as the programming language.RDLUtilities. The signature of the function is Kronos.Reporting.Reporting.RDLUtilities assembly. since this string indicates that the name of the subreport should not appear in the user interface. copy the dll from Kronos_install_dir\reporting to Program Files\Microsoft Visual Studio 8\Common7\IDE. – – The first dataset is typically the result of a query string executed against the “kronos” datasource.dll.Reporting.RDLUtilities. Localization. Make sure labels are returned even if the query returns no results. The settings for the XMLProcessDS dataset are different depending on whether the report is a list report or an employee report. • • • Workforce Central System Administrator’s Guide 215 . Implement externalized labels uniformly on all RDL files.Reporting.dll while writing custom reports. refer to an existing report definition file to learn about the construction of these datasets.Workforce. Note: If you are creating a report. The label localization function is contained in the Kronos.Utils. Modify the datasets used by the report. The second dataset is called “XMLProcessDS” and it is the result of a SOAP action against the “KronosReportingServices” datasource. Refer to the following requirements and best practices when modifying RDL files: • All custom functions are implemented in a custom assembly. In order to test and use functions from Kronos. Subreports should use the following file naming convention: ReportName_subreportname_subreport.rdl. and the type of employee report.rdl where subreportname is any readable string that explains the function of the subreport.RDLUtilities. String culture). The name of the assembly is Kronos. Note: Along with an understanding of the Workforce Central database tables and views. and these reports are handled somewhat differently. the selected value from one parameter cannot impact possible selections for a subparameter. This value enforces security. as in the case of selecting from a list of cities contained within a selected country or state. Conditional expressions in dataset formulas are supported. DateTime. Add the custom option to the report as a Report Parameter. 2. Workforce Central supports the following data types for custom reports: String. Integer. Refer to the following instructions to add a custom option: 1. 216 Kronos Incorporated . Custom report options allow you to pass additional data or selection criteria to a custom report. open the report that will use the custom option. A parameter should be marked as “internal” if its value is not passed to the report. but supplied from within the RDL itself. refer to “Customizing reports that use stored procedures” on page 240. For information about customizing these reports. • • • • Custom options You can create custom report options for custom reports. Conditional expressions in SQL statements are not supported.Chapter 7 Reports • Make sure the xml_process_status parameter. is the first in the list of parameters for a report. Report parameters in Visual Studio correspond to report options in Workforce Central. which gets its value from the status field in the XMLProcessDS dataset. You will populate available values in the Workforce Central user interface. Cascading parameters are not supported. In Microsoft Visual Studio. Set Available values to Non-queried and Default values to Null. Some reports access data via stored procedures. Indicate whether the report can support multiple values in the Multi-value checkbox. creating custom report options requires that you know how to create parameters within Microsoft Visual Studio. For example. 2. Workforce Central System Administrator’s Guide 217 .otherfiles setting in the Reports tab in System Settings. configure a custom option that has the same properties as the custom parameter you created in Visual Studio. Updating report labels Customizing and updating labels for reports differs depending on whether you are using basic reporting or Advanced Reporting. If you are using Advanced Reporting. This step is only required if you are using basic reporting. Click Deploy Report Files. In the Report Setup workspace. Make sure the custom RDL files are located at the location specified by the site. click the Advanced Setup tab. you can configure custom options however you choose. To deploy reports: 1.rpt. 3.reporting. The deploy will only work against those files on the same physical server. Deploying custom reports 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.Customizing reports 3. This may take several minutes. Note: For instructions on configuring custom options in Workforce Central. refer to the Workforce Central online Help. The default location is: Kronos_installation directory/wfc/reports/ OtherReports. All RDL files are redeployed. you must determine the application server you are logged into in order to know where to store the custom report(s). Note: If you access Workforce Central through a load balancer. In Workforce Central. Refer to the appropriate section below. including querying the database for values. 2. go to Kronos_Install_Dir\wfc\applications\wtk\properties\ U2li18n. On the Workforce Central application server.Chapter 7 Reports Basic reporting 1.ini files = Kronos_Install_Directory/wfc/applications output file name = KronosResources output directory = Kronos_Install_Directory/wfc/reporting For example: Kronos. In the same folder. 218 Kronos Incorporated . 3.ini 5.ini and Override_U2li18n*. save this new custom labels file with the following prefix: Override_ For example: Override_U2li18n. access the following directory: Kronos_Install_Dir\wfc\reporting 6. and so on.ResourceConverter c:\kronos\wfc\applications KronosResources c:\kronos\wfc\reporting Note: You can use absolute or relative paths to the appropriate directories. Change the values for the labels that you want to customize. for the Workforce Timekeeper (wtk) component. From a command line.ini for French labels.Reporting.ini or U2li18n_fr.exe with the following arguments: – – – root directory to all U2li18n*. For example. Make a copy of the file and delete all the labels except the ones you want to modify. On the Workforce Central application server.Reporting. access the external labels file for the Workforce Central component whose labels you want to customized. 4.ResourceConverter. execute the following file: Kronos. ini or U2li18n_fr. In the same folder.exe file creates a new KronosResources.es-MX.ini KronosResources.Advanced 1.fr-FR.ini files: Using a batch file: a.ini 5. 7. and so on.ini file for each language supported by Workforce Central. On the Workforce Central application server.zh-CN. for the Workforce Timekeeper (wtk) component. 3. For example. On the Workforce Central application server where you edited labels. access the external labels file for the Workforce Central component whose labels you want to customized.ini Reports .ini for French labels. 2. Update the labels on the SSRS server either using the batch file provided or by manually generating and copying KronosResources. Change the values for the labels that you want to customize. go to Kronos_Install_Dir\wfc\applications\wtk\properties\ U2li18n.Customizing reports The ResourceConverter. Make a copy of the file and delete all the labels except the ones you want to modify. Copy the following files to all Workforce Central application servers that are configured as reports servers: KronosResources. 4. save this new custom labels file with the following prefix: Override_ For example: Override_U2li18n.ini KronosResources. make the following location accessible using a shared folder or mapped network drive: Kronos_Install_Directory\wfc Workforce Central System Administrator’s Guide 219 .ini KronosResources. Manually generating and copying KronosResources. You can schedule this command to run at regular intervals if necessary. testServer-kronos-com-wfc.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.ini files to the SSRS server. On the Workforce Central application server.Reporting.bat automatically creates and copies the most up to date KronosResources. access the following directory: Kronos_Install_Dir\wfc\reporting b.exe with the following arguments: .Chapter 7 Reports b.ResourceConverter c:\kronos\wfc\applications KronosResources c:\kronos\wfc\reporting 220 Kronos Incorporated . c. Execute the following command: GetResources.root directory to all U2li18n*. execute the following file: Kronos.bat \\shared_folder_path where shared_folder_path is the path to the shared folder or mapped drive you created in step 5.ResourceConverter.ini files = Kronos_Install_Directory/wfc/applications .ini and Override_U2li18n*. \\appServer\kronos\wfc.Reporting. From a command line. open a command prompt and switch to the following directory: SQL_Server_Install_Directory\MSSQL.output file name = KronosResources . For example. GetResources. On the SSRS server. For example.output directory = Kronos_Install_Directory/wfc/reporting For example: Kronos.ini files: a. 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.ini e. Modify the Crystal Reports definition file in accordance with the requirements of Workforce Central.ini KronosResources.2\Reporting Services\ReportServer\ bin\gromit-kronos-com-wfc Giving users access to a custom report Decide which users you want to access the report. Customizing RPT reports Customizing RPT files requires the following steps: 1. On the Workforce Central application server. then add the report item to the appropriate report data access profile(s) under Workforce Central Setup > Access Profiles > Data Access Profiles > Reports.Customizing reports Note: You can use absolute or relative paths to the appropriate directories.ini KronosResources.es-MX. access the following directory: Kronos_Install_Dir\KronosInstallDirectory\wfc\ reporting d.ini KronosResources. C:\Program Files\Microsoft SQL Server\ MSSQL. Copy the following files: KronosResources.zh-CN.fr-FR. Workforce Central System Administrator’s Guide 221 . see the Workforce Timekeeper Database Tables Reference Guide and the Workforce Timekeeper Database Views Reference Guide. However. In order to complete these steps. In the Workforce Central Report Setup component. You can use Crystal Reports Designer version 10 or 11 to create custom reports. you need: • Crystal Reports Professional Edition software. A Kronos Service Representative can also help you to prepare custom reports. Refer to the Crystal documentation to determine what was new for Crystal version 11 release 1 and 2. • An understanding of the tables and views in the Workforce Central database. 4. along with a working knowledge of designing Crystal reports. purchased from the vendor. you must make sure that the report definition file addresses the following questions: 222 Kronos Incorporated . • The Crystal Reports definition file For Crystal Reports and Workforce Central to work together to produce reports that you can control from within Workforce Central. The ability to write to the following directory on the Reports directory on the Workforce Central Reports instances: Kronos_install_directory\wfc\reports\OtherReports • Access to the Report Setup component in Workforce Central. create or modify a report item that references the custom Crystal Reports definition file.Department Manager > Reports > Report Setup > Report Setup Access. with its accompanying license. Note: This access is granted in your Function Access Profile under Workforce Manager . 3.Chapter 7 Reports 2. Give users access to the custom report. Save the Crystal Reports definition file to the Kronos_install_dir\wfc\reports\OtherReports directory on all Workforce Central instances designated as Reports instances. For detailed information. reporting features that were new for Crystal 11 are not supported for Workforce Central reports. When you generate a report instance. This section addresses these Kronos-specific requirements for the Crystal Reports definitions file. Some reports use different options than others. you will need to address all of these issues in the report definition file. you might want to add a new time period or create an additional parameter within the report. these issues have already been addressed. or to pass a formatting control value to a report. Standard Options Workforce Central System Administrator’s Guide 223 . or for use in calculations. If you are creating a new report.Customizing reports • • • • What parameters (options) are needed by the report. Identify the report options that are needed for a report by viewing the report in the Report Setup component. and these reports are handled somewhat differently. If you are creating a new report. For information about customizing these reports. Workforce Central report options must be in lowercase. Note: Some reports access data via stored procedures. lowercase. or mixed case. Selected options for a report item must also be configured on the Crystal Reports definition. add the standard options (as defined in this section) to the report definition file. refer to “Customizing reports that use stored procedures” on page 240. However. 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. Report Options Report options allow you to pass data into a report file. Report options are specified as parameters in the report definition file. if any? Does the report require a HyperFind query to retrieve a list of people to include in the report? What time periods is a user allowed to choose for the report? How are labels translated for different languages? If you are creating a custom report by duplicating an existing file rather than starting with a new file. but not background option values. Background options are used to display foreground option values. at a minimum. you can select foreground options values. or all function access F profiles B B Function Access Profiles hd Displays the function access profiles selected Gmt server offset Returns the time difference. Excused.Chapter 7 Reports The following table describes the standard options. multiple. others control data display or report behavior: Background/ Foreground F B F B B B F B F B F Option Name Absences Absences hd Actual/Adjusted Actual/Adjusted hd Db timezone Decimal Format Employee page break Employee page break hd Exceptions Exceptions hd From Timeframe Function Access Profiles Description Select Unexcused.hh Select No or Yes to page break on each employee Displays the selected page break choice Select one. or both Displays the selected Holiday Credit Types Select one. between the timezones of the database server and the reporting server Select Credited. or all types of Exceptions Displays the selected Exception Types Passes starting date for timeframe selection Select one. or both Displays the selected Absence types Select Actual or adjusted amounts Displays the selected Actual/Adjusted choice Displays the timezone of the database server Formats time format to hh:mm or hh. or all Import Types Displays the selected Import Types Holiday Credit Type Holiday Credit Type hd Import Type Import Type hd F B F B 224 Kronos Incorporated . Some enable user selections. Denied. multiple. in seconds. multiple. Customizing reports Option Name Import Batch Import Batch hd Labor level count locale Description Select one import batch or latest completed batch Displays the selected Import Batch Displays the number of labor levels defined in the database Passed in by the Workforce Central framework to determine the locale to be used for report localization. or all audit types Displays the Audit Types selected Displays the timeframe selected Passes the selected timeframe type Passes ending date for timeframe selection Determines if wages appear on report based on function access profiles F B B B F B Workforce Central System Administrator’s Guide 225 . which stores the key/value pairs that allow report labels to be localized. multiple. Background/ Foreground F B B B location_ini Passed in by the Workforce Central B framework to identify the location of the u2li18n.ini file. multiple. Passes list of employee/person IDs that are not up to date B Not Updated Emp List hd Not Updated Emp Count hd Passes count of employee/person IDs that B are not up to date Pay Codes Pay Codes hd Printed For Query Name Request Time hd Timecard Audit Type Timecard Audit Type hd Timeframe hd Timeframe Type To Timeframe Wage Permission Select one. or all pay codes Displays the selected Pay Codes Displays Hyperfind Query name F B B Displays the user name who ran the report B Displays the time that all calculated totals B are up to date Select one. Multiple/ Discrete Column Available Choice: Values Typically Linked Internal Value Passed Excusedsw Unexcused:0 Excused:1 Both:0. Two internal values are separated by a comma (. Adjusted:[--same] “GMT +/. An entry of the form name:[. Only string or datetime entries have the same values internally and externally. for example.1 Unexcused. Count:PayCode name 1|PayCode name 2. Unexcused:0.. for example. • • An entry of the form name:number identifies a named choice and the internal code that represents it.hrs: DB Timezone Name”:[-same] Hh:mm:1 Hh. Adjusted:1.). An entry of the form name:n/m identifies an external value of name and an internal value of n/m. Excused.. An entry of the form count:name1|2. identifies a count of the number of choices for that option followed by each option name. 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. Both:[--same] Actual:0 Adjusted:1 ----Actual. for example.same] identifies entries that have the same internal and external values.Chapter 7 Reports Report option attributes The following table describes attributes from the previous table..hh:0 No:0 Yes:1 • • Option Name Type Absences Number Multiple Absences hd Actual/ Adjusted Actual/ Adjusted hd Db timezone Decimal Format String Discrete -- Number Discrete String String Discrete Discrete Number Discrete Employee page Number Discrete break 226 Kronos Incorporated . accessprofid Exceptions hd String From Timeframe Discrete Datetime Discrete Function Number Multiple Access Profiles Function String Access Profiles hd Gmt server offset Discrete Count:function access profile 1|2…. Violation:0/7 Missed In Punch:1/8 Missed Out Punch:0/9 Short Break:1/10 Unscheduled:0/11. accessprofid -Count:exception name1|2…:[--same] Datetimevalue:[--same] Accessprofile.profilenm: accessprofile.Customizing reports Option Name Type Employee page String break hd Exceptions String Multiple/ Discrete Column Available Choice: Values Typically Linked Internal Value Passed Discrete Multiple -No. Days Empl.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 -Any datetime column Vp_accessprofile.1/1 Early In:1/2 Late In:1/3 Long Break:1/4 Holiday Skipped:0/5 Min. Yes:[--same] absentexcepttypeid Cancelled Deduct:0/1. Number Discrete -- Seconds:[--same] Workforce Central System Administrator’s Guide 227 . Days Active Violation:0/6 Min. accessprofid or Accessprofile. paycodeid Count:Pay Code name1|2…: Logged in user name:[--same] Hyperfind query name:[--same] Max datetime all employees on report have up to date calculated totals: [--same] Number Multiple Import Type hd String Import Batch Import Batch hd Labor level count Not Updated Emp List hd Discrete -Importbtchstatid --- Number Discrete String Discrete Number Discrete Number Multiple Not Updated Number Discrete Emp Count hd Pay Codes Pay Codes hd Printed For Query Name Request Time hd Number Multiple String String String Discrete Discrete Discrete Datetime Discrete 228 Kronos Incorporated . Both [-- Holiday Credit Number Discrete Type Holiday Credit String Type hd Import Type Discrete -importcntnttypeid same] Labor Level Entries:1 Labor Level Set:2 People:3 Accrual Dates:4 Accruals:5 Punches:6 Pay Code Edits:7 Sched.Chapter 7 Reports Option Name Type Multiple/ Discrete Column Available Choice: Values Typically Linked Internal Value Passed Exceptionsw Exceptions Only:0 Credits Only:1 Both:2 Exceptions Only. Pay Code Edits:8 Schedules:9 Count:Import Type Name1|2…:-Specific batch: importbtchstatid\0 Latest completed batch: importbtchstatid\1 Batch Name and Date:[--same] Number:[--same] employeeid’s:[--same] Number of employeeid’s:[--same] paycodeid ---Paycode.name:paycode. Credits Only. -1/6/-1/0/.-1//2/0/0/ Edit Punch: -1/0/40/0/.-1/0/2/0/0. -1/6/20/0/.-1/0/4/0/0. -1/0/23/0/. -1/0/1/0/0. 1/5/-1/1/.-1/0/55/0/ Edit Pay Code: -1/6/20/1/. -1/0/22/0/.-1/5/4/1/1. audittimesheetid -1//30/0/0 Edit Duration: -1/6/30/0/. Pay period:0 Curr. -1/6/30/1/ Add Punch: -1/0/-1/0/.-1//4/0/0/.Customizing reports Option Name Type Timecard Audit Type String Multiple/ Discrete Column Available Choice: Values Typically Linked Internal Value Passed Multiple Vp_timecardaudit.12/-1/-1/-. -1//20/0/0. -1/0/21/0/. Pay period:1 Next Pay period:2 Prev. Add Duration:-1/0/30/1/. Schedule period:4 Next Schedule period:5 Week to Date:6 Last Week:7 Yesterday:8 Range of Dates:9 Range of Relative Dates:10 Specific Date:11 Datetimevalue:-[--same] ’Show wages’:1 ’Don’t show wages’:0 Timecard String Audit Type hd Timeframe hd String Timeframe Type Discrete Discrete Number Discrete To Timeframe Datetime Discrete Wage Permission Number Discrete Any datetime column -- Workforce Central System Administrator’s Guide 229 . -1/0/-1/1/. -1//-1/0/0.-1/5/2/1/1 Add Pay Code: -1/0/20/1/. -1/0/30/0/. -1/6/-1/1/. -1/1/20/0/ Delete Pay Code: -1/5/20/1/ ---Count:Audit Type 1|2… Timeframe Name or Specific Dates: Prev. -1/0/20/0/. -1/6/-1/1/ . Schedule period:3 Curr. the User Name that is associated with the scheduled job appears instead. based on the logged on user’s ability to view wage data as determined by their function access profile. Db timezone. For reports that are scheduled to run via the Event Manager. wage permissions are in Workforce Manager . the Query name parameter in the report header displays the name of the HyperFind query. This option is generally passed directly to a formula or field on a report that prints wage amounts. Printed For.Chapter 7 Reports Wage permissions The wage permission option is typically used to display or not display wage data on a report. using a 230 Kronos Incorporated . and does not display the formula or field to those users who do not have this permission in their function access profile. For any function access profile. The function access profile of the person generating the report instance determines the value of this option. Background options Most background header options have names ending in hd and are generally placed on the report as headers for foreground options. and Labor level count hd. and the format is passed directly to formulas that display time. The employee group that is associated with the user who is logged on determines the employees that can be seen on the report. The Printed For parameter appears on all standard reports in the header to indicate the user who requested the report. using a setting in Access Profiles > Function Access Profiles in the Setup workspace.System Configuration > Setup > Wage Profiles Setup.hh format. Decimal format This option determines if time appears in hh:mm or hh. • • If you use a HyperFind query. However. Other similar appearing background options are the Query Name. The function access profile of the person generating the report instance determines the value of this option. the ability to see wage data is determined by the person selected in the User Name field in the Report > Schedule Report tab. if the report is scheduled. the Requires HyperFind Query check box is selected. Use the following instructions to configure a report definition file to use a HyperFind query: 1. add the MYWTKEMPLOYEE table to the query. refer to the Workforce Central online Help. Custom report options allow you to pass additional data or selection criteria to a custom report. In the Database > Database Expert option. select Common Setup > Report Setup and then click a report in the list. Custom options You can create custom report options for custom reports. creating custom report options requires that you know how to create main and header parameters within Crystal Reports. The HyperFind query selects the employees to include in the report. create a parameter to go along with a custom report.Customizing reports setting in Display Preferences > Display Profiles > Display Format tab > Duration display group in the Setup workspace. 2. Note: For information about adding custom report items to Workforce Central Reports. Workforce Central System Administrator’s Guide 231 . To determine whether an existing report uses a HyperFind query. Note: Along with an understanding of the Workforce Central database tables and views. HyperFind queries If your report contains employee data. Creating a custom report option is a two-step process: 1. using a HyperFind query simplifies your report request. In Workforce Central Reports. In Crystal Reports Designer. On the navigation bar. and verify that the remaining joins are correct and complete. configure a custom option that has the same properties as the custom parameter you created in Crystal. If the report uses a HyperFind query. Report parameters in Crystal are the equivalent of report options in Workforce Central Reports. access the Report Setup component. This replacement works because of the integration between the Crystal Reports software and the Workforce Central system. 232 Kronos Incorporated . This must be the first selection criteria. and does not work unless the report is linked within the Workforce Central system. thereby limiting the resulting report instance to those employees or people whom the HyperFind query returns. In the Field Explorer > Parameter Fields. “{MYWTKEMPLOYEE. 3. it is likely to have a time period option in effect so that you can limit results to a specific time period.Chapter 7 Reports 2. Workforce Central does not support any modifications to the SQL statement made in the Show SQL Query option in Crystal Reports. Many of the Workforce Central database views include employee pay period dates. add a line containing. In the Report > Selection Formula > Record option. 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. Caution: Never enter this Selection Formula directly into the WHERE clause of the report. Time periods If your report displays employee data. A time period can be for pay periods or nonpay periods.SESSIONID} = {?wtksessionid}”. When a report instance is run. When you request both pay period and non pay period time periods. Nonpay period time periods contain the same date range for all employees. the Timeframe Type that is passed to the report file is a number between 3 and 11. add the WTKSESSIONID parameter. the Record Selection Formula uses a special formula. the employee or person IDs in the HyperFind query result set replace the {?wtksessionid} value. Pay periods can be different for each employee on a report. the From Timeframe and To Timeframe parameters get the dates pertinent to the time period selected. but be aware that labels or keys can change or be deleted after a version upgrade. The Workforce Central system calculates the earliest From Timeframe value and the latest To Timeframe value for every employee in the report. which could require modifications to custom reports. you should hard code the strings used in the Crystal Report file. and passes those values to the report parameters. you can continue to use the GetLocalizedLabel() function and . the Time Period Type that is passed is one of the following: Pay Period Previous Pay Period Current Pay Period Next Pay Period Value 0 1 2 When you select a pay period time period. This allows one Crystal Report file to be able to display strings in other languages without modifications to the report file. Users of Workforce Central who are not employees do not have pay periods assigned to them. The system ignores pay period portions of the formula.ini file with version upgrades from affecting your report labels.ini file to supply the strings for custom reports. When you select a nonpay period time period.Customizing reports If you select a Pay Period. This keeps any changes to the . thereby providing optimum performance for the report query. If you do not want to hard code strings. The same key can be used on multiple reports.ini. To hard code strings directly. The GetLocalizedLabel() formula accesses keys in the . When creating custom reports. Modifying the Workforce Central System Administrator’s Guide 233 . the From Timeframe and To Timeframe parameters receive datetime values. modify the report file by replacing any GetLocalizedLabel() functions with strings. Labels Standard reports use a special function named GetLocalizedLabel() that allows the labels and strings that appear on Crystal Reports to be stored in an external file named u2li18n.ini file to find a specific text string and add it to a report. To set up the GetLocalizedLabel() function on the PC where you are running the Crystal Reports software: 1.dll from: WFC. The GetLocalizedLabel() function will return ‘null’ if it is unable to retrieve a string for any reason.rootdir\instance_name\bin to: \\Program Files\Common Files\Business Objects\3.ini file. On a WFC reporting instance. Running a report in the Crystal Report Designer that uses the GetLocalizedLabel() function If you duplicate and modify a standard Crystal Report and choose not to delete all references to the GetLocalizedLabel() function. The default installation path is: \\Program Files\Common Files\Crystal Decisions\2. 3.ini from: WFC.Chapter 7 Reports u2li18n. located on the server where Crystal Designer is installed.0\bin\u2li18n. On the PC where Crystal Reports is installed. the report will not run in the Crystal Report Designer until the PC is modified for Crystal Report Designer to recognize this function.rootdir\instance_name\applications\wcb\properties \U2LI18N to the destination directory. copy U2LI18N.5\bin This allows the GetLocalizedLabel() function to access the strings in the .ini file is not recommended as it will be deleted during a version upgrade. 2. From a WFC reporting instance. This function is specific to Kronos applications and is not included in the Crystal Reports Designer software.0\bin This allows the Crystal Reports Designer to see the GetLocalizedLabel() function.ini 234 Kronos Incorporated . copy U2LI18N. add a Windows environment variable named UFLINIFILE to: \\Program Files\CommonFiles\Business Objects\3. the getLabel function. Restart your computer. the report may fail when run. 4. make sure that you are not using the Page N of M special field anywhere in the report design. 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. Saving the Crystal Reports definition file Before saving the Crystal Reports definition file. Giving users access to the custom report Decide which users you want to access the report. 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.ini file. HyperFind There are two design patterns for reports that use HyperFind: • the -411 placeholder Workforce Central System Administrator’s Guide 235 .Customizing reports This allows the GetLocalizedLabel() function to access the strings in the . Upgrading custom reports created in previous versions Specific custom reports considerations when upgrading Certain existing custom reports require special consideration when upgrading. The affected reports are those that use HyperFind substitution. or stored procedures employing the @key and @sessionid parameters. Kronos recommends that you avoid use of this field. 2. A HyperFind report contains either a “-411” or a “wtksessionid” in the first record of the record selection formula.EMPLOYEEID} = -411 b. In the Report > Selection Formula > Record menu. change the subreport linking to pass the WTKSESSIONID parameter. If the Requires HyperFind Query box is checked. perform the following procedure: 1.SESSIONID} = {?wtksessionid}” d.In WFC Report Setup. To manually update a report template that uses HyperFind. 5. Select “String” from the “Value type” dropdown list. Modify the record selection formula. then the report uses HyperFind. add the WTKSESSIONID parameter. Note the table and column in the “-411” Boolean expression in the record selection formula. clear the “Uses -411” check box. Modify the main report. 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. Repeat these steps for each subreport that uses the -411 placeholder. Select Database Expert from the Database Menu and add the MYWTKEMPLOYEE table to list of selected tables for the data source. a. To determine whether or not a report uses the -411 placeholder or the wtksessionid parameter. Open the report template in Crystal Designer. 236 Kronos Incorporated . In the Field Explorer > Parameter Fields menu. 6. look at the report properties in the Workforce Central Reports Setup page.Save the template file. open the report in Crystal Designer and open the record selection formula window (Report > Selection Formulas > Record). For example: {VPRACCRUALDTL.Chapter 7 Reports • the WTKSESSIONID parameter To determine whether or not a report uses HyperFind. add the following line as the first selection criteria: {MYWTKEMPLOYEE. In addition. Copy the new version of U2LI18N. Repeat the step c with the corresponding subreport parameters.2 the data type of the @key and @sessionid parameters was changed from string to number. 5.0\bin so that the new function is accessible to Crystal Reports Designer. perform the following steps: 1. To ensure that custom reports that use these parameters continue to work properly.Customizing reports getLocalizedLabel function The getLabel() function was used previously to perform the runtime localization of the labels used in the templates. – – locale location_ini 3. To upgrade to the new getLocalizedLabel() function. 2.dll from: WFC. Workforce Central System Administrator’s Guide 237 . Reports now must use getLocalizedLabel() instead of getLabel() to process labels correctly at runtime. ?location_ini) 4. This function has been replaced by the getLocalizedLabel() function. ?locale. Replace all instances of: getLabel('label') with getLocalizedLabel('label'. reassociate the custom templates against the stored procedure. If there are any subreports. Stored procedures In Workforce Central v5.rootdir\instance_name\bin to: \\ProgramFiles\Common Files\Business Objects\3. add the same parameters to each subreport and link it to the main report. Add two new parameters to the main report. if your report does not use any of the Crystal Reports Designer v10.0 reports back to v9. Generally.0 Custom reports written from scratch in earlier versions of Workforce Timekeeper have the following upgrade considerations: Crystal Report Designer version used to create custom reports 8.0 or v10.0/4.1 Embedded Crystal Report Engine version 8.5 9.Chapter 7 Reports Upgrading custom reports written with Crystal v8.1? Yes Yes Yes N/A N/A N/A Initial Embedded WTK Crystal Report version Engine version 4.3/4.5 9. 238 Kronos Incorporated .1 5.5 8.0 10 10 The standard reports in Workforce Timekeeper are stored in the version of the Crystal Engine installed in that release.1 5.3 5.5 9.5 9.1 5.0 10 Are reports forward compatible to WTK v5.4 5.0 5.0 9.4 5.5 to v9.0 10 Are reports forward compatible to WTK v5.4 5.0 format. Crystal v10.0 allows you to save v10.1 8.0? Yes N/A N/A N/A Are reports forward compatible to WTK v5.5 9.0? Yes N/A N/A N/A N/A N/A Are reports forward compatible to WTK v5.0/4.0 features. these reports cannot be opened in a previous version of Crystal Report Designer software. However.0 10 10 10 Custom reports created by duplicating standard reports in earlier versions of Workforce Timekeeper have the following upgrade considerations: Crystal Report Designer version used to create custom reports 8.0 8.0 9.1? Yes Yes N/A N/A Initial WTK version 4. Any report that uses this view will likely fail. Standard reports supplied with v5. 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. which incorporates the union SQL and is compatible with Workforce Central reporting architecture. This was necessary to improve performance and overcome the various DBMS limits on the total number of tables used in a query.0 introduced some changes to the database tables referenced by these reports. vp_accessprofile. will fail. Workforce Central System Administrator’s Guide 239 . Accrual Detail. However custom reports created in versions prior to v5. The Timecard Audit Trail report uses the vp_timecardaudit view.3 reports were defined to directly access standard database tables instead of report-specific database views. Custom reports can be modified by using Crystal’s mapping option to identify those columns that have been removed from the view.3 Several Workforce Central v4. because this view was modified to remove columns that returned audit data for signoffs and approvals.0 from the following standard data reports may need to be modified in v5. such as Accrual Balances and Projections. because the Crystal Report Designer has changed how queries with unions are implemented in version 9.Customizing reports Specific custom reports considerations when upgrading from Workforce Central v4. The following reports are affected: Accrual Balances and Projections Accrual Detail Accrual Summary Holiday Credit Timecard Audit Trail Import Errors Import Statistics Any report that uses the accrualtran database table.0 have been modified. Crystal’s mapping option can be used to change the report SQL to use this new view.1. Custom reports can be easily modified to use a new view.0. Workforce Central v5. Any report that uses the SQL query found on the standard Function Access Profile report will fail. and Accrual Summary. Schedule by Job Actual vs. Schedule by Labor Account Employees Currently Earning Time Employee Hours by Job Employee Hours by Job (Excel) Employee Hours by Labor Account Employee Hours by Labor Account (Excel) Employee Signoff Employee Transactions and Totals Employee Transactions and Totals (Excel) Stored Procedure(s) PREPROC_TotalizationNew accrual_bal_proj PREPROC_TotalizationNew PREPROC_TotalizationNew RPTSP_AccrualDetails PREPROC_TotalizationNew Accrual_summary RPTSP_ActualScheduleByJob PREPROC_TotalizationNew RPTSP_ActualScheduleByLabor PREPROC_TotalizationNew PREPROC_TotalizationNew RPTSP_HoursTotals PREPROC_Totalization RPTSP_HoursTotals PREPROC_Totalization RPTSP_EmpHoursTotals PREPROC_Totalization RPTSP_EmpHoursTotals PREPROC_Totalization PREPROC_TotalizationNew RPTSP_EmpTransTotals PREPROC_Totalization RPTSP_EmpTransTotals PREPROC_Totalization 240 Kronos Incorporated . Report Name Absent Employees Accrual Balances and Projections Accrual Debit Activity Summary Accrual Detail Accrual Summary Actual vs.Chapter 7 Reports Customizing reports that use stored procedures The following table lists Workforce Central reports that use stored procedures and the names of the stored procedures used. Subreports that query tables or views can be added to a stored procedure based report. not in subreports. Two input parameters are supported. these are the only two that are supported to control the results of the stored procedure itself. 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. Any other standard or custom report options can also be used to select the data on the report. For example.Customizing reports Report Name Exceptions Holiday Credits Hours by Job Hours by Job (Excel) Hours by Labor Account Missing Employees Timecard Audit Trail Time Detail Stored Procedure(s) absent_exception PREPROC_TotalizationNew PREPROC_TotalizationNew RPTSP_HoursTotals PREPROC_TotalizationNew RPTSP_HoursTotals PREPROC_TotalizationNew RPTSP_HoursTotals PREPROC_TotalizationNew PREPROC_Totalization Timecard_audittrail Time_details If you need to modify the data returned by a stored procedure for a particular report. – – Key — Used for the HyperFind input of employee ID’s. Actual_adjusted — Used to select Actual or Adjusted/Historical totals. Duplicate the stored procedures according to the Oracle or SQL server instructions and name the stored procedure with a prefix of CUST_. however. you must make a copy of the stored procedure and edit the copy rather than edit the original version in the Workforce Central database. • Workforce Central System Administrator’s Guide 241 . however. CUST_Time_details. This can be used in the report file itself. 242 Kronos Incorporated . which is populated with the employeeids for that HyperFind query. and From Timeframe options are not needed. To Timeframe. In addition to supplying the employee IDs for a report. The Key parameter does not appear in the list of available options in report setup. in addition to the stored procedure equivalent.Chapter 7 Reports • Linking the Key or Actual_adjusted parameters to subreport parameters is not supported. is different. so that the Timeframe Type. Parameters/options for reports that use stored procedures The Key input parameter is the sessionid from the mywtkemployee table. It is passed internally by the Workforce Central report engine to the time_details stored procedure. The Actual/adjusted parameter. The Actual_adjusted parameter also does not appear in the list of available options in report setup. visible in the options list. such as on Time Detail. the Key value can also be used to provide the start and end dates of the selected time frame for each employee. It is passed internally by the Workforce Central report engine to the stored procedure. Chapter 8 Workforce Central Portal Configuration This chapter contains the following topics: • • • • • • • • • “Overview of the Workforce Central Portal” on page 244 “Adding Kronos Web Parts to a new or existing SharePoint portal page” on page 249 “Customizing a Workforce Central Portal sample page” on page 255 “Using the Kronos Web Part page template to create a portal page” on page 256 “Customizing preconfigured Workforce Central Portal Web Parts” on page 257 “Creating custom Workforce Central Web Parts” on page 274 “Visual theme for the Workforce Central Portal and Kronos Web Parts” on page 287 “Customizing and creating Web Part Help topics” on page 288 “Troubleshooting” on page 292 . Some web parts are associated with a pre-configured XSLT file that formats the data in a table or chart format. The Workforce Central Portal requires Microsoft Sharepoint Services and Microsoft Office Web Components (OWC). and integrate them into an existing portal. The Workforce Central Portal supports multiple languages. refer to the Workforce Central Portal Installation Guide. System administrators can also customize the sample portal pages that are included in the Workforce Central Portal installation. A set of web parts comes with the Workforce Central Portal. Important: The Workforce Central Portal does not support Windows Integrated Authentication. For more information about installing the Workforce Central Portal. The Workforce Central Portal is compatible with Microsoft SharePoint portal servers on Microsoft operating systems. To accomplish this. the Workforce Central Portal uses web parts. Purpose of the Workforce Central Portal The Workforce Central Portal organizes important Workforce Central data and displays it in a way that is easy for managers to read. System administrators can choose from the Workforce Central Portal web parts or they can create custom web parts. 244 Kronos Incorporated . The Workforce Central Portal does not support single sign-on. Each web part displays data that is provided by the APIs that are installed with the Workforce Timekeeper application. The data and the presentation of specific Kronos web parts are configurable.Chapter 8 Workforce Central Portal Configuration Overview of the Workforce Central Portal This section presents information about: • • • The purpose of the Workforce Central Portal Portal page configuration options Pre-configured Web Parts that come with the product. the API is noted in the web part description.2 Web Parts. Uses the Genie API. A sample portal page that displays the default content for health care managers. using three sample XSL files that are provided for Genies. Pre-configured web part pages Sample portal pages Genies Portal Description A sample portal page that contains a display of Genie data in three output formats. If a web part uses one of the APIs delivered by the Workforce Timekeeper application. you can continue to use version 5.0 Web Parts. you cannot use a combination of Web Parts from Workforce Central Portal versions 5.0. Kronos Web Parts and sample pages provided by the Workforce Central Portal This section lists and describes the web parts and web part pages that are installed when you install the Workforce Central Portal on the portal server. and upgrade to Workforce Timekeeper version 6. you must replace all pre-configured or custom Kronos Web Parts with 6. However.2 and 6. Healthcare Manager Portal Workforce Central System Administrator’s Guide 245 .0.0.2. To use Workforce Central Portal version 6.Overview of the Workforce Central Portal Workforce Central Portal page configuration options System administrators can use the Workforce Central Portal to accomplish the following objectives: • • Add pre-configured or custom Kronos Web Parts to a new or existing portal page Customize a pre-configured Kronos sample portal page Important: If you are using Workforce Central Portal version 5. Chapter 8 Workforce Central Portal Configuration Sample portal pages Healthcare Staffing Portal Retail Portal Description A sample portal page that displays the default content for health care staffing managers. Users can view the charts in the portal. A sample portal page that displays the default content for retail managers. Configurable generic web parts Web part Kronos Navigation Description Enables Workforce Central Portal users to access Workforce Central application pages from the portal. Enables users to access Workforce Central application pages directly from the portal. Kronos XML API XSLT Table Enables system administrators to configure tables to display Workforce Central data. Kronos Navigation Links Kronos Process Manager In Box Enables users to view the number of actions and notifications that are stored in their Process Manager inboxes. The target application pages display for the time period and business location that is specified on the portal page. Enables system administrators to configure charts to display Workforce Central data. The items that appear on the tab menus depend on the access profiles to which the user is assigned. including custom Key Performance Indicators (KPIs) and Workforce Timekeeper Genies. using the standard Workforce Central tabs and menus. Users can view the tables in the portal. including custom Key Performance Indicators (KPIs) and Workforce Timekeeper Genies. Kronos XML API XSLT Chart 246 Kronos Incorporated . Kronos Staffing Requirements Kronos Coverage Detail Workforce Central System Administrator’s Guide 247 . in chart format. Uses the Staffing Requirements API. in the form of useful percentages that reflect sales and budget performance.Overview of the Workforce Central Portal Configurable Retail web parts Web part Kronos Productivity Monitor Navigator Description Enables users to select date and store location parameters for data that appears in the Productivity Monitor Table and Productivity Monitor Chart web parts. Summaries of sales data. Enables users to view the data in the Staffing Requirements web part. at the job level. Uses the Schedule Coverage API. Enables users to view sales data and Key Performance Indicators (KPIs) from the Productivity Monitor. and the amount by which the scheduled coverage is over or under the requirements. Enables users to view the staffing requirements for a health care location. Enables users to view sales data and Key Performance Indicators (KPIs) from the Productivity Monitor. in table format. Kronos Productivity Monitor Table Kronos Productivity Monitor Chart Kronos Key Performance Indicators Configurable Health Care web parts Web part Kronos Navigator Description Enables users to select time period and health care location parameters for data that appears in the health care-related web parts. The data is based on the date and store locations that are specified in the Productivity Monitor Navigator web part. per patient per day. Uses the Open Shifts API. for a specific health care location. budgeted. Uses the Hours Summary API.Chapter 8 Workforce Central Portal Configuration Web part Kronos Projected Overtime Description Enables users to view the amount of projected overtime for employees in a health care location. Enables users to view data from the Volume tab in the Workload Planner. Uses the HPPD API. Enables users to view total per pay code. Data can include the actual. or budgeted. Kronos Hours Summary Kronos Volume Kronos Open Shifts Kronos Hours Per Patient Day 248 Kronos Incorporated . Uses the Projected Overtime API. Enables users to a view a list of shifts that have not yet been assigned to employees. and projected volume of patients at a specific health care location. Uses the Volume API. scheduled. The data is based on the thresholds for overtime qualification that system administrators set in the Workforce Timekeeper application. Enables users to view the number of hours worked. To create a new portal page. Before you add Web Parts. log in to the SharePoint server site as a SharePoint administrator. you must do one of the following: • • To add Kronos Web Parts to an existing portal page. and create a blank layout page. using the controls that are provided by Microsoft SharePoint Services. “Adding Kronos navigation Web Parts to a portal page” on page 250 “Adding and connecting Kronos Web Parts to a portal page” on page 252 This section contains the following topics: • • Workforce Central System Administrator’s Guide 249 . log in to the portal page as a SharePoint administrator.Adding Kronos Web Parts to a new or existing SharePoint portal page Adding Kronos Web Parts to a new or existing SharePoint portal page The Workforce Central Portal enables system administrators to add and subtract Web Parts from the portal page. select a folder to include. b. you pick one. In the Advanced portion of the dialog box. Examples of categories are Timekeeping. Two types of navigation Web Parts can be added to a portal page: • Kronos Navigation — Standard Workforce Central tab menus. If you want to include links for more than one folder. Scheduling). you specify one folder. you can use both Web Parts on a portal page. 7. 8. Click the Virtual Server Gallery link to access the list of Kronos Web Parts. However. • Note: Both Web Parts provide the ability to link to the Workforce Central application pages to which users have access. If you add the Kronos Navigation Links Web Part. When you add the Web Part to the portal page. or area of functionality (for example. Timekeeping. and Scheduling.Chapter 8 Workforce Central Portal Configuration Adding Kronos navigation Web Parts to a portal page System administrators perform this procedure. Use this Web Part to emulate the look of the Workforce Timekeeper application. Drag and drop the navigation Web Parts to the location on the portal where you want them to appear. scroll to the Kronos Navigation Links Configuration setting. which has the tab menus at the top of the application page. right-hand corner of the screen. Typically. Select Add Web Parts > Browse to browse for a Web Part to add to the portal. My Genies. Kronos Navigation Links — A list of links to the Workforce Central application. you must add an instance of the Web Part for each folder to include. 9. Each folder represents a category of available of Workforce Central functions. 250 Kronos Incorporated . In the drop-down menu for the Web Part. Select the Modify Shared Page button at the top. select Modify Shared Web Part. depending on the preferred method of navigation. To select a folder: a. To add a navigation Web Part to the portal page: 6. The access profile to which you are assigned. the items that appear to a user who accesses the portal page depend on the access profile that is assigned to the user. Workforce Central System Administrator’s Guide 251 . appear in the tab menus. Use the drop-down list to select a folder. you must add another instance of the Kronos Navigation Links Web Part. Likewise. Only the items that you can access. the menu items or links that appear depend on the following conditions: – – Whether you are currently logged on to the Workforce Timekeeper application.Adding Kronos Web Parts to a new or existing SharePoint portal page c. If you want to add links from another folder. based on your access profile. Note: You can select only one folder. Whether you add the Kronos Navigation or Kronos Navigation Links Web Part. no menu items appear. If you are not. Chapter 8 Workforce Central Portal Configuration Adding and connecting Kronos Web Parts to a portal page System administrators perform these procedures. Overview The Workforce Central Portal provides the following pre-configured Kronos retail and health care Web Parts: Retail Web Parts Kronos Productivity Monitor Navigator Kronos Productivity Monitor Chart Kronos Productivity Monitor Table Kronos Key Performance Indicators Health care Web Parts Kronos Schedule Navigator Kronos Open Shifts Kronos Staffing Requirements Kronos Hours Summary Kronos Coverage Detail Kronos Hours Per Patient Day (HPPD) Kronos Approaching Overtime Kronos Volume Many of the Web Parts must be connected to show information according to business needs. Note the following: • The Kronos Productivity Monitor Navigator and the Kronos Schedule Navigator provide the ability to select the day and business location for which data appears in the other Web Parts. To provide this ability to other Kronos Web Parts that you add to the portal page. the other Web Parts must be connected to a navigator. health care facilities must use the Kronos Schedule Navigator. Retail businesses must use the Kronos Productivity Monitor Navigator. 252 Kronos Incorporated . • Many Web Parts depend on the Kronos Staffing Requirements Web Part to provide input into the information that they show. Adding Kronos Web Parts to a new or existing SharePoint portal page The following table summarizes the relationships of the Web Parts: Web Part All retail Web Parts except the Kronos Productivity Monitor Navigator Connection Connect to the Kronos Productivity Monitor Navigator, to allow users to select a day and business location. All health care Web Parts except the Connect to the Kronos Schedule Navigator Web Part Kronos Schedule Navigator to allow users to select a day and business location. Kronos Productivity Monitor Table Kronos Productivity Monitor Chart Kronos Coverage Detail Kronos Approaching Overtime Kronos Hours Summary Kronos Volume Kronos Open Shifts Kronos Hours Per Patient Day (HPPD) Each must be connected to the Kronos Staffing Requirements, which provides staffing data used by the other Web Parts. Adding Web Parts to a portal page consists of two tasks: • • Adding the Web Parts Connecting the appropriate Web Parts Adding Web Parts to a portal page 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). Workforce Central System Administrator’s Guide 253 Chapter 8 Workforce Central Portal Configuration Connecting Web Parts 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. 254 Kronos Incorporated Customizing a Workforce Central Portal sample page Customizing a Workforce Central Portal sample page System administrators perform this procedure. You can use one of the sample portal pages that are installed with the Workforce Central Portal as a template for a new portal page. 1. After you have installed the Workforce Central Portal, log on to SharePoint as an administrator and access the Kronos portal site you created. 2. Click Web Part Pages. A list of the Kronos sample portal pages appears. 3. Select the sample portal page to customize. If you are currently logged on to the Workforce Central system, data may or may not appear in the Web Parts on the sample page. Whether data appears depends on the Web Part and whether the Workforce Central database contains the type of data that the Web Part calls. If you are not currently logged on to the Workforce Central system: a. Click Enter credentials in any Web Part on the page. The Workforce Central logon screen appears. b. Enter your Workforce Central user name and password. 4. Perform the following tasks, as necessary, to customize the portal page: – – – Use SharePoint to add and remove Kronos Web Parts from the page. Edit configuration settings for Kronos Web Parts. Create custom Web Parts to add to the portal page. Workforce Central System Administrator’s Guide 255 Chapter 8 Workforce Central Portal Configuration Using the Kronos Web Part page template to create a portal page System administrators perform this procedure. You can choose to use the empty Web Part page template that is installed with the Workforce Central Portal. The template allows you to create a Web Part page that does not include the SharePoint menu or brand identity in the header. To access the Kronos Web Part page template: 1. Log on to SharePoint as an administrator and navigate to the New Web Part Page screen. 2. In the URL that appears in the Address box at the top of the screen, change spcf.aspx to kcustspcf.aspx. An example of how the URL should look is: http://<server name>/<location_of_SharePoint_site>/ _layouts/<locale>/kcustspcf.aspx where <locale> indicates the language being used. For example, 1033 represents English; 2058 represents Spanish. The Kronos Portal New Web Part Page screen appears. 3. Enter a name for the page you are creating. The Kronos template is called “Custom Template 4 Description” and is selected, by default. 4. Click Create. The empty Kronos template appears. 5. Begin adding and configuring Web Parts to the page. 256 Kronos Incorporated Customizing preconfigured Workforce Central Portal Web Parts Customizing preconfigured Workforce Central Portal Web Parts This section contains the following: • • • • “Using SharePoint to change the title and appearance of a Web Part” on page 257 “Changing labels in Kronos Web Parts” on page 260 “Configuring the Productivity Monitor KPIs (retail)” on page 264 “Configuring the Web Part charts for compatibility with Office Web Components” on page 270 Using SharePoint to change the title and appearance of a Web Part System administrators perform this procedure. 1. Click the down-facing arrow at the top, right-hand corner of the Web Part to change and select Modify Shared Web Part. If you do not see the downfacing arrow in the top, right-hand corner of the Web Part, click Modify Shared Page and select Design this Page; the arrow should appear. After you select Modify Shared Web Part, the dialog box for configuring the Web Part appears at the right of the screen. 2. Click Appearance. 3. Configure the Appearance settings for the Web Part. Give a Title to the Web Part. The Title appears at the top of the Web Part when it appears in the portal. The rest of the Appearance settings are up to you. 4. When you are finished, click OK. Workforce Central System Administrator’s Guide 257 Chapter 8 Workforce Central Portal Configuration Using SharePoint to change Kronos-specific settings for Web Parts System administrators perform this procedure. The following table explains the Kronos Web Parts that have Kronos-specific settings that can be changed using SharePoint: Configuration settings In Box Menu Text (in the Configuration portion of the Modify Shared Web Part dialog box) Forecast Map Levels (in the Configuration portion of the Modify Shared Web Part dialog box) Web Part Kronos Process Manager Inbox Description Text that shows in the menu for the Kronos Process Manager Inbox Web Part. Kronos Productivity Monitor Navigator The number of organizational levels in the forecast map for which volume data is summarized and displayed in the retail Web Parts. For example, if the business organizational structure consists of Site and Department 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. 258 Kronos Incorporated Customizing preconfigured Workforce Central Portal Web Parts Web Part Configuration settings Description The maximum number of locations that are represented by the data that appears in the Workforce Central Portal when a user first logs in. Examples: 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 Schedule Number of Locations Navigator (in the Configuration portion of the Modify Shared Web Part dialog box) Span Name Length Limit The maximum number of characters that are allowed in the headings that represent the shift or zone, and in the (in the Miscellaneous Web Part table headings. Kronos Coverage portion of the Modify Shared Web Part dialog • For the Kronos Staffing Requirements Web Part, the Detail 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. Kronos Staffing Requirements Workforce Central System Administrator’s Guide 259 For example. Specify the appropriate setting. the arrow should appear.Chapter 8 Workforce Central Portal Configuration To change the Kronos-specific settings for a Web Part: 1. 2. click OK.Library\<locale> where <locale> indicates the language being used.xml file that contains the default values for labels. right-hand corner of the Web Part to change and select Modify Shared Web Part. 3. 260 Kronos Incorporated . The labels files are located in the following directory: <drive>:\Inetpub\wwwroot\wpresources\ Kronos.WebParts. 4. Click the down-facing arrow at the top. When you are finished. 2058 represents Spanish. Click Configuration or Miscellaneous depending on the Web Part you are modifying. click Modify Shared Page and select Design this Page. 1033 represents English. the dialog box for configuring the Web Part appears at the right of the screen. Changing labels in Kronos Web Parts System administrators perform this procedure. After you select Modify Shared Web Part. right-hand corner of the Web Part. If you do not see the downfacing arrow in the top. You can change the labels that identify information in the following Kronos Web Parts: Kronos Hours Summary Kronos Productivity Monitor Table Kronos Open Shifts Kronos Productivity Monitor Chart Kronos Approaching Overtime Kronos XML API XSLT Chart Kronos XML API XSLT Table Each of these Web Parts has a corresponding . 4. For each label you want to change.0" encoding="utf-8" ?> . and do not edit any other text in the file. Do not remove the quotation marks. 3. this is the content of the Overtime_Labels. edit the text that appears after value = .xml file that is used by the Approaching Overtime Web Part: <?xml version="1. Make a copy of the original label file and give it a new name. in case you need to restore the file.Customizing preconfigured Workforce Central Portal Web Parts For example. 2.<Labels> <Label <Label <Label <Label <Label <Label name="Name" value="Name" /> name="Violation Type" value="Violation Type" /> name="Start Date" value="Start Date" /> name="Worked Hours" value="Worked Hours" /> name="Scheduled Hours" value="Scheduled Hours"/> name="Limit" value="Limit" /> <Label name="Amount Over" value="Amount Over" /> </Labels> To change the labels for a Kronos Web Part: 1. Open the original label file in a text editor. Workforce Central System Administrator’s Guide 261 . Save and close the file. In Workforce Central Setup. Access Employee Rule Sets and edit them so that the Severity setting for the following Hours parameters is set to “Warning”: – – Max Hours per week that the employee can be scheduled Max hours per biweekly period that the employee can be scheduled 3. Ensure that the limit value for each of the preceding rules represents the corresponding threshold for overtime qualification. The Kronos Projected Overtime Web Part of the Workforce Central Portal shows the employees at the selected location who are projected to earn overtime during the specified time period. To enable this functionality. 2. Some configuration of this content is possible. 262 Kronos Incorporated . in the case of the Kronos Projected Overtime Web Part. access Schedule Rule Sets. Projected overtime is determined by adding worked hours and scheduled hours and comparing the total hours to the limits that are specified in the Employee Rule Set. make the following modifications to the Scheduler Setup: 1.Chapter 8 Workforce Central Portal Configuration Additional configuration of health care Web Parts Most of the health care content in the Workforce Central Portal is related to specific functionality in Workforce Central or to new functionality that is introduced with the portal. This section contains the following topics: • • • “Configuring the Kronos Projected Overtime Web Part” on page 262 “Configure the number of days for the Kronos Schedule Navigator Web Part” on page 263 “Configuring the Kronos Hours Summary Web Part chart” on page 264 Configuring the Kronos Projected Overtime Web Part System administrators perform this procedure. configuration is required. Dashboard. the Kronos Schedule Navigator Web Part retrieves three days of data beginning with the first day of the specified time period. Change the value attribute to the number of days’ worth of data that you want the Kronos Schedule Navigator to retrieve each time you click Apply. By default. Open the web. For more information about editing Employee Rule Sets. Workforce Central System Administrator’s Guide 263 . Configure the number of days for the Kronos Schedule Navigator Web Part System administrators perform this procedure. refer to the Workforce Central online Help. To change the number of days worth of data retrieved by the Kronos Schedule Navigator Web Part: 1.NumberofDays" value="3"/> 3. Ensure that the appropriate Employee Rule Sets are assigned to the appropriate people.config file in the Inetpub\wwwroot directory. 2. Use the Kronos Schedule Navigator Web Part of the Workforce Central Portal to specify the time period and health care location parameters for the data that appears in the health care Web Parts.Customizing preconfigured Workforce Central Portal Web Parts 4. Locate the following entry in the <AppSettings> tag: <add key="Kronos. WebParts. This file is located in the following directory: <drive letter>:\Inetpub\wwwroot\wpresources\ Kronos.xsl file. Configuring the Productivity Monitor KPIs (retail) System administrators perform these procedures.Chapter 8 Workforce Central Portal Configuration Configuring the Kronos Hours Summary Web Part chart System administrators perform this procedure. It requires the following configuration setting: Configuration Setting XSL transform file Definition An XSL file that transforms the returned XML data into viewable output (in this case.Library The following section contains instructions to configure the KPIs by editing the KPITable. in KPI format). You can edit the formulas and threshold boundaries for the KPIs. 264 Kronos Incorporated . The Kronos Hours Summary Web Part chart requires the following configuration setting: Configuration Setting XSL transform file Definition An XSL file that transforms the XML data returned by Workforce Central into viewable output (in this case.xsl file. You can also add a KPI to the Web Part. chart format). The Productivity Monitor Table Web Part of the Workforce Central Portal displays Key Performance Indicators (KPIs). by defining a custom formula that uses one or more of the variables that are defined in the KPITable. the indicator icon in the output is yellow.. <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 ". the threshold boundaries for a KPI are defined under the <!-. 3. In the KPITable.gif" alt="Green"/> Workforce Central System Administrator’s Guide 265 .IfBelow" boundary To change the threshold boundaries.xsl file.xsl file. Changing the icons that indicate KPI status 1.IfAbove" boundary Lower than the ".. edit the boundary values. The row will reference the label of the KPI. find where the output HTML <table> is defined. just after the formula for the KPI. When the outcome is above or below the boundary values.Customizing preconfigured Workforce Central Portal Web Parts Changing the threshold boundaries for a KPI In the KPITable. When the outcome is between these boundary values. The table cell will look something like this: <td> <xsl:choose> <xsl:when test="$newKpiVariable >.. 2. Find the row within this table where the KPI whose icons you want to edit are defined. Find the <td> cell that contains the XML that applies the icon to this KPI.KPI Formulas and Variables and Thresholds--> comment line.. $newKpiNameGreenIfAbove"> <img src="/wpresources/greenlight. the indicator icon is green or red. depending on how you configure the KPI output. com. If you change the label for a KPI. You can add variables.KPI Formulas and Variables and Thresholds--> comment line.xsl file (actualSales and forecastSales). Each piece of data that is returned by the default XML response file is stored as a variable within the XSL file.w3schools. Changing the formula that determines a KPI Find the <!-.Variables used in KPI formulas--> comment line. use the XSL conventions for arithmetic operations. Refer to www. as necessary. The name of the KPI is included in a comment line before the formula. To change the math in the formula. Edit the src attribute for the <img> tags to match the path to the image you want to use.gif" alt="Red"/> </td> </tr> 4. This formula refers to variables that are defined in the first part of the KPITable. it is good practice to change the name in the comment line to match the new label. within the context of the new formula. The formula for the KPI is defined as the value for the "select" attribute.Chapter 8 Workforce Central Portal Configuration </xsl:when> <xsl:when test="$newKpiVariable <.Actual to Forecast Sales --> <xsl:variable name="actualToForecastSales" select="100 * ($actualSales div $forecastSales)"/> Notice that the KPI is defined as a variable: actualToForecastSales. The formula for each KPI is defined under this heading. under the <!-. <!-. 266 Kronos Incorporated . $newKpiNameRedIfBelow"> <img src="/wpresources/redlight. NEW KPI NAME--> <xsl:variable name="newKpiName" select= "$actualHours . <!--NEW KPI NAME--> <xsl:variable name="newKpiVariable" select= "100 * ($actualSales div $forecastSales)"/> c. Refer to www. Edit the "select" attribute in the <xsl:variable> tag to use the formula for the new KPI.Variables used in KPI formulas--> comment line. as necessary. and paste it at the end of the section labeled <!-KPI Formulas and Variables and Thresholds--> (just before the HTML <table> tag). copy an existing formula. You can add variables. To define the formula for calculating the KPI: a. Each piece of data that is returned by the default XML response file is stored as a variable within the XSL file. within the context of the new formula.Customizing preconfigured Workforce Central Portal Web Parts Adding a custom KPI 1.com. including the label for the formula. under the <!-.Actual to Forecast Sales --> <xsl:variable name="actualToForecastSales" select="100 *($actualSales div $forecastSales)"/> b.xsl file. In the KPITable. Change the name in the comment line and the "name" attribute in the <xsl:variable> tag to reflect the name of the KPI you want to create. To change the math involved in the formula.$scheduledHours"/> Workforce Central System Administrator’s Guide 267 . use the XSL conventions for arithmetic operations. The following example shows new variables in a new formula: <!-.w3schools. For example: <!-. before the closing </table> tag.xsl file. including the opening <tr> and closing </tr> tags for that row. Copy an existing set of boundaries and paste it beneath the line of text that contains the formula that you just defined.Chapter 8 Workforce Central Portal Configuration 2. Add a new row to the HTML table by copying all the text in a <tr> element. b. 3. Change the name attributes in the <xsl:variable> tag to reflect the name of the new KPI.0')"/> </td> Include the threshold boundaries for the new KPI: <td> <xsl:choose> <xsl:when test="$newKpiVariable >. a. c. In the KPITable. <xsl:variable name="newKpiNameRedIfBelow"> nnn </xsl:variable> where nnn is a numeric value that represents a percentage. and pasting it on the line after the last </tr> tag. b. Create a set of threshold boundaries for the new KPI. Edit the contents of that row to include a label for the new KPI: <tr> <td>New KPI Name</td> Include a reference to the variable that stores the new KPI: <td> <xsl:value-of select="formatnumber($newKpiVariable. find where the HTML <table> is defined. a. 268 Kronos Incorporated . Add a new row to the output table and include the new KPI. and edit the threshold values to reflect the boundaries for the new KPI. <xsl:variable name="newKpiNameGreenIfAbove"> nnn </xsl:variable> where nnn is a numeric value that represents a percentage. '#. xsl file. including the opening <tr> and closing </tr> tags for that row.gif" alt="Green"/> </xsl:when> <xsl:when test="$newKpiVariable <. Workforce Central System Administrator’s Guide 269 .gif" alt="Red"/> </td> </tr> Removing a KPI In the HTML Table element of the KPITable. delete all the text in the <tr> element for the KPI that you want to remove. $newKpiNameRedIfBelow"> <img src="/wpresources/redlight.Customizing preconfigured Workforce Central Portal Web Parts $newKpiNameGreenIfAbove"> <img src="/wpresources/greenlight. xsl. chart format). Two default XSL transform files are used for health care charts: one for each chart in the health care portal sample page. c. indicate that the chart data will come from Data typed in to a data sheet. The XSL transform files transform the XML data that is returned by Workforce Central into viewable output (in this case. 270 Kronos Incorporated . using the Microsoft Chart Wizard. Follow these steps to customize a chart using this method.xsl and the other uses LaborChart. choose Insert > Web Component. • To create an OWC-compatible XSL file. a. Charts in the SharePoint portal are built by Microsoft’s Office Web Components (OWC) software. d. One uses SalesChart. Kronos recommends that you start with a chart template in Microsoft FrontPage. Open a new HTML web page. In the Commands and Options dialog box. One uses HoursSummaryBarChart. b.xsl and the other uses HoursSummaryPieChart. Create a chart template in Microsoft FrontPage.Chapter 8 Workforce Central Portal Configuration Configuring the Web Part charts for compatibility with Office Web Components System administrators perform this procedure. In Microsoft FrontPage.xsl. select Spreadsheets and charts as the component type and choose Office Chart as the control. 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. Click Finish. Therefore. the XSLT configuration files must match the format that the OWC expects. 1. In the Insert Web Component dialog box. For example: f. Paste the copied text into the SalesChart. to define borders. g. set up the headings for the chart that you want to add.xsl or LaborChart. Copy from the beginning of this line down to and including the line: <.x:ChartSpace>.Customizing preconfigured Workforce Central Portal Web Parts e. c. Include temporary placeholder data for now. with a greater than symbol (>). In the XSL file. 2. Workforce Central System Administrator’s Guide 271 . Right-click on the chart and click Toolbar to show the Chart Toolbar. b. colors. Once you have set up the chart. use Find and Replace to replace all occurrences of <. with a less than symbol (<). From the Chart Toolbar. Copy the markup of the FrontPage chart template into the appropriate file: SalesChart. Locate the following line in the code view: <. In the XSL file.xsl file./x:ChartSpace>.xsl. use Find and Replace to replace all occurrences of >. it appears on the screen. While the chart is on the screen in Microsoft FrontPage. a. d. you can select options to add a legend to the chart and to further customize the Commands and Options for the chart (for example. e. click the Code button in the bottom left-hand corner of the screen to show the code view of the chart. In the Data Sheet tab. and fills).xsl or LaborChart. replacing the existing text between the <xml> tags in that file. 272 Kronos Incorporated . In the SalesChart. enter the following XSL code to extract the data from the XML response file: { <xsl:for-each select="//LaborData[@Date]"> <xsl:value-of select=". b. Replace the list of placeholder values with XSL code that extracts the appropriate data from the XML response file.xsl or LaborChart. The result is a list that looks like this: {242.25. Link the XSL file to data in the XML response file returned by Workforce Central. your XSL may be different.xsl file. Save the XSL file and make sure that the chart Web Part refers to the appropriate configuration file./@Actual" /> . For example. If you have customized your XML request file for use with the Kronos XML API XSLT Chart Web Part. 175.Chapter 8 Workforce Central Portal Configuration 3. if you want the first set of data in the chart to represent the Actual Labor Volume for each day of the week. refer to the Workforce Central Developers Toolkit Programmer’s Guide. look for the first list of placeholder values that you added to the chart wizard. Note: You must understand the structure of the XML response file in order to write XSL to extract data from it.5. 178. </xsl:for-each>} This says that for each <LaborData> element in the XML response file that has a "Date" attribute. For more information about the relationship between Workforce Central XML API requests and responses. 194.75. the chart that you customized will show the new data. 189. as interpreted by the OWC software. c. The next time you view the portal. followed by a comma. a.5. 220}. return the value of the "Actual" attribute. 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.25. or to use your own configuration files.Customizing preconfigured Workforce Central Portal Web Parts Advanced configuration of Kronos Web Parts System administrators perform advanced configuration procedures. you need a working knowledge of: • • • Workforce Central XML APIs XML XSL Note: Creating and advanced editing of these files is beyond the scope of this guide. To make anything other than minor changes to the default files. Workforce Central System Administrator’s Guide 273 . Advanced configuration of Kronos Web Parts requires knowledge about API request files and XSL transform files. • 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. This section provides: • • • • • • Instructions for creating custom Web Parts using the default configuration files supplied with the pre-configured Kronos Web Parts Information about how the Web Parts work Basic strategy for creating new Web Parts. XSL transform file (.dwp files cannot be edited. The . For example.xslt file) — Extracts the data from the associated API request file and formats the data for viewing. You can request data from any part of the Workforce Central suite. API request files can make use of any exposed Workforce Central API. a request file can request data from a specified Genie. Workforce Central XML APIs XML XSL Advanced editing of configuration files requires a working knowledge of: How Web Parts work A Web Part is associated with two file types: • API request file (. Any changes that you make to an XML API request file must be reflected in the XSL transform file. based on a specific HyperFind query and a reporting time period. which extracts data from the XML response and formats it for viewing.dwp file which contains the code that creates the Web Part. All of the other Kronos Web Parts consist of a .xml file) — Requests information from the Workforce Central database. as 274 Kronos Incorporated .Chapter 8 Workforce Central Portal Configuration Creating custom Workforce Central Web Parts System administrators perform these procedures. • • • Unexcused absences Missed punches Unscheduled time worked Non-productive Time — Show non-productive time that was taken by employees at a business location and during a specified time period. For a complete list of Workforce Central APIs and information about the relationship between Workforce Central XML API requests and responses. This information will be presented in pie chart format. Workforce Central System Administrator’s Guide 275 . Note: The WFCGenie API allows you to retrieve data from Workforce Timekeeper Detail and Rollup Genie types only. during the current pay period. Reg and OT Hours Summary — Show pay code hours or currency totals for home employees at a specific location. Examples of Web Parts to create The following are examples of Web Parts that system administrators can create to retrieve information from the Workforce Central database: Exceptions — Show whether employees at a business location have the following exceptions during a specified time period. refer to the Workforce Central Developers Toolkit Programmer’s Guide.Creating custom Workforce Central Web Parts long as that data is supported by a Workforce Central API. This information needs to be presented in table format. grant the appropriate employees access to view and use the Genie and HyperFind query. 276 Kronos Incorporated . 3. Through function access profiles. 2. Use SharePoint to configure the Web Part to reference the XML request and the XSL transform files that you created for it. 4. find or create a Genie that includes the information you need.Chapter 8 Workforce Central Portal Configuration Basic strategy for creating a Web Part System administrators perform these tasks. Kronos XML API XSLT Table — Use this to display the custom Web Part in table format. Use SharePoint to drag one of the following Kronos Web Parts onto the portal page: – – Kronos XML API XSLT Chart — Use this to display the custom Web Part in chart format. Find or create a HyperFind query that finds employees who meet the criteria required for the Web Part. The high-level strategy for creating a Web Part includes the following tasks: 1. 5. Create an API request file that references the Genie and HyperFind query. If the Web Part needs to extract data from a Genie. 6. 7. Create an XSL transform file to format the data. This information needs to be presented in table format. perform the following procedures. Because this example requires managers to be able to see all home employees. If managers needed to view employees based on more specific criteria. Create or edit a Genie profile to include the new Genie. all managers can use the “All Home” query. Link the Genie profile to the display profiles assigned to users who need to view the information in the Web Part. The Regular and Overtime columns will hold hours totals for each employee. Creating the required Genie. three columns (Name. and profiles Use Workforce Central Setup to perform this procedure: 1. To create this Web Part. 2. HyperFind query. the predefined “All Home” HyperFind query can be used. The following instructions are based on creating this Web Part: Reg and OT Hours Summary — Show pay code hours totals for regular and overtime hours for home employees at a business location. Overtime). Create a Genie called “Reg and OT Hours Summary” whose column set includes: – – Person Name A column for each of the following pay codes: Regular. The table will have a title. Workforce Central System Administrator’s Guide 277 . By default. Regular. during the current pay period. 3. for the current pay period. you would create the appropriate query and ensure that each manager’s assigned access profile allowed access to the query.Creating custom Workforce Central Web Parts Procedures for creating a Web Part based on a Genie System administrators perform these procedures. The pay codes can have different names. Overtime Note: The pay code names are for example purposes. and rows for each employee returned by the HyperFind query. xml to another directory. make a copy of the original file and give it a new name in case you need to restore the file.xml in any text editor. You can base the API request file on an existing request file. the value 1 specifies the current pay period. For example. The value of the TimeFrameName attribute in the TimeFramePeriod tag determines the type of the time period. Refer to the Workforce Central Developers Toolkit 278 Kronos Incorporated . To create an API XML request file for the Pay Code Summary example: 1. if necessary.Library Important: Before you edit a configuration file. The API request files are located in the following directory: <drive letter>:\Inetpub\wwwroot\wpresources\ Kronos. replace the default Genie and HyperFind query names with Reg and OT Hours Summary and All Home. Open Genie. Save a copy of Genie.Chapter 8 Workforce Central Portal Configuration Creating a request file for the Reg and OT Hours Summary example Create an API request file that loads the Genie and HyperFind query. In the file. the following illustration shows the default content of the Genie. 3. Doing this ensures that you can restore the original file. and specifies a time period for which to view information.WebParts. or save a copy of the file with a new names. For example. respectively.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> The values of GenieName and HyperFindQueryName attributes specify which Genie and HyperFind query is used to retrieve data. 2. xml. Workforce Central System Administrator’s Guide 279 . specific day. For our example. 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. The time period is the attribute you specify for TimeFrameName in the XML request file for the Web Part you create. the information in the new Web Part does not correspond with the time period in the navigator Web Parts. 4. Therefore. Save and close the request file with an appropriate. or range of days.Creating custom Workforce Central Web Parts Reference Guide—Timekeeping for information on using the TimeFramePeriod tag to specify a time period. you could name the file RegAndOTHoursSummary. descriptive name. In this example. The information includes the labels specified for each column. the timeframe is “1.xml request file. Betty" Column3="null" Column4="null"/> <GenieRow Column1="3" Column2="Fryman.” which represents the current pay period. The HyperFind query specified in the request file determines which employees are included in the response file. 3 280 Kronos Incorporated .Chapter 8 Workforce Central Portal Configuration Reading the XML response file for the Reg and OT Hours Summary Web Part example The following illustration shows an excerpt of example data returned by the RegAndOTHoursSummary. Names and totals data for the pay codes included in the Genie. Mercedes" Column3="40:00" Column4="1:00"/> </GenieRows> <Period> 2 <TimeFramePeriod TimeFrameName="1"/> </Period> 3 </Genie> </Response> Number Description 1 2 Information about the columns included in the Reg and OT Hours Summary Genie for this example. Christy" Column3="null" Column4="null"/> <GenieRow Column1="4" Column2="Diaz. <Response Status="Success" ACTION="Load"> <Genie GenieName="Pay Code Summary" GenieType="Detail" HyperFindQueryName="My 1 Employees"> <GenieColumns> <GenieColumn ColumnNumber="1" Label="RowKey" Product="N/A" ExtNum="-1" Width="100"/> <GenieColumn ColumnNumber="2" Label="Name" Product="WTK" ExtNum="1" Width="100"/> <GenieColumn ColumnNumber="3" Label="Regular" Product="WTK" ExtNum="14" Width="80"/> <GenieColumn ColumnNumber="4" Label="Overtime" Product="WTK" ExtNum="14" Width="80"/> </GenieColumns> <GenieRows> <GenieRow Column1="2" Column2="Richie. Timeframe specified in the request file. the same transform file can be used for both Web Parts. if you are creating a Genie-based Web Part in table format. • If you will create multiple Web Parts that contain varying numbers of columns or types of data. The example XSL transform file in this section demonstrates this capability.xsl as a starting point for your XSL file. Note: Detailed instructions for creating and editing XSL transform files is beyond the scope of this guide. Workforce Central System Administrator’s Guide 281 . and XSL. to make the transform files as efficient and reusable as possible. missed punches and unexcused absences).xsl shows and formats the maximum number of columns that can be included in a Genie. XML. Although these Web Parts have a different number of columns and the response file returns “true” or “false” values for exceptions. For example. the Reg and OT Hours Summary Web Part example is a Geniebased table that contains four columns of hours totals data. Genie. Creating and editing XSL transform files requires a working knowledge of Workforce Central XML APIs. include logic in the transform file so that it can be used to format response files for all similar Web Parts.Creating custom Workforce Central Web Parts Considerations when creating a transform file for Genie-based Web Parts This section presents ideas to consider when you create XSL transform files for Genie-based Web Parts. you can use Genie. but use the same basic format (table or chart). instead of hours totals. consider the following basic guidelines: • You can use an XSL transform file that is delivered with the Workforce Central Portal as a starting point. When you create an XSL transform file. or create a new file. For example. You want to create another Genie-based Web Part that shows employee exceptions (for example. Which method you use depends on the nature of the Web Part you are creating and how proficient you are with XSL. you must update the XSL file to handle the changes.xsl — Shows a select number of columns from the Pay Period Close Genie PayPeriodCloseChart. refer to “Considerations when creating a transform file for Geniebased 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.xsl file and save it with an appropriate descriptive name. Make a copy of the Genie. or create a new XSL file. you could name the file GenieTableWebParts. To create an XSL file for the Reg and OT Hours Summary example. Edit the content of the file to format the content of the Web Part. If you make changes to the XML request file that changes the data returned in the corresponding response file. For general guidance. you could name the XSL file RegAndOTHoursSummary.xsl. 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.xsl. 282 Kronos Incorporated . The three default XSL files that Kronos provides are: • • • Genie. You can either make a copy of the XSL file that best serves as a starting point for the custom Web Part. perform the following steps: 1. If you are going to create an XSL file that can be used to format a variety of Genie-based table Web Parts.xsl — Shows all the columns from the specified Genie PayPeriodCloseTable. – 2.Chapter 8 Workforce Central Portal Configuration Creating an XSL transform file for a custom Web Part Kronos provides three default XSL files that you can use as templates to format the Genie data.xsl — Shows a chart that contains the percentage of excused and unexcused absences from the Pay Period Close Genie. the arrow should appear. the dialog box for configuring the Web Part appears at the right of the screen. c. The HyperFind query and time frame are specified in the request file. If you do not see the down-facing arrow in the top. b. the names of the files are RegAndOTHoursSummary. to the appropriate portal page. When you are logged on. Workforce Central System Administrator’s Guide 283 . respectively. if data does not show in the Web Part. right-hand corner of the Web Part. Log on to the SharePoint site as an administrator and perform the following procedure: a. and for the time frame. After you select Modify Shared Web Part. Click the down-facing arrow at the top.Creating custom Workforce Central Web Parts 3.xsl. Add the Kronos XML API XSLT Table Web Part that comes with the Workforce Central Portal. the new Web Part displays the data for the employees who were retrieved by the HyperFind query. For our example.xml and GenieTableWebParts. ensure that the Workforce Central system is running and that you are logged on. Click Configuration and enter the names of the XML request file and XSL transform files in the appropriate text boxes. right-hand corner of the Web Part to change and select Modify Shared Web Part. After you finish the configuration. click Modify Shared Page and select Design this Page. This Web Part is the initial template for the Web Part. xsl file works in conjunction with the default XML request file to transform the returned data into KPIs with threshold indicators. Refer to “Configuring the Productivity Monitor KPIs (retail)” on page 264 for information about configuring this file. "Load. Creating a Web Part that displays non-Genie data is similar to creating a Web Part that displays Genie data.xml file or provide your own XML API request file to retrieve data from Workforce Central. However.xsl file works in conjunction with the default XML request file to transform the returned XML data into table format.xml file requests data from the ProductivityMonitor API. the WfsoXmlApiRequest. The XmlApiXsltTable. You can modify the Date and CategoryPath attributes of the <ProductivityMonitor> tag to filter the data that is returned from the Productivity Monitor. The KPITable. 284 Kronos Incorporated . By default. To return data for a single day. the API request file references a different API. use the "LoadDrillDown" action instead of the default action." You can modify the WfsoXmlApiRequest.Chapter 8 Workforce Central Portal Configuration Creating a Web Part for non-Genie data System administrators perform these actions. and the employees or business locations for which to retrieve the data. You can request data from any part of the Workforce Central suite.xsl file works in conjunction with the default XML request file to transform the returned XML data into chart format. For instructions on how to set up an XSL transform file for a chart and to design a chart. You can modify the Date and CategoryPath attributes of the <ProductivityMonitor> tag in order to filter the data that is returned from the Productivity Monitor. The default XML API request file is WfsoXmlApiRequest.xml. For a complete list of Workforce Central APIs and how to use them. as long as that data is supported by a Workforce Central API. Use the Kronos XML API XSLT Chart Web Part to add a Kronos Web Part that displays data in chart format. To return data for a single day. The Kronos XML API XSLT Chart Web Part requires the following configuration settings: Configuration Setting XML API request file XSL transform file Definition An XML file that requests data from the Workforce Central database. refer to “Configuring the Web Part charts for compatibility with Office Web Components” on page 270. An XSL file that transforms the XML data returned by Workforce Central into viewable output (in this case. in chart format).xml file requests data from the ProductivityMonitor API. By default. You choose the data to retrieve. refer to the appropriate Developer’s Toolkit Reference Guide." The XmlApiXsltChart.Creating custom Workforce Central Web Parts Creating a Web Part using the Kronos XML API XSLT Chart System administrators perform this procedure. "Load. the time period for which to retrieve the data. Workforce Central System Administrator’s Guide 285 . the WfsoXmlApiRequest. use the "LoadDrillDown" action instead of the default action. You can modify this file or provide your own XML API request file to retrieve data from Workforce Central. Then. and column 7 holds the wage rates for employees. multiplying a wage rate by the number of hours worked. The following illustration is an excerpt from an XSL transform file for Web Part that lists employees.5 hours.Chapter 8 Workforce Central Portal Configuration Note: All changes that you make to the XML request file must be reflected in the XSL transform file.00').'.substring-after(substring-after(@Column6.':').##'). Performing mathematical calculations using two or more values that are returned by the XML request file.00')"/> </xsl:otherwise> The calculation includes dividing the minutes portion of each hours total by 60 to convert minutes to decimal format. Including logic to perform calculations in a Web Part You can include logic in an XSL transform file to perform mathematical calculations.'. For example. column 6 is the column in the Genie that holds vacation hours totals for employees. changing 5:30 to 5. their vacation balances. For example. In the example.'###. and vacation pay liability. Examples include: • • Converting an hours total value that uses hours:minutes format to a decimal value. Refer to the Workforce Central Developers Toolkit Programmer’s Guide for more information.###.'.'######. <xsl:otherwise> $<xsl:value-of select="translate(format-number(@Column7 * format-number(concat(substringbefore(@Column6.')). 286 Kronos Incorporated . The XSL contains logic that converts hours totals in hours:minutes format to decimal format and multiplies a pay code balance by the employee’s wage rate.'0.'NaN'. the converted hours total is multiplied by the employee’s wage rate.':') div 60. including colors. If you change the visual theme of the Workforce Central system. or the Workforce Central visual theme (if you have applied it to the Workforce Central Portal page). Other elements of the Web Parts. inherit the corporate visual theme. such as the title and the border. Notes: • The Workforce Central Portal uses a default Kronos visual theme. you can apply that theme to the Kronos portal page that you create using the Workforce Central Portal. and graphics.Visual theme for the Workforce Central Portal and Kronos Web Parts Visual theme for the Workforce Central Portal and Kronos Web Parts The Workforce Central system allows system administrators to create a custom visual theme by changing nearly 150 visual properties. • – Workforce Central System Administrator’s Guide 287 . If you add Kronos Web Parts to an existing corporate portal: – The content of the Kronos Web Parts reflects the Workforce Central visual theme. logos. fonts. The visual theme is the default theme for the Workforce Central Portal. The properties are stored in a style sheet that is used by all Workforce Central products that are installed with a Workforce Central application server instance. Make a backup copy of the file and save it with a new name. For example. Open the original Help topic in a text editor. For example.html. Locate the Help topic to edit. Help topics for Kronos Web Parts are HTML files. You can customize the information in Web Part Help topics. 1033 is English and 2058 represents Spanish. 288 Kronos Incorporated . You can also customize the content of the Web Part’s Help topic to describe the information in the new display. Each Workforce Central Portal Web Part includes a context-sensitive Help topic that a user can view by clicking Help on the drop-down menu for the Web Part. For example. For example. you want to update the related Help topic to indicate the number of organizational levels for which volume data is summarized and displayed in the retail Web Parts. suppose you changed the Forecast Map Levels configuration setting for the Kronos Productivity Monitor Navigator Web Part. Now. To customize a Web Part Help topic: 1. 3. the Help topic file for the Kronos Productivity Monitor Navigator is called Productivity_Navigator.Chapter 8 Workforce Central Portal Configuration Customizing and creating Web Part Help topics System administrators perform this procedure. 4. 2. Customizing Kronos Web Part Help topics You can customize a Kronos Web Part that is delivered with the Workforce Central Portal. ORIGINAL_Productivity_Navigator. Navigate to the following directory: drive_letter:\Inetpub\wwwroot\wpresources\ Kronos.WebParts.html.Library\help\locale where locale is a directory with a numeric name that indicates the language version of the Workforce Central Portal that is installed. and create Help topics for Web Parts you create. In the following example.</span> Important: Do not alter any other text in the HTML file. Workforce Central System Administrator’s Guide 289 . scheduled. and actual sales and labor information. Save the file in the original directory. When you display the Help file for the Web Part on portal page. you will see the changes. The text is located near the end of the file and is enclosed by <span> tags. Locate the text in the Help file. 6. 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.Customizing and creating Web Part Help topics 5. and with a name that reflects the content of the custom Web Part. scheduled.</span> Important: Do not any other text in the HTML file. For example.html). In the following example (Productivity_Navigator.Library\help\<locale> where <locale> is a directory with a numeric name that indicates the language version of the Workforce Central Portal that is installed.Chapter 8 Workforce Central Portal Configuration Creating and linking a Help topic to a custom Web Part If you create a custom Web Part. 4. Locate the text in the Help file. 3. and actual sales and labor information. you can create a Help topic for the Web Part and link the topic to the Web Part. Open one of the HTML files in a text editor. Use Save As to save the file into the same directory. save the file. 2. After you have edited the text. Navigate to the following directory: <drive letter>:\Inetpub\wwwroot\wpresources\ Kronos. the text that you can change is bold to clarify what you can change in the file: <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.WebParts. 1033 is English and 2058 represents Spanish. Creating a Help topic 1. The text is located near the end of the file and is enclosed by <span> tags. 290 Kronos Incorporated . 5. In the drop-down menu for the Web Part. In the Advanced portion of the dialog box. select Modify Shared Web Part. 4. 3. Workforce Central System Administrator’s Guide 291 . Enter the path and name of the custom HTML Help topic you created. 5. you must link it to the Web Part. the custom Help topic you created appears. Close the dialog box. 2. 1. Add the custom Web Part to the portal page. scroll to the Help Link text box.Customizing and creating Web Part Help topics Linking a Help topic to a custom Web Part After you have created the Help topic for the custom Web Part. When you select Help from the drop-down menu for the Web Part. ” The following error message appears: “XML API Error: The value for the property is not valid . The following error message appears: “XML API Error: This user is not authorized to perform the action or it is not a valid action name within the bean . or the value could not be found–for example. or both. 292 Kronos Incorporated . the requested volume driver doesn’t exist. delimiter. Action: Load. Make sure that the user’s Function Access Profile allows access to the Workforce Manager > Scheduling > Forecasting access control point.” Description/Solution The user is not authorized to access the Workforce Central XML APIs. must end with the &apos.Name: VolumeDriver. 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 The following error message appears: “XML API Error: The user is not authorized to use the XML service. %. The user does not have access to the data requested in the API. or @).. Workforce Central Portal users can access the same information using the portal as they can when they use the full Workforce Central application.Chapter 8 Workforce Central Portal Configuration Troubleshooting In general.Bean: ProductivityMonitor. The user has attempted to log in using a user name or password that contains special characters (for example.. Make sure that the requested volume driver exists in the Workforce Central database.” The user is not authorized to access the data requested by the API. &. #. Value: some_value. Make sure that the API > XML access control point is set to “Allowed” within the user’s Function Access Profile.” The following error message appears: “XML API Error: The reference to entity . Make sure that the user’s Function Access Profile allows access to the Workforce Manager > Scheduling > Forecasting access control point. Ask a Workforce Central system administrator to change the user name or password. Blank or unexpected columns appear in a Web Part that contains Genie data. Modify the XSL transform file to reflect the new Genie column set.Troubleshooting Issue The following error appears after a user attempts to log in: “An incorrect user name or password was entered. click the Advanced button and then enter the Workforce Central application server URL (for example. If necessary. A Genie column number has changed since the Web Part’s XSL transform file was configured. Workforce Central System Administrator’s Guide 293 . Compare the value of the MenuText attribute in the Web Part’s configuration file with the text of the same link in the Workforce Central navigation menu. Make sure that the user’s Function Access Profile allows access to the Workforce Central XML APIs. The name of the link has changed in Workforce Central since the link or tab was configured. click Sites. select Tools > Internet Options. This results from a change to the Genie column set in Workforce Central Setup. A prompt for a user name and The Web browser’s security setting is not allowing the request. Please try again. These values must be the same. Add the Workforce Central application server URL to the list of sites in the local intranet zone: In the Internet Explorer window. http:// application_server_name) and click Add. or the user does not have permission to access the component in Workforce Central. Make sure that the user’s access profile allows access to the selected Workforce Central component. In the Security tab.” Description/Solution The user entered incorrect values or is not authorized to use the APIs. password appears when the user clicks on a tab.” The following error appears during navigation from the portal to the Workforce Central application server: “You do not have permission to access the requested resource. Chapter 8 Workforce Central Portal Configuration Issue The following error message appears: “XML API Error: The value assigned to the property could not be found . the Workforce Central Inbox in the full application shows only Active tasks from the last 30 days. Kronos recommends viewing the Workforce Central Portal from a web browser that is installed on a desktop operating system.” 294 Kronos Incorporated . Some versions of Internet Explorer are for use only on server operating systems. Genie. You can modify the number of days included in the count by editing the following property: wba. This results from a change to the Genie name in Workforce Central Setup. Modify the XSL transform file to reflect the new Genie name.wf. When Workforce Central Portal is accessed using certain versions of Internet Explorer installed on a Windows 2003 Server. and therefore are configured differently from browsers on desktop operating systems.2.2 the Workforce Central Portal and Workforce Central Portal version 5. security issues can occur. Description/Solution The name of the Genie has changed since the Web Part’s XSL transform file was configured. and you have components: customized any XML calls to the Genie API. Value: some_value. The user cannot edit any Web Parts on an existing Web Part page. The count in the Kronos Process Manager Inbox Web Part represents all tasks associated with the user.Name: GenieName.” The user cannot delete an existing Web Part page. By default. you must change the name of the API in the XML request files “Cannot create the object from Genie to WFCGenie.tasklist.defaulttaskdays The following error appears in If you are upgrading to Workforce Central version 5. The count of notifications in the Kronos Process Manager Inbox Web Part is different from the count in the Workforce Central Inbox. Description/Solution The XML syntax in the web.config file. Workforce Central System Administrator’s Guide 295 . and that each tag is nested properly. Make sure that all the tags in the file are balanced with opening and closing tags.Troubleshooting SharePoint Issue Attempting to navigate to the Workforce Central Portal site URL causes an application error that references the web.config file is invalid. Chapter 8 Workforce Central Portal Configuration 296 Kronos Incorporated . These values help you to configure your system quickly. 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 Kronos provides predefined data to simplify the task of configuring your system. You cannot modify other predefined data. You can modify some predefined data. such as the default logon profile. such as labor levels. 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 2. Click one of the following Workforce Genies. A <name> Genie window opens and lists the predefined entries. Workforce Genie Accrual Detail Detail Predefined Entry Accrual Reporting Period Activity Employee Detail Activity Employee Status Activity Event Details Attendance Genie Biometric Status Current Event Details IS Summary Orphaned Event Details Pay Period Close Reconcile Timecard Shift Close Shift Start Schedule Group Detail Roll-up Schedule Group Roll-up QuickFind Schedule Editor Schedule Group Assignment Activity Event Rollup Schedule Group Roll-up QuickFind Schedule Editor 298 Kronos Incorporated Workforce Genies Workforce Genie Schedule Assistant Schedule Planner Leave Case Detail Predefined Entry Schedule Assistant Schedule Planner Leave Cases Leave Hours 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. Predefined Values IS Summary Values Set for This Genie • • • • • • • • • • • • • • • • • • Default HyperFind Query is All Home. Default Time Period is Current Pay Period. Column Set is IS Summary. Default HyperFind Query is All Home. Default Time Period is Previous Pay Period. Column Set is Pay Period Close. Default HyperFind Query is All Home. Default Time Period is Yesterday. Column Set is Reconcile Timecard. Default HyperFind Query is All Home. Default Time Period is Today. Column Set is Shift Close. Default HyperFind Query is All Home. Default Time Period is Today. Column Set is Shift Start. Default HyperFind Query is All Home. No Default Time Period is selected. Column Set is Schedule Group Detail. Default HyperFind Query is All Home. Default Time Period is Current Schedule Period. Column Set is Schedule Group Roll-up. Default Time Period is Week to Date. Column Set is Quickfind. Pay Period Close Reconcile Timecard Shift Close Shift Start Schedule Group Assignment Schedule Group Roll-up • • • Quickfind • • Workforce Central System Administrator’s Guide 299 Appendix A Predefined Data Predefined Values Schedule Editor Values Set for This Genie • • • • • • • • • • • • • • • • • • • • Default HyperFind Query is All Home. Default Time Period is Current Schedule Period. Default Column Set is Schedule Editor. Default Interval is Daily Intervals. Default HyperFind Query is <None>. Criteria Set is Eval Rule Set Group Default. Column Set is Schedule Assistant. Default HyperFind Query is All Home. Default Time Period is Current Schedule Period. Default Main tab is Employee. Column Set is Scheduler Planner. Default Schedule Assistant tab is Schedule Assistant. Schedule Assistant is Schedule Assistant. Default Interval is Daily Intervals. Default HyperFind Query is All Home. Default Time Period is Current Pay Period. Column Set is Leave Cases. Default HyperFind Query is All Home. Default Time Period is Current Pay Period. Default Column Set is Leave Hours. Schedule Assistant Schedule Planner Leave Cases Leave Hours 300 Kronos Incorporated HyperFind query 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. Predefined Values All Home Definition This HyperFind query defaults to include a manager’s employee group and/or Organizational group. All Home and Scheduled This HyperFind query defaults to include all employees in Job Transfers the user’s Employee Group and/or Organizational group, as well as those with jobs that are scheduled in the user’s organizational group. All Home and Transferred-in This HyperFind query defaults to include all employees in the user’s Employee Group and/or Organizational group, as well as those who are transferred-in to the user’s group. To add a new HyperFind query, click New on the menu bar. To edit an existing query, select an entry from the list, then click Edit. Workforce Central System Administrator’s Guide 301 Appendix A Predefined Data Workforce Genie profile To access the Workforce Genie profile, in the Setup workspace, select Display Preferences > Display Profile Building Blocks > Workforce Genie Profiles. The Workforce Genie Profile window opens and displays the list of profiles on your system. To access the predefined Super Access profile, click its name. Kronos Global Support uses the Super Access profile, which provides access to all Genies in a specific order. You can edit the predefined Super Access profile. 302 Kronos Incorporated People 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. Workforce Central System Administrator’s Guide 303 Appendix A Predefined Data 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. Predefined Values Default Definition This profile has the following settings: Password • • • The password is set to expire in 30 days. The minimum length is at least six characters. Reuse monitoring is set to remember the previous ten passwords. Session Restrictions • • • Super Access 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. 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. 304 Kronos Incorporated You can use Process Administrator to do the following: • • • • • View the status of all processes and tasks. View and analyze statistics for processes and tasks. Monitor resource workloads. delete. or mark tasks as done. and restart processes. select System Configuration > Process Management > Process Administrator from the Setup workspace. Abort or reassign tasks. Abort. To start the Process Administrator. Use Process Administrator to manage processes and tasks that are active in your system.Appendix B System Administration of Process Manager This appendix contains the following sections: • • • • • “Managing processes with Process Administrator” on page 306 “Managing tasks in a process using Process Administrator” on page 311 “Monitoring resources using Process Administrator” on page 317 “Troubleshooting Process Manager” on page 318 “Enhancing Process Manager performance” on page 319 Process Administrator enables you to manage the processes that you implement with Process Designer and Workforce Central across the organization. . Appendix B System Administration of Process Manager Managing processes with Process Administrator Use Process Administrator to manage all the processes that are active in your system. Click the Refresh button on the tab. click the All Processes tab. Activated-All Activated-w/Aborted Shows all processes that have be activated and have one or Tasks more aborted tasks. Shows all processes that have completed. Viewing the status of all processes To view the status of all processes: 1. 2. view the following process information: Column ID Process Name Description The ID of the process. 306 Kronos Incorporated . Aborted Completed Templates Shows all processes whose root task has a state of ABORT. Shows all processes that have been activated. 4. 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. The name of the process. Select or clear one or more of the check boxes to filter the list of processes that is displayed: Filter Ready Description Shows all processes that are activated and available but have not been started by a user. In the table displayed on the tab. Shows all process templates 3. From the Process Administrator. State Aborted Tasks Template ID Indicates whether the process contains aborted tasks. or aborted. The ID of the template that was used to initiate the process. READY — the process template is activated and available but has not been started by a user. ABORT — the process has been stopped. DONE — the process has finished. 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. because the process has an earliest start date that has not yet arrived. It is used when the process is designed to reference templates that are included as subprocesses. Unique Key Description The unique key that is assigned to process templates of the same type. or the process has an instance in the pool. Workforce Central System Administrator’s Guide 307 . After you examine the process information. It is also used to ensure that templates of the same type do not have overlapping effective dates. 5. Note that any aborted task in a process will cause the entire process to move to the ABORT state. The state of a process in the system: ACTIVE — the process has been started in the system.Managing processes with Process Administrator Column App. Click Abort and then click Yes in the confirmation message box if you are sure that you want to abort that process. Select the appropriate filtering check boxes and click Refresh. Select the process or processes that you want to delete. 2. The screen automatically refreshes to display the change in status for the process. In the Setup workspace.Appendix B System Administration of Process Manager Aborting a process If a process is not working properly or if it needs to be halted. you can use Process Administrator to restart it. To delete a process: 1. 3. or abort. 3. To delete a process template: 1. click the All Processes tab. The availability of certain functions depends on the state of the process. you can use Process Administrator to abort that process. Click Delete and then click Yes in the confirmation message box if you are sure that you want to delete that process or processes. When the process is ready to resume. select System Configuration > Process Management. click the All Processes tab. From the Process Administrator. The screen automatically refreshes to display the change in status for the process or processes. Note that the availability of certain functions depends on the state of the process. From the Process Administrator. 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. Select the process that you want to stop. 4. 308 Kronos Incorporated . 2. 4. Select the appropriate filtering check boxes and click Refresh. To abort a process: 1. you can use Process Administrator to delete the unneeded process. This means that the template will no longer appear in the Process Templates editor and cannot be included in a Process Profile. 4. Workforce Central System Administrator’s Guide 309 . Restarting a process When a previously aborted process is ready to resume. click the All Processes tab. delete all the processes using the template. To delete a logically deleted process template: 1. you can use Process Administrator to restart it. Note that the availability of certain functions depends on the state of the process. Click Restart. 3. 5. 2. Delete the process template. In Process Administrator. Select the process that you want to restart. Use the Remove button to delete the template from the profile. the template is logically deleted. The screen automatically refreshes to display the change in status for the process.Managing processes with Process Administrator 2. From the Process Administrator. 7. select the profile that you want to edit. 3. Delete the process template from the Template List. To restart a process: 1. Under Profile Name. Click Process Profiles. From the Process Profiles menu bar. click Edit. 6. 2. Click Process Templates. 4. Select the appropriate filtering check boxes (include Aborted) and click Refresh. Note: If a process template is deleted and the processes that use the template exist in the database. A list of resource IDs and names along with the corresponding tasks and statuses: active. for all processes. and aborted processes. The activation status. How many tasks are assigned to employees. which indicates how many people are using the system. 310 Kronos Incorporated . How many processes have been run within a certain period of time. completed. so you can adjust an employee’s workload by reassigning the tasks to other employees. along with a count. or assigned. completed. by status. and a count of all resources associated with the processes.Appendix B System Administration of Process Manager Viewing process reports Reports can provide the following kinds of information to help you manage processes on your system: • • • The number of activated. click the Reports tab and select the check box to indicate which data you want to see: Report Summary Processes Processed Resource Workload Description A count of all processes. To view process reports from the Process Administrator. unactivated. State Analysis Detail A read-only view of the process in plain text. See “Graphical Detail view” on page 312 for more information. See “State Analysis Detail View” on page 313 for more information. isolate a problem that is causing a particular task in the process to fail. Process Resources A read-only list of resources who are participating in the process. identify a resource to whom you want to send a message about a particular task. View Tabular Detail Description A table of all process tasks and their properties. 3. This is the only view in which you can use the available functions to change the status of certain tasks. XML Detail A read-only view of the process in XML. Viewing and changing the status of tasks in a process To view or change the status of tasks in a specific process: 1. • The state of the task and a brief explanation about that status. From the Process Administrator. for example. Use the Process Resources view to. 2. Workforce Central System Administrator’s Guide 311 . Select one of the following views.Managing tasks in a process using Process Administrator Managing tasks in a process using Process Administrator Use Process Administrator to manage tasks within processes that are active in your system. Select the process name. Note that you can make changes to tasks in a process only through the Tabular Details view. Graphical Detail A read-only graphical representation based on the process template in use. See“Tabular Detail view” on page 312 for more information. Each line represents a task and contains the following information: • Name and ID of the task. for example. click the Process Details tab. Use the XML Detail view to. A list of IDs for tasks that must finish before this task can begin. Name of the task. ABORT — The task has been aborted. The earliest start date (ESD) at which the task can begin. A resource is currently working on the task. The time at which the task finished. The time at which the task began. One of the following states: • • • • • ACTIVE — A resource is currently working on that task. Green — The task is active. The ID of the parent task in the task hierarchy within the process. 312 Kronos Incorporated . Red — The task has been aborted. PASSIVE — The task is passive in the sense that it will not execute. Brown/Black — The task is done. color-coded bars on the tasks indicate the following: • • • • Blue — The task is ready but a resource has not worked on it. because it is the false (“No”) condition of a Branch task. The ID of the process template that contains the task. in milliseconds. Graphical Detail view In the Graphical Detail view.Appendix B System Administration of Process Manager Tabular Detail view The Tabular Detail view provides the following task information: Field Task ID Name State Description ID of the task as assigned by the Process Engine. DONE — The task has been completed. by design. Duration Start date End date Earliest SD Predecessors Parent ID Template ID Amount of time it took for the task to finish. READY — The task is ready but a resource has not yet begun work on it. click the Process Details tab. From the Process Administrator. From this view.Managing tasks in a process using Process Administrator State Analysis Detail View Use the State Analysis Detail view to. or to resolve an issue with an aborted task. Select the process name. for example. determine why a particular task has not been completed.) Workforce Central System Administrator’s Guide 313 . you use the Tabular Detail view on the Process Details tab: 1. (See the Workforce Central Process Manager Programmer’s Guide for specific information about modifying a process template to control the reassignment of tasks. 2. 3. Select the Tabular Detail view. Reassigning a task to another resource To balance resource workloads and remove bottlenecks from a process. 4. you may need to reassign a task from one resource to another. you can perform the following actions: Action Set Done Force Done Force Ready Reassign Properties Description Changes the state of any active task (except a root task) to DONE Changes the state of any aborted task (except a root task) to DONE Changes the state of any aborted task (except a root task) to READY Allows you to reassign the task to a different resource ID Displays the properties of the task The following sections describe each action. You may also be asked by an authorized employee or manager to reassign a task if a process template has been configured to prevent individuals from reassigning their tasks from the Tasks tab of their Inbox during that particular business process. Changing the status of tasks in a process To change the status of tasks in a specific process. 3. 5. (If the Reassign function is not active. 4. 1. if the task is ACTIVE. it means that you cannot reassign a task in that state. 2. If you are the administrator who was assigned in the Business Automation system setting to receive Process Manager error notifications. From the Process Administrator. Select the process name. Marking a task as done If an aborted or active task is no longer necessary for the completion of a particular process and you do not want that task to impede the progress of the process. 7. Select the process name. To reassign a task: 1. From the Process Administrator. 2. Select the Tabular Details view.Appendix B System Administration of Process Manager For example. Click Submit. for example. You can then use Process Administrator to reassign the task to an appropriate individual.) 6. 3. you will receive a message about this failed task. click the Process Details tab. 4. you can mark that task as DONE so the process can continue to the next task. the associated task in that process will fail. click the Process Details tab. Select the Tabular Details view. Select the row that contains the task. Enter the ID for the resource that you want to reassign the task to. if a resource in a process does not have an assignment in the Reports To field. Select the row that contains the task and then click one of the following: – – Force Done — Changes the state of any aborted task (except a root task) to DONE Set Done — Changes the state of any active task (except a root task) to DONE 314 Kronos Incorporated . Click Reassign. Changing the status of a task to READY If a problem with a previously aborted task has been solved and you want to make that task available again in the process. 2. Workforce Central System Administrator’s Guide 315 . To view statistics for tasks in a specific process: 1. Process Administrator automatically refreshes the screen to display the status of that task in the State column as READY. From the Process Administrator.Managing tasks in a process using Process Administrator Process Administrator automatically refreshes the screen to display the status of that task in the State column as DONE. From the Tabular Details view of the Process Details tab. From the Tabular Details view of Process Details tab. For example. Click the Properties button on the menu bar. Viewing task statistics for a process To identify bottlenecks in a process or other problem areas. you can modify that task in the process template to either increase the amount of allotted time or reduce the scope of that task. Process Administrator displays the properties of that task as set in the Process Designer template. if the statistics show that a particular task took significantly more time to finish than was originally planned for. select the row that contains the task that you want to mark as READY. 1. you can use this view to see if there is an error message. you can change the status of that task to READY. you can view statistics for tasks in a specific process. if a task has aborted. For example. click the Process Analysis tab. 1. Click the Force Ready button on the menu bar. select the row that contains the task that you want to examine. 2. Viewing the properties of a task You can view the properties of a task to help resolve problems with a process. Task Template ID The ID of the task template. 3. This is specified in Process Designer. on the General Properties tab of the task in the template. Average number of milliseconds it took for this task to finish. In the table displayed on the tab.Appendix B System Administration of Process Manager 2. Maximum number of milliseconds it took for this task to finish. Minimum number of milliseconds it took for this task to finish. Average percentage of the process execution time it took for this task to finish. Select a process from the Template drop-down list on the menu bar. you can view the following statistics to help identify bottlenecks in the process: Column Task Name Planned Duration Description The name of the task. The amount of time allotted to this task when the process template was designed. Avg % Time Avg Time (ms) Min Time (ms) Max Time (ms) 316 Kronos Incorporated . The Engines tab displays the following statistics to help monitor process resources in a clustering environment: Column Server Engine Status Threads in Use Total Threads Description Name or IP address of the application server that is running a Process Engine. described on page 310.” Number of threads in use on the Process Engine.Monitoring resources using Process Administrator Monitoring resources using Process Administrator You can monitor and manage the workloads for all resources associated with the processes in your system by using these previously described Process Administrator features: • • The Reports tab. VM Mem Usage (KB) VM Total Mem (KB) Click the column name to sort the table on that column. described on page 313. Kilobytes of memory available for the Java virtual machine. After conferring with a manager. As a result. Total number of threads available. The data in the columns is refreshed when you click the Engines tab or when you click the Refresh button at the top of the page. Workforce Central System Administrator’s Guide 317 . The Reassign function in the Tabular Detail view of the Process Detail tab. several processes are not progressing because that resource’s tasks have not been completed. if you click the Reports tab and review the Resource Workload data. This number is determined by the following system setting: wba. you might observe that one resource has many more active (uncompleted) tasks than another. especially in a clustered environment. A useful tool for monitoring process resources. is the Engines tab. For example. Status of the Process Engine on the application server: “running” or “paused.processengine. you might be asked to reassign certain tasks from the overloaded resource to a less burdened resource.threadpoolsize Kilobytes of memory in use by the Java virtual machine. Click task list.” failed. Use Process Administrator to locate the API failure.Appendix B System Administration of Process Manager Troubleshooting Process Manager The following table summarizes some common process template issues and how to resolve them: Problem Solution User receives the error message “This The user should click Refresh to update his or her task may no longer be available. Process Designer.Process for non-Engine issues. Tip: You can also use the WFC. If the error still appears.log to troubleshoot. Process Manager information has the context WBAP. an API task has Refresh to update your task list. and WBAP. 318 Kronos Incorporated . A process template does not appear in Be sure that you deployed the template from the Process Templates editor. Messages are not being sent to external SMTP e-mail addresses. Be sure the E-Mail and Messaging tabs in the system settings are configured to send mail to the SMTP e-mail address.ProcessEngine for Process Engine issues. Support for clustering includes a Cluster Manager system service. Clustering Clustering allows multiple Process Engine instances to simultaneously access and monitor the same set of processes.clustermanager. Workforce Central System Administrator’s Guide 319 . How clustering works With clustering.eligible Business Automation system setting. In a clustered environment. and the ability to implement load-balancing in process applications via Process Manager. simplified support for multiple client application instances. See “Setting up Cluster Manager” on page 320 for more information. This is achieved by configuring the Process Engines to access the same database and coordinate with one another through the Cluster Manager. Each application server is eligible (by default) to host the Cluster Manager. Benefits of a cluster include scalability. the ability to start and stop Process Engines as a cluster using Event Manager. If a Process Engine is not available on that server. Cluster Manager ensures that the request is serviced by one (and only one) Process Engine to advance the process to the next task that requires input. process requests from Workforce Central applications such as Workforce Scheduler are submitted to the local Process Engine on the application server the request was made from.Enhancing Process Manager performance Enhancing Process Manager performance Process Manager includes two ways to enhance performance: clustering and pooling. based on the wba. work can be distributed on up to 8 application servers each running a process engine. All of the Process Engines in a cluster connect to the same database server. and the addition of an Engines tab to Process Administrator to monitor each engine in the cluster. Cluster Manager will direct the request to an engine on another application server. depending on how many are needed for your organization. specify false for this setting on those servers. Note: You must have a Cluster Manager. you must configure the Workforce Central System Settings on the machine that you designated as the Cluster Manager during installation. Managing the clustered Process Engines Use the Engines tab of the Process Administrator application to monitor Process Engines. • For more information about the Process Manager system settings. the other Process Engines will automatically register with the new Cluster Manager without requiring you to restart a server. To set up Cluster Manager. If that machine should require scheduled maintenance or experience a system failure.clustermanager. view individual process instances. The scheduled engine stop or restart event coordinates a Process Engine shutdown for all of the Process 320 Kronos Incorporated . such as payroll processing time. An engine pause should be scheduled during peak Workforce Central server loads. which provides failover protection in that any server is automatically eligible to assume the role of Cluster Manager if there is a system failure.eligible — The default setting is true.Appendix B System Administration of Process Manager Setting up Cluster Manager Cluster Manager is a service that runs on one machine in the cluster. 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. wba.rmiregistry.port — The port on which to start the Cluster Manager. even in a single-server environment. If you want to exclude particular servers from functioning as the Cluster Manager. and manage the deployment and pooling of process templates. Use an Event Manager application to schedule engine pause times and stop and restart events. see “Business Automation settings” on page 99. Cluster Manager can run on any of the other application servers as well. In the Setup workspace. If the pool is depleted before the next pool building event. because the work to create a process instance has already been done. Only Workforce Central applications that rely on Process Manager are affected during this period. select System Configuration > Process Templates. Select the template that you want to create a pool for. The pool is then reduced by one. The pool building event should be scheduled regularly (such as daily) during an off peak time. 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. a preallocated process instance from the pool will be used. During the pool building event. if a request for a new process instance is made. Workforce Central System Administrator’s Guide 321 . the pool is adjusted down. all actively deployed process templates with pool size greater than zero will be instantiated in the database for future use. During regular operation of the Workforce Central applications. This reduces the response time and database load. other applications will continue to operate normally.Enhancing Process Manager performance Engines in the cluster. Pooling reduces the database CPU load. 2. 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. Click Edit. Setting up process pooling To set up process pooling: 1. 3. If the pool for a given process already exists and is larger than the current pool specified for that process template. then the standard process allocation is used. processengine.maxpoolsize setting. In the Max Pool Size text box. Run the pool builder at non-peak hours to avoid poor performance. 6. indicate the maximum pool size for the template. 5. If you do not want to use a pool. For more information about the Process Manager system settings. In the Setup workspace. the Pool Manager will create template pools whose size is the lesser of the values. enter 0 (zero).server. If the Max Pool Size value on the Process Templates page and this Max Pool Size system setting are not the same.Appendix B System Administration of Process Manager 4. 322 Kronos Incorporated . Use an event manager application to schedule pool building. 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. see “Business Automation settings” on page 99. select System Configuration > System Settings > Business Automation and then set the default maximum pool size per server in the wba. date and time. 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 . In version 6. but install languages using a language pack CD. and currency formats that are appropriate for most North American English-language environments. Workforce Central regional settings support text.0. This appendix provides information about how to implement other languages and formats. you no longer select languages during installation.Appendix C Regional Settings By default. Configuration Manager enables you to select one or more languages to deploy to an instance. using system settings. but you can configure the instance. you can deploy many languages to one instance. number and currency formats. You must then configure each instance individually. time. The language CD has a single installation program that can install one or more of the languages on the CD. a program called Configuration Manager starts. you must then configure the needed system settings to display date.Appendix C Regional Settings Workforce Central language packs In version 6. date and time formats. when you install Workforce Central.0. No settings. are modified when the language is deployed. After the installation of the language. After the language CD is installed. the product installs English language files. to run only language. The language pack is a CD that contains a set of language files available for translated products.) Languages are installed onto a server once. 324 Kronos Incorporated . or display themes. you can install a language pack. (Currently. If you need other languages. such as language and country. although the supported languages vary. and Latin 9 character sets to co-exist in the same database. such as language and country. depending on the database. Unicode Unicode encompasses more than 100. based on the database version. Latin 2. except bi-directional (right-toleft) languages. however they support only Latin 1. System settings and driver set up are handled during the installation process.Character set support Character set support Workforce Central v6. and Latin 9 characters sets. Can be set up using Unicode. and display themes after installation. Workforce Central v6. such as Hebrew and Arabic. You must configure settings. Database Oracle 10gR2 Characters supported All characters within Unicode. Latin 2. Regardless of the databases in use. The following table lists the characters supported by the databases. The languages and character sets supported differ. date and time formats.000 characters.0 supports the Unicode character set. Separate databases are no longer required for the different character sets. you no longer need separate databases for Latin 1 and Latin 2 support. For example. SQL Server 2000 SQL Server 2005 Oracle 10gR1 Workforce Central System Administrator’s Guide 325 .0 supports Unicode setup for all SQL Server and Oracle databases. all supported languages for a database platform can now be set up in a single database. Setting up these databases in Unicode allows Latin 1. Users who are connected to the French instance see the user interface in French. needs at least one instance for each country to support the appropriate regional settings. that connect to a common database. a company that has English.and French-speaking employees in Canada and English-speaking employees in the United States. number. uses three instances (U. Data entered by users is displayed as entered. For example. In each of the following cases. Multilanguage — A company that uses multiple languages in one or more countries needs at least one instance for each language in each country. Canadian English. date. such as Spanish in Mexico. Single Language/Multicountry — A company that uses a single language in multiple countries. Sorting is also based on the server’s language and regional settings. different configurations for non-U.Appendix C Regional Settings Workforce Central instances and regionalization In a regionalized environment. while those connected to the English instance see the user interface in English.S. and Canadian French). but the time. can use one instance. English instances might be required. and currency are formatted according to server settings. but one instance has country settings for the United States and the other instance has country settings for Canada. English. the instance settings connect to a single common database: • Single Language/Single Country — A company that uses a single language in a single country.S. • • 326 Kronos Incorporated . The instance is set to the appropriate regional settings for the language and country. Each instance is set up to use English as the language. such as English in the United States and Canada. depending on the specific conditions. Themes — In v6. use the following settings to set the language and country for the appropriate instances: • • site.local.0.How Workforce Central displays regionalized data and text How Workforce Central displays regionalized data and text Workforce Central displays various data and text elements differently in: • • • “Browser applications” on page 327 “Reports” on page 329 “Data collection devices” on page 330 Browser applications The sections that follow describe how Workforce Central displays various data and text elements in browser applications.name setting on the Display tab in system settings to global.theme. log off.LANGUAGE site. If you need to display multi-byte characters need to be displayed. The text for the GUI is in properties files. Workforce Central System Administrator’s Guide 327 . system administrators can create a custom theme to change the appearance of colors and fonts in Workforce Central application pages. To see the new theme. then log on. To support a language other than the English default.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. change the site. Workforce Central uses the time zone associated with the user’s People record or the time zone on the Locale tab in system settings. The default theme is Basic.local.portal. The text for online Help is in a set of HTML files in the Help directory and its subdirectories. Text Display and Online Help — The English or language pack files are installed on the application server. DateFormat site.local. in English. No error message occurs.local. and 8p to indicate 8 o’clock in the evening. For example.SHORT_DATE site.LONG_DATE site. If you change the default language and or country.Appendix C Regional Settings Date and time data associated with all other actions (for example. you can type 8a to indicate 8 o’clock in the morning.local. you can use the site.DAY_MONTH The order of the day and month must match that of the browser locale. To support time formats in languages other than the English default. but the date in each application displays differently than the long date format. set the following properties on the Locale tab in System Settings: • • • • • • site. Use the 24-hour format or two-letter time markers if the time markers have the same first letter.COUNTRY on the Locale tab).local. audit trail information) originate from the regional settings of the application server’s operating system. The default values for Time and Date display are determined by the country selected in system settings (site. and the long date format of the language or country you specified is different from the system default.local. the calendar displays in English date format. To support date formats in a language other than the English default. Workforce Central uses the employee’s Display Profile to determine whether to display the time in 12-hour or 24-hour format. For the time display. If the long date value doesn't match the short date. you must enter 8de or 8 to indicate 8 o’clock in the morning.TimeFormat setting on the Locale tab in System Settings: Notes: 328 Kronos Incorporated . you must also change the Long Date value to the long date format of the specified language or country. You can modify this information at any time. In Hungarian. and 8du or 20 to indicate 8 o’clock in the evening.local. VARIANT and site. Depending on the language and currency code you’ve chosen.56$ (Canadian Dollars) French French: 1.currency. Reports The sections that follow describe how the system displays various data and text elements in preconfigured and custom reports.56 (US Dollars) Canadian English: $1.234. You can change this using site. The currency setting determines the view and entry format. are based on the display that is associated with the language and country installed on the instance.currency. currency appears as follows: USE English: $1.How Workforce Central displays regionalized data and text Currency Format — The currency format is based on information in Regional Settings.currency. Text Display — Report file sets are installed in English or the language installed using the language pack.56€ (Euros) For additional information about currency settings.hh).VARIANT to specify whether the currency is Euro. Workforce Central System Administrator’s Guide 329 .local.country on the Locale tab in system settings. the currency setting is based on the United States. 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.local.234.local.234. Number and Amount Formats — The number and amount formats.language and site.local.local. You can use only one currency setting per database. You can use the following settings for currency on an instance: • • site.local. durations) are based on the user’s Display Profile for displaying durations (either HH:MM or HH. excluding currency.COUNTRY Use site.LANGUAGE site. The amount formats for time (for example. If no information is entered in the system settings.234.56 (Canadian Dollars) Canadian French: 1. see “Currency support” on page 332. go to www. Date and Time Formats — For displaying time in reports. the date format base on your browser language preference of Internet options is displayed. Currency Format — The format for displaying currency in reports is based on the report file set that is installed on the instance. If you are using advance reporting.com and search “Arial Unicode MS. if the report is in RDLC and SSRS report format. If it is Crystal report. and you have basic reporting.” Install the font on all client machines and. such as reports in Chinese. the browser looks for a Unicode fall-back font on your machine (minglu). the display format is determined by the settings for time-of-day display in the application server’s operating system. If you need to view reports that contain multibyte characters. make sure that Arial Unicode MS is installed. If you have a Unicode font on your machine. If this font is not installed on your system. Data collection devices The sections that follow describe how the following data collection devices display various data and text elements: 330 Kronos Incorporated . in the case of RDLC reports (basic reporting). To find out about installing Arial Unicode MS. The report file set is determined by the language that was selected during installation of the language pack. A substitute font might not provide support for multibyte characters. the display format for dates in reports is determined by the country settings for date display. The display format for dates in report is depend on report types.microsoft. 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. on the Workforce Central Server. reports automatically use a substitute font that is installed. it uses that instead of giving you bad characters. Workforce Central uses the format (12-hour or 24-hour) that is specified in the user’s Display Profile. The report file set language is determined by the language that was selected during installation. in the application server’s operating system. perhaps Arial.Appendix C Regional Settings Note: All reports use the following font by default: Arial Unicode MS. If no information is available in the user’s Display Profile. The display format for the Date and Time that is set for the terminal in DCM. and Spanish only. 400/100 series terminals are ASCII-7 English only Date and Time Data and Format for Punches Using a Timekeeper terminal — The Date and Time associated with a punch entered using a Timekeeper terminal is based on the time zone that is set for the terminal in Data Collection Manager (DCM). Number and Amount Formats — The format for numbers and amounts (excluding currency) is based on the settings for the terminal in DCM. but not bi-directional for both thick client and Smart Views. Latin 2. including multibyte. and Latin 9 for thick client. The following is supported: • • • 4500 v2. such as error messages. French. 4500 v2. Workforce Central System Administrator’s Guide 331 . Text that you have entered in the database (for example.How Workforce Central displays regionalized data and text • • • Kronos 4500 Terminal Kronos Series 400 terminal 150/154 Terminals Text Display — Data collection devices display text that is already included in the product. Currency Format — Data collection devices display currency on terminals in the format appropriate for the system settings.3: Unicode. employee names or labor level entries) is displayed as you entered it. Smart Views are English. only in English.2 and earlier: Latin 1. and not in the French format (for example. English and United States. dollars.S. If instances are set to support different formats. Because the database only supports one currency format.S. 8. If the company sets up the English instance to support U.S.50€). The display format is determined by the currency.-based company with employees in the U. For example. a U. Collars. and the monetary amounts might be misconstrued. one English) that connect to a common database. the amount is recorded and displayed as US$4.900 pesos. the company has decided to enter all monetary units in U. The currency settings determine the display format and entry format.S. dollars. users on different instances may become confused about the monetary information they view and enter.S. dollars and the Spanish instance to support pesos.-English and one for French-France) that connect to a common database.S.S. format (for example. monetary amounts entered by users in each of these countries will be stored in the database as U. country.900 and could be paid incorrectly. If a US$500 bonus is entered by a Mexican user as the day’s exchange rate amount of 4. If no format is specified in System Settings. Users who are connected to the French-France instance will still view and enter currency in the U. and France uses two instances (one for U.50).S. $8. a Mexican-American company uses two instances (one Spanish. which stores and displays monetary amounts in U. 332 Kronos Incorporated . and language settings that are specified in System Settings. the currency settings are the Workforce Central default settings.Appendix C Regional Settings Currency support The Workforce Central database supports a single currency. Kronos recommends that all instances be set to support the same currency format. For example. the translation of the predefined element name remains intact. For example. However. if you modify the name of one of the fields in the Time Detail Report. Element Data Access Profile Predefined Name All Pay Codes All Work Rules All Reports All Shift Templates All Pattern Templates All Schedule Groups All Availability Templates (Workforce Scheduler only) Empty Display Profile Default Super Access Yes Yes Modifiable? No No No No No No No Workforce Central System Administrator’s Guide 333 . If you change the preconfigured names within one of the predefined elements without changing the name of the predefined elements. If you install a language from the language CD. Preconfigured names in reports are not translated. but the field name is not. The following table shows the predefined names and whether you can modify them. see “Browser applications” on page 327. if you do. You can modify the text of many of these predefined names. such as the names of individual Function Access Profiles or reports. the predefined names are automatically translated into the installed language. not the translated name.Using and modifying predefined names Using and modifying predefined names Workforce Central includes many elements with predefined names. the name “Time Detail Report” is still correctly translated. the translated version displays only the modified name. For more information. Appendix C Regional Settings Element Function Access Profile Predefined Name Default IS IS Using Organizational Map Other Manager Other Manager Using Organizational Maps Payroll Manager Payroll Manager Using Organizational Maps Professional Employee Professional Employee Using Organizational Maps Scheduling Manager Time Stamp and Hourly Employee Modifiable? Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Time Stamp and Hourly Employee Using Org Maps Yes Generic Data Access Profile HyperFind All Home All Home & Scheduled Job Transfers All Home & Transferred-in Labor Level Sets All Labor Accounts Empty Profile Logon Profile Default Super Access People Reports SuperUser Absent Employees Yes Yes Yes No No Yes Yes No No All Access Yes 334 Kronos Incorporated . Schedule by Job Actual vs. Predefined Name Accrual Balances and Projections Accrual Carryover Limits Accrual Codes Accrual Date Configurations Accrual Date Patterns Accrual Debit Activity Summary Accrual Detail Accrual Earned Grants Accrual Earning Limits Accrual Fixed Grants Accrual Policies Accrual Pool Balances Accrual Probation Periods Accrual Profiles Accrual Summary Accrual Taking Limits Actual vs. cont. Schedule by Labor Account All Zone Badge Numbers Biometric Enrollment Activity Biometric Enrollment Detail Biometric Enrollment Summary Bonus/Deduction Rules Break Rules Combined Pay Codes Comments Comments By Employee Comments By Location Modifiable? No No No No No No No No No No No No No No No No No No No No No No No No No No No No No Workforce Central System Administrator’s Guide 335 .Using and modifying predefined names Element Reports. Monthly Employee Schedule .Weekly Employee Sign-off Employee Transactions and Totals Employee Transactions and Totals (Excel) Employees Currently Earning Time (On Premise) Exception Rules Fixed Rules Float Function Access Profiles Generic Data Access Profiles Holiday Credit Rules Holiday Credits Holidays Modifiable? No No No No No No No No No No No No No No No No No No No No No No No No No No No No No 336 Kronos Incorporated .Appendix C Regional Settings Element Reports. cont.Weekly Daily Rest Device Assignments Device Groups and Device Assignments Device Work Rule Definitions Device Work Rule Profiles Employee Attendance Profiles Employee Discipline Levels Employee Hours by Job Employee Hours by Job (Excel) Employee Hours by Labor Account Employee Hours by Labor Account (Excel) Employee Schedule . Predefined Name Core Hours Rules Coverage-Monthly Coverage-Weekly Coverage Detail . Using and modifying predefined names Element Reports.Weekly Majority Rules Modifiable? No No No No No No No No No No No No No No No No No No No No No No No No No No No No No Workforce Central System Administrator’s Guide 337 . Predefined Name Holiday Credit Rules Home Labor Account Assignment History Hours by Job Hours by Job (Excel) Hours by Labor Account Hours by Labor Account with Graph Summary Import Errors Import Statistics Job Configuration Labor Levels Leave Hours Detail Leave Hours Summary Leave Hours Summary (Excel) Leave Profiles Leave Reasons Leave Rules Leave Types List of Activities List of Configurations List of Field Definitions List of Form Profiles (DAP) List of Forms List of Result Code Profiles (DAP) List of Result Codes List of Teams List of Units of Measure Location Schedule .Weekly Location Schedule Detail . cont. cont.Weekly Organizational Job Configuration Organizational Map Location Types Organizational Map Locations Organizational Sets Orphaned Activity Events Overtime Equalization Detail Overtime Rules Pay Code Data Access Profiles Pay Codes Pay rule Audit Trail Pay Rules Perfect Attendance Person Attributes Person Job Assignment Punch Origin Report Data Access Profiles Rest Breaks Rounding Rules Schedule by Labor Account .Appendix C Regional Settings Element Reports.Monthly Open Shifts .Monthly Schedule by Labor Account .Weekly Schedule Deviation Rules School Calendar Audit Single Zone Modifiable? No No No No No No No No No No No No No No No No No No No No No No No No No No No No No 338 Kronos Incorporated . Predefined Name Missing Employees Monthly Location Schedule Night Worker On Call Open Shifts . Weekly Staffing Sheet Detail .Daily Terminal Rules Time Detail Timecard Audit Trail Timecard Signoff/Approval Audit Trail Users Currently Locked Out Weekly Activity Weekly Working Time Work in Process Activity Status Work in Process Cost Detail Work in Process Cost Detail by Group Work in Process Cost Summary Work in Process Cost Summary by Group Work in Process Time to Complete Work in Process Time To Complete Summary Work Rule Data Access Profiles Work Rules Workforce Requirement Analysis Yield Detail Yield Detail by Group Yield Summary Yield Summary by Group Young Worker Zone Rules Modifiable? No No No No No No No No No No No No No No No No No No No No No No No No No No No Workforce Central System Administrator’s Guide 339 .Daily Staffing Sheet .Using and modifying predefined names Element Reports. cont. Predefined Name Staffing Efficiency Staffing Sheet . if you defined a pay code named “Sick. provide text in both languages in the entry.” Workforce Central always displays this pay code as Sick.” 340 Kronos Incorporated . For example.Travail. create duplicate data in each language. Use generic data access profiles to segment the data. you could define the text for this labor level to be “Work . and a labor level that you would call “Work” in English and “Travail” in French.and French-language instances. assign data access profiles in the appropriate language (assign data access profiles that use English terms to English-speaking employees. • Note: If you want to provide predefined names in multiple languages. To each user. the text strings that you define always appear in the single language that you used when you defined the text string. assign data access profiles that use French terms to French-speaking employees.Appendix C Regional Settings Using site-defined text strings in a multilanguage environment If you define individual text strings and you have a multilanguage environment (that is. and so on). Kronos suggests the following for customers who use multilanguage environments: • • For pay codes. making it easier for administrators who make assignments to employees. To accommodate both languages. and reports. For example. if you use a single database and have different languages installed on different instances). regardless of the language of the instance. work rules. assume that you have a site with English. See the Setup online Help for more information about generic data access profiles. Appendix D Registry Keys 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 . icx Function description=Foo Function identifier=TKCS Function name=Timekeeper CS Home directory=C:\Kronos\wfc\Config Icon Preference=LAUNCHER Toolbar icon file=none • • • 342 Kronos Incorporated .ico Toolbar icon file=none [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\Cross Launch\WTK] Access profile column=none Executable=nodialog.exe -iconfigApps.exe Function description=Comments Configuration Function identifier=Comments Function name=Comments Home directory=C:\Kronos\wfc\cmnapps Icon Preference=LAUNCHER Launcher icon file=comments. • [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC] Common Path=C:\Kronos\WFC\kronoscm Help Dir=C:\Kronos\wfc\help Install Path=C:\Kronos [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\config] Web Server URL=ORASMOKE [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\Cross Launch\COMMENTS] Executable=comments.Appendix D Registry Keys Windows registry keys The following registry keys are established during installation of the Workforce Central system. Note: UNIX commands are case-sensitive. but it defaults to 0. ServicePack: A string used by Workforce Central Setup. If false. WebServerURL: The Web server used for Background Processor authentication. Here is a sample Registry. OracleDBOwner: Required because of multiple instance database deployment.UNIX registry keys UNIX registry keys Portions of the Windows registry settings are supported in Workforce Central for UNIX platforms by a new properties file. Registry. the database calls will be written to the SQL trace file. SequencePreallocationSize: The number of rows in the database’s sequence table that an application will capture at a time.properties.1 Explanation: LastPayPeriodUpdate: The Background Processor will update this number. SqlTrace: If true. the database calls will not be recorded. This file resides in the [WFC. SqlTraceFile: The name of the SQL trace file.rootdir]/wfc/properties directory.properties file: LastPayPeriodUpdate = 0 OracleDBOwner = TKCSOWNER SequencePreallocationSize = 100 SqlTrace = false SqlTraceFile = sql. Workforce Central System Administrator’s Guide 343 .1.txt WebServerURL = cnortonnt3 ServicePack = 4. Appendix D Registry Keys 344 Kronos Incorporated . perform the following procedures: • • “Configuring Workforce Central to enable single sign-on” on page 346 “Configuring SiteMinder” on page 347 .Appendix E Single Sign-On You can set authentication to allow users to log on to Workforce Central automatically without having to re-enter a username or password after they have logged onto their browser. This process is called Single Sign-on. To set up Single Sign-on. singlesignon.log. In SSOSiteMinder.SSOSiteMinderSubject c. Set sso.log b. select System Configuration > System Settings > Security. The default is SMUSER.security.security. Set sso. On the Security tab.properties 4. Log on as SuperUser. Configure SiteMinder to work with Workforce Central. 5.jsp 6.principal. 7.kronos. 346 Kronos Incorporated .singlesignon. In the Setup workspace.properties to WFC.module.file to WFC.kronos.security.properties. do the following: a. 3.wfc.level to DEBUG.rootdir\wfc\logs\SSOSiteMinder.module to com. In WFC.rootdir/wfc/properties/ SSOSiteMinder. Set sso. Set site. Set site.logoffurl to /wfc/html/kronos-sso-restart.auth. You can verify this using the Microsoft Management Console.security.singlesignon to true b.log.wfp. Set site. 2.properties. c.Appendix E Single Sign-On Configuring Workforce Central to enable single sign-on To configure Workforce Central to enable single sign-on by using Computer Associates’ eTrust® SiteMinder®: 1. do the following: a.key to what identifies the users credentials. set com. Verify that the ISAPI SiteMinder Agent Filter precedes the ISAPI JBoss Filter. set the Actions button to Web Agent actions. WFCAnon contains “ou=People. b. a. and Put). select the Perform regular expression pattern matches check box. Create an anonymous authentication scheme named WFCAnon.Configuring SiteMinder Configuring SiteMinder This section assumes that you have SiteMinder installed. Create a realm for Workforce Central non-logon URLs named WFCRealm Set the resource Filter to /wfc/ and the authentication scheme to WFCAnon b. dc=com” for the User DN. Use the SiteMinder Policy Server to create authentication schemes for Workforce Central (WTK). in your policy domain. dc=Kronos. Set the resource Filter to logonWithUID and the authentication scheme to WFCFormAuthentication 3. Create a realm for Workforce Central logon URLs named WFCLogonRealm The WFCLogonRealm should be a sub-realm of WFCRealm. For more information about configuring SiteMinder. and that you understand basic SiteMinder configuration. Post. Use the SiteMinder Policy Server to create realms for Workforce Central. and select all types of HTTP methods (Get. Use the SiteMinder Policy Server to create rules for Workforce Central. Create a rule that will handle all non-logon WFC URLs in the WFCRealm named WFCAllowAllRule Set the effective resource to the wildcard character *. a. a. see the SiteMinder documentation. To configure SiteMinder: 1. Workforce Central System Administrator’s Guide 347 . For example. Create a basic or form authentication scheme named WFCFormAuthentication 2. Appendix E Single Sign-On This rule activates for all non-logon WFC URLs accessed by the HTTP methods Get. it informs WFC that this user has been authenticated. If SiteMinder authenticates a user accessing this logon URL. it uses anonymous authentication. select the Perform regular expression pattern matches check box. 348 Kronos Incorporated . Therefore. all WFC URLs are passed through WFC without an authentication check by Siteminder. b. it uses basic or form authentication. username. Therefore. WFC only allows access to protected non-logon URLs by previously authenticated users. 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. and password. 4. Create a rule that will handle all logon WFC URLs in the WFCLogonRealm named logonWithUIDRule Set the effective resource to the wildcard character *. and Put. set the Actions button to Web Agent actions. Use the SiteMinder Policy Server to create policies for Workforce Central. Since this rule is part of the WFCLogonRealm. access to all logon URLs are redirected to the form identified in WFCFormAuthentication. Post. b. Post and Put. This rule activates for all logon WFC URLs accessed by the HTTP methods Get. a. All users are prompted for their credentials. 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. Since this rule is part of the WFCRealm. Post. and select all types of HTTP methods (Get. and Put). This appendix contains the following sections: • • “Diagnostic Tools user interface” on page 350 “Diagnostics Tools and usage” on page 351 . Workforce Central Web server. Note: Some of the diagnostic tools require you to have the JRE Plug-in installed on the application server. and services errors.Appendix F Diagnostic Tools The diagnostic tools are designed to assist in diagnosing run time. The Diagnostic Tools Logon screen appears. 4. 2. select the SSL check box. Diagnostic Tools logon screen The first time that you log on to the Diagnostic Tools main menu. Click OK.Appendix F Diagnostic Tools Diagnostic Tools user interface To start the diagnostic tools. to start a selected diagnostic tool. 350 Kronos Incorporated . you must: 1. Click the tool name in the left pane. Enter the Superuser password in the Enter Password box. • • The left side of the window displays a tree-type structure with folders that contain the different diagnostic and troubleshooting tools. Enter the Superuser user name in the Enter User Name box. Select the primary host name in the upper left-hand corner in the left pane. Launching a specific application After you enter information in the logon screen and click OK. 3. At the bottom of the right pane is a Launch button. Click Launch at the bottom of the right pane. the Diagnostic Tools main window appears. To use a specific diagnostic tool: 1. 2. The right side of the window displays instructions and information about a selected diagnostic tool. double-click the diagnostic tools icon. If your server uses SSL connection. 3. This window contains two panes. In the left pane of the Diagnostic Tools main window.smtp_url key in Workforce Central System Configuration > System Settings > Email.email. Some Workforce Central Workforce Central System Administrator’s Guide 351 . Enter values into each box: – – FromEmail — Enter the From e-mail address. Message — Enter a test message. SMTPHostName — Enter the mail server SMTP. Click Start. select SMTPMailServerDiagnostic from the email folder. 2. Running the SMTP Mail to Launcher Diagnostic Tool The SMTP Mail to Launcher Diagnostic Tool provides the capability to test and qualify the customer’s client e-mail software. To run the SMTP Mail Server Diagnostic Tool: 1. The diagnostic tool sends an e-mail to the address listed in the ToEmail box and lists the results in the Results box. Subject — Enter a test subject.Diagnostics Tools and usage Diagnostics Tools and usage The diagnostic tools for Workforce Central (WFC) include: • • • SMTP Mail Server SMTP Mail To Launcher Shift Builder Running the SMTP Mail Server Diagnostic Tool The SMTP Mail Server Diagnostic Tool validates SMTP connectivity. Click Launch. – – – 4. 3. ToEmail — Enter the To e-mail address. The STMPMailServerDiagnostic dialog box appears. The mail server SMTP is listed in the site. Body — Enter a test message. This validates that the information is parsed correctly and that the e-mail is being sent to the individual designated in the To: box. Fill in the appropriate information: – – – To — Enter the To e-mail address. such as Novell. 4. The MailToTester page appears. 5. select SMTPMailToLauncher from the e-mail folder. Running the Shift-Builder Diagnostic Tool The Shift Builder diagnostic tool logs onto Workforce Central and checks: • • • • The ScheduleProc database table record count The SchedPatrnDate next run date database table For failed shiftbuilder employees in the database The WtkGlobalSettings. 3. Some e-mail client software packages. In the left pane of the Diagnostic Tools main window. for XML user/password 352 Kronos Incorporated . Subject — Enter a test subject or accept the default. 2. In the e-mail client application. Click Launch. then the application works correctly. If the e-mail client is displayed with the same information that appears on the MailToTester page. click Send. The user’s e-mail client opens. Click Launch.Appendix F Diagnostic Tools applications launch the customer’s e-mail client using the W3C3 e-mail to url syntax. do not support the latest W3C e-mail to url format and do not work correctly with the Workforce Central product. To run the SMTP Mail to Launcher Diagnostic Tool: 1.properties file. Note: This tool can only be run if the Diagnostic Tools client setup is installed at the Workforce Central server. SchedPatrnDate Designates the date and time after which no shifts have been built.Diagnostics Tools and usage • The WPKSite. The diagnostic tool lists the results in the text boxes. • An employee may be added into a schedule group. In the left pane of the Diagnostic Tools main window. A restart button appears when the tool is finished running. 2. Click Launch. select ShiftBuilderDiagnostic from the shiftbuilder folder. • Workforce Central System Administrator’s Guide 353 . The ShiftBuilderDiagnostic dialog box appears. or the Shift Builder has stopped running. The diagnostic tool lists the results in the text boxes as in the following table: Text box ScheduleProc (count) Description Returns the number of Shift Builder tasks that have not yet been completed. An employee may have an individual schedule pattern and needs to have shifts built for that pattern. the Shift Builder has finished running and has no tasks left to complete. The buttons at the bottom of the ShiftBuilderDiagnostic dialog box disappear while the tool is running. There are three types of Shift Builder tasks: • • A schedule group may exist that needs to have shifts built for it. 3. In this case. • A zero indicates that the Periodic Shift Builder will not be run on the next startup of the system.properties file. The user cannot call up an editable Schedule Editor for any date after the one designated in the SchedPatrnDate text box. the shifts that the employee inherited from the group need to be built. but was unable to complete all of its tasks. Click Start. If the value is greater than zero. If the value in the ScheduleProc(count) text box is zero (0). then the Shift Builder is currently running. A one indicates that the Periodic Shift Builder will be run on the next startup of the system. To the right side of this text box is a zero (0) or a one (1). unless the AlwaysBuildShiftsOnStartup property has been set. for Event Manager key and values To run the Shift-Builder diagnostic tool: 1. required key.enabled.eventmanager. The Event Manager can have problems if the XMLUSER username and password defaults have been changed in this location. if a schedule group failed to process properly. the IDs of all the employees associated with that schedule group are listed. WPKSite(Event Lists the site. This should be set to Manager Info) true in order for the Shift Builder to run through this server’s event manager. The username and password that are returned in the WtkGlobalSettings field must match the username and password that appear in the USERACCOUNT table.Appendix F Diagnostic Tools Text box Description FailedEmployees Lists the employee IDs of any employees who failed to run in the Shift Builder. This property is found in System Configuration > System Settings > Event Manager. For example. WtkGlobal Settings Lists the encrypted username and password that is used to log on to the Workforce Central server. 354 Kronos Incorporated . ShiftBuilderGovernor.Days — This property designates the maximum number of days populated by the periodic Shift Builder. Global.ShiftBuilderThreads.ShiftBuilderGovernor. The default value for this property is 1. if the global. This property is found in System Configuration > System Settings > Global Values. The default value is 5.WtkScheduler. This is set to true by default.ShiftBuilderGovernor.MaximumDaysInFutureToCreateShifts — This property designates the maximum number of future days for which shifts will be populated. The default value is 270.WtkScheduler. This property is found in System Configuration > System Settings > Global Values.Active — If this property is set to 1. Global. the periodic shift builder is run every time the server starts up.Diagnostics Tools and usage Text box ShiftBuilder (properties) Description The following properties are listed: • site. • • • • Workforce Central System Administrator’s Guide 355 .Active key is set to 1. a limit is placed on the number of days populated by the periodic shift builder.WtkScheduler. Global. This property is found in System Configuration > System Settings > Global Values.ShiftBuilder.AlwaysBuildShiftsOnStartup — If this property is set to true. This property is found in System Configuration > System Settings > Global Values.WtkScheduler. starting with the current day. Global.Max — This property designates the maximum allowed number of concurrent periodic shift builder threads. for KDEMO databases. The default value for this property is 30 days.WtkScheduler. This property is found in System Configuration > System Settings > Service.service. Appendix F Diagnostic Tools 356 Kronos Incorporated . multiple domains 163 WinNT. single domains 164 164 B Background Processor employees excluded 58.Index A access control points Messaging system 47 Process Manager 47 Active X enabling 25 All Servers system information 55 Applications system information 57 archiving system log reports 83 Audit system settings 98 authentication LDAP default method 164 OTHER 165 proprietary 163 Windows Integrated authentication WinNT. 59 workspace 58 Business Automation system settings clustering monitoring resources 317 Process Engine 317 color select for custom theme 181 specify custom colors in images 189 configuration settings before editing 94 editing 95 creating 317 custom Web Parts 274 to 286 considerations for transform files 281 creating non-QuickNav-based Web Parts 284 creating QuickNav-based Web Parts 277 to 283 creating with the XML API XSLT Chart 285 examples 275 including calculation logic in Web Parts 286 strategy for creating 276 customization create custom theme 179 99 D data access profiles delegates 51 Data Source system settings adding 108 overview 107 database deleting a report 63 displaying a report 63 C Clock Synchronize system settings Cluster Manager 44 about 319 setting up 320 105 . Index report display 62 report status 61 running a report 63 switching databases 110 system information 60 system settings 109 viewing a report 63 working with reports 63 database reports available reports 60 creating DRD files 63 deleting 63 Display workspace 62 displaying 63 DRD creation guidelines 65 running 63 viewing 63 delegate authority data access profile 51 using 50 deleting a logically deleted process template 309 deleting a profile 317 deploy custom theme 195 diagnosis run time 349 service 349 Web server 349 diagnostic tools Shift-Builder Diagnostic tool 352 SMTP Mail Server Diagnostic tool 351 SMTP Mail to Launcher Diagnostic tool 351 starting 350 Display system settings 116 DRD files creating 63 guidelines for creating 65 duplicating a profile 317 E e-mail available notifications 40 diagnostics 351 multi-instance environment configuration 37 notification types 39 system settings 117 employees excluded retroactive pay calculation 59 totals calculation 58 Engines tab Process Administrator 317 Enterprise eTIME software components 36 Enterprise eTIME Portal adding and connecting Web Parts 249 to 254 changing ADP-specific Web Part settings 258 changing Web Part labels 260 changing Web Part titles and appearance 257 configuring charts for OWC compatibility 270 to 272 configuring health care Web Parts 262 to 264 configuring KPIs 264 to 269 creating a visual theme 287 creating custom Web Parts 274 to 286 creating Help for custom Web Parts 290 customizing ADP Web Parts 257 to 273 customizing sample portal pages 255 customizing Web Part Help topics 288 linking Help to custom Web Parts 291 match suite custom theme 196 page configuration options 245 purpose 244 sample portal pages 245. 247 troubleshooting 292 using the ADP Web Part page template 256 Web Parts 245 to 247 environments multi-instance 36 358 Kronos Incorporated . 305 G Global Values system settings 126 Global Values tab Process Manager settings 46 vacation bidding application settings 46 group edits clearing results screen 138 multi-instance environment configuration 37 system settings 136 31 H HyperFind queries and Reports To field 48 I images specify colors for custom theme 189 J Java Plug-in system settings 139 K key performance indicators configuring 264 to 269 K-mail task and system settings 149 KPIs configuring 264 to 269 M Messaging system access control points 47 system settings 149 Meters system information 68 multi-instance environments configuration overview 36 Workforce Central System Administrator’s Guide 359 .Index Event Manager multi-instance environment configuration system settings 120 working with system settings 122 37 L LDAP authentication default method 164 Licenses system information 67 Locale system settings 140 log file gathering collecting files 88 gathering files 88 listing files to be gathered 86 opening gathered files 89 overview 85 log files archiving system log reports 83 system settings 145 log on changing the relogon session timeout enabling Active X 25 overview 24 single sign-on 24 Log Reports filtering 82 overview 76 running 82 log reports archiving 83 Logging Context system settings 148 logo prepare for custom theme 184 logoff timer. changing 165 logs Event Manager 123 F function access profiles Messaging system 47 Process Manager 47. Enterprise eTIME adding and connecting Web Parts 249 to 254 changing ADP-specific Web Part settings 258 changing Web Part labels 260 configuring charts for OWC compatibility 270 to 272 configuring health care Web Parts 262 to 264 configuring KPIs 264 to 269 creating a visual theme 287 creating custom Web Parts 274 to 286 creating Help for custom Web Parts 290 customizing ADP Web Parts 257 to 273 customizing sample portal pages 255 customizing Web Part Help topics 288 linking Help to custom Web Parts 291 match suite custom theme 196 page configuration options 245 purpose 244 troubleshooting 292 using the ADP Web Part page template 256 predefined data Enterprise eTIME QuickNav profile 302 HyperFind Query 301 logon profiles 304 people 303 Primary Labor Account system information 69 printers enabling 151 system settings 150 printing list of profiles 317 Process Administrator 45 abort a process 308 changing status of tasks 314. offline 25 new process profile 317 Notification server 39 O offline mode 25 changing superuser account 29 online mode changing SuperUser account 29 OTHER authentication 165 Overtime equalization enabling in system settings 127 overview 317 P People Editor updating Reports To field 49 pooling about 321 pool building 321 setting up 321 Portal.Index configuring E-mail 37 configuring Event Manager 37 configuring Group Edits 37 N navigation. 315 changing status tasks 313 delete a process 308 delete a process template 308 Engines tab 317 marking completed tasks 314 overview 305 Process Analysis tab 315 Process Details tab 311 process status 306 reassigning tasks 313 reports 310 resource workload 317 restart a process 309 start 305 status of all tasks 311 task statistics 315 viewing task properties 315 360 Kronos Incorporated . 45 deactivating templates 317 Global Values settings 46 overview 44 system settings 99. 305 troubleshooting 318 upgrading 45 process profiles creating new 317 deleting 317 duplicating 317 editing 317 printing list 317 renaming 317 Process Profiles editor 44.Index Process Analysis tab Process Administrator 315 Process Designer 44 logging on with Windows Vista 44 overview 44 Process Details tab Graphical Detail view 312 Process Administrator 311 Process Resources view 311 State Analysis Detail view 313 Tabular Detail view 312 XML Detail view 311 Process Engine 44 clustering 317 Process Manager access control points 47 activating templates 317 categorizing process templates 317 components 44. 317 starting 317 process templates activating 317 categorizing 317 deactivating 317 deleting 308 Process Templates editor 44 overview 317 viewing 317 processes aborted 307 aborting 308 active 307 changing task status 313 counts 310 deleting 308 done 307 Graphical Detail view 312 Process Resources view 311 ready 307 restarting 309 State Analysis Detail view 313 status 310 Tabular Detail view 312 task statistics 315 viewing reports 310 viewing status 306 viewing task status 311 XML Detail view 311 profiles creating new process profile 317 deleting a process profile 317 duplicating a process profile 317 editing a process profile 317 printing list of process profiles 317 renaming a process profile 317 properties modifying 34 properties files file types 34 groups 34 overview 34 properties validation 97 property groups 34 proprietary authentication 163 Workforce Central System Administrator’s Guide 361 . system database report display 62 deleting a database report 63 displaying a database report 63 Log Reports 75. 346 system settings 160 server All Servers system information 55 logging on and off 24 managing remotely 26 Web and App Server system settings Service system settings overview 167 settings system configuration 22 severity levels Event Manager log 124 single sign-on configuring Enterprise eTIME 346 configuring SiteMinder 347 logging on 24 SMTP connectivity validating 351 SQL Coverage system settings overview 169 SQL tracing. 76 running a database report 63 viewing a database report 63 resources counts 310 viewing workload 317 response file (XML) reading 280 Retention Policy Affected Databases system settings 152 Retention Policy Database Setup system settings 153 Retention Policy Options and Tuning system settings 154 S security client 28. 30 overview 28 password 28 single sign-on 28.Index R registry keys UNIX 343 Windows 342 relogon session timeout changing Enterprise eTIME session 32 changing JBoss session 32 overview 31 renaming a profile 317 report terminology 199 reports concept overview 198 for processes 310 system settings 157 terminology 199 Reports tab Process Administrator 310 Reports To field Process Manager configuration 48 updating with People Editor 49 reports. enabling 170 Startup system settings 171 status of processes 310 of tasks 310 SuperUser account changing 29 system administration adding data source names 108 adding printers 151 changing logoff timer 165 clearing Group Edit Results 138 enabling printers 151 enabling SQL tracing 170 173 362 Kronos Incorporated . 93 Printers 150 Process Manager 305 Reports 157 Retention Policy Affected Databases 152 Retention Policy Database Setup 153 Retention Policy Options and Tuning 154 Security 160 Service 167 SQL Coverage 169 Startup 171 task buttons 95 Transformation 172 values validation 97 Web and App Server 173 working with 95 Workforce Central System Administrator’s Guide 363 . 93 system configuration overview 22 Process Administrator 305 system information 53. 59 Licenses 67 Meters 68 overview 53.Index offline mode 25 switching databases 110 understanding authentication 163 working with Event Manager 122 System Configuration Log Report 75. 76 running 82 system reports database report status 61 deleting a database report 63 displaying a database report 63 Log Reports 75. 76 overview 23 Process Profiles editor 317 Process Templates editor 317 System Settings 91. 76 running a database report 63 viewing a database report 63 working with database reports 63 system security authentication 163 system settings Audit Settings 98 before editing 94 Business Automation 99 Clock Synchronize 105 Data Source 107 Database 109 Display 116 editing 95 E-mail 117 Enterprise eTIME Portal 116 Event Manager 120 Global Values 46. 126 Group Edits 136 Java Plug-in 139 Locale 140 Log File 145 Logging Context 148 Messaging tab 149 overview 91. 54 Primary Labor Account 69 Threads 71 User 73 system log reports archiving 83 filtering 82 overview 75. 54 system information All Servers 55 Applications 57 Background Processors 58 database information 60 database report status 62 Database workspace 60 employees excluded 58. css file 185 Threads system information 71 tools diagnostic 349 transform file (XSL file) 282 Transformation system settings 172 troubleshooting Enterprise eTIME Portal 292 SQL tracing 170 U UNIX registry keys 343 User system information 73 V vacation bidding application Global Values settings 46 validate SMTP connectivity 351 validation. 315 marking as done 314 reassigning 313 status 310 viewing properties 315 viewing statistics 315 viewing status 311 template categories 317 templates activating 317 categorizing 317 deactivating 317 Web Part page for Enterprise eTIME Portal 256 theme create custom theme overview 27 create new theme folder for custom theme 180 deploy 195 edit theme style sheet 185 extend to Enterprise eTIME Portal 196 select colors for 180 specify custom colors in images 189 test 194 use custom logo 184 theme. system settings 97 visual theme creating for the Enterprise eTIME Portal 287 W Web and App Server system settings 173 Web Part Help customizing 288 Web Part Help topics creating 290 linking to custom Web Parts 291 Web Part page template 256 Web Parts adding and connecting 249 to 254 changing ADP-specific settings 258 changing labels 260 changing titles and appearance 257 configuring charts for OWC compatibility 270 to 272 configuring health care Web Parts 262 to 264 considerations for transform files 281 creating custom Web Parts 274 to 286 creating non-QuickNav-based Web Parts 284 creating QuickNav-based Web Parts 277 to 283 creating with the XML API XSLT Chart 285 customizing 257 to 273 examples of custom Web Parts 275 how they work 274 364 Kronos Incorporated .Index T tasks changing status 313. 314. Index including calculation logic in Web Parts strategy for creating 276 Windows Integrated Authentication 164 Windows Vista logging on to Process Designer 44 WinNT authentication mulitiple domains 163 single domains 164 workflow notifications access 42 available notifications 40 notification types 39 overview 39 setting up 41 286 X XML response file reading 280 XSL transform file 282 Workforce Central System Administrator’s Guide 365 . Index 366 Kronos Incorporated .