Survey
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Enterprise eTIME System Administrator’s Guide ® An administrator’s guide to the Enterprise eTIME system. Enterprise eTIME Suite Version 5 Document Part Number: 4703077-002 Document Revision: A The information in this document is subject to change without notice and should not be construed as a commitment by ADP, Inc. ADP is not responsible for any technical inaccuracies or typographical errors which may be contained in this publication. Changes are periodically made to the information herein, and such changes will be incorporated in new editions of this publication. ADP may make improvements and/or changes in the product and/or the programs described in this publication at any time without notice. This document or any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. All rights reserved. © 2001—2004 Kronos Incorporated. ADP provides this publication "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of merchantability or fitness for a particular purpose. The ADP Logo is a registered trademark of ADP of North America, Inc. eTIME is a registered trademark of Automatic Data Processing, Inc. Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper, Gatekeeper Central, Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My Genies, PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShopTrac, ShopTrac Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Comm.Mgr, CommLink, DKC/Datalink, FasTrack, HyperFind, Improving the Performance of People and Business, Kronos 4500, Kronos 4500 Touch ID, Kronos e-Central, KronosWorks, Labor Plus, Schedule Assistant, Smart Scheduler, Smart View, StartLabor, Start Quality, Start WIP, Starter Series, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite, WIP Plus, Workforce Activities, Workforce Connect, Workforce Employee, Workforce HR, Workforce Manager, Workforce MobileTime, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos Incorporated or a related company. All other trademarks or registered trademarks used herein are the property of their respective owners and are used for identification purposes only. When using and applying the information generated by Kronos products, customers should ensure that they comply with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws. Published by ADP, Inc. Automatic Data Processing, Inc. One ADP Boulevard Roseland, New Jersey 07068 For more information, see the following ADP, Inc. Web page: http://www.adp.com Document Revision History Document Revision Product Version Release Date A Enterprise eTIME 5.0 April 2004 Contents About This Guide Organization of This Guide ........................................................................viii Abbreviations and Terminology ................................................................... ix Enterprise eTIME Documents ...................................................................... xi Chapter 1: Introduction System Configuration Overview ................................................................1-2 Configuring Enterprise eTIME ...................................................................1-3 Logging On to Enterprise eTIME ...............................................................1-6 Working with Passwords ............................................................................1-9 Changing the Relogon Session Timeout ..................................................1-12 Working with Property Files ....................................................................1-15 Configuring a Multiserver Environment .................................................1-24 Working with Workflow Notifications ....................................................1-27 Chapter 2: System Information Working with System Information ............................................................2-2 All Servers Information ..............................................................................2-3 Applications Information ............................................................................2-4 Background Processors Information ..........................................................2-5 Database Information .................................................................................2-8 Licenses Information ................................................................................2-15 Local Server Information .........................................................................2-16 Meters Information ...................................................................................2-17 Primary Labor Account Update Information ...........................................2-18 Threads Information ................................................................................2-20 User Information ......................................................................................2-22 Contents Chapter 3: Log Report Log Reports ................................................................................................ 3-2 Log Files .................................................................................................... 3-5 Log File Report .......................................................................................... 3-6 Filtering and Running Log Reports .......................................................... 3-7 Archiving System Log Reports ................................................................. 3-8 Chapter 4: System Settings Overview .................................................................................................... 4-2 Working with System Settings ................................................................... 4-3 Callable Totalizer Settings ......................................................................... 4-7 Clock Synchronize Settings ....................................................................... 4-9 Database Settings ..................................................................................... 4-11 Data Source Settings ................................................................................ 4-18 E-mail Settings ......................................................................................... 4-21 Event Manager Settings ........................................................................... 4-24 Global Values Settings ............................................................................. 4-30 Group Edits Settings ................................................................................ 4-37 Java Plugin Settings ................................................................................. 4-40 Locale Settings ......................................................................................... 4-42 Log File Settings ...................................................................................... 4-47 Logging Context Settings ......................................................................... 4-50 Portal Settings .......................................................................................... 4-51 Printers Settings ....................................................................................... 4-55 Reports Settings ....................................................................................... 4-58 Security Settings ...................................................................................... 4-61 Service Settings ........................................................................................ 4-67 SQL Coverage Settings ............................................................................ 4-69 Startup Settings ........................................................................................ 4-71 Timekeeping Settings ............................................................................... 4-72 Transformation Settings ........................................................................... 4-74 Web Server Settings ................................................................................. 4-75 iv ADP, Inc. Contents Chapter 5: Reports Overview ...................................................................................................5-2 Generating a Report ..................................................................................5-13 Generating Custom Reports .....................................................................5-15 Appendix A: Predefined Data Data Access Profiles ..................................................................................A-2 Enterprise eTIME QuickNav Building Blocks .......................................... A-3 Enterprise eTIME QuickNavs ................................................................... A-6 Display Profiles ......................................................................................... A-8 Labor Level Sets ........................................................................................ A-9 HyperFind Query ..................................................................................... A-10 Enterprise eTIME QuickNav Profile ....................................................... A-11 People ...................................................................................................... A-12 Logon Profiles .........................................................................................A-13 Function Access Profiles ......................................................................... A-14 Appendix B: Function Access Profiles Accessing Function Access Profiles .......................................................... B-4 Understanding Timecard Access ............................................................... B-5 Function Access Profile Tables ................................................................. B-6 Appendix C: Registry Keys Windows Registry Keys ............................................................................ C-2 UNIX Registry Keys ................................................................................. C-4 Appendix D: Regional Settings Translation Concepts and Methodology .................................................... D-2 Application Servers and Regionalization .................................................. D-8 Database Servers ....................................................................................... D-9 Character Set Support .............................................................................. D-10 Currency Support ..................................................................................... D-11 Using and Modifying Predefined Names ................................................ D-12 Using Site-defined Text Strings in a Multilanguage Environment ......... D-18 Enterprise eTIME System Administrator’s Guide v Contents Appendix E: Single Sign-On Configuring Enterprise eTIME ..................................................................E-2 Configuring JRun with Netegrity/SiteMinder ............................................E-3 Configuring SiteMinder .............................................................................E-4 Appendix F: Custom LDAP Authentication Method Understanding Custom LDAP Authentication .......................................... F-2 Configuring Enterprise eTIME to Use Custom LDAP .............................. F-3 Using the LDAPConfig Utility .................................................................. F-4 Appendix G: Diagnostic Tools Diagnostic Tools User Interface ............................................................... G-2 Diagnostic Tools Logon Screen ......................................................... G-2 Launching a Specific Application ...................................................... G-2 Diagnostics Tools and Usage .................................................................... G-3 Index vi ADP, Inc. About This Guide This preface contains the following sections: ! Organization of This Guide ! Abbreviations and Terminology ! Enterprise eTIME Documents About This Guide Organization of This Guide The chapters in this guide provide the following information: viii ! Chapter 1, “Introduction,” contains an overview of the Enterprise eTIME® system architecture and describes the tasks that you use to administer the system. ! Chapter 2, “System Information,” explains the System Information component of the Enterprise eTIME system and describes the tasks that you use to work with System Information. ! Chapter 3, “Log Report,” explains the Log Report section of the System Configuration component and describes the tasks that you use to work with log reports. ! Chapter 4, “System Settings,” explains the System Settings section of the System Configuration component and describes the tasks that you use to work with System Settings. ! Chapter 5, “Reports,” contains information about working with reports in the Enterprise eTIME system. ! Appendix A, “Predefined Data,” describes predefined data that the Enterprise eTIME system provides to simplify your administration tasks. ! Appendix B, “Function Access Profiles,” contains information about the Function Access Profiles predefined data. ! Appendix C, “Registry Keys,” describes the registry keys that were set up when your Enterprise eTIME system was installed. ! Appendix D, “Regional Settings,” discusses values that need to be set for different countries and languages. ! Appendix E, “Single Sign-On,” provides detailed information about Single Sign-On configuration. ! Appendix F, “Custom LDAP Authentication Method,” contains an overview of custom LDAP authentication and how to configure Enterprise eTIME to use custom LDAP. ! Appendix G, “Diagnostic Tools,” contains an overview of the diagnostic tools and describes how to use the different tools. ADP, Inc. Abbreviations and Terminology Abbreviations and Terminology This guide uses the following abbreviations and terms: Abbreviation/Terms Meaning ADSI Microsoft Active Directory Service Interface API Application Program Interface BGP Background Processor. A platform on which a Background Totalizer application runs. daemon A process that runs in the background and performs a specified operation at predefined times or in response to certain events. DCM Data Collection Manager. A set of functions that deals with data from data collection devices. In a multiserver environment, the DCM can run on a dedicated server. DNS Domain Naming Service DSN Data Source Name GUI Graphical User Interface HTTP HyperText Transport Protocol. A communication protocol between a client and a server. HTTPS HyperText Transport Protocol Secure. A communication protocol with encryption security, using a Secure Sockets Layer. IE Microsoft Internet Explorer IP Internet Protocol address ISO International Standards Organization JDBC Java Database Connectivity JRE Java Runtime Environment JRun The application server that resides on the Enterprise eTIME server that provides the Java Virtual Machine (JVM) and performs many tasks such as Java Server page (JSP) support and Web communication. JSP Java Server Page Enterprise eTIME System Administrator’s Guide ix About This Guide x Abbreviation/Terms Meaning JVM Java Virtual Machine LDAP Lightweight Directory Access Protocol ODBC Open Database Connectivity PDF Portable Document Format RSA A public-key cryptosystem developed by RSA, Inc. SMTP Simple Mail Transfer Protocol SSL Secure Sockets Layer ADP, Inc. Enterprise eTIME Documents Enterprise eTIME Documents The following documentation is available to help you install, maintain, and use the Enterprise eTIME database and software: ! Enterprise eTIME Installation Guide for Windows provides an overview of the Enterprise eTIME architecture, outlines the system requirements, explains how to install the product’s server and client components, and includes licensing and upgrade requirements. ! Enterprise eTIME Installation Guide for UNIX describes how to install the Enterprise eTIME server on UNIX platforms. It provides an overview of the Enterprise eTIME architecture, outlines the system requirements, and explains how to install the Application Server and Background Processor on UNIX platforms. ! Getting Started with Enterprise eTIME—A Guide for Managers explains some of the most common tasks that managers are likely to perform. It summarizes key product features for people who access employee time and attendance information. The book also explains the various Enterprise eTIME components and the most common tasks that managers are likely to perform with each component. ! Getting Started with Enterprise eTIME—A Guide for Employees 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 Enterprise eTIME—A Guide for Employees (HTML version) explains some of the most common employee tasks in Enterprise eTIME Professional - HTML Client, which include using the Timecard, Time Stamp, and Quick Time Stamp components, as well as viewing personal reports. ! Enterprise eTIME System Administrator’s Guide describes the administrator’s activities, such as system configuration and setup, and working with log reports, predefined data, and diagnostic tools. ! Enterprise eTIME Database Tables Reference Guide contains details about the Enterprise eTIME database tables. Enterprise eTIME System Administrator’s Guide xi About This Guide xii ! Enterprise eTIME Database Views Reference Guide provides information and details about Views and how they are used as virtual tables in Enterprise eTIME. ! Enterprise eTIME Database Installation Guide instructs customers and service personnel who install or upgrade Enterprise eTIME databases. Instructions include installing and setting up the Relational Database Management System (RDBMS) and ADP application database components, and upgrading your database components for compatibility with new versions of Enterprise eTIME products. ! Enterprise eTIME Database Administrator’s Guide explains how to maintain the Oracle and SQL Server 2000 databases for Enterprise eTIME. This guide includes procedures for backing up databases, restoring and recovering databases, adjusting performance, and using maintenance utilities. ! Enterprise eTIME Import Guide: Table Format provides instructions and table data for Enterprise eTIME Import tables. ! Enterprise eTIME Import User’s Guide provides information about setting up and running XML and table imports for labor management systems. It describes the Transaction Assistant used to correct failed XML import data. ! Enterprise eTIME XML Import Guide provides information that specifically addresses XML import issues, and includes descriptions of all of the tags, actions, and properties used by import transactions. ! Guide to Translating and Customizing the Enterprise eTIME User Interface and Online Help provides instructions for editing the browser-based graphical user interface, the Setup applications user interface, and the associated browser-based Help files for Enterprise eTIME and Enterprise Scheduler. ! Developer’s Toolkit documentation: Enterprise eTIME includes an Application Program Interface (API) that you can use to access certain Enterprise eTIME features from application programs. The Enterprise eTIME Developer’s Toolkit Programmer’s Guide includes annotated sample programs that show how to use the API, and the Enterprise eTIME Developer’s Toolkit Reference Guide provides detailed information about each element of the API. ADP, Inc. Enterprise eTIME Documents ! Online Help for the Enterprise eTIME system is installed automatically with the product. To access online Help: click the Help link at the bottom of the navigation bar; click the Help icon in the component; or click the Help button in a dialog box. ! Release notes provide additional information about Enterprise eTIME, including a list of new features, resolved issues, and late-breaking changes. Enterprise eTIME System Administrator’s Guide xiii About This Guide xiv ADP, Inc. Chapter 1 Introduction This chapter introduces the Enterprise eTIME system architecture and discusses its implementation in single-server and multiserver environments. This chapter contains the following sections: ! System Configuration Overview ! Configuring Enterprise eTIME ! Logging On to Enterprise eTIME ! Working with Passwords ! Changing the Relogon Session Timeout ! Working with Property Files ! Configuring a Multiserver Environment ! Working with Workflow Notifications Note: As a system administrator, you should ensure that sign-off in Enterprise eTIME is performed on a regular basis. This practice keeps the Callable Totalizer running at peak performance. Chapter 1 Introduction System Configuration Overview Enterprise eTIME labor management software enables employees to use an Internet Explorer or Netscape browser to enter, review, change, and approve the time spent in a number of job-related activities. Managers can then review, change, or approve the employees’ time, as well as use the system to set schedules, generate reports, and transfer time information to their payroll system. Use the System Configuration component to manage and configure the Enterprise eTIME system. As system administrator, you can configure various aspects of an application server, diagnose and correct problems, and establish database and networking parameters. Enterprise eTIME uses a three-tier client/server application structure. For more information, see the Enterprise eTIME Installation Guide for Windows. 1-2 ADP, Inc. Configuring Enterprise eTIME Configuring Enterprise eTIME After the initial installation of Enterprise eTIME, you perform configuration tasks in Enterprise eTIME Setup and in the System Configuration component. ! To complete setting up your Enterprise eTIME system, you perform configuration tasks in Enterprise eTIME Setup. ! To make adjustments to the Enterprise eTIME system, you perform configuration tasks in the System Configuration component. Note: Before you move from Enterprise eTIME Setup to the Enterprise eTIME System Configuration component, save the changes that you made in Enterprise eTIME Setup and then close the Enterprise eTIME Setup application. Doing this ensures that these changes will appear in the Enterprise eTIME System Configuration component. Enterprise eTIME Setup Enterprise eTIME Setup, a Windows-based component, enables you to configure the Enterprise eTIME system and provides methods for: ! Defining labor levels and their associated entries. ! Defining unique and complex pay codes, pay rules, holiday credit rules, and work rules. ! Defining accrual codes and accrual rules. ! Defining access to the Enterprise eTIME components. ! Setting up log on restrictions and user profiles. ! Determining how Enterprise eTIME displays appear. You assign the profiles, rules, and labor levels that you define using Enterprise eTIME Setup in the Web-based People Editor. Enterprise eTIME System Administrator’s Guide 1-3 Chapter 1 Introduction The configuration that you can perform in Enterprise eTIME Setup is as follows: ! Labor levels—The general categories that define an organization's job structure. ! Labor accounts—Consist of one labor level entry for each labor level. Labor accounts are used throughout the system as a way to organize or group people and labor resource information. ! Pay codes—Organize time or money that people earn. ! Work rules—Combinations of work rule building blocks that apply specific payroll rules to shifts. ! Accruals—Amounts of time or money that people earn or accrue, based on their company's accrual policy. ! Wage calculations—The hourly rate used to calculate an employee's wages. ! Access profiles—Determine the Enterprise eTIME components that users can access and the types of functions that users can perform within the Enterprise eTIME system. System Configuration The System Configuration selection on the Enterprise eTIME navigation bar contains the following components that deal with administering the system (these are accessible only with administrative rights): 1-4 ! System Information—Displays a set of tabs representing different characteristics of the system. Clicking each tab displays that area’s parameters in a workspace. This component is used primarily for viewing the current state of the application server, although several areas have some available actions. ! Log Report—Displays a workspace that can be edited, and that enables you to determine the information to be detailed in the log, and an action menu. This component allows you to create a customized log report. ADP, Inc. Configuring Enterprise eTIME ! System Settings—Displays a set of tabs representing different characteristics of the system and a workspace that can be edited. Clicking each tab displays properties for that area in the workspace, and an action menu. This component allows you to change the values for system properties and save the changes in a custom property file. When the system is offline, the system configuration components are the only part of the Enterprise eTIME system that are accessible. For information about offline mode, see “Offline Mode” in this chapter. Because you can access the Enterprise eTIME system through a Web browser, you do not need direct access to the system console and property files to administer the system. Instead, you can administer the Enterprise eTIME system from a remote location through System Configuration. Enterprise eTIME System Administrator’s Guide 1-5 Chapter 1 Introduction Logging On to Enterprise eTIME Users normally access the Enterprise eTIME system through the Web logon page specified for your server: http://<server>/wfc/logon Note that this URL is case-sensitive. Users of Enterprise eTIME Professional - HTML Client access the Enterprise eTIME system through: http://<server>/wfc/html/ess/logon.jsp Users of Enterprise eTIME Professional - HTML Client using Quick Time Stamp access the system through: http://<server>/wfc/html/ess/quick-ts.jsp For more details about HTML Client logons, see the Enterprise eTIME Installation Guide for Windows. Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your communication protocol on the Web Server Settings tab, you must use https:/ / rather than http:// for the logon URLs. Logging On with Single Sign-on If you have single sign-on enabled using SiteMinder, you can access Enterprise eTIME using the following URL: http://{server_name}/wfc/logonWithUID 1-6 ADP, Inc. Logging On to Enterprise eTIME Offline Mode As system administrator, you may need access to the administration functions of the system, even if the database is offline. When the database is not available or when the system is unavailable, you can access the Enterprise eTIME system via a special offline logon URL for system administrators. You can also use this offline logon URL if you have single sign-on enabled using SiteMinder. To access the system in offline mode, enter the following URL in your browser: http://<server>/wfc/offlineLogon Note that this URL is case-sensitive. If you log on to the system in offline mode, the System Information, Log Report, and System Settings components are the only entries that appear in the navigation bar. Note: If you specify HTTPS (HyperText Transport Protocol Secure) for your communication protocol on the Web Server Settings tab, you must use https:/ / rather than http:// for the logon URLs. Offline Mode Passwords You specify the offline mode user name and password using the site.security.authentication.offline.username and the site.security.authentication.offline.password keys on the Security settings tab. The system encrypts the value of this password. Enterprise eTIME System Administrator’s Guide 1-7 Chapter 1 Introduction Database Offline When the database is offline: ! The Database system information tab indicate that the database is offline and that no information is currently available. ! You can see that the database is offline in the Server Status box on the All Servers information tab. The WFC log lists the reason that the system appeared in offline mode. ! The site.local.TIMEZONE property on the Locale settings tab loses its validation capabilities. For more information, see Chapter 4, “System Settings.” Managing a Server Remotely You can perform the following tasks remotely using any Web browser: 1-8 ! Access log reports ! Change system configuration settings ! Restart a server ADP, Inc. Working with Passwords Working with Passwords Within the Enterprise eTIME system, there are various tasks that you can perform with passwords. ! Set passwords and security ! Update your JRun Service password ! Update the registry entries Setting Passwords and Security Enterprise eTIME has some security features that allow you to work with the passwords. You can: ! Change passwords ! Set the users’ browsers to remember passwords ! Utilize the single sign-on feature Superuser Password Security The system is configured with a predefined password for superuser. To change the online password, click Change Password in the navigation bar and enter the new password in the dialog box. Enterprise eTIME System Administrator’s Guide 1-9 Chapter 1 Introduction Client Security You can set your users’ browsers to remember passwords so that they can log on more quickly. You can disable Password Save using the following two methods: ! ! Disabling Password Save With a Deployment Tool—Using this method, you can simultaneously disable this capability for all the browsers that use your site. Users cannot change this setting. – For Microsoft Internet Explorer browsers, turn off the AutoComplete function using the Microsoft Internet Explorer Administration Kit Customization Wizard; then deploy the browsers to your users’ desktops. – For Netscape browsers, use Password Manager as part of the customization process, using the Netscape Client Customization Kit. Disabling Password Save From User Desktops—If the browsers are already on your users' desktops, you need to change this setting at each browser. However, you cannot prevent users from altering the setting. – For Microsoft Internet Explorer browsers, turn off AutoComplete through the browser’s Tools > Internet Options Content tab. – For Netscape browsers, use the Password Manager facility through the browser’s Edit > Preferences > Privacy and Security facility. Single Sign-On You can set Enterprise eTIME authentication to allow users to automatically log on to Enterprise eTIME without having to re-enter a username or password once they have logged on to their browser. This process is called single sign-on. For information about configuring your Enterprise eTIME system to utilize single sign-on, see Appendix E, “Single Sign-On.” 1-10 ADP, Inc. Working with Passwords Updating Your JRun Service Password If you change your Windows User account password on your server platform, you need to change the password in your JRun Service. 1. Select Start > Settings > Control Panel > Services. 2. In the Services dialog box, double-click JRun Default Server. 3. In the Service dialog box, do one of the following: • For Windows NT, enter your new password in the Password text box and the Confirm Password text box. • For Windows 2000, select the Log On tab, enter your new password in the Password text box and in the Confirm Password text box. 4. Click OK. Updating the Registry Entries The Background Processor makes a connection to the Enterprise eTIME database using a database user name and password provided by ADP. If you change this user name and password, you must update the Enterprise eTIME registry entries. To update the database user name and password on AIX: 1. Change to your installation directory. Note: For Enterprise eTIME installations on UNIX platforms, the default installation directory is /usr/local/adp/. 2. At the command line, all on one line, type: wfc/bgp/addDSN.sh [new user name] [new password] /wfc/properties/Registry.properties To update the database user name and password on all other platforms, use the Data Source tab. Enterprise eTIME System Administrator’s Guide 1-11 Chapter 1 Introduction Changing the Relogon Session Timeout After a set amount of inactivity in the Enterprise eTIME application, the system times out and prompts users for their password. After they enter their password, the system logs them back into the application. Session timeouts for Enterprise eTIME user inactivity are governed by the JRun session timeout parameter and the Enterprise eTIME Session Timeout grace period. The Enterprise eTIME Session Timeout grace period represents the number of minutes prior to the JRun session timeout that the Enterprise eTIME Relogon dialog box will appear. The Enterprise eTIME Relogon dialog box informs the user that their session is about to timeout, and prompts them to relogin in order to prevent timeout. If the user does not respond to the relogin request in time, the JRun session times out, the Enterprise eTIME application closes, and the user must relogin through the Enterprise eTIME logon screen. Example 1: JRun Session Timeout = 30 Enterprise eTIME Session Timeout Grace Period = 1 The Relogon dialog window appears after 29 minutes of inactivity; the JRun session closes after 30 minutes. Example 2: JRun session Timeout = 60 Enterprise eTIME Session Timeout Grace Period = 10 The Relogon dialog window appears after 50 minutes of inactivity; the JRun session closes after 60 minutes. 1-12 ADP, Inc. Changing the Relogon Session Timeout Changing the JRun Session Timeout Setting Note: You should copy the app-config.xml file (<Enterprise eTIME.rootdir>/ adp/wfc/properties) to a backup directory before you change the relogon session timeout. To change the session timeout for the Relogon screen: 1. Stop the Enterprise eTIME server using the Stop Enterprise eTIME icon. 2. Open the app-config.xml file in a text editor (<Enterprise eTIME.rootdir>/adp/wfc/properties). 3. Find the following line, where xxx is the number of minutes until session timeout: <session-config><session-timeout>xxx</sessiontimeout></session-config> 4. Enter a new value for the session timeout. The default value is 30 minutes. Do not change this value to a zero (0) or a negative integer. 5. Delete the comment characters (<!-- and --!>) that are located before and after the line of code. 6. Save the file with the original name that it had before you edited it. 7. Restart the Enterprise eTIME server using the Start Enterprise eTIME icon. Enterprise eTIME System Administrator’s Guide 1-13 Chapter 1 Introduction Changing the Enterprise eTIME Session Timeout Grace Period To change the Enterprise eTIME Session Timeout Grace Period: 1. On the Enterprise eTIME navigation bar, select System Configuration > System Settings > Web Server. 2. Enter a new value for the following key: site.webserver.session.timeout.graceperiod.minutes This value is the number of minutes that the Re-logon warning screen should display prior to the JRun session timing out. The default value is 1 minute. 3. Click Save to save the changes. 4. Click Restart Server to restart the Web server. 1-14 ADP, Inc. Working with Property Files Working with Property Files Property files are simple text files containing specifications that enable you to configure your Enterprise eTIME system. A property is defined as a line in a property file that takes the following form: property_name = value For example: site.email.batchDelivery = true Caution: Access properties only through the System Configuration component, which creates custom files. You should never modify the properties files directly. Modifying the properties files directly could render your system unusable if you modify data in them improperly. The Enterprise eTIME system maintains a subset of configuration specifications in the database, as well as in different types of property files: File Type Description Property files Files located in the Enterprise eTIME directory of each application server. Some properties are configured by default, and others you can specify during installation or initial setup. After they are installed, do not modify these files, but use custom property files instead. Custom property files Files created to keep property files intact when modifying site properties. When the System Configuration component is used to modify configuration options, these changes are stored in custom property files. The System Configuration component is the primary means to modify configuration options. Custom file names are created using the properties filename with the prefix of custom_ automatically added to the property file. When the application server is started, values in a custom property file override any matching values in the original property file. If you have multiple versions of custom files, the latest dated version takes precendence over earlier versions. Enterprise eTIME System Administrator’s Guide 1-15 Chapter 1 Introduction File Type Description Database tables Contain some properties not found in property files that are database resident, and remain relatively stable across multiple sites. Unlike regular property files, no custom overrides exist. Temporary property files Created for all properties maintained in the database, and kept in the same directory as property and custom property files. Not used for normal operations, but are used when the database is unavailable and you cannot access the database tables. Each time that the Enterprise eTIME system starts up, these files are re-created with the most current data from the database. Properties are site-specific, as in the following: 1-16 ! In a single-server environment, values relate to the entire Enterprise eTIME system. ! In a multiserver environment, values relate to either the current application server, or the database server and all the application servers connected to it. ! Properties in the database relate to all of the application servers in the system. Used when a property needs to be consistent in a multi-server environment. ADP, Inc. Working with Property Files Modifying Properties Caution: Never manual edits to any property files, as this could render your system unusable if you modify data in them improperly. Modify properties using the System Settings component of the Enterprise eTIME system, where each tab specifies a particular set of properties. To change the value of a property, access the appropriate tab, enter the new value in the Value box, and click Save. The system automatically copies this property name and the value that you typed to a custom_xxxx.properties property file. The system automatically backs up any existing custom property file before applying changes that you made using System Settings. The name of the backup file is custom_xxxx.properties.nnn, where xxxx is the name of the property file and nnn is a sequential number. Having backup files allows you to keep multiple sets of properties. For example, you can connect an Enterprise eTIME server to any one of a number of databases by creating a custom_xxxx.properties.nnn file for each database. You can rename these files or store them in different locations until you need them. Each property belongs to a property group, and is located in a specific property file, as in the following example: Property Property Group Property File site.log.loglevel site.log WFCSite.properties Enterprise eTIME System Administrator’s Guide 1-17 Chapter 1 Introduction At startup time, the system overrides the values in the property files with matching values in the custom property files. For example, if you modify the site.log.loglevel property from INFO to ERROR, the WFCSite.properties property file contains the value INFO and the custom_WFCSite.properties property file contains the value ERROR. The value ERROR overrides INFO when the system is started. The use of custom files allows you to do the following: ! To restore the initial values, use the Restore Defaults menu item on the System Settings tab. For example, you could set up values for your production database in the initial property file and values for your archived database in a custom property file. Then, if you use the archived database, you can use the custom property file. To return to your production database, use the Restore Defaults menu item on the System Settings Database tab. ! If you are upgrading your Enterprise eTIME system, the upgrade rewrites your properties files. If you have custom property files, back up these files before the upgrade. After the upgrade, you can restore your modifications by copying the current custom property files, custom_xxxx.properties, where xxxx is the name of the property file, into the properties folder and restarting the server. ! To restore a previous set of custom modifications, you can restore a historical custom property file. Select the appropriate backup file, rename it to custom_xxxx.properties, then restart the server to recover the desired set of custom modifications. You need to look at the contents of the custom_xxxx.properties.nnn to determine which file you want. Caution: Never modify the custom_WFCSite.properties file in the properties folder. If you modify the wrong information or the wrong file, you could cause system failures. When you replace an existing custom_WFCSite.properties file in the properties folder with the appropriate file for the desired database, you have the ability to connect to any one of the databases. Ensure that the file is properly renamed to custom_WFCSite.properties when you add it to the properties folder. 1-18 ADP, Inc. Working with Property Files Property File Descriptions Property files are located in the {WFC.rootdir}\properties directory on Windows platforms and the {WFC.rootdir}/properties directory on UNIX platforms. The properties directory contains all the property, custom property, and temporary property files. This directory contains several other property files in addition to the ones listed in the following table. Caution: Do not change any of these property files. Access properties only through the System Configuration component, which creates custom files. Accessing the properties files directly could lead to errors in them which could render your system unusable. The following files reside in the properties directory, with the file extension .properties. File Description WFCSite Contains most of the site-specific configurable properties for your system. WtkGlobalSetting Contains properties that apply to all the application servers. These properties are maintained in the database and are only copied to this file for use in the offline mode. This file is created from the WtkGlobalSettings table when the system is started. WFCDsnname All Enterprise eTIME application servers share the dsnname properties. These properties are maintained in the database and are only copied to this file for use in the offline mode. This file is created from the WFCDsnname table when the system is started. WFCPrinter Contains the printers that are shared among the application servers. These properties are maintained in the database and are only copied to this file for use in the offline mode. This file is created from the WFCPrinter table when the system is started. Enterprise eTIME System Administrator’s Guide 1-19 Chapter 1 Introduction File Description WFCServer A list of all the application servers in your Enterprise eTIME system is maintained in the WFCServer table in the database. These properties are maintained in the database and are only copied to this file for use in the offline mode. This file is created from the WFCServer table when the system is started. SiteDsnname Contains initial properties established when your system was started for the first time. Contains the dsn settings returned by Enterprise eTIME to the BGP, Configuration applications, and DCM when they are authenticated against the Enterprise eTIME server. SitePrinter Contains the Enterprise eTIME printer specified during installation. SiteServer Contains the Enterprise eTIME server name specified during installation. ApplicationRegistry Lists applications installed on your application server. 1-20 WFCStrings Contains the text of all user-visible messages and data that can be translated to other languages. Also note internationalization files such as WFCStrings_es.properties (for Spanish) and WFCStrings_fr.properties (for French). WFC Contains system properties such as the paths for HyperText Markup Language (HTML) and JavaServer Pages (JSP). WFCProduct Contains Enterprise eTIME product data. Also note internationalization files such as WFCProduct_es.properties (for Spanish) and WFCProduct_fr.properties (for French). SQL String properties Contains all of the SQL statements that your system uses. SQLCoverage Contains a count of how many times each SQL string has been used by the application. ADP, Inc. Working with Property Files File Description Vlslm Contains the licensing configuration information. License Contains the license configuration options information. LleImportErrors Contains the labor level entries import error messages. SQL String Properties You can specify up to three files. You specify the files that contain these SQL string properties as the values of the following properties, located in WFCSite.properties: ! site.service.sql.strings.file.first ! site.service.sql.strings.file.second ! site.service.sql.strings.file.third String properties files are based on the database platform: ! SQLStrings.properties—Contains SQL statements common to Microsoft SQL Server, Oracle and DB2. ! SQLStringsORACLE.properties—Contains SQL statements specific to Oracle statements. ! SQLStringsDB2.properties—Contains SQL statements specific to DB2. ! SQLStringsSQLSVR.properties—Contains SQL statements specific to Microsoft SQL Server. ! SQLStringsOS390.properties—Contains SQL statements specific to OS390. Enterprise eTIME System Administrator’s Guide 1-21 Chapter 1 Introduction Examples of SQLString property file assignments are: site.service.sql.strings.file.first = SQLStrings.properties site.service.sql.strings.file.second = SQLStringsSQLSVR.properties. You can specify other SQLString property files that are in the properties directory. Groups of Properties Properties are grouped based on subject matter. For example, the site.log group contains all of the properties that are associated with system logs. Examples of properties in this group are site.log.active, site.log.file.name, and site.log.rollover.maxlogs. Each tab in System Settings deals with one group of properties. Properties are maintained in property files or in database tables. The following list shows the property group that is associated with each System Settings tab and the location of the property group: System Settings Tab Property Group Location Callable Totalizer site.totalizer WFCSite.properties Database site.database WFCSite.properties Data Source dsnname For online operations, the WFCDsnname database table For offline operations, WFCDsnname.properties E-mail site.email WFCSite.properties Event Manager site.eventmanager WFCSite.properties Global Values global For online operations, the WtkGlobalSettings database table For offline operations, WtkGlobalSetting.properties 1-22 ADP, Inc. Working with Property Files System Settings Tab Property Group Location Group Edits site.groupedit WFCSite.properties Local Values site.local WFCSite.properties Log File site.log WFCSite.properties Logging Context site.loggingContext WFCSite.properties Portal site.portal WFCSite.properties Printers printer For online operations, the WFCPrinters database table For offline operations, WFCPrinters.properties Reports site.reporting WFCSite.properties Security site.security WFCSite.properties Service site.service WFCSite.properties SQL Coverage test.SQLCoverage WFCTest.properties Startup test.startup WFCTest.properties Web Server site.webserver WFCSite.properties Enterprise eTIME System Administrator’s Guide 1-23 Chapter 1 Introduction Configuring a Multiserver Environment You can set up the Enterprise eTIME system to operate on multiple application servers to improve performance, especially if your organization has more than 2,000 employees. Since each application server is set up with only one language, one country, and one currency, you must set up multiple application servers to deal with multiple languages, countries, and currencies. If you set up multiple application servers, a user can connect to any Web or application server. The user specifies a Uniform Resource Locator (URL) for connecting to the Enterprise eTIME system. This URL depends on whether your system uses load-balancing software from a third party to balance the load of incoming requests and determine which application server receives any specific request. ! If load balancing is not used, each user must specify the URL for a specific application server. ! If you use load-balancing software, all users must specify the same URL. The software then determines which application server handles user requests. For more information about multiserver envrionments, see the Enterprise eTIME Installation Guide for Windows or the Enterprise eTIME Installation Guide for UNIX. Configuring Group Edits for a Multiserver Environment For Group Edits, the primary Group Edit server is the only one authorized to run the Group Edit Recovery and Delete threads. You must designate one server as the primary Group Edit server using the site.groupedit.primaryServer key. 1-24 ADP, Inc. Configuring a Multiserver Environment Configuring E-mail for a Multiserver Environment For Workflow Notifications, the primary Notification server monitors conditions for which the notification is requested and initiates the preparation of e-mails when the condition is met. You must designate one server as the primary notification server. This server can be the same one that you use for other purposes, or it can be a dedicated server. Notifications can be configured on any server, but only the primary notification server can initiate notification processing. You must reconfigure other keys on the E-mail settings tab. If you have a multiserver environment, you must configure the e-mail function: ! By default, the site.email.primary_server value is set to true for all application servers. Determine which is your primary Notification server and set this property to false for all other application servers. ! For the primary Notification server, set the site.email.smtp.url value to the URL of your e-mail server. ! For the primary Notification server, set the site.email.sender value to an e-mail address; for example, [email protected]. ! By default, the site.email.enable value is set to false. You must set this value to true on all application servers if e-mail is supported. Configuring Event Manager for a Multiserver Environment For Event Manager, you can set up events on any server, but only the primary Scheduler server can schedule the event processing. You must designate one server as the primary scheduler. This server can be the same one that runs other applications, or it can be a dedicated server. Note: Before you designate a server as the primary Scheduler, you must install Microsoft Task Scheduler, part of the Microsoft Internet Explorer (IE) 5.5 application. To install the Task Scheduler, install IE 5.5 and select the Offline Editing Tools option. Install Task Scheduler as a service that starts automatically. Enterprise eTIME System Administrator’s Guide 1-25 Chapter 1 Introduction In a multiserver environment, configure the Event Manager function: ! ! You can configure only one application server as the primary Scheduler to manage events created through the Event Manager function. – Windows NT and Windows 2000 platforms: By default, the site.eventmanager.enabled key is set to true for all application servers. Although an event can be scheduled from any application server in the system, only the primary Scheduler can initiate the processing of these events. You must determine which is your primary server and change this value to false for all other application servers. – UNIX platforms: Set the value of site.eventmanager.enabled to false since Event Manager runs on the companion Windows server. By default, the site.eventmanager.hostname key is set to LOCALHOST for all application servers. Retain this setting for your primary Scheduler server only. Set the value for all other servers to the name of the primary scheduler server. Note: For UNIX platforms, fill in the value of with the name of the companion Windows server. Set other values to false. If you are setting up the primary server and your site is configured for Secure Sockets Layer (SSL) communications, set site.eventmanager.hostname to the fully-qualified domain name, for example, sslserver.kronos.com. For all application servers, where you set site.eventmanager.enabled to false, set the value of site.eventmanager.hostname to the name of the Scheduler server. 1-26 ADP, Inc. 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 example, you can notify a manager if people have not completed their timecards by a specific time in the pay period. In a single-server environment, the notification server is the same as the application server. In a multiserver environment, one server acts as the primary notification server and monitors all notifications that were created at any application server. At the appropriate time, the notification server generates the notification and e-mails it to the specified recipients. Notification Types Several types of notifications are available. Each type is a template that you use to set up a specific notification request. There are two categories of notification types, automatic, and those initiated by an event. ! Automatic notification types are activated at a predefined period of time before or after the end of a pay period, and provide a mechanism for sending an automatic reminder to a manager or an employee. These types include pay period based for both managers and employees. For these notification types, select a HyperFind query from the Recipients drop-down list to obtain a list of e-mail recipients. To notify managers, select the employees listed in the notification by selecting a HyperFind query from the Employees drop-down list. Because the recipient list and the list of people returned from the HyperFind query can be large and unstable, you may modify the lists returned in either HyperFind query. Enterprise eTIME System Administrator’s Guide 1-27 Chapter 1 Introduction ! Event-initiated notification types include the following: – Approved, signed off, and edited, which all relate to employees and are associated with timecards. These are initiated by a person who takes an action, such as a manager who signs a timecard. For some types, such as group edit completion and event status, you cannot specify the e-mail recipients, which are determined by the function access profile that contains access control points for the notification type. – Group-edit failures. The recipients are determined by the function access profile that contains an access control point for this notification type, though you can also specify additional recipients. – Database unavailable and application server rebooted, both of which require administrative intervention. You can specify the recipients. For more information about notification types, see the online Help for Workflow Notifications. Available Notification Several types of notifications are available. 1-28 ! For managers, pay period based—Sent to managers based on the number of days and/or hours before or after the end of a pay period for various reasons, such as all employees whose timecards contain missed punches. ! For employees, pay period based—Sent to employees based on the number of days and/or hours before or after the end of a pay period for various reasons, such as all employees whose timecards contain missed punches. ! Server Notification—Sent when a user-selected event occurs on a userselected Enterprise eTIME service. ! Event status—Sent whenever a change in status is recorded for an Enterprise eTIME event. ! Database server unavailable—Sent when the database server becomes unavailable. ! Application server booted—Sent whenever the Enterprise eTIME application server is started or restarted. ADP, Inc. Working with Workflow Notifications ! Group edit failed—Sent when a group edit fails before completion. ! Group edit completed—Sent when a Group edit has completed. ! Timecard signed off by manager—Sent to employees after their timecards have been signed off by a manager. ! Timecard approved by manager—Sent to employees after their timecards have been approved by a manager. ! Timecard edited by manager after employee approval—Sent to employees when their timecard is edited by a manager after the employee has approved the timecard. For more details and specific configuration instructions, see the online Help for the notification that you are setting up. Setting Up a Workflow Notification To set up a Workflow Notification, you must first establish the notification properties to enable the process. You only do this once using the e-mail function described in “E-mail Settings” in Chapter 4. Specify attributes such as the URL of your Simple Mail Transfer Protocol (SMTP) server, name the sender of the Workflow Notifications, and enable batch delivery. Most of the properties in the e-mail function are established during installation or initial configuration, and do not usually change. After establishing the properties, you can also do the following: ! Select the notification type that matches your needs by using the Workflow Notifications component. Complete the template with your specific requirements. ! The recipients for different notification types are determined differently, as described in the previous “Notification Types” section. Depending on the notification type, identify the recipients of the notification. To customize an email message and name it, complete the Name and Message entries. Enterprise eTIME System Administrator’s Guide 1-29 Chapter 1 Introduction ! You can find records of people who are candidate e-mail recipients and determine whether e-mail addresses are present for these people using the People Editor. You can add any addresses not present. If you set up a recurring notification, be sure to update each Person record accordingly as new people are added or deleted from the list of recipients. ! Determine access, as explained in the following section. Access Notification depends upon access, determined by the following: ! A function access profile, which identifies an Enterprise eTIME system component to which a group of users has access; for example, HyperFind. If necessary, create an appropriate function access profile in Enterprise eTIME Setup in your configuration PC, using Enterprise eTIME Setup > Access Profiles. ! An access control point, which identifies a specific function that can be accessed, and can be set for Enterprise eTIME Professionals or Enterprise eTIME Managers. For specified recipients to receive notification, not only does the notification have to be initiated, the recipient must have the appropriate access control point settings in their function access profiles. For example, to set up a notification for a group edit completion, you must also set the E-mail on Completed Group Edit access control point to Allowed. The following notifications types rely on access control points to determine recipients: 1-30 ! Group Edit completed ! Group Edit failed ! Event Status ! Timecard signed off by manager ! Timecard approved by manager ! Timecard edited by manager after employee approval ADP, Inc. Working with Workflow Notifications To determine whether an Enterprise eTIME Professional qualifies to receive a notification, access Enterprise eTIME Setup > Access Profiles > Enterprise eTIME Professional > E-mail Notifications to Employees: Access Control Point Description E-mail when timecard edit occurs after employee’s approval Notify an employee if a manager edits a timecard after an employee approves it. E-mail when timecard is approved Notify an employee if a manager approves his or her timecard. E-mail when timecard is signed off Notify an employee when his or her timecard is signed off after approval. To determine whether an Enterprise eTIME Manager qualifies to receive a Workflow Notification, access Enterprise eTIME Setup > Access Profiles > Enterprise eTIME Manager - Department Manager > E-mail Notification: Access Control Point Description E-mail a completed group edit Notify a manager when a group edit has been completed. E-mail an incomplete group edit Notify a manager when a group edit fails. E-mail event status Notify a user of a change in status for a scheduled event. Enterprise eTIME System Administrator’s Guide 1-31 Chapter 1 1-32 Introduction ADP, Inc. Chapter 2 System Information This chapter explains the System Information component of the Enterprise eTIME system and describes the tasks that you use to administer the system. This chapter contains the following sections: ! Working with System Information ! All Servers Information ! Applications Information ! Background Processors Information ! Database Information ! Licenses Information ! Local Server Information ! Meters Information ! Primary Labor Account Update Information ! Threads Information ! User Information Chapter 2 System Information Working with System Information System Information displays a set of tabs that displays information about the current state and configuration of the application server. Click a tab to see the information for that area displayed in a workspace. Although System Information functions are primarily for viewing only, you can do the following: ! Update the display with the most current information by clicking Refresh in the Enterprise eTIME header. Note: You cannot update the workspace using your browser’s Refresh button. ! Print the display, using your browser’s print function. ! Stop and restart threads listed in the Threads tab. ! Click Restart Server on the Local Server tab to restart the server. Caution: Clicking the Restart Server button causes the system to shut down immediately. Users receive no advance warning. 2-2 ! Delete application servers that are no longer connected to the database in the All Servers tab. ! Generate database reports on the Database tab if you have a SQL Server or ORACLE database. ADP, Inc. All Servers Information All Servers Information The All Servers workspace contains information about all of the application servers connected to the database that is indicated on the Database tab. The following information appears in the workspace: ! Server Name—Identifies each application server that is connected to the database. ! Server Status—Shows whether each application server is online. ! Language—Shows the language of each application server. ! Reports Engine—Shows whether each application servers report engine is enabled. ! Event Manager—Identifies the Enterprise eTIME server that is the Event Manager server. Event Manager determines which Enterprise eTIME server is the Event Manager server by looking at the database. ! Protocol—Shows the protocol of each application server. The Restart button is unavailable at this time. Click Delete to remove an application server that is disconnected from the database and is no longer part of Enterprise eTIME. Enterprise eTIME System Administrator’s Guide 2-3 Chapter 2 System Information Applications Information The Applications workspace allows you to view the name and version number of the products that are currently installed on the application server. This list of products can also be found in {Enterprise eTIME.rootdir}\wfc\applications. Some components of Enterprise eTIME appear as products, such as Event Manager. You can also see this list in the ApplicationRegistry.properties property file. 2-4 ADP, Inc. Background Processors Information Background Processors Information The Background Processors information tab has different workspaces. ! Background Processors workspace—Allows you to view any employees that have been excluded from totals calculation. ! Totals Calculation - Excluded Employees workspace—Allows you to view any employees that have been excluded from totals calculation. ! Historical Edits with Retroactive Pay Calculation - Excluded Employees workspace—Allows you to view any employees that have been excluded from historical edits with retroactive pay calculation. Background Processors Workspace The Background Processors workspace allows you to view any employees that have been excluded from totals calculation or have untotalized Historical edits. ! If there are employees with untotalized Totals Calculations, the number appears as a link to the Totals Calculation - Excluded Employees workspace. ! If there are employees with untotalized Historical edits, the number appears as a link to the Historical Edits with Retroactive Pay Calculation - Excluded Employees workspace. Click Resubmit All Employees for Totals Calculation to submit all of the employees that qualify for totalization without going to the Totals Calculation Excluded Employees workspace. Click Resubmit All Employees for Historical Edits to resubmit all of the employees that qualify for retroactive totalization without going to the Historical Edits with Retroactive Pay Calculation - Excluded Employees workspace. Note: Submitting one or more employees for totalization means that they become eligible for retotalization. This attempt to retotalize an employee does not happen until a background processor is available. Enterprise eTIME System Administrator’s Guide 2-5 Chapter 2 System Information Totals Calculation - Excluded Employees Workspace The Totals Calculation - Excluded Employees workspace allows you to view any employees that have been excluded from totals calculation. 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 submittal to totals calculation ! Name ! Person ID from Database ! ID Field from People Editor ! Last Totals Update The following actions are available: ! Select All—Selects all of the viewable employees. ! Deselect All—Deselects all of the viewable employees. ! Resubmit—Submits any selected employees that qualify for totalization. Clicking Background Processors returns you to the Background Processors workspace. 2-6 ADP, Inc. Background Processors Information Historical Edits with Retroactive Pay Calculation - Excluded Employees Workspace The Historical Edits with Retroactive Pay Calculation - Excluded Employees workspace allows you to view any employees that have been excluded from historical edits with retroactive pay calculation. 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 submittal to totals calculation ! Name ! Person ID from Database ! ID Field from People Editor The following actions are available: ! Select All—Selects all of the viewable employees. ! Deselect All—Deselects all of the viewable employees. ! Resubmit Employees—Submits any selected employees that qualify for totalization. Clicking Background Processors returns you to the Background Processors workspace. Enterprise eTIME System Administrator’s Guide 2-7 Chapter 2 System Information Database Information The Database information tab has different workspaces. ! Database workspace—Allows you to view the status and details about the database that the Enterprise eTIME server is currently connected to, and run and view various database reports. ! Database Report Status workspace—Allows you to view the current list of database reports. ! Database Report Display workspace—Allows you to view a database report that you selected in the Database Report Status workspace Database Workspace The Database workspace allows you to view the status and details about the database that the Enterprise eTIME server is currently connected to, and run and view various database reports. The following information appears in the workspace: ! Database Service ID—Your application server can connect to different databases. The database shown is the one to which the application server is currently connected. ! Status—Shows whether the database is online. ! Version—Shows the version of the database. ! Database Server ! Server Time—The time of day shown is the time used for all time-specific data. Synchronize your application server’s time of day with that of the database using the Clock Synchronize Settings tab. ! 2-8 – If the database and the application server are in the same time zone, the Enterprise eTIME system uses this value. – If the database and the application server are in different time zones, the system accommodates the different time zone. Database Product ADP, Inc. Database Information ! Product Version ! Available Database Reports—For SQLServer or ORACLE databases only. This functionality is not available for DB2 databases. If you have a SQLServer or ORACLE database, you can run database reports that provide statistical and diagnostic information. The Available Database Reports list box contains four predefined reports (Space allocation, Object Reconciliation Information, Schema Reconciliation Information, and Tuning Parameters). You can create and list custom reports here by building your own Database Report Definition (DRD) files. For more information, see “Creating Database Report Definition Files.” You can use these reports to view information such as: ! How much space is left ! Number of extents available ! Table space definitions ! Grants and permissions ! Performance tuning parameters Click View Report Status to access the Database Report Status workspace. The View Report Status link is active even if there are no reports listed in the Database Report Status workspace. When there are no reports, an empty list appears. Click Run Report to run a report. When you run a report, the Database Report Status workspace appears automatically. Enterprise eTIME System Administrator’s Guide 2-9 Chapter 2 System Information Database Report Status Workspace The Database Report Status workspace allows you to view the current list of database reports. The list of reports appears in a table format that contains the following information for each report: ! A check box that indicates if the report has been selected for deletion ! Report Name ! Status ! Start Date and Time ! Finish Date and Time ! Requested By User The following menu items are available: ! Refresh Status—Updates the workspace with any new or updated data ! Select All—Selects all of the reports ! Deselect All—Deselects all of the reports ! Delete—Deletes a report from the list Click on a report name of a completed or failed report to view that report. Clicking the Database tab or the Database link returns you to the Database Information workspace. Click Refresh to update the workspace with any new or updated data. Note: You cannot update the workspace using your browser's Refresh button. The system periodically deletes reports from this workspace if you do not manually delete them. You can configure the length of time that it takes for a report to be automatically deleted using the site.database.all.dbreport.Report.RepTimeToLive key on the Database settings tab. The value is expressed in hours and the default is 72 hours. 2-10 ADP, Inc. Database Information Database Report Display Workspace The Database Report Display workspace allows you to view a database report that you selected in the Database Report Status workspace. Clicking the Database link returns you to the Database information workspace. Clicking Report Status brings you to Database Report Status workspace. Working with Database Reports You can work with database reports using the Database Information tab in System Information. To run a database report: 1. Select System Configuration > System Information > Database. 2. Under Available Database Reports, highlight the report. 3. Click Run Report. To display a database report: 1. Select System Configuration > System Information > Database. 2. Click View Report Status. 3. In the Database Report Status workspace, click the report name. To delete a database report: 1. Select System Configuration > System Information > Database. 2. Click View Report Status. 3. In the Database Report Status workspace, select the report by clicking in the box to the left of the Report Name. 4. Click Delete. 5. Click OK in the confirmation dialog box. Enterprise eTIME System Administrator’s Guide 2-11 Chapter 2 System Information Creating Database Report Definition Files You can create and list custom reports to appear in the Available Database Reports list box by building your own Database Report Definition (DRD) files. The DRD file must contain all four attributes that the database reporting framework needs to execute the report: name of the report, database platform ID, SQL type, and SQL string. The attributes are expressed using Key and Value pairs. The Key and Value pairs are: ! Name of the report – The first key component can be anything, but the user must use it as the first component for each of the four keys that comprise the DRD file. – The second key component can be anything, but the user must use it as the second component for each of the four keys that comprise the DRD file. It must be unique among other DRD files. If the system detects a duplicate value in more than one DRD file, then only the first DRD file is displayed in the report list and any duplicates are ignored. – The third key component must be reportName. The entire key must be followed by the “ = ” string. Thereafter, the user may specify any value as the reportname, for example Person Report. ADP recommends that you name the DRD file the same name as the report to easily associate a report with its DRD file. For example, sqlServerPersonReport.drd. ! Database platform ID – The first component is the same as the first key component for the report name attribute. – The second component is the same as the second key component for the report name attribute. – The third key component must be dbPlatformID. The key must be followed by the “ = ” string. Thereafter, the user may specify either of the valid values SQLSERVER or ORACLE. 2-12 ADP, Inc. Database Information ! SQL Type – The first component is the same as the first key component for the report name attribute. – The second component is the same as the second key component for the report name attribute. – The third key component must be sqlType. The key must be followed by the “ = ” string. Thereafter the user may specify either of the valid values STANDARD or STORED. Since our hypothetical example uses SQL, not a stored procedure, the value paired with this key is STANDARD. ! SQL String – The first component is the same as the first key component for the report name attribute. – The second component is the same as the second key component for the report name attribute. – The third key component must be sqlString. The key must be followed by the “ = ” string. Thereafter the user may specify either the executable SQL or the name of the stored procedure. Guidelines for Creating Database Report Definition Files A customized Database Report Definition (DRD) file must conform to the DRD file format. In order for customized database reports to execute correctly, you must follow these rules: ! The contents of a DRD file must be entirely ASCII text. ! The contents of a DRD file must comply with the key and value format. ! The DRD files must reside in the folder <ADP Installation>\wfc\reports\DBReports\DRD ! The extension of a DRD file must be .drd (must be lowercase). ! ADP recommends that you use SELECT statements only. SELECT statements usually return results sets. Enterprise eTIME System Administrator’s Guide 2-13 Chapter 2 System Information ! ADP recommends that you not use stored procedures, especially when SELECT statements can be used instead. A stored procedure against a SQL Server database will likely return a result set, but will not return report column headers. As stored procedures become more complex, the result set(s) become less predictable. A stored procedure against an Oracle database does not even return a result set, so it does not produce a report at all. If you specify a stored procedure (as opposed to actual SQL) to produce the report, you must ensure that the compiled procedure resides in the database. You can create a SQL Server stored procedure through Query Analyzer, or you can pass a script file containing the Create Procedure statement to an Open Database Connectivity (ODBC) or Java Database Connectivity (JDBC) connection to build the procedure. In either case, you must have the appropriate permissions to create objects in the database. Stored procedures are compiled by issuing the Create Procedure command. Once compiled, they reside in the database. 2-14 ! If your Create Procedure statement has no syntax problems and is correctly referencing existing DB objects, then the statement creates and compiles the procedure. If there are problems that will not let the procedure be created in a valid state, be aware that the procedure gets created but is in an INVALID (un-compiled) state. ! You should test your SQL or stored procedure prior to executing it from the feature. The application is not responsible for the correctness of the SQL, so you must ensure that the SQL works as intended. Executing a bad DRD file may or may not return anything in the way of a results set. Therefore, there is no guarantee that you will see anything that will be helpful if you view the report. The report appears in the Report Status page with a status of Failed. ! The application does not check to ensure that there is adequate disk space for the report results file since there is no way to know in advance what the size of the results file will be. ! You must be logged on as a user who has access rights to the System Configuration features as well as full-access rights to the database. This logon includes the user name that was specified at installation time, as well as the username “SuperUser” and the usual password associated with that username. ! The purpose of the feature is to generate reports, not to perform updates (such as inserts, changes, and deletes). ADP, Inc. Licenses Information Licenses Information The Licenses workspace allows you to view the current licensing information for Enterprise eTIME on the application server. You can view your license limit, licenses in use, and the resulting license availability for each product. Click Reread License Files to update the workspace with any new or updated data from the license files. The notification threshold at the top of the workspace specifies the number of licenses left available before a notification is sent warning that the number of available licenses is getting low. The threshold value is a percentage of the total number of licenses. For example, if you have licenses for 1000 employees, and the percent is set to 90, an e-mail notification is sent out when the number of licenses in use reaches 900. You can edit the notification threshold by changing the value in site.email.license.percent in E-mail Settings. You define the notification e-mail address during the notification configuration process. If you have multiple servers, you must install license update files on each server and each server's license workspace must be refreshed for the additional licenses to be available for that server. Enterprise eTIME System Administrator’s Guide 2-15 Chapter 2 System Information Local Server Information The Local Server workspace contains a list of all servers that are connected to the same database. You can view the following application server information: ! Server Name—Identifies your current application server. Property files are specific to the application server. If you administer multiple application servers, use this information to identify the server to which you are connected before you modify its properties. ! Server IP Address—Identifies the IP address of the application server. ! Server Status—Indicates whether the application server started up in online or offline mode. ! Server Time ! Server Version ! User Sessions—Specifies the number of current users on this application server. This value is equal to the number of rows in the User information tab. Click Restart Server to restart the application server. You receive a confirmation message before the restart occurs. Caution: Clicking Restart Server causes the system to shut down immediately. All user sessions are terminated with no warning. 2-16 ADP, Inc. Meters Information Meters Information The Meters workspace allows you to view the performance utilities that are installed on the application server. By studying the results of running these meters, you can assess the performance of your system and analyze peak usage periods. To open a specific meter to view its results, click the blue triangle next to the meter. Click Reset to restore a meter to its initial state before the system collects any data. The Reset feature is intended for debugging when you are working with a TLM Representative. Enterprise eTIME System Administrator’s Guide 2-17 Chapter 2 System Information Primary Labor Account Update Information The Primary Labor Account Update Information tab has different workspaces. ! Primary Labor Account Update workspace—Allows you to view the number of people who have changes in their primary labor account after the organizational map process occurs that needs to be fixed. ! Resubmit All People for Account Update workspace—Allows you to view the people who have changes in their primary labor account after the organization map process occurs that needs to be fixed. Primary Labor Account Update Workspace The Primary Labor Account Update workspace lists the number of people who have changes that need to be fixed in their primary labor account 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. 2-18 ADP, Inc. Primary Labor Account Update Information Resubmit All People for Account Update Workspace The Resubmit All People for Account Update workspace lists the people who have changes in their primary labor account after the organization map process occurs that need to be fixed. 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 ! Person ID from Database ! ID Field from People Editor The following actions are available: ! 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. After you manually update any employee’s primary labor accounts, submit them for primary labor account updates. For information about updating employees primary labor accounts in People Editor, see the Help topic “Changing a person’s profile.” Clicking Primary Labor Account Update returns you to the Primary Labor Account Update workspace. Enterprise eTIME System Administrator’s Guide 2-19 Chapter 2 System Information Threads Information The Threads workspace allows you to view, restart, and stop the long-running Enterprise eTIME daemons that are currently running on the application server. Keep track of these daemons to see that they run as expected. Each row shows information about one thread. Columns display information about each thread: ! ! 2-20 Restart—Click this button to Restart a thread that is Stalled or Stopped. Works with an entry in the State column. – Restarting a Controller thread restarts all the Worker threads that are associated with it. – Restarting a Worker thread has no effect on any other thread. Stop—Click this button 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 if the thread is 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. ADP, Inc. Threads Information ! State—Identifies the current status of a thread: – Running; the thread is currently performing work. – Stopped; the thread is not currently running. – Stalled; the thread is not doing useful work; it has encountered a problem and is unable to proceed. The system activates Controller threads periodically. If a Controller thread is activated and identifies a child Worker thread that is stalled, the Controller thread restarts the stalled Worker thread. – ! Ready and waiting for work. Controller—Identifies how a thread is controlled. – For a Worker thread, this column identifies its parent Controller thread. – For a Controller thread, this column has a blank value. ! 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. Enterprise eTIME System Administrator’s Guide 2-21 Chapter 2 System Information User Information The User workspace identifies users who are currently logged onto the application server. Information for each user appears in a separate row. You can use this workspace to see who has logged on to the application server. Users should have a separate system ID and should not all use superuser as a login. In addition to the logon time, the following information appears for each user: ! The Last Access column shows the last time that each user took an action in the session. It also identifies users whose sessions have remained inactive for a period of time. ! The Elapsed Time column shows how long a user session has lasted. This column can also identify unusually long-running sessions. ! The Remote User column identifies the Internet Protocol (IP) address of the user’s PC. If multiple users have the same User Name, the Remote User column distinguishes between them. Click Refresh to receive up-to-date values for Last Access and Elapsed Time. 2-22 ADP, Inc. 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 ! Log Files ! Log File Report ! Filtering and Running Log Reports ! Archiving System Log Reports Chapter 3 Log Report Log Reports Use the Log Report workspace to specify parameters for a log report based on information in the system log files. You can: ! Arrange this information into customized reports. ! Generate reports by using the default values or by specifying a log filter to produce a more concise report. ! Distribute the reports by e-mail, by first highlighting, copying, and pasting the log report output to a file, then e-mailing the log report file as an attachment. Though you can access any log file with a text editor such as Wordpad, log files can be large and unwieldy. You can create a customized log report using the Log Report workspace. The default location for log reports is {Enterprise eTIME.rootdir}\logs for Windows platforms and [installation directory]/wfc/logs for UNIX platforms. The Enterprise eTIME system records system events for one application server in one or more system log files. If you have a multiserver environment, each application server has its own set of log files. If you use the log for analysis and troubleshooting, you can print the report using the print function in your browser. ! In Internet Explorer, click Print or right-click on the report page and select Print. ! In Netscape, select File > Print. To specify multiple items in a drop-down list, use Shift+Click to select adjacent items, or use Ctrl+Click to select random items. Click Run Report to run a log report after you have selected filter criteria. Click Refresh to restore the report defaults and update the server list with any new servers attached to the same database. 3-2 ADP, Inc. Log Reports Key and Value Details Servers—Select a server, a combination of servers, or all servers. The default setting is All. Note: If you have multiple servers attached to your database, consider selecting a subset of the entire list of servers instead of all servers. Selecting a subset of servers lessens the possibility of memory errors. If you select a subset, you need to run the log report several times with different servers listed each time in order to get data from all of the servers. The extent to which you might have to select a subset depends on multiple factors, such as the amount of memory on the host server, the number of servers connected to the same database, as well as the filtering criteria supplied for the log report. Start Date and End Date—The Start Date and End Date specify a range of dates and an optional time. The first value is always the Date. The report includes any messages that were generated during the specified date and time ranges. Context—Context classifies log messages by the Enterprise eTIME subsystem that generated them. You can filter your report based on the context categories that you need. The default is All. If you select multiple contexts, the report includes messages from each context in the order in which you selected them. The purpose of this entry is to reduce the amount of information used for a report. If you know that a specific context is involved with a problem, specify that context to significantly reduce the amount of data that you read. For example, if your problem involves WFC.WFP.DAEMON, select that function from the list to see only records related to that context. ADP recommends that you use the Context option when requested to do so by TLM Support. Most of the time, select All. Enterprise eTIME System Administrator’s Guide 3-3 Chapter 3 Log Report User Name—A User Name is a user session name associated with a message. The log includes the system as a user. The default is All. Set this variable to a specific user name to find all log entries associated with this user. To enter multiple User Names, put a comma (,) between each user. A space is not required between the comma and the next User Name. Priority—This value determines the severity level display of the system log. Severity levels are not inclusive, so you can request one level, several levels, or All. The default value is All. Specifying All includes all available log levels. You set the value of the site.log.loglevel property in the Log File tab of the System Settings component. 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 ADP support personnel (not intended for general use) Note: Use DEBUG only if requested by TLM Support. Message Contains—The Message Contains value is a text string typically found in messages. This value is an optional text box. The default is all message text. You can specify any text string that occurs in the message portion of the log record to get only records containing that text. You cannot use the percent sign (%) or the single quote (‘) in the text string. Sort By—The Sort By filter arranges the report in the order of the selected criteria. If a report is sorted by DATE, PRIORITY, and CONTEXT, the messages in the report are ordered first by date, followed by priority order of ERROR, WARN, INFO, DEBUG, and then the messages are sorted by selected context groups. The default sort order is DATE. 3-4 ADP, Inc. Log Files Log Files A system log can span multiple servers. The Server drop-down list shows all application servers that are connected to the database that you are using. Note: Log files might contain error messages that do not require you to take any action. If you see error messages, but the system is in online mode and the task that you are doing completes correctly, ignore the error messages. These error messages are for tracking purposes only. When your Enterprise eTIME system was installed, the value of the property site.log.file.name was set to WFC.log. The name WFC.log is used for the first log file name in the drop-down list. While WFC.log has no number associated with it, the remaining list entries have numbers. The WFC.log file is the file currently being written. When WFC.log reaches its maximum size, the file is renamed WFC.log.1, the names of all existing log files are incremented by 1, and a new WFC.log file is created. The number of log files available from the drop-down list depends on the number of log files that you specified in the site.log.file.rollover.maxlogs property. This property is available in the Log File tab of the System Settings component. ! If you specified 0 (zero), the only log file written is WFC.log. When that file is completed, it is emptied and rewritten. ! If you specified a number other than zero, you can have as many completed log files as that number specifies. The oldest log file in the system has the highest number. When all of the log files specified in site.log.file.rollover.maxlogs are written, the oldest log file is cycled out. Note: Do not modify a log file using a text editor, as the log report expects a certain format, and changes may prevent the report from displaying properly. Enterprise eTIME System Administrator’s Guide 3-5 Chapter 3 Log Report Log File Report One system log message is written to each line with the following information: ! A time stamp of the form yyyymmddhhmmss; for example, 20020207040816. ! The name of the context for which the message was recorded; for example, WFC.STARTUP. ! The user ID of the user who caused the message to be written. ! The log level (or severity) encountered; for example, INFO. ! The text of the message; for example, Initializing WFC properties.... Note: These log report facilities are only available for the system log and do not include information recorded in specialized logs for the Event Manager or Reports. You might see an Event Manager or a Reports exception in the system log. However, you should examine the logs for those components, rather than relying on the system log to inform you of a problem. The following example illustrates a system log file: 3-6 ADP, Inc. Filtering and Running Log Reports Filtering and Running Log Reports You can filter log reports to include only certain log messages. All criteria are optional. Limit the report content by specifying content that can help you analyze server activity. Results are always in alphabetical order based on the sort order that you specified in the Sort By selection boxes. To filter and run a log report: 1. Select System Configuration > Log Report. 2. Select the filter criteria from the following options: • Select a server from the drop-down list. Note: If you have multiple servers attached to your database, consider selecting a subset of the entire list of servers instead of all servers. Selecting a subset of servers lessens the possibility of memory errors. If you select a subset, you need to run the log report several times with different servers listed each time in order to get data from all of the servers. The extent to which you might have to select a subset depends on multiple factors, such as the amount of memory on the host server, the number of servers connected to the same database, as well as the filtering criteria supplied for the log report. • Enter the Start Date. • Enter the End Date. • Select one or more Context categories from the drop-down list. • Enter one or more User Names. Separate multiple User Names with a comma and no space before the next User Name. • Select one or more Priorities. 3. Enter a single text string in Message Contains. 4. Choose a method for sorting the results. 5. Click Run Report. Enterprise eTIME System Administrator’s Guide 3-7 Chapter 3 Log Report Archiving System Log Reports Log files are automatically created in the <Enterprise eTIME.rootdir>\wfc\logs directory using the following defaults: ! Create a new log file when the current log file is greater than 500KB ! Keep a minimum of 10 backup logs The oldest log file has the highest number. When all of the logs have been used, the oldest one is recycled. To set your own archiving schedule, do the following: 1. Select System Configuration > System Settings > Log File. 2. In the site.log.file.rollover.maxsize key, specify the maximum size of the log file before rollover occurs. 3. In the site.log.file.rollover.maxlogs key, specify the maximum number of logs to save. 4. Click Save. 3-8 ADP, Inc. Chapter 4 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 ! Log File Settings ! Working with System Settings ! Logging Context Settings ! Callable Totalizer Settings ! Portal Settings ! Clock Synchronize Settings ! Printers Settings ! Database Settings ! Reports Settings ! Data Source Settings ! Security Settings ! E-mail Settings ! Service Settings ! Event Manager Settings ! SQL Coverage Settings ! Global Values Settings ! Startup Settings ! Group Edits Settings ! Timekeeping Settings ! Java Plugin Settings ! Transformation Settings ! Locale Settings ! Web Server Settings Chapter 4 System Settings Overview System Settings displays a set of tabs representing different characteristics of the system that relate to your application server. Clicking each tab displays properties for that area in a workspace that can be edited, and an action menu. This component allows you to change the values for system properties and save the changes in a custom property file. System Settings are the configuration files that contain the properties and parameters for configuring a server at the site. Typically, configuring a server is done at installation. If you have an administrator access profile, you can edit the system settings. After the initial configuration, avoid editing settings except to fine-tune or adjust the system for a different environment. Caution: Always access properties only through the System Configuration component, which creates custom files. Accessing the properties files directly could lead to errors in them which could render your system unusable. When you modify a property using System Settings, the system automatically writes to the appropriate custom property file. You cannot inadvertently modify the wrong file. Most of these properties are site-specific and pertain to a single application server. These properties are maintained in property files at the application server site. Some properties are global in nature and pertain to all application servers in the system. These properties are maintained in the database. 4-2 ADP, Inc. Working with System Settings Working with System Settings Use the System Configuration component to manage and configure the Enterprise eTIME system. ! Before Editing a Configuration Setting ! Editing a Configuration Setting ! Using System Settings ! Understanding Properties Validation Before Editing a Configuration Setting For your convenience and your server's protection, the current configuration settings are backed up when you end an editing session. Backup files are saved using <filename>.properties.<nn>, where <filename> is the name of the properties file that is saved and <nn> is the next lowest available number between 1 and 999. After editing a configuration value, verify that any changes that you make return the correct results. This verification is important because the values that you enter are not verified for appropriateness of the entry, spelling, or the number or type of characters. Changes that you make do not take effect until you restart the server. Click Restart Server on each system settings tab to restart the Enterprise eTIME server. You receive a confirmation message before the restart occurs. Caution: Clicking Restart Server causes the system to shut down immediately. All user sessions are terminated with no warning. Enterprise eTIME System Administrator’s Guide 4-3 Chapter 4 System Settings Editing a Configuration Setting 1. Select System Configuration > System Settings. 2. Click the tab for the configuration setting to edit. 3. Select the current setting of the property to edit. 4. Type the new entry over the current setting. 5. Click Save. Tips for editing configuration settings: ! You can change more than one property value on a setting tab before you click Save. ! To return to the last saved settings, click Reload. ! To return the default configuration settings, click Restore Defaults. Using System Settings From a System Settings tab, you can do the following: ! Save—When you click Save, the system looks for any modifications that were made to properties in the tab that is currently visible. If a property is maintained in a property file, the system writes the modification to a custom property file. For example, if the property is contained in the WFCSite.properties property file, your modifications are written to custom_WFCSite.properties. If a property is maintained in a database table, the system modifies the value directly. ! Restore Defaults—When you click Restore Defaults, the system archives all custom properties that are visible and restores all of the original properties for this tab. Note: Restoring defaults has no effect on properties that are maintained in the database. Modified database values remain modified. 4-4 ADP, Inc. Working with System Settings ! Restart Server—Click Restart Server to start the server again so that the changes that you made can take effect. Restart Server causes the Enterprise eTIME server to shut down immediately. All user sessions are terminated with no warning. Then, the server restarts. Caution: Clicking Restart Server causes the system to shut down immediately. All user sessions are terminated with no warning. ! Add—The Printers and Data Source tabs contain multiple instances of one property type. You can add one or more entries to describe a new instance of the property. To add another instance of a property, click Add. This creates a new empty instance of the property name with the next sequential number attached to the name. Then type the value of the new property. For example, you can add another printer on the Printers tab. If printer.1 through printer.6 are already in use, click Add to get the new property printer.7 and type the qualified name for the seventh printer. You can leave property instances empty. For example, if your list included a property instance, printer.8, with the value MyPrinter;\\printer\print, and then you removed this printer, you can delete the value and leave printer.8 empty. If it has no value, the system ignores this property instance. Some property instances are described by multiple properties. If you click Add for an instance that requires multiple properties, you receive multiple new properties for the new instance. For example, if you click Add on the Data Source tab, you get new property names for dsnname.n.name, dsnname.n.pwd.rsa, and dsnname.n.usr, where n is the next sequential object. To add a new dsnname instance, you must provide values for all three properties. ! Refresh—Click Refresh to update the workspace with any new or updated data. Note: If you make any changes to any of the system settings, you must restart the Enterprise eTIME server for the changes to take effect. Enterprise eTIME System Administrator’s Guide 4-5 Chapter 4 System Settings Understanding Properties Validation Validation is performed on some properties settings when you click Save or Restore Defaults. Validation occurs to ensure the following where appropriate: ! Required fields have a value entered. ! A numerical entry is equal to or above a minimum value. ! A numerical entry is equal to or below a maximum value. ! A numerical key has a numerical value entered. ! A text value has uppercase or lowercase letters where needed. ! A text value is within a minimum and maximum string length. If you enter an invalid value, you receive an error message when you click Save. The error message indicates the key and a general description of what is wrong. All entries are saved at the same time. No property changes are saved for that page if any validation errors occur, even if a single entry only fails. All errors must be corrected and the page must be saved again. Many keys contain an option button or drop-down lists. Keys in each of the settings’ key and value details contain the following information, where applicable: 4-6 ! Whether the key is required ! A minimum value ! A maximum value ! A default value ADP, Inc. Callable Totalizer Settings Callable Totalizer Settings The Callable Totalizer settings control the Callable Totalizer properties. The Callable Totalizer is used by other components, such as Group Edits, Accruals and Timecards, to: ! Calculate totals ! Calculate accrual balances ! Validate accruals Key and Value Details site.totalizer.number_of_engines—The maximum number of instances that the Callable Totalizer can be running concurrently. By default, one instance of the Callable Totalizer is specified to run in an application server. Using this property, you can specify multiple instances. The number of instances that you need depends on the amount of activity experienced from components that are calling the Callable Totalizer. You can experiment with different values for this property. Performance problems can occur when you start up the system with multiple Callable Totalizers installed. This problem occurs because, when each Callable Totalizer starts up, it loads a list of rules (pay rules, work rules, limit rules, and so on) into its internal cache for better performance when running. On a large system with many rules, this process can take 10 minutes or more. A site can opt to run more than one Callable Totalizer. Each Callable Totalizer is launched in sequence, and each one loads its cache of rules. Therefore, it takes four times as long to start four Callable Totalizers. Thus, if it takes 10 minutes per Callable Totalizer, it may take 40 minutes to start up four of them. Once the system is running, we can expect four times faster throughput of totalization requests, since four Callable Totalizers do the work. The operating system performs delegation at runtime, plus any other load-balancing that might have been specified at the site by the client. Value: required; minimum=1; installed default=1 Enterprise eTIME System Administrator’s Guide 4-7 Chapter 4 System Settings site.totalizer.startup_number_of_tries—Specifies the number of times that the application tries to connect to the remote Callable Totalizer once the Callable Totalizer has been started. Value: required; minimum=1; installed default=200 site.totalizer.wait_interval—Specifies the amount of time, in milliseconds, that the Callable Totalizer waits in between startup attempts. Value: required; minimum=1; installed default=5000 4-8 ADP, Inc. Clock Synchronize Settings Clock Synchronize Settings The Clock Synchronize settings establish the general parameters for synchronizing the application server’s date and time with that of the database server. When services start up, the application server retrieves the date and time from the database server. The Clock Synchronize settings control the Clock Synchronize daemon, which is a service that runs and keeps the application server time synchronized with the database server time. The Clock Synchronize daemon keeps an internal delta between the application server and the database server times. When an application requests the current application server time, the delta is applied to the current application server time. If the application server and the database server are in different time zones, the system ignores the difference in the time zones. The delta is calculated as if both servers are in the same time zone. Since clocks time can change as time passes, you can specify this synchronization process to occur at multiple intervals throughout a day. Using the Clock Synchronize settings tab, you can: ! Enable a clock synchronization to occur throughout a day ! Specify synchronization intervals ! Specify the times of the day that the synchronization should occur You can also synchronize the application server time and the database server times by restarting the Clock Synchronize daemon on the Threads tab. Key and Value Details site.clocksync.number_of_daily_syncs—Determine how many times a day that the application server clock should synchronize to the database server clock. A zero value disables the clock synchronization process, and the application server uses its own clock. Value: required; installed default=1 Enterprise eTIME System Administrator’s Guide 4-9 Chapter 4 System Settings site.clocksync.hour_of_sync—Specifies what hour of the day the clock synchronization process should occur. Possible values are 0 to 23, with 0 being midnight. You can specify a non-critical time in a day for the synchronization process to occur. If you have site.clocksync.number_of_daily_syncs set to synchronize multiple times a day, the hour specified in site.clocksync.hour_of_sync will be one of the daily synchronizations. For example, if you have site.clocksync.number_of_daily_syncs set to 4, and site.clocksync.hour_of_sync set to 9, one of the synchronizations will occur at 9:00. Value: required; minimum=0; maximum=23; installed default=1 site.clocksync.minute_of_sync—Specifies what minute of the hour the clock synchronization process should occur. Possible values are 0 to 59. You can specify a non-critical time in a day for the synchronization process to occur. If you have site.clocksync.number_of_daily_syncs set to synchronize multiple times a day, the hour and minute specified in site.clocksync.hour_of_sync and site.clocksync.minute_of_sync will be one of the daily synchronizations. For example, if you have site.clocksync.number_of_daily_syncs set to 4, site.clocksync.hour_of_sync set to 9, and site.clocksync.minute_of_sync set to 23 one of the synchronizations will occur at 9:23. Value: required; minimum=0; maximum=59; installed default=0 4-10 ADP, Inc. Database Settings Database Settings Database information shows values that are established during installation or configured immediately after installation. These values are not likely to change unless you switch databases or upgrade your system. Different application servers can access different databases for different purposes. For example, one server can connect to a test database, while other servers can connect to a production database. This tab only reflects the database that this application server is connected to. An application server can only be connected to one database at a time. However, multiple application servers can be connected to the same database. Unless you switch databases, you are not likely to modify any of the database properties in this tab. If you do need to modify a value, you can do so while the database is running. However, your modification does not take effect until the application server is shut down and restarted. If you modify a database property for one application server, be sure to make the same modifications to all application servers that connect to the same database. Key and Value Details site.database.all.loginTimeout—When connecting to the database, the connection must be made before this number of seconds has elapsed, or the process of connecting will abort. When you are restarting the server and your database is extremely busy, set this key to a higher number to give your system the extra time it needs to make the connection. Value: required; minimum=1; maximum=30; installed default=5 site.database.all.dbreport.RepTimeToLive—Defines the amount of time (in hours) that database report files stay in the Enterprise eTIME system before being automatically deleted. The Database Report Status workspace lists the available database reports. Value: required; minimum=0; installed default=72 Enterprise eTIME System Administrator’s Guide 4-11 Chapter 4 System Settings site.database.<database name>.url—The database name with .url is the jdbc connection string used to connect to the database. site.database.<database name>.usr—The database name with .usr is the user name of your database. site.database.<database name>.pwd—The database name with .pwd is the password associated with the specified user name. site.database.<database name>.drv—The database name with .drv is the jdbc driver to use. site.database.<database name>.dsn—The database name with .dsn is the data source name for that connection. site.database.<database name>.min—The database name with .min is the minimum database pool size. site.database.<database name>.max—The database name with .max is the maximum database pool size. If you get messages in your log files that the pool size is exceeded, increase this value in increments of 10. site.database.all.dbutility.tempTableIDsTimeToLive—Specifies how many hours database IDs can stay in the database utility temp tables before being purged by the DB Utility Clean Up Worker thread. site.database.all.dbutility.cleanUpThreadWakeUpInterval—Specifies how often the DB Utility Clean Up Worker thread should wake up to check for outdated records in the database utility temp tables. This value is specified in seconds. site.database.all.dbreport.customDBReportDatabase.usr—Sets the user name of the owner of the database for Oracle multi schema databases. Used by the database reporting engine to run reports as the owner of the database schema. site.database.all.dbreport.customDBReportDatabase.pwd—Sets the password associated with the user name of the owner of the database for Oracle multiscan databases. 4-12 ADP, Inc. Database Settings Switching Databases You may need to switch databases at times; for example, from production to test. One database was identified when your system was installed and this is probably your production database. Configuration settings for this database appear in the WFCSite.properties property file. Note: The system implements properties changes in a precise sequence. Do not alter the procedure for modifying properties. For example, always change the property settings on the Database Settings tab before changing the properties on the Data Source Settings tab. Switching Windows Databases To switch Windows databases, do the following: 1. In Enterprise eTIME, select System Configuration > System Settings > Database. 2. Set the site.database.dbname.url property to the URL of the database to which you want to switch. Use the following format: jdbc:driver:database_server:port?database=database_ name or database_SID For example, if the database has a driver inetdae7, a port value of 1433, a name of archivedb, and is on a server named server_1, the property value would be: jdbc.inetdae7:server_1:1433?database=archivedb Note: Use the database name in the URL when referring to a SQL Server database and the database SID when referring to an Oracle database. 3. Set the site.database.dbname.usr property to the user account name of the database to which you want to switch. Enterprise eTIME System Administrator’s Guide 4-13 Chapter 4 System Settings 4. Set the site.database.dbname.pwd property to the password for the above user account. 5. Click Save. 6. Stop the Enterprise eTIME server using the Stop Enterprise eTIME icon. 7. Do one of the following: ! For Windows NT, access the Control Panel on the application server by selecting Start > Settings > Control Panel. ! For Windows 2000, select Start > Settings > Administrative Tools. 8. Select DataSource (ODBC). 9. In the ODBC Data Source Administrator dialog box, click the System DSN tab. 10. Highlight the name of the database to which the application server is currently pointing and click Configure. 11. 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. 12. Click OK. 13. Restart the Enterprise eTIME server using the Start Enterprise eTIME icon. 14. In Enterprise eTIME, select System Configuration > System Settings > Data Source and change the values of the dsnname.1.usr and dsnname.1.pwd.rsa properties to the user account name and the associated password for the new database. Note: Remember to reconfigure the application server after you are done accessing the archive database. 4-14 ADP, Inc. Database Settings Switching UNIX Databases To switch UNIX databases, do the following: 1. In Enterprise eTIME, select System Configuration > System Settings > Master Database. 2. Set the site.database.dbname.url property to the URL of the archive database to which you want to switch. Use the following format: jdbc:driver:database_server:port?database=database_ SID For example, if the database has a driver inetdae7, a port value of 1433, an SID of arch4, and is on a server named server_1, the property value would be: jdbc.inetdae7:server_1:1433?database=arch4 3. Set the site.database.dbname.usr property to the user account name of the database to which you want to switch. 4. Set the site.database.dbname.pwd property to the password for the above user account. 5. Click Save. 6. Stop the Enterprise eTIME server using the Stop Enterprise eTIME icon. 7. Open the odbc.ini file. 8. For the database to which the Enterprise eTIME application server is currently pointing, change the SID and host database information to that of the database to which you want to switch. 9. Save the file. 10. Restart the Enterprise eTIME server using the Start Enterprise eTIME icon. 11. In Enterprise eTIME, select System Configuration > System Settings > Data Source and change the values of the dsnname.1.usr and dsnname.1.pwd.rsa properties to the user account name and the associated password for the new database. Note: Remember to reconfigure the application server after you are done accessing the archive database. Enterprise eTIME System Administrator’s Guide 4-15 Chapter 4 System Settings Properties Affected by Switching Databases The following properties are affected by switching databases: ! site.database.<database name>.url—In this property, database is the value that you specify for the site.database.names property. For example, if you specify a value of product, then change the name of the URL property to site.database.product.url. The value assigned to this property identifies the JDBC connection string that connects the application server to the database. The syntax is jdbc:driver:database_server:port?database = database_name. Note that the property specifies the same database_name in its name and its value. In most cases, you only need to change the database_server and the database_name values. For example, if the driver has a value of inetdae7, a port value of 1433, a database named summary, and a database server named server_1, then your property file contains the following line: site.database.summary.url = jdbc:inetdae7:server_1:1433?database = summary 4-16 ! site.database.<database name>.drv—Identifies the name of the JDBC driver. Only the name of the property should change to match the name of your database. The property value should remain unchanged. For example, if your current database is named prod and you are switching to a database named integ, then change the current property to site.database.integ.drv = com.inet.tds.TdsDriver ! site.database.<database name>.usr—Identifies the database logon user ID that was set up during the initial configuration. If you use the same logon user ID for the new database, change only the property name. ! site.database.<database name>.pwd—Specifies the value of the encrypted password that was set up during the initial configuration. If you use the same password, change only the property name. ADP, Inc. Database Settings ! site.database.<database name>.dsn—Identifies the data source name associated with the database. To switch databases, include the name of the database in the property name and its value. The dsn name is needed for components that access the database through an ODBC connection. For example: site.database.integ.dsn = integ ! site.database.<database name>.min—Only the name should change to match the name of your database. The value should remain unchanged. For example: site.database.integ.min = 10 ! site.database.<database name>.max—Only the name should change to match the name of your database. The value should remain unchanged. For example: site.database.integ.max = 50 Note: Properties with global scope across application servers are maintained in database tables. If you switch databases, you must copy these properties to the new database. For more information about properties in the database, see “Working with Property Files” in Chapter 1. Enterprise eTIME System Administrator’s Guide 4-17 Chapter 4 System Settings Data Source Settings The system uses Java Database Connectivity (JDBC) most of the time, but uses Open Database Connectivity (ODBC) for selected components, such as the Background Processor, Enterprise eTIME Setup, and Data Collection Manager. When your Enterprise eTIME application server was installed, the installer provided the data source name, user ID, and password for an ODBC connection to the database. This information was captured in the following properties: ! Dsnname.name ! Dsnname.usr ! Dsnname.pwd.rsa Note: For SQL databases, the data source name must match exactly the data source name in the computer’s ODBC setting. These properties were written to a temporary property file SiteDsnname. properties. When the system was started for the first time, these three properties were written to the WFCDsnname table in the database as dsnname.1.name, dsnname.1.pwd.rsa, and dsnname.1.usr, as well as to the SiteDsnname.properties.1 file, which is located in your properties directory. Note: All DSN names must be unique. There is no validation on DSN names; therefore, you must verify that there are no duplicate DSN names. If you find a duplicate DSN name, edit the name and click Save. Do not modify any properties in this setting unless you want the change to be applied to all of the application servers in the system that are connected to the same database. After you click Save, any changes that you made are permanent. There is no way to restore or reload the previous settings. 4-18 ADP, Inc. Data Source Settings Key and Value Details dsnname.<dsn number>.name—The data source name (DSN) that is submitted by Enterprise eTIME Setup during client logon. This name is associated with the user and password used to access the database. This DSN must also be configured in Enterprise eTIME Setup, which is done at the installation of the Enterprise eTIME Setup application client. Note: All DSN names must be unique. There is no validation on DSN names; therefore, you must verify that there are no duplicate DSN names. dsnname.<dsn number>.usr—The user name associated with the DSN used for database access. dsnname.<dsn number>.pwd.rsa—The password for the DSN and user. Passwords are stored encrypted. Adding Data Source Names You must add Data Source Name (DSN) properties for any other ODBC connections used, by using the Add action on this tab. Note: All DSN names must be unique. There is no validation on DSN names; therefore, you must verify that there are no duplicate DSN names. When you click Add, the system adds the three property names, and you enter the values. When you click Save, the three new properties are added to the WFCDsnname table. There is no limit to the number of DSN entries that you can add. The Data Source tab lists all the dsnnames in your system. Note: An ODBC Data Source needs to be added any time that Enterprise eTIME Setup is installed on a PC and the DSN provided during installation is not the same as any DSNs already listed on this tab. Enterprise eTIME System Administrator’s Guide 4-19 Chapter 4 System Settings All dsnname password properties are encrypted with RSA encryption standards. The system automatically handles this type of encryption. If you add or modify a dsnname password, you must enter the value using this tab and let the system encrypt it. Do not modify any properties in this tab unless you want the change applied to all application servers in the system. Note: Properties with a global scope across application servers are maintained in database tables. If you switch databases, you must copy the appropriate properties to the new database. Properties with global scope belong to the property groups global, printer, servers, and dsnname. For more information about properties, see “Working with Property Files” in Chapter 1. 4-20 ADP, Inc. E-mail Settings E-mail Settings E-mail (also known as Workflow Notifications) settings enables you to establish parameters for all notification e-mails that Enterprise eTIME generates. For more information, see “Working with Workflow Notifications” in Chapter 1. You can enable batch delivery using the site.email.batchDelivery property. In cases where multiple notifications to the same recipient result from a single function, batch delivery consolidates these notifications into one e-mail. For example, if you import data or the system performs multiple pay code edits, the batched e-mail includes multiple messages. Once the system begins an e-mail, messages are added to it until the Notification server is triggered to send the email. With the next message, another e-mail is started. Key and Value Details site.email.enable—This indicates whether the notification is enabled or disabled in this Enterprise eTIME server. The Simple Mail Transfer Protocol (SMTP) email application program interface (API) is always available. This setting refers to the notification engine only. Value: required; installed default=false site.email.availability.enable—This indicates whether to enable or disable e-mail when an employee changes their availability pattern. Set to true to enable e-mail. Value: required; installed default=true site.email.primary_server—Set to true to indicate this Enterprise eTIME server is the primary Notification server. This server keeps track of all notifications and generates the appropriate e-mail when a notification condition is initiated. Any server can create Notifications, but only the Notification server can process them. In a single-server environment, the Notification server is the local host. In a multiserver environment, one application server is designated as the primary Notification server. Only one primary server exists in a multiserver environment. Value: required; installed default=true Enterprise eTIME System Administrator’s Guide 4-21 Chapter 4 System Settings site.email.smtp_url—The URL of the SMTP mail server. Value: installed default=mail1.company.com site.email.batchDelivery—Indicates whether a batch delivery is selected. If it is set to true, all e-mails in the queue with the same recipient will be grouped as one e-mail and sent out. Value: required; installed default=true site.email.msg_queue_sleep_time—Time interval when the message delivery engine is idle if the queue contains no messages. The maximum amount is 60 minutes. Value: minimum=1; maximum=60; installed default=60 site.email.smtp_server_timeout—How long the message delivery engine should wait for the SMTP server connection before timing out. The display is in seconds. Value: minimum=1; installed default=120 site.email.sender—Sender field in an e-mail. The e-mail must appear in the format of [email protected], even if it is not a valid address. Value: installed [email protected] site.email.max_attempts—Maximum number of attempts for the system to send a message via e-mail before stopping. Value: installed default=3 site.email.msg_queue_time_between_purges—Interval between the message queue purges. The format is dd:hh:mm. Value: installed default=00:00:60 site.email.language.charset—The character set used in encoding the subject and message body. Value: required; installed default={site.charset.htmlxml.codepageid} Note: If you use Windows Code Page 1252 for your character set, you must change the character set for e-mail to ISO-8859-x. 4-22 ADP, Inc. E-mail Settings site.email.includeStartupInfoLog—Set to true to attach the startup info log to the server booted notification. Value: required; installed default=true site.email.includeStartupErrorLog—Set to true to attach the startup error log to the server booted notification. Value: required; installed default=true site.email.license.percent—Determines the number of licenses left available before a notification is sent to a specified e-mail address warning that the number of available licenses is getting low. The value is a percentage of the total number of licenses. For example, if you have licenses for 1000 employees, and the percent is set to 90, an e-mail notification is sent out when the number of licenses in use reaches 900. The e-mail address that this notification gets sent to is specified during the notification configuration process. site.email.addresses.delimiter—The character that separates e-mail addresses when multiple e-mail addresses are used. Value: maximum=1; installed default=; Enterprise eTIME System Administrator’s Guide 4-23 Chapter 4 System Settings Event Manager Settings The Event Manager settings establish the general parameters for handling events. An Enterprise eTIME system event is task automated and scheduled to run at a predetermined time or periodically. Examples of events are importing data or generating a report. The configuration of the Event Manager settings includes identifying: ! The servers available in the installation ! The user names and passwords necessary to allow all components to execute and communicate Note: During installation, you were prompted to enter a user name and password for the application server to launch events. If you did not enter values, you will not be able to schedule reports. You can enter the values into site.eventmanager.NT.user and site.eventmanager.NT.pwd. Key and Value Details site.eventmanager.enabled—Indicates whether this Enterprise eTIME server is the Event Manager scheduler server. If this value is true, this system is responsible for reading events from the database and scheduling them on the Microsoft Task Scheduler. Only one server per installation can be marked true. For UNIX users, this value should be false. Value: required; platform=Windows; installed default=false site.eventmanager.startup —When the Enterprise eTIME server is started, the Event Manager enters a startup process that synchronizes the database and the jobs on the Microsoft Task Scheduler. If this value is false, the synchronization is not done. For UNIX users, this value should be false. Value: required; platform=Windows; installed default=true 4-24 ADP, Inc. Event Manager Settings site.eventmanager.recovery—If the events on the Microsoft Task Scheduler are seriously out of sync with the database, this property can be set to true. When the Enterprise eTIME server is started, the Event Manager enters a more aggressive startup process that rewrites all of the jobs on the Microsoft Task Scheduler. For UNIX users, this value should be false. Value: required; platform=Windows; installed default=false site.eventmanager.logEnabled—The EXE and DLL components are used for Event Management. These components do not have access to the Java logging methods on the Enterprise eTIME server (currently). These settings describe the logging for these components. For UNIX users, this value should be false. Value: required; platform=Windows; installed default=false site.eventmanager.logPriority—If the site.eventmanager.logEnabled setting is marked true, you must enter a priority in this setting. Higher log priority numbers causes a larger log: 1 = Error 2 = Warning 3 = Debug Value: minimum=1; maximum=3; platform=Windows; installed default=1 site.eventmanager.logName—If the site.eventmanager.logEnabled setting is marked true, you must enter a path and log name in this setting. Value: platform=Windows; installed default=C:\WFCEvtMgr.log site.eventmanager.NT.user—All events must run as an NT user. This user must have NT administration rights on the Event Manager scheduler server. Value: platform=Windows site.eventmanager.NT.pwd—All events must run as an NT user. This user must have NT administration rights on the Event Manager scheduler server. The NT user password is stored encrypted. Value: platform=Windows Enterprise eTIME System Administrator’s Guide 4-25 Chapter 4 System Settings site.eventmanager.wfc.user—When an Event is run, Event Manager logs on to an Enterprise eTIME server to submit the Event (XML) to the API interface. This setting is the Enterprise eTIME user that is used for that logon. Any user who is used for this purpose must have the TASK_RUNNER ACP as well as any application program interface (API) bean ACPs for the Events that will be run. This key is not used on UNIX servers. Value: platform=Windows; installed default=TaskRunner site.eventmanager.wfc.pwd—Contains the Enterprise eTIME logon user. The value of the password is stored encrypted. This key is not used on UNIX servers. Value: platform=Windows site.eventmanager.maxUserListSize—Specifies the largest list that may be returned by an Event Manager user search. Value: minimum=1; maximum=100; platform=Windows; 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, regardless of the number of steps required to process it. – The system notifies the Microsoft Task Scheduler of an event’s existence. The Microsoft Task Scheduler places the event’s notification on a queue located at the Scheduler server. The time base for a scheduled event is the primary event manager server. It is the master clock. The implications of this are especially important when using multiple servers. For example, if the application server that you are using is in Eastern Standard Time (EST), but the Task Scheduler is on the primary event manager server which is located in Pacific Standard Time (PST), the events that you schedule are based on PST time, which is the time on the primary event manager server. 4-26 ADP, Inc. Event Manager Settings ! Executing Events—Executing a Microsoft Task Scheduler event means running the TaskRunner utility. TaskRunner calls the Microsoft Task Scheduler. In a multiserver environment, when the Microsoft Task Scheduler executes an event, the actual processing of the event is randomly distributed to application servers in the system. ! ! Synchronization—Values vary depending on your platform. – Windows platforms: If the property site.eventmanager.startup is true, then the Scheduler synchronizes the notifications on its queue with jobs in the database that are waiting to be executed. A mismatch can occur if you modify or delete a job in the database. – UNIX platforms: Set this value to false, because Event Manager runs on the companion Windows server. Recovery—Values vary depending on your platform. – Windows platforms: If site.eventmanager.recovery is true, the system does aggressive synchronization. All events are rescheduled. Only take this action if the event process appears to be seriously corrupted, causing a large number of errors to appear in the Event Manager log. The location of the Event Manager log is specified in site.eventmanager.logName. – UNIX platforms: Set this value to false. Note: While recovery can be valuable, it can necessitate many additional cycles. Decide whether synchronization or cycles are more important to your system and enable or disable this property on that basis. Enterprise eTIME System Administrator’s Guide 4-27 Chapter 4 System Settings ! The Event Manager log—The Event Manager and the Microsoft Task Scheduler do not use the system log. If an exception occurs, the event might be reported to the system log. Event Manager exceptions are always reported in the Event Manager log. Specify properties for the Event Manager log in the Event Manager tab as follows: – site.eventmanager.logEnabled—Set to true. (For UNIX platforms, set this value to false.) – site.eventmanager.logPriority—Enter a priority. – site.eventmanager.logName—Enter a log and path name. The Event Manager log does not use parameters that are set for the system log. Unlike the system log, you must manage the Event Manager log directly. If a problem develops, your Event Manager log file can grow quickly. The Event Manager writes log messages to a single file with no size limit. Monitor this file on a regular basis to determine if you need to delete information. Report facilities are not available for the Event Manager log. You must browse the complete log using a text editor. ! Severity level—The value of the severity level for the Event Manager log is set in the site.eventmanager.logPriority property as 1, 2, or 3; where the levels are equivalent to system severity levels of ERROR, WARNING, or DEBUG, respectively. See “Log File Settings” in this chapter for a description of the severity levels in the system log. Note: You should keep the Event Manager log enabled most of the time. If Event Manager is running normally, little information is written to this log. However, if a problem develops, the initial log entries are invaluable in diagnosing and correcting the problem. The recommended severity level is ERROR; that is, site.eventmanager.logPriority = 1. TLM Support might ask you to set a different level for a short time. 4-28 ADP, Inc. Event Manager Settings Scheduling Event Manager Tasks Sometimes MS Task Scheduler has error messages when you have a large number of tasks scheduled. According to Microsoft, 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, you may receive an error message. This error occurs when the buffer that stores the account information for all scheduled tasks is limited; the buffer puts a limit on the number of jobs that you can schedule with user credentials. There is no limit on the number of jobs that you can create without user credentials. To work around this behavior, stop and start the task scheduler service, wait for 10 to 15 minutes, and then schedule jobs. To remove disabled Enterprise eTIME Events on the MS Task Scheduler: 1. In Enterprise eTIME > System Configuration > System Settings > Event Manager, set site.eventmanager.startup to true and site.eventmanager.recovery to false. 2. Stop the Enterprise eTIME server using the Stop Enterprise eTIME icon. 3. Remove all Enterprise eTIME Events from the MS Task Scheduler if the Event is set to DISABLED. ! In Windows 2000, open the MS Task Scheduler by clicking Start > Settings > Control Panel > Scheduled Tasks. ! In Windows NT, open the MS Task Scheduler by double-clicking on My Computer and then double-clicking on Scheduled Tasks. 4. Start the Enterprise eTIME server using the Start Enterprise eTIME icon. 5. For Windows NT only, stop and restart the Task Scheduler Service: a. Select Start > Settings > Control Panel > Services. b. Select Task Scheduler in the list of services. c. Click Stop. d. Click Start. 6. Wait 15 minutes. 7. Repeat steps 4 - 6 until all events are rescheduled on the MS Task Scheduler. Enterprise eTIME System Administrator’s Guide 4-29 Chapter 4 System Settings Global Values Settings The Global Values settings specify properties that remain constant for all application servers in the system. Global properties are maintained in the WtkGlobalSettings table in the database. Caution: Do not modify any properties in this setting unless you want the change applied to all of the application servers in the system. Properties with global scope across application servers are maintained in database tables. If you switch to a new database, you get the global value settings that relate to that database. You can copy properties settings to a new database. See “Working with Property Files” in Chapter 1 for more information. After you click Save, any changes that you made are permanent. There is no way to restore or reload the previous settings. 4-30 ADP, Inc. Global Values Settings Key and Value Details global.database.timezoneid—The time zone ID of the database server. If the database server and application server are located in a different time zone than the employees’ time zone, some Enterprise eTIME features could be reported or generated incorrectly early or late. 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. For example, if the database server is in the Eastern time zone, and the employee is in the Central time zone, then the employee might be considered absent an hour too early. ! Missed Out exceptions might be reported inappropriately as early or late. ! System-generated persistent events might be generated inappropriately as early or late. If your database server and application server are located in different time zones than some or all of your employees, set this property to the database servers’ time zone. If time zones are not an issue, set the property to the Default value. Value: required; installed default=DEFAULT global.wfc.html.framework.tableNavigatorDefaultMaxPages—Defines the number of sections that each table navigation element will display at once. Value: required; installed default=10 global.wfc.html.framework.tableNavigatorDefaultPagesize—Defines the number of rows that will display per table selection. Value: required; installed default=25 global.LongList.LLMaintLongListThreshold—The default long list warning limit for Labor Level Entry maintenance. Value: required; minimum=1; installed default=100 global.LongList.ManagerSummaryEmployeeThreshold—Maximum number of employees that can be displayed in a Detail QuickNav. Value: required; minimum=1; installed default=1000 Enterprise eTIME System Administrator’s Guide 4-31 Chapter 4 System Settings global.LongList.ScheduleSummaryEmployeeThreshold—Maximum number of employees that can be displayed in a Scheduling QuickNav. Value: required; minimum=1; installed default=200 global.m8m.login.password—Sets the password for logging in the URL Dispatcher Service used by the 4500. Value: required; installed default=4500User global.m8m.login.username—Sets the user name for logging in the URL Dispatcher Service used by the 4500. Value: required global.OvertimeEqualization.enabled—Set to true to enable overtime Equalization. When this is set to true, the Overtime menu appears on Time and Attendance QuickNavs menus. Note: If you change this setting, you must restart the Enterprise eTIME server for the change to take effect. Value: required; installed default=False global.ServerInfo.Heartbeat.Interval—Sets the heartbeat interval (in seconds) for each server to notify the database that the server is active. Value: required; minimum=1; maximum=86400; installed default=120 global.TransactionAssistant.StartDateTime.DefaultNumberOfHours—The number of hours in the past for setting the default start date and time used for displaying errors in the Transaction Assistant. Value: required; minimum=1; maximum=8784; installed default=72 global.Wtk.MaxDaysToDisplayPayChecksInEarningHistory—The maximum number of days to display paychecks in earnings history. Value: required; minimum=1; maximum=365; installed default=365 global.WtkScheduler.availability.defaultAvailType—Provides the default availability for all the employees in the organization when Enterprise Scheduler is installed. Choices are unavailable, unknown, or available. Value: required; installed default=unknown 4-32 ADP, Inc. Global Values Settings global.WtkScheduler.MaxDaysToMarkScheduleOutOfDate—Informs the background processor the maximum number of days in the future that schedule changes do not need to be totalized. This keeps the background processor from recalculating totals needlessly. For example, if you add a shift to an employee three months in the future, there is no need to inform the background processor since the shift addition does not affect any current totals. Value: required; minimum=1; maximum=365; installed default=31 global.WtkScheduler.MaximumDaysInFutureToCreateShifts—Scheduled shifts that follow a pattern are populated into the future. Since a pattern could be forever, the system must limit their population and, from time to time, populate them further into the future. This value limits how far in the future shifts are created at any one time. The default value is 270 days. Approximately every week the system populates these forever patterns out to 270 days from that date. Increasing this value allows users to see shifts further into the future, while decreasing this value decreases the amount of disk space needed to hold all of the shifts. Value: required; minimum=0; installed default=270 global.WtkScheduler.MaximumListForHyperfind—The threshold of when to switch from putting values in a SQL ‘in ( )’ list, to putting the values into an intermediate table and performing a join. A value greater than 1,000 will result in database failures. Unless TLM Support requests you to change the value of this key, do not change it. global.WtkScheduler.MaximumNoOfRuleViolatsionsSentToClient—The maximum number of rule violations sent to the client from the server. If a threshold is not defined, the system uses 50 as the maximum number of rule violations. When the rule violation translator attempts to get the rule violations, it stops at the maximum defined. If the maximum is exceeded, a message displays on the rule violations tab indicating that it exceeded the display limit of x. Value: required; minimum=1; maximum=100000 Enterprise eTIME System Administrator’s Guide 4-33 Chapter 4 System Settings global.WtkScheduler.ShiftBuilderGovernor.Active—Use to activate the Shift Builder Governor. Possible values are: 0 = off 1 = on Value: required; installed default=0 global.WtkScheduler.ShiftBuilderGovernor.Days—Days to limit shift building. Value: required; minimum=0; installed default=30 global.WtkScheduler.ShiftBuilderThreads.Max—The maximum number of shift builder threads that the Shift Builder controller is allowed to run concurrently. The Shift Builder controller tries to keep this many threads active at all times until all required shifts have been built. Value: required; minimum=0; installed default=5 global.WtkTotalizer.ApplyScheduledAccountsInNonPfsWorkedAmounts— Controls whether or not scheduled transfers are applied to Worked Amounts in Project View, on days for which Pay-From-Schedule is not in effect. Possible values are: 0 = Do not apply scheduled transfers to Worked Amounts in Project View. 1 = Apply scheduled transfers to Worked Amounts in Project View. global.WtkTotalizer.getEmpToTotalizeChunkSize—Determines the number of employees in a group that is processed by the background processor (BGP). To improve system performance, the BGP processes small groups of employees rather than individual employees. 4-34 ADP, Inc. Global Values Settings global.WtkTotalizer.getEmpToTotalizeInactiveBGPMinutes—The background processor (BGP) uses this key to determine whether to select employees who are already undergoing background processing on another BGP. If the specified amount of time has not passed, the BGP will not pick up the employee. The value of this key is multiplied with the value in global.WtkTotalizer.getEmpToTotalizeChunkSize. The resulting number is the number of minutes that the system uses to evaluate whether to collect an employee. If an employee has remained in the In Process state for the resulting number of minutes, the system determines that the other BGP has failed to process that employee and thus collects them for reprocessing. global.WtkTotalizer.IdleMinutesBeforeRetroTotalization—The number of minutes that the background processor has to be completely idle before it can start the retrototalization processes. global.WtkTotalizer.MaxDaysInFutureEventAffectsTotalization—The maximum number of days in the future that events, such as punches, affect the range of totalization. The background processor ignores timecard or scheduled events that are greater than this number of days in the future. This minimizes the load to the background processor, which improves system performance. If you need to project certain data far into the future, such as accrual balances, make sure that you set this key sufficiently high to accommodate the desired window. Value: required; minimum=0; installed default=365 global.WtkTotalizer.MinimumDaysInFutureForActualTotals—Minimum number of days in the future that the database contains actual totals. This setting specifies how far out in the future that the background processor will totalize actual data for an employee. Value: required; minimum=1; maximum=366; installed default=3 global.WtkTotalizer.MinimumDaysInFutureForScheduledTotals—Minimum number of days in the future that the database contains scheduled totals. This setting works with the Store Scheduled and Projected Totals check box in pay rules. The background processor calculates scheduled and projected totals for employees. The global.WtkTotalizer.MinimumDaysInFutureForScheduledTotals setting specifies how far out in the future that totalization is performed. Value: required; minimum=1; maximum=366; installed default=3 Enterprise eTIME System Administrator’s Guide 4-35 Chapter 4 System Settings global.WtkTotalizer.MinimumInactiveDaysWithoutTotalingActuals— Minimum number of days that the Callable Totalizer can view without retotaling an employee with no activity. Value: required; minimum=1; maximum=60; installed default=7 global.WtkTotalizer.MinimumInactiveDaysWithoutTotalingSchedule— Minimum number of days that the Callable Totalizer can view without retotaling the schedule for an employee with no schedule changes. Value: required; minimum=1; maximum=60; installed default=7 global.WtkTotalizer.PaycodeMovesAreContributingShifts—Determines whether pay code moves contribute to holiday calculations. It specifies whether moving hours from one pay code to another has an impact on the shift history for holidays with Work History Qualifiers. Set to yes to have pay code moves contribute to holiday calculations. Value: required; installed default=no global.xmlservice.login.password—XML service password used by one server to communicate with another server. Value: required global.xmlservice.login.username—XML service user name used by one server to communicate with another server. Value: required; installed default=XMLUSER 4-36 ADP, Inc. Group Edits Settings Group Edits Settings The Group Edits settings workspace enables you to optimize the Group Edit Results component of the system. The default value for the site.groupedit.primaryServer property is automatically set to true for all application servers in your system. If you have a multiserver environment, you must determine which application server functions as the primary server and set this property to false for all other application servers in your system. Note: A system error occurs if you do not configure your multiserver environment properly. A number of different editing threads runs in the background on the primary application server. The Delete thread is activated periodically and removes any editing threads beyond the specified time period. The Recover thread is activated periodically to poll the editing threads. The Recover thread restarts any editing thread that has stalled. Because Group Edit data is maintained in the database, any application server can perform the delete and recovery functions. The application server with the site.groupedit.primaryServer property set to true is the one specified to run the Delete and Recover threads. Key and Value Details site.groupedit.enabled—Set to true for enabling Groupedit functionality. Value: required; installed default=true site.groupedit.primaryServer—Set to true to specify that this server is the primary Enterprise eTIME server used to run the persistent threads. Value: required; installed default=true site.groupedit.DaysCleanup—Number of days until items are deleted from group edit history. Value: required; minimum=0; installed default=7 Enterprise eTIME System Administrator’s Guide 4-37 Chapter 4 System Settings site.groupedit.deletethread.pollingInterval—Polling interval for the Delete thread in minutes. This interval is longer than the time that the thread does the delete job. Value: required; minimum=0; installed default=30 site.groupedit.recoverthread.pollingInterval—Polling interval for the Recover thread in minutes. This interval is longer than the time that the thread does the recovery job. Value: required; minimum=0; installed default=30 site.groupedit.RequestHandler.pollingInterval—Polling interval for RequestHandler to wait until a thread is available from the Group thread pool (in seconds). Value: required; minimum=0; installed default=5 site.groupedit.RequestHandler.numberOfGroupEditThreads—Number of Groupedit Threads used for processing (in numbers). Value: required; minimum=0; installed default=20 site.groupedit.RequestHandler.ReusableHandlerController.pollingInterval— Polling interval for ReusableHandlerController thread (in minutes). This interval must be less than the polling interval for ReusableGroupThread. Value: required; minimum=0; installed default=60 site.groupedit.RequestHandler.ReusableGroupThread.pollingInterval— Polling interval for ReusableGroupThread (in minutes). Value: required; minimum=0; installed default=300 site.groupedit.employeeCountThreshold—Specifies the number of employees that will be accumulated before the entries appear in the Groupedit log. Value: required; minimum=0; installed default=500 site.groupedit.groupEditLogFailureCountThreshold—Defines the number of Group Edit Log Failures that will be accumulated before the entries appear in the Groupedit log. Value: required; minimum=0; installed default=500 4-38 ADP, Inc. Group Edits Settings Clearing the Group Edit Results in QuickNavs You can specify how often the system should clear the Group Edit Results. 1. Select System Configuration > System Settings > Group Edits. 2. Set site.groupedit.DaysCleanup to a set number of days. The default is 7 days. 3. Click Save. Enterprise eTIME System Administrator’s Guide 4-39 Chapter 4 System Settings Java Plugin Settings The Java Plugin settings controls the version of the JRE to install on client machines, and the name of the JRE installer. These settings only affect ADP Enterprise eTIME applets. These settings do not control the server machine JRE (JRun). Key and Value Details The numbers in the Java Plugin installer, version, and CLSID multi version match the JRE version. Some example of values are: JRE version Java Plugin installer Java Plugin Java Plugin CLSID Multi Version Version Jre 1.3.1_02 English j2re-1_3_1_02-win.exe 1,3,1,2 clsid:CAFEEFAC-0013-00010002-ABCDEFFEDCBA Jre 1.3.1_02 International j2re-1_3_1_02-win-i.exe 1,3,1,2 clsid:CAFEEFAC-0013-00010002-ABCDEFFEDCBA Jre 1.4.1_05 English j2re-1_4_1_05-windows- 1,4,1,5 i586.exe clsid:CAFEEFAC-0014-00010005-ABCDEFFEDCBA Jre 1.4.1_05 International j2re-1_4_1_05-windows- 1,4,1,5 i586-i.exe clsid:CAFEEFAC-0014-00010005-ABCDEFFEDCBA site.java.plugin.location—The path of the client-side JRE plugin, for example, /WFC/plugins. site.java.plugin.installer—The version of the Java plugin installer. This value is the exact name of the executable in the path of the client-side JRE plugin. The numbers in the value match the JRE version, for example, if the JRE is 1.4.1_05 International, the Java plugin installer is j2re-1_4_1_05windows-i586-i.exe. Value: required 4-40 ADP, Inc. Java Plugin Settings site.java.plugin.version—The version of the Java plugin. This value is commadelimited. The numbers in the value match the JRE version, for example, if the JRE is 1.4.1_05 International, the Java plugin version is 1,4,1,5. Value: required site.java.plugin.CLSID.multiVersion—Specifies the CLSID used by Enterprise eTIME applets. The numbers in the value match the JRE version, for example, if the JRE is 1.4.1_05 International, the Java plugin class ID is clsid:CAFEEFAC-0014-0001-0005-ABCDEFFEDCBA. Value: required site.java.plugin.CLSID.multiVersion.active—Specifies whether the multi version of the JRE plugin should be used. Use true to specify that the multi version of the JRE plugin should be used. Value: required; installed default=true Enterprise eTIME System Administrator’s Guide 4-41 Chapter 4 System Settings Locale Settings The Locale settings determine how the date, times, and language appear in Enterprise eTIME components. These settings are an expansion of the basic regional settings on the Web server. Under typical circumstances, these settings do not change. Note: You must restart the Enterprise eTIME system using the stop and start Enterprise eTIME icons in order for new values of any language or country keys to take effect. Key and Value Details site.local.TIMEZONE—The time zone on the application server. Value: required; installed default=(GMT -05:00) Eastern Time (USA; Canada) site.local.DefaultWeekStartDay—The starting day of the scheduling week. This value is available when Enterprise Scheduler is installed, and is used to define the start of the week for schedule rules, such as minimum hours per week. Value: required; installed default=Sunday site.local.DateFormat—The display format for dates: FULL - day, month DD,YYYY AD LONG - month DD,YYYY MEDIUM - abbreviated month DD,YYYY SHORT - MM/DD/YY, completely numeric Value: required; installed default=LONG 4-42 ADP, Inc. Locale Settings site.local.TimeFormat—The display format for times: FULL - HH:MM:SS AM/PM Time zone LONG -HH:MM:SS AM/PM MEDIUM - HH:MM:SS AM/PM SHORT - HH:MM AM/PM Value: required; installed default=SHORT site.local.timestamp.ServerDateFormat—The display format for the Time Stamp server date and time. Value: required; installed default=EEEE, MMMM dd, yyyy site.local.SHORT_DATE—The display format for the short date. In all of these cases, a hyphen or period separator can replace the slash separator, provided that the same separator character is used. 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 natural order of the Locale. Value: required; installed default=E M/dd Enterprise eTIME System Administrator’s Guide 4-43 Chapter 4 System Settings site.local.LONG_DATE—The display format for the long date. In all of these cases, a hyphen or period separator can replace the slash separator, provided that the same separator character is used. 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 natural order of the Locale. Value: required; installed default=M/dd/yyyy site.local.DAY_MONTH—The display format for the date when only the month and day of the month are displayed. Value: required; installed default=M/dd site.local.LANGUAGE—The display language on the application server. Identifies the language based on the standard two-letter language codes that the International Standards Organization (ISO) established in ISO 639-1. ADP provides text and messages in French, Spanish, and English. For other languages, use the Translation and Customization Toolkit CD. The language code is stored in the properties file, and the UI displays the ISO 639-1 description of the language code. Value: required; installed default=English 4-44 ADP, Inc. Locale Settings site.local.COUNTRY—Identifies the country based on the standard two-letter country code established by ISO 3166. Examples are MX for Mexico, CA for Canada, and US for the United States. The country code is stored in the properties file, and the UI displays the ISO 3166 description of the country code. Value: required; installed default=United States site.local.VARIANT—Indicates if the currency is the Euro or not. Valid entries are Euro or blank. site.local.currency.LANGUAGE—The currency language on the application server. Identifies the language based on the standard ISO 639-1 two-letter language codes associated with the currency that your site uses; for example, a value of en identifies English as the language associated with the currency. The language code is stored in the properties file, and the UI displays the ISO 639-1 description of the language code. Value: required; installed default=English site.local.currency.COUNTRY—The display currency country code on the application server. Identifies the country based on the standard two-letter country code established by ISO 3166 associated with the currency; for example, a value of US identifies U.S. dollars. The country code is stored in the properties file, and the UI displays the ISO 3166 description of the country code. Value: required; installed default=United States Note: You must specify the same value for this property on every application server associated with one database. site.local.currency.VARIANT—Indicates if the currency is the Euro or not. Valid entries are Euro or blank. site.local.quickTimestamp.HourMode—Indicates the default time display mode for the Quick Time Stamp running clock. Valid entries are 12 Hour Mode (1 - 12 AM/PM) or 24 Hour Mode (0-23). Value: required; installed default=12 Hour Mode (1 - 12 AM/PM) Enterprise eTIME System Administrator’s Guide 4-45 Chapter 4 System Settings site.local.charset.encoding—Specifies the character set vendor of the Enterprise eTIME system as either Windows or ISO and specifies the code page that is used for SQL Server JDBC connections. Note: You must restart the Enterprise eTIME system in order for a new value of site.local.charset.encoding to take effect. You must change the code page if your database contains text in a language that Windows Code Page 1252 does not support. If you do not use Windows Code Page 1252 for your character set, you must change the character set for e-mail to the appropriate ISO-8859-x in the site.email.language.charset key. For more information about the site.email.language.charset key, see “E-mail Settings” in this chapter. Value: required; installed default=Western European (Windows Cp1252) site.local.jarlist—The case-sensitive file name of a single Java Archive (.jar) used to store the localized versions of visible strings in the Java applets. site.local.jarlist.version—A decimal number that indicates the current version of the file specified in the site.local.jarlist property. Value: minimum=0; maximum=4095 site.local.successIndicator.timestamp.format—The date and time format for the success indicator. Value: required; installed default=h:mm a 4-46 ADP, Inc. Log File Settings Log File Settings Log files contain all of the log information recorded for the application server. The log files contain messages that record the server activities and assign a priority to the message. You can specify to use a single log file or multiple log files, and a maximum log file size for your server. If you specify using a single log file, WFC.log is rewritten when it reaches its maximum size. If you specify multiple log files, WFC.log is renamed to WFC.LOG.n, where n is the number of the next available log (1, 2, and so on). When the last log that you specify is filled, the oldest log is reused. 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 Key and Value Details site.log.active—Set to true to activate logging; or false to deactivate logging. Value: required; installed default=true Enterprise eTIME System Administrator’s Guide 4-47 Chapter 4 System Settings site.log.loglevel—Logging level for all contexts. Valid entries are: Severity Level Description ERROR Reserved for serious errors. The logged event might compromise system stability or data integrity. This level produces the fewest number of records and is used for normal operations. WARNING An unexpected condition has occurred that probably is an error, but is not serious enough to compromise system stability or data integrity. When this level is requested, WARNING and ERROR events are recorded. INFO Records normal events that you or TLM Support may need to see. When this level is requested, INFO, WARNING, and ERROR events are recorded. DEBUG Provides information for TLM Support. Use this log level only when TLM Support requests, since it produces a large number of records and can affect system performance. ADP recommends that you do not use this log level any longer than necessary to find the needed information. When this level is requested, DEBUG, INFO, WARNING, and ERROR events are recorded. Value: required; installed default=ERROR You do not have to click Restart Server to start the server again so that the changes you made can take effect. The change takes place when you save the new value. Caution: When you save the value, the system shuts down immediately. All user sessions are terminated with no warning. 4-48 ADP, Inc. Log File Settings site.log.file.append—When initializing logging: true = appends the new file false = overwrites the existing file Value: required; installed default=true site.log.file.name—Name and path of system log file. If the name is a simple file name, then the log file is located relative to the Enterprise eTIME root directory. Value: required; installed default=WFC.log site.log.file.rollover.maxsize—Maximum size of the log file before rollover occurs. You can use the suffixes KB, MB, or GB. Value: required; installed default=500KB site.log.file.rollover.maxlogs—Maximum number of saved log files to keep. If the value is 0, the main log file is overwritten when the rollover criteria are satisfied. Value: required; minimum=0; installed default=10 site.log.format.multiline—Specifies how to write messages with embedded new lines to the log file. flat = write them as one long line normal = write multiline messages as separate lines Value: required; installed default=normal Enterprise eTIME System Administrator’s Guide 4-49 Chapter 4 System Settings Logging Context Settings The Logging Context settings workspace contains properties for a selected number of contexts and enables you to set severity levels individually for them. The Logging Context settings are used for debugging purposes. Unless TLM Support requests you to change the values of these properties, leave them set to their installed defaults. Caution: Do not change any parameters on this page without direction from TLM Support since the parameters are for debugging purposes only. This information represents contexts that you want to make available for the system log. Any site.loggingContext property that you specify here appears in the Context drop-down box of the Log Report component. 4-50 ADP, Inc. Portal Settings Portal Settings The Portal settings establish the way that elements appear on the user interface. Under typical circumstances, these settings do not change. Key and Value Details site.portal.colors.color1—Specifies the color of the applet banner background. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=56,84,156 site.portal.colors.color2—Specifies the color of the horizontal menu text in the applets. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=0,0,102 site.portal.colors.color3—Specifies the color of the text and drop-down borders in the applet banner. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=205,223,255 site.portal.colors.color4—Specifies the color of the title in the applet banner. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=247,247,247 site.portal.colors.color5—Specifies the background color of buttons in the applet banner. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=0,0,102 Enterprise eTIME System Administrator’s Guide 4-51 Chapter 4 System Settings site.portal.colors.color6—Specifies the background color of horizontal menu in the applet banner. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=247,247,247 site.portal.colors.color7—Specifies the color of the inactive menu tab background in the applets. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=120,154,235 site.portal.colors.color8—Specifies the color of the inactive menu tab text in the applets. Specify the color in a comma-separated RGB format (red, green, blue) with each color value between 0 and 255, such as 56,84,156 for a dark blue. Value: required; minimum=0; maximum=255; installed default=255,255,255 site.portal.minmax.icons.minimize—Specifies the URL of the image shown as the minimize icon. Value: required; installed default=/wfc/html/images/minimizeNavBar.gif site.portal.minmax.icons.maximize—Specifies the URL of the image shown as the maximize icon. Value: required; installed default=/wfc/html/images/maximizeNavBar.gif site.portal.navmenu.icons.show—This flag determines if the navigation bar implements the accompanying open, close, link, and disabled link icons for a collapsible menu. true = show toggle handles false = hide toggle handles Value: required; installed default=true 4-52 ADP, Inc. Portal Settings site.portal.navmenu.toggle.handle.type—Defines the toggle handle style to be used in the navigation bar for a collapsible menu. 0 = no handle 1 = image handle 2 = character handle Value: required; installed default=2 site.portal.navmenu.toggle.handle.opened.url—Specifies the URL of the image shown as the opened-state icon for a collapsible menu if the handle type is set to 1, image handle. Value: required; installed default=/wfc/html/images/openednode.gif site.portal.navmenu.toggle.handle.closed.url—Specifies the URL of the image shown as the closed-state icon for a collapsible menu if the handle type is set to 1, image handle. Value: required; installed default=/wfc/html/images/closednode.gif site.portal.navmenu.toggle.handle.link.url—Specifies the URL of the image shown as the link icon for a direct hyperlink if the handle type is set to 1, image handle. Value: required; installed default=/wfc/html/images/linknode.gif site.portal.navmenu.toggle.handle.disabled.url—Specifies the URL of the image shown as the disabled link icon for a direct hyperlink if the handle type is set to 1, image handle. Value: required; installed default=/wfc/html/images/disablednode.gif site.portal.navmenu.toggle.handle.closed.character—Character symbol used to indicate the closed-state if the handle type is set to 2, character handle.The default Enterprise eTIME value is the plus sign (+). You can replace this value with your own symbol. Value: required; installed default=+ Enterprise eTIME System Administrator’s Guide 4-53 Chapter 4 System Settings site.portal.navmenu.toggle.handle.opened.character—Character symbol used to indicate the opened-state if the handle type is set to 2, character handle.The default Enterprise eTIME value is the minus sign (-). You can replace this value with your own symbol. Value: required; installed default=site.portal.navmenu.toggle.handle.link.character—Character symbol used to indicate a direct hyperlink if the handle type is set to 2, character handle. Value: required; installed default=_ site.portal.navmenu.toggle.handle.disabled.character—Character symbol used to indicate a disabled link if the handle type is set to 2, character handle. Value: required; installed default=_ site.portal.systemconfiguration.MaxTabsInRow—The number of tabs to display on a single menu row for System Information and System Settings. Value: required; minimum=1; maximum=8; installed default=7 site.portal.external.communication.protocol.include—Set to true to force the communication protocol to be included in custom URLs. Value: required; installed default=true site.portal.external.communication.protocol—The default communication protocol used when invoking custom URLs. Value: required; installed default=http 4-54 ADP, Inc. Printers Settings Printers Settings The Printers setting workspace lists all the printers that have been defined for your system. Each printer must be visible to the server. The system uses these printers when Print is selected when running Reports. If a report is viewed first, then the printer selection comes from the browser, not this list. You can add or remove a printer from this list. As printers are added to your system, their names are added to the WFCPrinters table. Anything that you print using your browser’s print command is not printed to a server-based printer. Instead, it is printed to the printer that is associated with your PC. As part of the installation process, the installer provided the name of one printer to be used for server-based printing such as reports scheduled in Event Manager. The system captures this information and writes it to a temporary property file SitePrinter.properties. When the system is started for the first time, it reads the SitePrinter.properties file, updates the database with that information, and then renames the SitePrinter.properties file with .1 appended to the name so that it does not get processed again. Note the following information regarding printers: ! Printers are a global resource for the system. In a multiserver environment, all application servers have the same list of printers. ! Printer properties are maintained in the database. ! There is no limit to the number of printers that can be defined. Click Add to add a new printer to the current list. When you add a server-based printer, enter its virtual name, path, and a comment. Use a semicolon (;) to separate the names; for example: printer.p1 = WFC Printer 1;\\\\APOGEE\\LochNess;Group 1 where WFC Printer 1 is the name that appears in print dialog boxes. Enterprise eTIME System Administrator’s Guide 4-55 Chapter 4 System Settings Properties with global scope across application servers are maintained in database tables. If you switch databases, you must copy the appropriate properties to the new database. See “Working with Property Files” in Chapter 1 for more information. Caution: Do not modify any properties in this setting unless you want the change applied to all of the application servers in the system. After you click Save, any changes that you made are permanent. There is no way to restore or reload the previous settings. Key and Value Detail printer.<printer number>—This string represents the Enterprise eTIME server printer information. This information is in three parts, separated by semicolons. ! The first part is the printer name to appear in the printer selection list. ! The second part is the path that maps to the printer. ! The third part is the printer group. Example: Enterprise eTIME Printer 1;\\printserver\printer; Group1 4-56 ADP, Inc. Printers Settings Enabling a Server-Based Printer To add a server-based printer to the Enterprise eTIME system, follow these steps: 1. Define the printer in the System Settings component in the Printers tab. 2. Provide the JRun user account with access to the printer. 3. Provide the server with access to the printer. JRun is installed under a Windows NT user account. That user must have access rights to all printers listed in the Printers tab. When you add a printer to the system, someone with Full Control access rights for the print server must log onto Windows NT to make the printer accessible to the JRun user account. To determine if a printer is accessible from the server, log on to Windows NT using the JRun user account. Now use standard Windows NT facilities to add a printer. If your printer appears in the list of printers available for selection, it is accessible from your server. You do not need to actually add the printer. Seeing it on the list ensures its availability to the system. Enterprise eTIME System Administrator’s Guide 4-57 Chapter 4 System Settings Reports Settings The Reports settings establish the reporting properties. Before users can create and schedule a report, you must establish the reporting properties using this information. See Chapter 5, “Reports,” for information about creating reports. Note: For UNIX platforms, reports are on the companion Windows server. Key and Value Details site.reporting.GenerateRepsToDir—Specifies the location where the generated reports are stored. Value: required; platform=Windows; installed default={Enterprise eTIME.rootdir}/reports/{site.local.LANGUAGE}/reportoutput site.reporting.executable.log—Specifies the location where the ProduceReport log is stored. Value: required; platform=Windows; installed default={Enterprise eTIME.rootdir}/logs/WFCReporting site.reporting.rpt.files—Specifies the location where the report files are stored. Value: required; platform=Windows; installed default={Enterprise eTIME.rootdir}/reports/{site.local.LANGUAGE}/ site.reporting.rpt.otherfiles—Specifies the location where custom report definitions are stored. site.reporting.RepTimeToLive—Number of hours before the generated reports are cleaned up from the disk. Value: required; minimum=0; platform=Windows; installed default=72 4-58 ADP, Inc. Reports Settings site.reporting.RepCleanUpDaemon.enable—Set to true to enable the report server’s cleanup process, which deletes both the reports entry from the Check Run Status tab and the report file. The deletion is based on the report’s request date and time and the length of time designated in the site.reporting.RepTimeToLive key. Value: required; platform=Windows; installed default=true site.reporting.diagnoseRptSqlOnError.enable—This setting allows SQL errors to appear in the .pdf file generated by the Crystal Reports engine. Set to true to enable detailed troubleshooting for SQL errors within a failed Crystal Reports file. Set to false only if the report engine performance is being severely affected by having this set to true. Value: required; platform=Windows; installed default=true site.reporting.MaxNumRepAgents—Defines the maximum number of the Report Agents that are running in the background. Value: required; minimum=0; platform=Windows; installed default=2 site.reporting.totalization.interval—Specifies the interval of time that a report waits on a queue. Value: required; minimum=0; platform=Windows; installed default=30 site.reporting.totalization.retries—Specifies the number of attempts that the report engine makes when running a SQL query, which returns a list of persons that have been totalized by the Background Totalizer. Reports never directly calls or runs the Background Totalizer, but verifies a column value that is set to the person’s current totalization status. Value: required; minimum=0; platform=Windows; installed default=7 site.reporting.totalizer.threshold—Specifies to the report engine how to report a list of persons who failed to totalize. If the number is less than or equal to this value, the report sends a list of failed person IDs. If the number exceeds this value, the report sends a status value that generates a generic totalization failure message. Value: required; minimum=0; platform=Windows; installed default=100 Enterprise eTIME System Administrator’s Guide 4-59 Chapter 4 System Settings site.reporting.totalizer.threshold.megaproblem—If the total number of non totalized persons exceeds this value, the totalization sequence is terminated, and a failure report is run. Value: required; minimum=0; platform=Windows; installed default=10000 site.reporting.importbatchrange—Specifies the range value that is used as a filter when searching the database for any import batches that have been run. The value is in days, and is used to create a date range from today backwards for the specified number of days. Value: required; minimum=0; platform=Windows; installed default=90 site.reporting.engine.enable—Set to true to indicate if the report engine is enabled in this server. Value: required; platform=Windows; installed default=true 4-60 ADP, Inc. Security Settings Security Settings Security settings establish an offline environment and specify the authentication mode that your application server uses. When the system is in offline mode and the database is not accessible, the user must log on using the offline URL. An authentication of the user name and password occurs. The user ID and password must match those in Enterprise eTIME's records. Key and Value Details site.security.authentication.offline.username—Logon user name for use in offline mode. Value: required; installed default=superuser site.security.authentiction.offline.password—Offline mode logon password. Passwords are stored encrypted. Value: required site.security.authentication.logoff.restartTimer.seconds—Specifies the number of seconds allotted for the server to restart before the user is redirected back to the logon page after logging off of Enterprise eTIME. Value: required; minimum=0; installed default=120 site.security.SSL.FQDN—Fully-qualified domain name of the local server used for SSL-enabled connections. For example, myserver.adp.com. Enterprise eTIME System Administrator’s Guide 4-61 Chapter 4 System Settings site.security.authsrc—Authentication type: The definition of your server security method. Examples: ! LDAP://<your LDAP server name>/ou=<your organizational unit>, o=<your organization name> ! WinNT—support for multiple Windows NT domains ! WinNT://<your NT Domain name>—support for a single Windows NT domain ! OTHER://provider=<Authentication Module>;property=<Authentication Module property file> See “Understanding Authentication” for more information about the different authentication types. Value: installed default=PROPRIETARY site.security.singlesignon—Set to true to specify that single sign-on is enabled. Value: required; installed default=false site.security.singlesignon.module—The name of the module, such as Java class file, that implements single sign-on for Enterprise eTIME. This is only used when integrating Enterprise eTIME with a third party single sign-on solution. Value: installed default=com.kronos.auth.SSOSiteMinderSubject site.security.singlesignon.module.properties—The name of the property file that contains configuration information used in the single sign-on module. This is only used when integrating Enterprise eTIME with a third party single sign-on solution. Value: installed default=C:/adp/wfc/properties/SSOSiteMinder.properties site.security.html.ess.global.securityTimeout.Minutes—Sets the logoff timer on all the pages within Enterprise eTIME Professional - HTML Client. This value determines the inactivity time period each user has prior to automatic logoff. Value: required; minimum=1; maximum=30; installed default=25 4-62 ADP, Inc. Security Settings site.security.html.ess.global.QTS.securityTimeout.Minutes—Sets the Quick Time Stamp logoff timer for all the pages within Enterprise eTIME Professional HTML Client. When logged in via Quick Time Stamp, this value determines the inactivity time period each user has prior to automatic logoff. Value: required; minimum=1; maximum=30; installed default=5 site.security.html.ess.global.QTS.confirmationTimeout.Seconds—Sets the redirect timer on the Quick Time Stamp - Time Recorded page within Enterprise eTIME Professional - HTML Client. This value determines the display length of the results page prior to redirection back to the Quick Time Stamp page. Value: required; minimum=1; maximum=60; installed default=10 site.security.authentication.urldispatcher—The name of the module that implements authentication for the URL Dispatcher Service used by the 4500. The default authentication model for the URLDispatcher is device only requests. If you want the URLDispatcherServlet to default to accept requests from any browser, not just the browser on the 4500, substitute DeviceOnlyAuthentication with AnyBrowserAuthentication. For example: site.security.authentication.urldispatcher=com.kronos.wfc.wfp.urldispatcher.secur ity.AnyBrowserAuthentication Understanding Authentication Authentication is the validation of a user name and password by a trusted authority. The system makes different kinds of authentication modules available. Note: Regardless of the type of authentication that you specify here, the following accounts always use ADP authentication: SuperUser, Totalizer, TaskRunner, and DCM’s user accounts. Enterprise eTIME System Administrator’s Guide 4-63 Chapter 4 System Settings Your authentication type is established during the initial configuration of the system, and is the value of the property site.security.authsrc. The following are available property values: ! PROPRIETARY If you specify this value, the system validates the user ID and password associated with a user in the ADP database. Note: This is the local and default authentication scheme. The user must exist in the database to which the server is attached. Changing databases when using PROPRIETARY authentication may cause authentication problems. The authentication source must be the same across domains. ! WinNT If you use a WinNT value without specifying a domain, Enterprise eTIME proxies the authentication request to a Windows domain server as specified as part of the user name at logon. Windows validates the user ID and password. This setting is used for supporting authentication against multiple Windows NT domains. Enterprise eTIME user names must be specified as <domain name>\<user id>; for example, CORPORATE_DOMAIN\dgormley. This entire value is the full user name value stored in the Enterprise eTIME user account table and shown in all views, QuickNavs, and reports. When users log on to Enterprise eTIME, they enter their full user name in the logon screen; for example, CORPORATE_DOMAIN\dgormley. The corresponding Windows user “dgormley” must exist in the “CORPORATE_DOMAIN” domain. Some additional Windows domain configuration may also be required. The Enterprise eTIME Server machine is defined as a member of some domain, for example, the A domain. If the Enterprise eTIME server needs to authenticate users that are defined in domains B and C, then domains B and C must be configured to be trusted by domain A. 4-64 ADP, Inc. Security Settings ! WinNT://<your_NT_domain> (not available for UNIX platforms) For example, WinNT://CORPORATE_DOMAIN If you use a WinNT value, Enterprise eTIME proxies the authentication request to a domain server. Windows validates the user ID and password. For WinNT authentication, the user name must match the ADP user name recorded in the Enterprise eTIME database. This setting is used for supporting authentication against a single Windows NT domain where all of the Enterprise eTIME users have Windows accounts in one domain. ! LDAP://<your_LDAP_server_name>/ou=<your_organizational_unit>, o=<your_organization_name> For example, LDAP://tdyernt/ou=people, o=kronos.com If you specify LDAP, Enterprise eTIME proxies the authentication request to a Lightweight Directory Access Protocol (LDAP) server. LDAP validates the user ID and password. See your WinNT or LDAP documentation for information about these processes. Regardless of which process you use, the user ID must match the recorded ones in the Enterprise eTIME system’s database tables. For LDAP authentication, the LDAP user id (uid) attribute must match the ADP user name recorded in the Enterprise eTIME database. ! OTHER://provider=<Authentication Module>;property=<Authentication Module property file> This uses a custom authentication method. This custom authentication method uses the module identified by <Authentication Module> to validate the Enterprise eTIME user’s credentials, which is usually a username and password. This module is configured using the <Authentication Module property file> properties file. One use of custom authentication is for custom LDAP authentication. This is implemented in a module installed with Enterprise eTIME, and can be used as an alternative to the default Enterprise eTIME LDAP authentication method. This custom LDAP authentication module can accommodate a wide range of LDAP configurations. See Appendix F, “Custom LDAP Authentication Method,” to configure Enterprise eTIME to use Custom LDAP module. Enterprise eTIME System Administrator’s Guide 4-65 Chapter 4 System Settings Changing the Logoff Timer You can change the length of time delay when you are logging off Enterprise eTIME. 1. Select System Configuration > System Settings > Security. 2. Set site.security.authentication.logoff.redirectTimer to the number of seconds you want. 3. Click Save. 4-66 ADP, Inc. Service Settings Service Settings Service settings establish properties related to the application server. A number of property files contains templates for SQL statements that the system uses. When your system was initially configured, files containing SQL statements that conform to your requirements were selected. These files do not change and are specified as the following: site.service.sql.strings.file.{first, second, third} Use the property site.service.sql.trace.on.off with a setting in the SQL Coverage tab to enable SQL tracing. Key and Value Details site.service.sql.strings.file.first—First SQL Strings properties file. Value: required; installed default=SqlStrings.properties site.service.sql.strings.file.second—Second SQL Strings properties file. site.service.sql.strings.file.third—Third SQL Strings properties file. site.service.sql.trace.on.off—This setting works with the new logging package, which means the site.log.WFC.PERSISTENCE.SQLTRACING setting must be set to DEBUG. ! Set this to off to disable SQL tracing. ! When this setting is set to on, SQL is added to the log. Value: required; installed default=off site.service.business.LL.MAX_MOST_RECENT_USED_ITEMS—Number of most recently used transfer settings available for reuse. Value: required; minimum=1; installed default=5 Enterprise eTIME System Administrator’s Guide 4-67 Chapter 4 System Settings site.service.business.LL.MAX_LABOR_LEVEL_ENTRIES—Maximum number of named entities displayed at the client, such as labor level entries, nonorganizational jobs, labor level sets, and HyperFind queries. Value: required; minimum=1; installed default=1000 site.service.ShiftBuilder.AlwaysBuildShiftsOnStartup—Set to true to specify that the periodic shift builder should run each time the server starts up. Value: required; installed default=false site.service.ShiftBuilderController.MaxTriesBeforeGivingUp—Defines how many times the ShiftBuilderControllers should try a thread before giving up. Value: required; minimum=1; maximum=5; installed default=5 site.service.ShiftBuilderController.MaxShiftBuilderControllers—The maximum number of concurrent shift builder controllers. To optimize the memory and speed of an import, adjust the maximum number of controllers. The specific setting depends on the available memory and the memory requirements of each import item. More ShiftBuilderControllers use more memory, but may improve speed. Use zero (0) to suppress the shift builder. Value: required; minimum=0; maximum=20; installed default=2 site.service.business.type.TimePeriodType.MAX_DAILY—The maximum standard hours for daily time period. Value: required; minimum=0; maximum=24; installed default=24 site.service.business.type.TimePeriodType.MAX_WEEKLY—The maximum standard hours for weekly time period. Value: required; minimum=0; maximum=168; installed default=168 site.service.business.type.TimePeriodType.MAX_PAY_PERIOD—The maximum standard hours for pay period time period. Value: required; minimum=0; installed default=744 4-68 ADP, Inc. SQL Coverage Settings SQL Coverage Settings The SQL Coverage settings is a debugging tool that tracks the number of times each SQL statement is executed. You should not have to use this information for any other reason. Key and Value Details test.SQLCoverage.enabled—SQL coverage tracking is only performed when this value is true. Value: required; installed default=false test.SQLCoverage.writebackcount—Number of changes to the SQL Coverage properties entries between rewriting the file. Value: required; minimum=1; maximum=100; installed default=25 test.SQLCoverage.refresh—If this value is true, the system re-creates the SQL Coverage properties from the SQLStrings*.properties. Value: required; installed default=false test.SQLCoverage.traceback—List of statements to be backtraced. You can find out where a SQL statement is invoked from by entering its name in this field. A complete traceback is written to the log. You can add multiple statements separated by spaces. test.SQLCoverage.driverLogging—Set to true to create a log of all JDBC driver communications. This can be helpful when debugging driver problems. The JDBCdriver.log file contains the output. Value: required; installed default=false Enterprise eTIME System Administrator’s Guide 4-69 Chapter 4 System Settings Enabling SQL Tracing To enable SQL tracing: 1. Select System Configuration > System Settings > Log File. 2. Set site.log.loglevel to DEBUG. 3. Click Save. 4. Select System Configuration > System Settings > Service. 5. Set site.service.sql.trace.on.off to on. 6. Click Save. 7. Select System Configuration > System Settings > SQL Coverage. 8. Set test.SQLCoverage.enabled to true. 9. Click Save. 4-70 ADP, Inc. Startup Settings Startup Settings The Startup settings control how the Enterprise eTIME system starts up. ! If test.startup.offline is set to true, the offline services are started (ExtensionDiscoveryService, PropertiesExtensionLoaderService, PluginService, PlatformManagerService, PreLoadServletsService, and ApplicationInstaller). If any of these offline services fail to start, the system becomes unavailable. No online services are started, the system starts in offline mode, and users must log on using the offline logon mode. ! If test.startup.offline is set to false, the system starts in online mode. False is the default and means the system attempts to start the online services, including ServiceSphere, which attempts a database connection. Key and Value Detail test.startup.offline—The system will not attempt a database connection. False is the normal startup mode that attempts to start the online services and a database connection. If this setting is marked as true, no online services are started, no database connection is attempted, and the offline services are started. Users must then log on using the offline logon mode. Value: required; installed default=false Enterprise eTIME System Administrator’s Guide 4-71 Chapter 4 System Settings Timekeeping Settings The Timekeeping settings deal with timekeeping information. To change the settings, click in the text box of a property and type the new entry. Key and Value Details site.timekeeping.optimistic_lock_buffer_size_in_minutes—Specifies the amount of time, in minutes, to add to the end of the time period to verify that there are no conflicting edits to the employee’s timecard before performing a save function. The system automatically verifies that no other changes have been made in the same time frame. This key lengthens the time period to be checked. Value: required; minimum=0; installed default=0 site.timekeeping.signOffGracePeriodDeltaInMinutes—Specifies the amount of time, in minutes, in which punches can be added at the boundary of a signed off region. When an employee works over a day divide and the previous pay period is signed off, the user loses access to the in-punch of the first shift of the current pay period. This key lengthens the current time period into the previous pay period to gain access to the in-punches that fall into the previous pay period. Value: required; minimum=0; installed default=0 site.timekeeping.historicalEditsIncludeInCurrentTotals—Determines if the Include in totals for effective date check box is selected by default in the Historical Amount dialog boxes when creating historical edits. Value: required; installed default=false site.timekeeping.retroHistoricalEditsIncludeInCurrentTotals—Determines if the Include in totals for effective date check box is selected by default in the Add Historical Amount with Retroactive Pay dialog box when creating historical edits with retroactive pay. Value: required; installed default=false 4-72 ADP, Inc. Timekeeping Settings site.timekeeping.cacheSizeForTimesheetItemSeqNums—Number of sequence numbers obtained by the application server at one time for use in updating the TIMESHEETITEM table. This key is used for performance tuning. Value: required; minimum=0; installed default=1000 site.timekeeping.cacheSizeForPunchEventSeqNums—Number of sequence numbers obtained by the application server at one time for use in updating the PUNCHEVENT table. This key is used for performance tuning. Value: required; minimum=0; installed default=1000 Enterprise eTIME System Administrator’s Guide 4-73 Chapter 4 System Settings Transformation Settings The Transformation settings is used as a data transformation service for any services, such as reports. Key and Value Details site.transformation.controllerPollingInterval—The polling interval for the TranformerController thread (in milliseconds). Value: required; minimum=1; installed default=2000 site.transformation.MaxNumTransformerThreads—The maximum number of transformer threads that can be run at any given time. Value: required; minimum=1; installed default=2 site.transformation.transformerManagerSleepInterval—The sleep interval (in milliseconds) for the TransformerManger thread before it checks the transformation queue for requests. Value: required; minimum=1; installed default=5000 4-74 ADP, Inc. Web Server Settings Web Server Settings The Web Server setting is the communication component that receives requests from users and returns responses to them. Web Server settings allows you to set properties for this component. In a multiserver environment, each application server contains a Web Server component. The default communication protocol is HTTP. However, much of the data between users and the system is text-based and, therefore, easily readable. If you require a more secure protocol, you can configure your Web server to use HTTPS instead, which uses a Secure Sockets Layer (SSL) to encrypt the data with a digital certificate technique. Key and Value Details site.webserver.session.timeout.graceperiod.minutes—This property sets 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. The client-side "Logon again Timer" is calculated on the client based on the Web server's own session timeout interval and this grace period value. Value: required; minimum=1; installed default=1 site.webserver.communication.protocol—The protocol used by the Web server for all communication. This value is either http (standard mode) or https (secure mode). Value: required; installed default=http Enterprise eTIME System Administrator’s Guide 4-75 Chapter 4 System Settings site.webserver.applet.communication.protocol—The protocol used by applets for communication with the application server. Value Definition http Standard mode https Secure mode system Applets will use the protocol determined from the HTTP request, which is the protocol used to request the applet. Value: required; installed default=system site.webserver.QTS.maxRoundTripNetworkLatency.seconds—Defines the maximum network latency time for the Quick Time Stamp (QTS) result page requests. You can select an alternate network latency time for the QTS in the event the round trip from client to server exceeds 1 second. You might use this setting in situations such as if you are using the QTS application across a satellite connection and the one-way transfer time is equal to or greater than 500 milliseconds. Possible values for this key are 1, 2, 3, 4, and 5. Value: required; installed default=3 4-76 ADP, Inc. Chapter 5 Reports This chapter contains information about working with reports in the Enterprise eTIME system. This chapter contains the following sections: ! Overview ! Generating a Report ! Generating Custom Reports Chapter 5 Reports Overview The Enterprise eTIME system works with a runtime version of Crystal Reports v9.0 to deliver reports that can provide complex information to users. You can use the complete Crystal Reports v8.5 or v9.0 software to create custom reports. Note: You must use the drivers appropriate for your database that are supplied by Crystal Reports v8.5 or v9.0 to create a custom report. You cannot use the drivers used by the Enterprise eTIME application. For UNIX installations, Reports and Event Manager are run on the companion Windows server. Reports are generated on the companion Windows server, and after they are complete, they are copied back to the UNIX server. If you are logged on to the UNIX server, any access to a previously completed report originates from the UNIX server’s cache of these reports in the directory as specified. Adobe Acrobat Reader 4.05 or 5.0 must be installed on all browser clients that are used to access reports. Terminology The following terms are used in connection with reports: Term Description background options or Other options set up to display information in the report header. parameters You can set up background options to identify selected option values, display calculated totals, display a HyperFind query name, specify security for wages data, display the name of the person who runs the report, and format time values. Background options are specified in the Crystal Reports definition and in the Report Setup component of Enterprise eTIME. Users cannot select or modify these options or option choices when they request a report. 5-2 ADP, Inc. Overview Term Description custom options Additional report options in addition to the standard report options. An identifier of a runtime question that allows users to enter values to qualify the results that appear on a report. custom report A report created specifically for your organization. You can use the Enterprise eTIME system with Crystal Reports software to generate these additional reports for users. foreground options or Choices selected when users request a report in the Reports parameters component and passed to Crystal Reports to control the result set of a report query. These options are established for any report definition in Crystal Reports and then in the Report Setup component of the Enterprise eTIME system. options Enterprise eTIME settings that indicate viewable items or report selection criteria. option or parameter choice A selectable value for an option or a parameter. For example, if the option or parameter is Absences, then the choices are Unexcused, Excused, or Both. parameters Crystal Reports report definition settings that indicate viewable items or report selection criteria. The Enterprise eTIME options and the report definition parameters must match exactly. report The combination of a report item and a report definition. report definition A Crystal Reports file that, with a report item, creates a report. Crystal Reports always have an .rpt file extension. report instance Generated by the system when a user requests a report. report item An object in the Enterprise eTIME database that specifies the report name, options, and other information, and provides a link to the Crystal Reports report definition file. standard report A report provided by the system. See the Reports component online Help for descriptions of standard reports. Enterprise eTIME System Administrator’s Guide 5-3 Chapter 5 Reports Reports Directory Report definitions are stored in the directory that you specify in the site.reporting.rpt.files property. When your system is installed, this value is set to: ! {Enterprise eTIME.rootdir}\wfc\applications\wtk\ reports for Windows platforms ! [installation directory]/wfc/applications/wtk/ reports for UNIX platforms This directory contains standard report definitions. The definitions are in .rpt format; you cannot view them directly without Crystal Reports software. Do not modify the contents of this directory. (Windows platforms only) The following directories are located in {Enterprise eTIME.rootdir}\wfc\reports\: Directory Description DBReports Directory used by the Database Reports feature. Contains two subdirectories: ! ! DRD—repository for the database report definition (drd) files results—repository for the database report result files OtherReports Directory for custom report definitions. Like the reports in KronosReports, they are in .rpt format; you cannot view them directly without the complete Crystal Reports software. (Windows platforms only) reportoutput Subdirectory for report instances. You can format these instances as .pdf, .htm, .xls, .doc, or .rtf files. other files, such as Other files in this directory are for the internal use of the system. exceptions.pdf Do not modify them. 5-4 ADP, Inc. Overview Reports Server The process that Enterprise eTIME uses to generate a report depends on your selection in the Reports user interface: ! If you run a report to view on the screen, the request is handled by the reports engine of the application server that you are logged into, if the application server supports reports. ! If you print, e-mail, or schedule a report, Event Manager processes the request. Event Manager searches for a list of available report servers, chooses a server at random, and submits the report request to that server as an HTTP/ XML request. If you run many reports to view on the screen, you can improve system performance by creating one or more application servers dedicated to generating reports. You do this by disabling the report service on the primary application server that handles user authentication and enabling the report service on the application server where you want to run reports: 1. Log on to the primary application server or the application server where you want reports to run. 2. Select System Configuration > System Settings > Reports on the navigation bar. 3. On the site.reporting.engine.enable key, click true or false according to the type of server that you are setting up. When the primary application server receives a report request from a client, it either runs the report itself (if the report service is enabled), or it delegates the request to other servers (if the report service is disabled). It does not have the discretion to run the report at certain times and to relay the request elsewhere at other times. If you disable the reports service on the primary application server and enable it on one reports server only, the primary application server directs all requests to run reports to the reports server. Enterprise eTIME System Administrator’s Guide 5-5 Chapter 5 Reports If you set up more than one reports server, the primary application server gives every report server an equal opportunity of receiving report requests by doing the following: 1. When an application server starts, it registers itself in the database. The server is added to a list of servers in the ServerInfo service, and the report server receives that list of servers via the ServerInfo service. 2. When you run a report to view on the screen, the request goes to the application server to which you are logged in. ! If the application server’s report engine is enabled, it generates the report. ! If the report engine is disabled, the report request is passed to another server. When a report request has to go to another server, the request searches the list of servers in the ServerInfo service and sends the report request to the first report server on the list. If that server is not online, the request goes to the next server in the list. Subsequent report requests go to the next available report server on the list, and the process goes on until all report servers have run a report. Two consecutive reports do not go to the same report server unless it is the only report server. Queue Performance Considerations A number of properties that you can set in the Reports tab affects how quickly reports can be completed and removed from the queue. Factors that affect the server’s throughput include: ! 5-6 site.reporting.MaxNumRepAgents—The number of agents that you can specify. Each agent represents a separate thread. If you have a long-running report and a single agent, you block other reports that are waiting to be processed. However, each agent incurs overhead and too many agents can adversely affect the performance of the server. ADP, Inc. Overview ! site.reporting.totalization.retries—The number of times that a report can use the Totalizer application. The more retries that you allow, the longer a report can remain on a queue. ! site.reporting.totalizer.threshold—The number of uncalculated rows that you allow in a report. This value affects the failure rate and the number of times that reports are resubmitted to the Totalizer application, thereby increasing the reports load. Report Logs The Reports function does not use the system log. By default, a reports log is generated for each agent that you specify in the following property: site.reporting.MaxNumRepAgents ! site.reporting.executable.log—All Reports log files are located in the directory that you specify with the property. The system names each log file WFCRportinglogn.log, where n represents an agent. For example, if you specify site.reporting.MaxNumRepAgents = 2, you have two log files named WFCRportinglog0.log and WFCRportinglog1.log. Each log file is 100KB in size and is recycled when completed. ! site.reporting.logging—This value is a bitmap that can be helpful to TLM Support. Its value was set to zero when your system was installed. If you have problems with some aspect of the Reports function, TLM Support might ask you to modify this property and e-mail the resulting log file. Enterprise eTIME System Administrator’s Guide 5-7 Chapter 5 Reports Accessing Reports The following factors determine how the Enterprise eTIME reporting facility is used: ! The Reports component on the Enterprise eTIME navigation bar enables a general user to select and run an existing report. The report can be a standard report or a previously created custom report. For more information, see “Generating a Report” in this section. ! The Report Setup component under Common Setup on the navigation bar in combination with Crystal Reports software enables you to create custom reports. After you create a report, it is available to general users through the Reports component. For more information, see “Generating Custom Reports” in this section. ! The Reports tab in the System Settings component allows you to establish properties that are in effect for all reports. For further information, see “Reports Settings” in Chapter 4. Enterprise eTIME maintains reports in files on your application server. Existing reports must be located on every application server in your Enterprise eTIME system. Each application server must have the same report files in the same directories. The following are default locations for report files on each application server: ! Windows platforms—{Enterprise eTIME.rootdir}\wfc\applications\wtk\reports and {Enterprise eTIME.rootdir}\reports\ ! UNIX platforms—[installation directory]/wfc /applications/wtk/reports and [installation directory]/wfc/reports/ Note: Although reports for a UNIX application server are generated on the companion Windows server, the results are stored on the UNIX server in a subdirectory. 5-8 ADP, Inc. Overview The system provides a runtime-only version of Crystal Reports; you do not need to purchase a copy to view, print, or e-mail a report instance of any standard report. Access reports from the Reports component on the navigation bar or by clicking the Reports icon where available from the launch bar of any Enterprise eTIME component, including QuickNav, the Timecard editor, or the individual schedule. Users can run a report immediately for online viewing, printing, or inclusion in an e-mail; or set up a scheduled event to produce the report at a specific time or scheduled interval, in a specified output format, and to a specified destination. Checking Report Status You can check on the status of a report by selecting Reports > Check Run Status. The report listing includes the following report statistics: ! Name of the report. ! Distribution format—for example, PDF or HTML text. ! Date and time that the report was requested and completed. ! Status: – Waiting—This is the first state that a report enters. Reports in this state are waiting to be processed by the first available report agent. The report agent determines if the report requires a HyperFind query, and, if a query is required, it runs the query. A report remains in the waiting state until its HyperFind query is complete. The performance of a HyperFind query is affected by the SQL that it generates and other activities on the database. – Updating—In the updating state, the report agent checks to see if the totals required by the report are up to date. If the totals are up to date, the report advances to the next state, which is running. If the totals are not up to date, the report is returned to the queue until the next report agent becomes available. This cycle repeats and the report will continue to be returned to the queue until its totals are up to date, depending on the totalization settings. For more information, see “Setting Up for Totalization.” Meanwhile, the report agent that returns the report to the queue is available to work on the next report. If a report does not require totals, this state is ignored. Enterprise eTIME System Administrator’s Guide 5-9 Chapter 5 Reports – Running—When a report enters the running state, a produceReport.exe process is started for that report. The produceReport.exe process communicates with Crystal Reports and formats the data that it returns in order to produce the actual report. This process uses minimal resources at times because Crystal Reports does most of the work. For example, for a report that requires a lot of SQL processing, the process may remain at 0% CPU use for a longer time than usual while waiting for data from Crystal Reports. Reports in the running state also use memory resources in direct relation to the amount of SQL generated. – Complete—When a report is finished running, its status is reported as complete. You can only view or distribute completed reports. – Failed—If a report fails for whatever reason, its status is reported as failed. You can open a failed report as it might contain helpful troubleshooting information. ! Output—For example Screen, E-mail, or Print. ! User—Users with appropriate access rights can view the user names of other users who generated reports. Double-click the report or select View Report to view a report online that has a screen output. The PDF-formatted report opens unless you selected a different output option. 5-10 ADP, Inc. Overview Blank Reports in the Adobe Reader Due to an interaction problem between some versions of Microsoft Internet Explorer and Adobe Acrobat, one-page reports occasionally appear blank when opened in the Adobe Reader. If this occurs, select Refresh after the report runs. The report appears in .pdf format. To permanently prevent one-page reports from appearing blank, configure Internet Explorer to use Adobe Acrobat Reader as a helper application, rather than a plug-in, by doing one of the following: ! For Acrobat Reader 4.05, select File > Preferences > General, and clear the Web Browser Integration check box. ! For Acrobat Reader 5.0, select Edit > Preferences > Options > Web Browser Options, and clear the Display PDF in Browser check box. Setting Up for Totalization When the system calculates totals for some reports, the following properties are involved: ! site.reporting.totalization.interval—A report that requires totals is placed in a queue. If totalization is not completed during the first Totalizer session, the report is returned to the queue. The value that you specify here is the number of seconds that the report waits on the queue. After the time has elapsed, the system calls the Totalizer application again. ! site.reporting.totalization.retries—The value that you specify here determines the maximum number of times that a report can call the Totalizer application. Enterprise eTIME System Administrator’s Guide 5-11 Chapter 5 Reports ! 5-12 site.reporting.totalizer.threshold and site.reporting.totalizer.threshold.megaproblem—If the number of retries specified in site.reporting.totalization.retries is exhausted and totals for all employees have not been calculated, the values of these properties determine how the system handles the report: – If the number of employees with uncalculated totals is less than or equal to the value of site.reporting.totalizer.threshold, then the system produces the report, listing the failed employees. – If the number of employees with uncalculated totals is greater than the value of site.reporting.totalizer.threshold, but less than the value of site.reporting.totalizer.threshold. megaproblem, the report does not list the failed employees, but simply contains a count of them. – If the number of employees with uncalculated totals is equal to or greater than the value of site.reporting.totalizer.threshold. megaproblem, the report is not run. Instead, the system generates a failure message. ADP, Inc. Generating a Report Generating a Report Use the Reports component on the Enterprise eTIME navigation bar to generate a report. The Reports workspace lists all reports, both standard reports and custom reports that you can create. When you select a report from the list, a description appears to the right of the report list. Use the Show drop-down list to select a HyperFind query or a location to determine the data to be processed by the report. The location chooser is used for Enterprise Scheduler reports. When you select a report and click Set Options, the Options list appears. You can use the Options list to do the following: ! Identify any options for which the user can select choices or accept the default values. ! Specify the format of a report instance if it is being e-mailed. Initiate a report job by clicking Run Report. The report job combines a report item and a report definition to create a report instance. Enterprise eTIME System Administrator’s Guide 5-13 Chapter 5 Reports The following example shows a completed instance of the Employee Hours by Labor Account report: In a multiserver environment, a user can initiate a request for a report from any Enterprise eTIME application server, and the system can run the report on any Windows server designated as an Enterprise eTIME report server. The system automatically copies the report instance to the server that initiates a request to access it. The user can then log on to any application server via a browser to see the completed report, which always appears to reside on the local application server. 5-14 ADP, Inc. Generating Custom Reports Generating Custom Reports Creating a custom report involves using the following: ! Crystal Reports 9.0 software, purchased from the vendor, and a Crystal Decisions license. You need a working knowledge of the Crystal Reports 9.0 reporting tool. You must understand the tables and views in the Enterprise eTIME database. For detailed information, see the Enterprise eTIME Database Tables Reference Guide and the Enterprise eTIME Database Views Reference Guide. ADP Professional Services can also help you to prepare custom reports. ! The Report Setup component (under Common Setup) on the Enterprise eTIME navigation bar. For a multiserver environment, you need access paths and write access permissions for all of the Windows servers designated as an Enterprise eTIME report server in your environment. The standard report definitions are installed in the KronosReports directory. You must install any custom report definitions to the adp/wfc/reports/OtherReports directory on each of these report servers. Note: If you fail to add a custom report definition to every Windows application server, the user sees the report listed in the Reports component, but may not be able to run it. Although you can query the Enterprise eTIME database with other reporting tools, the integration of Crystal Reports and the Enterprise eTIME system allows you to use a number of facilities not available with other reporting tools. Using Crystal Reports and the Enterprise eTIME system allows you to do the following: ! Use the Event Manager component to schedule a report instance to run at a specific time or at specified intervals. ! Send your completed report instance to a printer, your browser, or to an e-mail recipient from within Enterprise eTIME. ! Use the HyperFind query to select people or the location chooser to select locations for a report instance. ! Browse the report instance online. Enterprise eTIME System Administrator’s Guide 5-15 Chapter 5 Reports ! Determine who can access specific information, such as wages data, within a report. ! Include the most current totalized data from the database. To generate a custom report, do the following: ! Create a Crystal Reports report definition: – Determine calculated totals for employee data. – Determine whether to use a HyperFind query or a location chooser. – Determine which Time Periods may be needed. – Determine which Report Options are needed. – Place your custom report definition on all application servers. ! Create an Enterprise eTIME report item. ! Create custom options (optional). ! Determine access profiles for users who access the report. Note: Standard Scheduler reports which use the report accelerator process can only be customized by duplicating and modifying a report item that has the Uses Accelerator(s) check box selected. You cannot select the Uses Accelerator(s) check box since it is unavailable. Standard or other views, or tables may be joined to the original accelerated report views if additional information not on the original report view is required. However, since this additional information is not an accelerated view, report performance could be impacted. Accelerated views used on different reports cannot be combined into one accelerated report. 5-16 ADP, Inc. Generating Custom Reports Creating a Crystal Report You should use an existing report (standard or custom) to create a new report by duplicating and modifying the original existing report. Standard Scheduler reports that use the report accelerator process can only be customized by duplicating and modifying a report item that has the Uses Accelerator(s) check box selected. You cannot select the Uses Accelerator(s) check box since it is unavailable. Note: When you open duplicated reports in Crystal Reports to customize, the database and password assignments from the original ADP development database are retained in the Set Location preferences. You need to set the datasource location to your database in order to run the report in the Crystal Reports development application. Assigning a Name to the Crystal Report File A report file name must be unique. To see the file name of an existing report, access Common Setup > Report Setup on the navigation bar, and click a report in the Name column. The file name appears in the Report File Name text box. Calculating Employee Data Many reports display totals calculated by the system. Calculations are usually needed for the following: ! Pay codes and amounts ! Accruals and amounts ! Absences and exceptions ! Schedules ! Sign off ! Holiday credit data If your report contains calculated totals, the report definition and the report setup item must reflect this. Enterprise eTIME System Administrator’s Guide 5-17 Chapter 5 Reports The report item for a report that requires totaled data contains a flag that identifies this requirement. The system passes any report item with this flag to the Totalizer, a background process that the system periodically activates to run for a specific period of time and calculate totals. When the system generates a report instance that uses totaled data, each employee record in the HyperFind result set is examined to see if the totals are up to date. If they are up to date, the report is run. Otherwise, the report is queued for a Totalizer session. If, after the Totalizer session, employee records remain with totals that are not up to date, the system returns the report to the queue and waits for another Totalizer session. The number of times that the system can return a report to the queue depends on the value in site.reporting.totalization.retries and the length of time that it waits depend on the value in site.reporting.totalization.interval. For more information, see “Reports Settings” in Chapter 4 To determine whether your report needs totals, consider the following situations: ! A report that does not use employee-specific data does not need totals; for example, Break Rules report. ! A report that displays only the names of people does not need totals; for example, a report about users who are unable to log on to the system. Reports that do not need totals can include: 5-18 – People – Accrual Pool Balances – Badge Numbers – Zone Rules ADP, Inc. Generating Custom Reports ! If a report displays employee names and payroll information, it needs totals; for example, a report about pay code amounts or accruals information for employees. Reports that need totals include: – Time Details – Hours by Labor Account – Employee Sign Off – Exceptions – Accruals Balance and Projections To determine whether an existing report uses totals, access the Report Setup component. On the navigation bar, select Common Setup > Report Setup and then click a report. If the report uses totals, the Contains Totals Data check box is selected. The requirement for totals is retained in the totalsw column of the reports table in the database, where a value of 1 means that totals are used and a value of 0 means that they are not. Using HyperFind Queries If your report contains employee data, using a HyperFind query simplifies your report request. To determine whether an existing report uses a HyperFind query, access the Report Setup component. On the navigation bar, select Common Setup > Report Setup and then click a report in the list. If the report uses a HyperFind query, the Requires HyperFind Query check box is selected. Because only employee data is totaled, you cannot have a report that displays totals without also using a HyperFind query. However, your report can use a HyperFind query, but not require totals. Enterprise eTIME System Administrator’s Guide 5-19 Chapter 5 Reports If the report displays calculated totals, set up the Crystal Reports report definition to accept a HyperFind query. Do this using the Crystal Reports Record Selection Formula, and include the following statement: <table or view name>.employeeid = -411, where table or view name is replaced by a table or view name in your query that has an employeeid column. Otherwise, if the report does not display calculated data, the Record Selection Formula of the report must include: <table or view name>.personid = -411, where table or view name is replaced by a table or view name in your query that has a personid column. When a report instance is run, the employee or person IDs in the HyperFind query result set replace the –411 marker, thereby limiting the resulting report instance to those employees or people whom the HyperFind query returns. The HyperFind replacement string must be the first selection criteria, and the format must be <table.column> = -411 This replacement works because of the integration between the Crystal Decisions software and the Enterprise eTIME system, and does not work unless the report is linked within the Enterprise eTIME system. Caution: Never enter this Selection Formula directly into the WHERE clause of the report. Enterprise eTIME does not support any modifications to the SQL statement made in the Show SQL Query option in Crystal Reports. 5-20 ADP, Inc. Generating Custom Reports Determining Time Periods If your report displays employee data, it is likely to have a time period option in effect so that you can limit results to a specific time period. Time period can be for pay periods or nonpay periods. Pay periods can be different for each employee on a report. Nonpay period time periods contain the same date range for all employees. Many of the Enterprise eTIME database views include employee pay period dates. When you request both pay period and non pay period time periods, the Record Selection Formula uses a special formula. The following code example illustrates a time period Record Selection Formula for the report definition: If you select a time period for any non pay period type, the Timeframe Type passed to the report file is a number between 3 and 11. If you select a Pay Period, the Time period Type passed is as follows: Pay Period Value Previous Pay Period 0 Current Pay Period 1 Next Pay Period 2 Enterprise eTIME System Administrator’s Guide 5-21 Chapter 5 Reports When you select a pay period time period, the From Timeframe and To Timeframe parameters receive datetime values. The Enterprise eTIME system calculates the earliest From Timeframe value and the latest To Timeframe value for every employee in the report, and passes those values to the report parameters, thereby providing optimum performance for the report query. When you select a non pay period time period, the From Timeframe and To Timeframe parameters get the dates pertinent to the time period selected. The system ignores pay period portions of the formula. Users of Enterprise eTIME who are not employees do not have pay periods assigned to them. Specifying Report Options Identify the Enterprise eTIME Report options needed for the report, which are specified in Report Setup. Respective Crystal Reports options are specified as part of the report definition. You can select foreground options values when generating a report instance, but not background options. Background options are used to display foreground option values selected for a report instance, or to pass a value to a report to control formatting, or for us in calculations. Options selected for a report item must also be configured on the Crystal Reports definition, otherwise errors might result when creating a report instance. The only allowable difference between these options is that the Crystal Reports option names can be written in uppercase, lowercase, or mixed case. 5-22 ADP, Inc. Generating Custom Reports Report Options The following table describes each standard option: Background/ Foreground Option Name Description Absences Select Unexcused, Excused, or both F Absences hd Displays the selected Absence types B Actual/Adjusted Select Actual or adjusted amounts F Actual/Adjusted hd Displays the selected Actual/Adjusted choice B Db timezone Displays the timezone of the database server B Decimal Format Formats time format to hh:mm or hh.hh B Employee page break Select No or Yes to page break on each employee F Employee page break hd Displays the selected page break choice B Exceptions Select one, multiple, or all types of Exceptions F Exceptions hd Displays the selected Exception Types B From Timeframe Passes starting date for timeframe selection F Function Access Profiles Select one, multiple, or all function access profiles F Function Access Profiles hd Displays the function access profiles selected B Gmt server offset Returns the time difference, in seconds, between the timezones of the database server and the reporting server B Holiday Credit Type Select Credited, Denied, or both F Holiday Credit Type hd Displays the selected Holiday Credit Types B Import Type Select one, multiple, or all Import Types F Enterprise eTIME System Administrator’s Guide 5-23 Chapter 5 5-24 Reports Background/ Foreground Option Name Description Import Type hd Displays the selected Import Types B Import Batch Select one import batch or latest completed batch F Import Batch hd Displays the selected Import Batch B Labor level count Displays the number of labor levels defined in the database B Not Updated Emp List hd Passes list of employee/person IDs that are not up to date B Not Updated Emp Count hd Passes count of employee/person IDs that are not up to date B Pay Codes Select one, multiple, or all pay codes F Pay Codes hd Displays the selected Pay Codes B Printed For Displays the user name who ran the report B Query Name Displays Hyperfind Query name B Request Time hd Displays the time that all calculated totals are up to date B Timecard Audit Type Select one, multiple, or all audit types F Timecard Audit Type hd Displays the Audit Types selected B Timeframe hd Displays the timeframe selected B Timeframe Type Passes the selected timeframe type B To Timeframe Passes ending date for timeframe selection F Wage Permission Determines if wages appear on report based on function access profiles B ADP, Inc. Generating Custom Reports Report Option Attributes The following table describes attributes from the previous table: The last column identifies all available choices for an option and the internal values that the system passes to Crystal Reports for these option choices. ! An entry of the form name:number identifies a named choice and the internal code that represents it; for example, Unexcused:0. ! An entry of the form name:[..same] identifies entries that have the same internal and external values; for example, Adjusted:1. Only string or datetime entries have the same values internally and externally. ! An entry of the form count:name1|2... identifies a count of the number of choices for that option followed by each option name; for example, Count:PayCode name 1|PayCode name 2. ! An entry of the form name:n/m identifies an external value of name and an internal value of n/m. Two internal values are separated by a comma (,). Multiple/ Discrete Column Available Choice: Option Name Type Values? Typically Linked Internal Value Passed Absences Number Multiple Excusedsw Unexcused:0 Excused:1 Both:0,1 Absences hd String Discrete -Unexcused, Excused, Both:[--same] Actual/ Number Discrete Actual:0 Adjusted Adjusted:1 Actual/ String Discrete -Actual, Adjusted:[--same] Adjusted hd Db timezone String Discrete -“GMT +/- hrs: DB Timezone Name”:[-Same] Decimal Number Discrete -Hh:mm:1 Format Hh.hh:0 Employee page Number Discrete -No:0 break Yes:1 Employee page String Discrete -No, Yes:[--same] break hd Enterprise eTIME System Administrator’s Guide 5-25 Chapter 5 Reports Multiple/ Discrete Column Available Choice: Option Name Type Values? Typically Linked Internal Value Passed Exceptions String Multiple absentexcepttypeid Cancelled Deduct:0/1,1/1 Early In:1/2 Late In:1/3 Long Break:1/4 Holiday Skipped:0/5 Min. Days Active Violation:0/6 Min. Days Empl. Violation:0/7 Missed In Punch:1/8 Missed Out Punch:0/9 Short Break:1/10 Unscheduled:0/11,1/11 Very Early In:1/12 Late Out:0/3 Work History Violation:0/14 Long Interval:0/4 Short Shift:0/10 Early Out:0/2 Very Late Out:0/13 Exceptions hd String Discrete -Count:exception name1|2…:[--same] From Datetime Discrete Any datetime Datetimevalue:[--same] Timeframe column Function Number Multiple Vp_accessprofile. Accessprofile.profilenm: accessprofile.accessprofid Access Profiles accessprofid or Accessprofile. accessprofid Function String Discrete -Count:function access profile 1|2…. Access Profiles hd Gmt server Number Discrete -Seconds:[--same] offset Holiday Credit Number Discrete Exceptionsw Exceptions Only:0 Type Credits Only:1 Both:2 Holiday Credit String Discrete -Exceptions Only, Credits Only, Both [-Type hd same] 5-26 ADP, Inc. Generating Custom Reports Multiple/ Discrete Column Available Choice: Option Name Type Values? Typically Linked Internal Value Passed Import Type Number Multiple importcntnttypeid Labor Level Entries:1 Labor Level Set:2 People:3 Accrual Dates:4 Accruals:5 Punches:6 Pay Code Edits:7 Sched. Pay Code Edits:8 Schedules:9 Import Type hd String Discrete -Count:Import Type Name1|2…:-Import Batch Number Discrete Importbtchstatid Specific batch: importbtchstatid\0 Latest completed batch: importbtchstatid\1 Import Batch String Discrete -Batch Name and Date:[--same] hd Labor level Number Discrete -Number:[--same] count Not Updated Number Multiple employeeid’s:[--same] Emp List hd Not Updated Number Discrete Number of employeeid’s:[--same] Emp Count hd Pay Codes Number Multiple paycodeid Paycode.name:paycode.paycodeid Pay Codes hd String Discrete -Count:Pay Code name1|2…: Printed For String Discrete -Logged in user name:[--same] Query Name String Discrete -Hyperfind query name:[--same] Request Time Datetime Discrete Max datetime all employees on report have hd up to date calculated totals: [--same] Enterprise eTIME System Administrator’s Guide 5-27 Chapter 5 Reports Option Name Type Timecard String Audit Type Timecard String Audit Type hd Timeframe hd String Timeframe Type Multiple/ Discrete Column Available Choice: Values? Typically Linked Internal Value Passed Multiple Vp_timecardaudit. Add Duration:-1/0/30/1/, -1/0/30/0/, audittimesheetid -1//30/0/0 Edit Duration: -1/6/30/0/, -1/6/30/1/ Add Punch: -1/0/-1/0/, -1/0/-1/1/, -1//-1/0/0,-1/0/4/0/0,-1//4/0/0/,-1/0/2/0/0, -1/0/1/0/0,-1//2/0/0/ Edit Punch: -1/0/40/0/, -1/6/-1/1/, -1/6/-1/1/ , -1/6/-1/0/, 1/5/-1/1/,-1/5/4/1/1,-1/5/2/1/1 Add Pay Code: -1/0/20/1/, -1/0/20/0/, -1/0/22/0/, -1/0/21/0/, -1//20/0/0, -1/0/23/0/,12/-1/-1/-,-1/0/55/0/ Edit Pay Code: -1/6/20/1/, -1/6/20/0/, -1/1/20/0/ Delete Pay Code: -1/5/20/1/ Discrete -Count:Audit Type 1|2… Discrete -- Timeframe Name or Specific Dates: Number Discrete -- Prev. Pay period:0 Curr. Pay period:1 Next Pay period:2 Prev. Schedule period:3 Curr. Schedule period:4 Next Schedule period:5 Week to Date:6 Last Week:7 Yesterday:8 Range of Dates:9 Range of Relative Dates:10 Specific Date:11 Datetimevalue:-[--same] To Timeframe Datetime Discrete Wage Permission 5-28 Number Discrete Any datetime column -- ’Show wages’:1 ’Don’t show wages’:0 ADP, Inc. Generating Custom Reports Wage Permissions The wage permission option grants report and system display access, where some people can view the wage information and others cannot. This option is generally passed directly to a formula or field on a report that prints wage amounts, and does not display the formula or field to those users who do not have this permission in their function access profile. The function access profile of the person preparing the report determines the value of this option, using a setting in Enterprise eTIME Setup > Access Profiles > Function Access Profiles. For any function access profile, wage permissions are in Enterprise eTIME Manager System Configuration > Setup (Windows client) > Wage Profiles Setup. Background Options Most background header options have names ending in hd and are generally placed on the report as headers for foreground options. Other similar appearing background options are the Query Name, Printed For, Db timezone, and Labor level count hd. ! If you use a HyperFind query, the Query name parameter in the report header displays the name of the HyperFind query. ! The Printed For parameter appears on all standard reports in the header to indicate the user who requested the report. However, if the report is scheduled, the User Name that is associated with the scheduled job appears instead. The employee group that is associated with the user who is logged on determines the employees that can be seen on the report. Many of these background options appear in the example report shown in “Generating a Report.” Enterprise eTIME System Administrator’s Guide 5-29 Chapter 5 Reports Decimal Format This option determines if time appears in hh:mm or hh.hh format, and the format is passed directly to formulas that display time. The function access profile of the person preparing the report determines the value of this option, using a setting in Enterprise eTIME Setup > Display Preferences > Display Profiles > Time Display Tab > Duration display group. Placing a Report on All Application Servers After you set up and test a custom report file, copy it to the {Enterprise eTIME.rootdir}/wfc/reports/OtherReports folder for each Enterprise eTIME application server in your system that is configured as a report server. To avoid errors, you must know the network or physical location of every application server. If a user selects a report that is not on the application server that executes a report instance request, an error results. Crystal Reports GetLabel() function Labels and Strings on Standard Crystal Reports Standard reports use a special function named GetLabel() that allows the labels and strings that appear on Crystal Reports to be stored in an external file named u2li18n.ini. This allows one Crystal Report file to be able to display strings in other languages without modifications to the report file. The GetLabel() formula accesses keys in the ini file to find a specific text string and retrieve it to a report. The same key can be used on multiple reports. When creating custom reports, you should hard code the strings directly on the Crystal Report file. This keeps any changes to the .ini file with version upgrades from affecting your report labels. To hard code strings directly, modify the report file by replacing any GetLabel() functions with strings. 5-30 ADP, Inc. Generating Custom Reports Note that you can continue to use the GetLabel() function and .ini file to supply the strings for custom reports, but be aware that labels or keys can change or be deleted after a version upgrade, which could require modifications to custom reports. Modifying the u2li18n.ini file is not recommended as it will be deleted during a version upgrade. The GetLabel() function will return ‘null’ if it is unable to retrieve a string for any reason. Running a Crystal Report That Uses the GetLabel() Function If you duplicate and modify a standard Crystal Report and choose not to delete all references to the GetLabel() function, the report will not run until your pc is modified for Crystal Reports to recognize this function. This function is specific to ADP applications and is not included in the Crystal Reports software. To set up the GetLabel() function on the pc where you are running the Crystal Reports software so that the report can be run and strings displayed: 1. On an Enterprise eTIME reporting server, copy {Enterprise eTIME.rootdir}\wfc\bin directory\U2LI18N.dll to \\Program Files\Common Files\Crystal Decisions\2.0\bin. This allows Crystal Reports to see the GetLabel() function. 2. On an Enterprise eTIME reporting server, copy {Enterprise eTIME.rootdir}\wfc\applications\wtk\ properties directory\U2LI18N.dll to \\Program Files\Common Files\Crystal Decisions\2.0\bin. This allows the GetLabel() function to access the strings in the .ini file. 3. On your pc where Crystal Reports is installed, add an environment variable to Windows named UFLINIFILE with path: \\Program Files\CommonFiles\CrystalDecisions\2.0\bin\u2li18n. ini. This also allow the GetLabel() function to access the strings in the .ini file. Enterprise eTIME System Administrator’s Guide 5-31 Chapter 5 Reports Setting Up the Enterprise eTIME Report Item The second task in generating a custom report is to set up the Enterprise eTIME system component. After you create the Crystal Decisions report and copy it to all application servers, access the Report Setup component from Common Setup on the navigation bar and create a report with the appropriate settings. Creating a New Report Item Note: Standard Scheduler reports that use the report accelerator process can only be customized by duplicating and modifying a report that has the Uses Accelerator(s) check box selected. You cannot select the Uses Accelerator(s) check box since it is unavailable. To create a new report item: 1. Select Common Setup > Report Setup > New to create a new blank report item. 2. In the Name text box, type a unique name for the report. Use the list at the top of the page to see the existing report names. General users see this name listed alphabetically in the Reports component. 3. In the Report File Name text box, type the unique file name of the crystal report that you placed in the OtherReports directory of every application server. The file type extension is not necessary. 4. In the Description text box, enter a description. General users see your description along with the report’s name in the Reports component. 5. Select the Requires HyperFind Query check box if you added the HyperFind syntax (<table or view name>.employeeid = -411 or <table or view name>.personid = -411) to the report definition. This check box enables you to select employees whenever you run the report. 5-32 ADP, Inc. Generating Custom Reports 6. Select the Contains Totals Data check box if your report displays employee totals. If selected, then the Requires Hyperfind Query check box is automatically selected; you cannot have totals data without also having the HyperFind query in your report file. 7. In the Time Periods drop-down list, select time periods from the drop-down list that relates to the Time Periods in the report definitions. Choices include the following: – None: The report does not use timeframes. – Specific Date: The report accepts a single date. If you select a specific date timeframe, the .rpt file still contains the From Timeframe and To Timeframe parameters; the application passes two dates. For example, 1/1/2001 12:00:00 A.M. and 1/1/2001 11:59:59 P.M. – Date Range Only: The report accepts exactly two dates. You cannot specify Pay Periods or Week to Date. – All: All timeframes selections are available, including pay period selections. – Schedule Periods: All time frame selections are available, except for pay periods. 8. In the Categories field, select one or more report categories. A report item can be listed in one or more report categories. By default, all reports are listed in the All category. You can specify multiple categories. 9. In the Available Options field, add or create and add the report options that you previously defined as Crystal Reports parameters in the report definition. 10. Click Save. Enterprise eTIME System Administrator’s Guide 5-33 Chapter 5 Reports Duplicating a Report Item If you duplicated and modified a report file, you can also duplicate the report item shown in the Report Setup component. To do this: 1. Select Common Setup > Report Setup. 2. Select the report to be duplicated, and click Duplicate. Except for the Name, Description, and Report File Name entries, all attributes of the selected report item are duplicated, including Categories. Note: Standard Scheduler reports which use the report accelerator process can only be customized by duplicating and modifying a report item that has the Uses Accelerator(s) check box selected. You cannot select the Uses Accelerator(s) check box since it is unavailable. 3. Specify a unique name to identify the new report in the Name text box. 4. Type any descriptive text such as a description of the report in the Description text box. 5. In the Report File Name text box, type the unique file name of the crystal report that you placed in the OtherReports directory of every application server. The file type extension is not necessary. 6. To be able to select employees whenever you run this report, select the Requires HyperFind Query check box. Remember that the Crystal .rpt file must also be configured to use HyperFind. 7. To include totalized data, select the Contains Totals Data Totals check box. 8. Select the appropriate time periods for use with this report from the Time Periods drop-down list. Remember that the Crystal .rpt file must be configured to use these same time periods. 9. To assign this report to a category, click Categories and select one or more categories. 5-34 ADP, Inc. Generating Custom Reports 10. Select the Report Options, as follows: ! To add report options, in the Available Options list, click each option to include in the report, then click Add. ! To select every option, click Add All. The options appear in the Selected Options list. ! To remove report options, click each option in the Selected Options list, then click Remove. ! To remove every report option and start over, click Remove All. Note: Custom reports can use either standard Enterprise eTIME Reports options or custom options that you create. For information about creating custom options, refer to “Creating Custom Options.” The options you select for the custom report item must also be configured as part of the Crystal .rpt file. 11. Click Save. Creating Custom Options Report options allow you to define additional selection criteria for a report each time that you run the report. If you use custom reports, or plan on doing so, you can create custom report options, which allow for even more run-time flexibility when running custom reports. Note: Along with an understanding of the Enterprise eTIME database tables and views, creating custom report options requires that you know how to create main and header parameters within Crystal Reports. Report parameters in Crystal are the equivalent of report options in Enterprise eTIME Reports. Enterprise eTIME System Administrator’s Guide 5-35 Chapter 5 Reports Creating a custom report option is a two-step process: 1. In Crystal Reports, create a custom parameter to go along with a custom report. 2. In Enterprise eTIME Reports, configure a custom option with the same properties as the custom parameter you created in Crystal. You must have the appropriate Enterprise eTIME permissions to perform this step. Note: Custom options only work with custom reports. For information about creating custom reports, see “Generating Custom Reports” in this section. For information about adding custom report items to Enterprise eTIME Reports, see “Setting Up the Enterprise eTIME Report Item” in this section. The Enterprise eTIME documentation does not describe creating parameters within Crystal Reports. Configuring Custom Options in Enterprise eTIME To configure custom options, do the following: 1. Select Common Setup > Report Setup > Custom Options within the Enterprise eTIME user interface and select New to create a new custom option. 2. In the Option Name field, enter the exact name that you gave to the corresponding main parameter in the Crystal Reports definition file. This name will appear in the Set Options tab when a report to which it applies is selected from Reports. 3. Enter information in the remaining fields that define the option: 5-36 ! Description—Add information about the option that may help the user choose when to use the option. ! Value Type—Enter the type of information that this option holds - a number, a string, or a date and time. ! Display at Run Time—Select from a drop-down menu whether to have the pick list value or the pick list description associated with the value appear at runtime. ADP, Inc. Generating Custom Reports ! Create header option—If you created a header parameter in Crystal Reports corresponding to the main parameter that you are configuring here, select this check box and a header option will be created automatically. ! Allow to pick multiple values at runtime—Select this check box if you want the option to allow for multiple value entries. ! Pick List Values—Add possible values for the option and descriptions of those values into this table to allow the user to pick from a list when defining the option at runtime. If you chose to have the descriptions display at runtime, both the value and description fields are required here. Note: At runtime, users have the ability to enter values not included in the Pick List using the Ad Hoc Value text box. 4. After you complete the necessary fields, click Save. The new custom option and its header option, if you have chosen to create one, now appear in the same list of available options within the Report Setup workspace as the standard options and any custom options that were previously created. This option can now be selected and saved along with the particular report item(s) for which it was created. Note: After configuring a custom option, you may have to refresh the workspace in order to see the new option in the list. Enterprise eTIME System Administrator’s Guide 5-37 Chapter 5 Reports Guidelines and Rules for Creating and Using Custom Options ! Enterprise eTIME does not support the ability to set default values for custom options. ! When selecting a custom option for a custom report in Report Setup, make sure that you select both the main option and the corresponding header option, if applicable. ! The option name in Enterprise eTIME and the parameter name in Crystal Reports must be the same. ! The properties, such as value type and multiple value setting, applied in the Custom Options setup must match those entered as part of the definition of the parameter in Crystal Reports. ! You can use a custom option with one or more custom reports as long as the report definition file for the custom report contains the matching custom parameter. ! If a custom report using custom options is scheduled, the custom option values set before scheduling are the values that are used for the scheduled report. ! When creating a header parameter in Crystal Reports, you must give it the same name as the main parameter followed by a space and then “hd.” For example, a header parameter corresponding to a main parameter named “Labor Level 1” would be named “Labor Level 1 hd.” The value type for header parameters must be “string” and header parameters should be set to receive one value. ! Custom options of type date and time are not intended to override the standard time period selection for a report. Instead, use date and time options to further define criteria for selecting data from an already qualified time period or in reports that do not rely on a time period selection. Giving Users Access to the Report Decide which users can access the report, then add the report item to the appropriate report data access profile(s) under Enterprise eTIME Setup > Access Profiles > Data Access Profiles > Reports. 5-38 ADP, Inc. Appendix A Predefined Data The Enterprise eTIME system provides predefined data to simplify the task of configuring your system. These values help you to configure your system quickly. You can modify some predefined data; for example, the default logon profile. You cannot modify other predefined data, such as labor levels. See the online Enterprise eTIME Setup Help for information about working with the predefined data, such as adding data access profiles. This appendix describes the following predefined data: ! Data Access Profiles ! Enterprise eTIME QuickNav Building Blocks ! Enterprise eTIME QuickNavs ! Display Profiles ! Labor Level Sets ! HyperFind Query ! Enterprise eTIME QuickNav Profile ! People ! Logon Profiles ! Function Access Profiles Note: Before you move from Enterprise eTIME Setup to the Enterprise eTIME System Configuration component, save the changes that you made in Enterprise eTIME Setup and then close the Enterprise eTIME Setup application. Doing this ensures that these changes will appear in the Enterprise eTIME System Configuration component. Appendix A Predefined Data Data Access Profiles To access the Data Access Profiles: 1. Start Enterprise eTIME Setup. 2. Double-click the Access Profiles icon. 3. Expand the Data Access Profiles entry. 4. Double-click one of the following predefined data access profiles. 5. To access one of the following predefined data access profiles, double-click the name on the right side of the workspace. You cannot edit predefined data access profiles. Predefined Values Definition All Pay Codes This value includes all pay codes: those that currently exist and those that may be added in the future. All Work Rules This value includes all work rules: those that currently exist and those that may be added in the future. All Reports This value includes all reports: those that currently exist and those that may be added in the future. All Shift Templates This value includes all shift templates: those that currently exist and those that may be added in the future. All Pattern Templates This value includes all pattern templates: those that currently exist and those that may be added in the future. This value includes all availability templates: those that All Availability currently exist and those that may be added in the future. Templates (Enterprise Scheduler only) All Schedule Groups A-2 This value includes all schedule groups: those that currently exist and those that may be added in the future. ADP, Inc. Enterprise eTIME QuickNav Building Blocks Enterprise eTIME QuickNav Building Blocks The predefined Enterprise eTIME QuickNav building blocks do not include any pay code columns because the system does not provide predefined pay codes. When you configure the QuickNavs during initial configuration, you can modify the predefined values listed in this section to add pay code total columns. All of the predefined QuickNavs provide information about employees or other details. The system does not provide predefined labor levels and, therefore, does not provide predefined roll-up QuickNavs. You define roll-up QuickNavs during initial configuration. All predefined QuickNavs are either Detail QuickNavs or Schedule QuickNavs. To access the Enterprise eTIME QuickNav building blocks: 1. Start Enterprise eTIME Setup. 2. Double-click the Display Preferences icon. 3. Expand the Enterprise eTIME QuickNav Building Blocks entry. 4. Select Detail Column Sets, Schedule Editor Column Sets, Schedule Assistant Column Sets, or Schedule Planner Column Sets. 5. To access one of the predefined profiles, double-click the name on the right side of the workspace. You can edit predefined profiles. Rows are sorted in ascending order by Person Name. Predefined Values Columns Included in QuickNavs IS Summary ! ! ! ! ! ! ! ! ! ! Person Name Home Account User Name E-mail Address Active Badge Number Assigned Manager Employee Group Home Phone Work Phone Last Totalization Enterprise eTIME System Administrator’s Guide A-3 Appendix A Predefined Data Predefined Values Columns Included in QuickNavs A-4 Pay Period Close ! ! ! ! ! ! ! Person Name Employee Approval Manager Approval Signed Off Missed Punch Unexcused Absence Expected Pay Period Hours QuickFind ! ! ! Person Name Person ID Home Account Reconcile Timecard ! ! ! ! ! ! ! ! ! Person Name Unexcused Absence Missed Punch Early In Late In Early Out Late Out Unscheduled Hours Totals Up-To-Date Shift Close ! ! ! ! ! ! ! ! ! Person Name Unexcused Absence Excused Absence On Premises Missed Punch Early In Late Out Unscheduled Hours Totals Up-To-Date Shift Start ! ! ! ! ! ! ! ! Person Name Unexcused Absence Excused Absence On Premises Unscheduled Hours Hire Date Home Phone Totals Up-To-Date ADP, Inc. Enterprise eTIME QuickNav Building Blocks Predefined Values Columns Included in QuickNavs Schedule Editor ! ! ! ! Person name Schedule Totals Department Job Schedule Assistant ! Percent Match (Enterprise Scheduler ! Person Name only) ! Primary Org ! Job ! Selected Job Seniority ! Expected Weekly Hours ! Scheduled Weekly Hours ! Availability ! Home Phone ! Worker Type ! Skills ! Certification Name ! Last Scheduled Event ! Next Scheduled Event Schedule Planner ! Person name (Enterprise Scheduler ! Schedule Totals only) ! Department ! Job Enterprise eTIME System Administrator’s Guide A-5 Appendix A Predefined Data Enterprise eTIME QuickNavs To access Enterprise eTIME QuickNavs: 1. Start Enterprise eTIME Setup. 2. Double-click the Display Preferences icon. 3. Expand the Enterprise eTIME QuickNavs. 4. Double-click one of the Enterprise eTIME QuickNavs predefined entries: Enterprise eTIME QuickNav Predefined Entry Detail IS Summary Pay Period Close Reconcile Timecard Shift Close Shift Start QuickFind QuickFind Schedule Editor Schedule Editor Schedule Assistant Schedule Assistant Schedule Planner Schedule Planner 5. To access one of the following predefined QuickNavs, double-click the name on the right side of the workspace. You can edit predefined QuickNavs. A-6 Predefined Values Values Set for This QuickNav IS Summary ! ! ! ! Default HyperFind Query is set to All Home Default Time Period is set to Current Pay Period Column Set is set to IS Summary Navbar Category is set to My QuickNavs ADP, Inc. Enterprise eTIME QuickNavs Predefined Values Values Set for This QuickNav Pay Period Close ! ! ! ! Default HyperFind Query is set to All Home Default Time Period is set to Previous Pay Period Column Set is set to Pay Period Close Navbar Category is set to My QuickNavs Reconcile Timecard ! ! ! ! Default HyperFind Query is set to All Home Default Time Period is set to Yesterday Column Set is set to Reconcile Timecard Navbar Category is set to My QuickNavs Shift Close ! ! ! ! Default HyperFind Query is set to All Home Default Time Period is set to Today Column Set is set to Shift Close Navbar Category is set to My QuickNavs Shift Start ! ! ! ! Default HyperFind Query is set to All Home Default Time Period is set to Today Column is set to Shift Start Navbar Category is set to My QuickNavs Quickfind ! ! ! Default Time Period is set to Week to Date Column Set is set to Quickfind Navbar Category is set to My QuickNavs Schedule Editor ! ! ! ! ! Default HyperFind Query is set to All Home Default Time Period is set to Current Schedule Period Default Main tab is Employee Column Set is Schedule Editor Navbar Category is set to My QuickNavs Schedule Assistant ! Default Location is set to All Home Locations Schedule Planner ! ! ! ! ! ! ! Default Location is set to All Home Locations Default Time Period is set to Current Schedule Period Default Main tab is Employee Column Set is Scheduler Planner Navbar Category is set to Scheduler Default Schedule Assistant tab is Schedule Assistant Schedule Assistant is Schedule Assistant Enterprise eTIME System Administrator’s Guide A-7 Appendix A Predefined Data Display Profiles To access the Display Profiles: 1. Start Enterprise eTIME Setup. 2. Double-click the Display Preferences icon. 3. Select Display Profiles. 4. To access one of the following predefined Display Profiles, double-click the name on the right side of the workspace. You can edit predefined Display Profiles. TLM Support uses the Super Access profile, which provides access to all settings. The settings for the Default predefined display profiles are: A-8 Tab Settings Time Display ! ! ! Labor Account ! Job ! The Show Job and Location description in tool tips on mouse over is selected. Timecard ! ! ! The project-view start day is Monday. The Edit future timecards box is not selected. Timecard Editor Totals are displayed by labor account. Manager Selections ! ! The duration display is specified as HH:mm. Display Time is in 12-hour format. Scheduled shift display is shift start and stop times. The Show Labor Level Entry description on mouse-over in Timecard Editor is selected. ! The Use Shorthand Labor Account notation entry is selected for all labor levels. The Schedule Period is set to weekly. No default Enterprise eTIME QuickNav Profile is provided. ! No default Custom URL Profile is provided. ! No Workload Planner Profile is provided. ADP, Inc. Labor Level Sets Labor Level Sets To access the Labor Level Sets: 1. Log onto the Enterprise eTIME system. 2. Use QuickFind to select an existing Enterprise eTIME Professional or Enterprise eTIME Manager. 3. With the person selected in the QuickFind workspace, click the People icon to access the People Editor. 4. On the Job Assignment tab, select Employee Role from the list on the left to access the Employee Role workspace. You can edit predefined labor levels. Predefined Values Includes Labor Levels All Labor Levels Yes, those that currently exist and those that may be added in the future. Empty No To add a new labor level or to edit an existing label level, click the Labor Level Transfer Set drop-down list in the Enterprise eTIME Manager or the Enterprise eTIME Professional group and select an entry from the list. Then click New or Edit. Enterprise eTIME System Administrator’s Guide A-9 Appendix A Predefined Data HyperFind Query To access the HyperFind query: 1. Log onto the Enterprise eTIME system. 2. Expand the Common Setup component in the navigation bar. 3. Select HyperFind Queries. You can edit predefined HyperFind Queries. Predefined Values Definition All Home 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 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 or to edit an existing query, select an entry from the list. Then click New or Edit. A-10 ADP, Inc. Enterprise eTIME QuickNav Profile Enterprise eTIME QuickNav Profile To access the Enterprise eTIME QuickNav profile: 1. Start Enterprise eTIME Setup. 2. Double-click the Display Preferences icon. 3. Expand the Display Profile Building Blocks entry. 4. Select Enterprise eTIME QuickNav Profiles. 5. To access the predefined Super Access profile, double-click its name on the right side of the workspace. TLM Support uses the Super Access profile, which provides access to all QuickNavs in a specific order. You can edit the predefined Super Access profile. Enterprise eTIME System Administrator’s Guide A-11 Appendix A Predefined Data People The SuperUser person is not accessible. However, to access people other than the SuperUser: 1. Log onto the Enterprise eTIME system. 2. Use QuickFind to select an existing Enterprise eTIME Professional or Enterprise eTIME Manager. 3. With the person selected in the QuickFind workspace, click the People launch button to access the People Editor. TLM Support uses the Super Access profile, which provides access to all settings. You cannot edit the Super Access profile. A-12 ADP, Inc. Logon Profiles Logon Profiles To access the Logon profiles: 1. Start Enterprise eTIME Setup. 2. Double-click the Access Profiles icon. 3. Select Logon Profiles. 4. To see a predefined logon profile, double-click the name on the right of the workspace. You can edit predefined logon profiles. Predefined Values Definition Default This profile has the following settings: Password ! ! ! The password is set to expire in 30 days. The minimum length is at least six characters. Reuse monitoring is set to remember the previous ten passwords. Session Restrictions A password change is not required at the next logon. ! Account lockout occurs after three failed logon attempts. The lockout duration is set to one minute. ! Inactivity timeout is set to one hour. ! Super Access TLM Support uses the Super Access profile, which provides access to all settings. Enterprise eTIME System Administrator’s Guide A-13 Appendix A Predefined Data Function Access Profiles To access the Function Access Profiles: 1. Start Enterprise eTIME Setup. 2. Double-click the Access Profiles icon. 3. Select Function Access Profiles. 4. To see a predefined function access profile, double-click the name on the right of the workspace. You can edit predefined function access profiles except for Super Access. Detailed values for the all predefined function access profiles appear in Appendix B, “Function Access Profiles.” Predefined Values Definition Default This value does not include any rights or online access. IS Intended for technical IS personnel who are involved with all aspects of the system. and IS Using Organization Predefined data for the IS profile includes access to most functions, including the Application Program Interface Maps (API), the System Configuration component, and Enterprise eTIME Setup. This profile does not include access to wage information. Other Manager and Other Manager Using Organization Maps A-14 Intended for managers who are not involved with payroll; for example, Department or Scheduling Managers. Predefined data for this profile includes access to all timecard and scheduling functions, as well as wage information for everyone but this manager. It does not include access to APIs, the System Configuration component, Enterprise eTIME Setup, or any wage information. ADP, Inc. Function Access Profiles Predefined Values Definition Payroll Manager Intended for managers involved with various aspects of the payroll function. and Payroll Manager Using Predefined data for this profile includes access to most functions, including the timecard editor, scheduler, and Organization Maps Enterprise eTIME Setup. It includes access to wages for others and oneself. Does not include access to APIs or the System Configuration component. Professional Employee Intended for non management personnel who can enter their own timecard information, using an hourly or project view, and and produce selected reports. Professional Employee This profile includes access to My Timecard and My Using Organization Reports functions. It does not include access to any manager Maps functions. Salaried Professional Employee This profile contains most of the same settings as the Professional Employee profile, and is used primarily for demonstration purposes. This profile is included only in kdemo databases. Scheduling Manager Intended for managers using Enterprise Scheduler. Predefined data for this profile includes access to schedule functions, such as availability, schedule rules, and Workload setup. Super Access TLM Support uses the Super Access profile, which provides access to all settings. Time Stamp and Hourly Employee Intended for non management personnel who can enter their own timecard information, using a time stamp view, and produce selected reports. and Time Stamp and Hourly Employee Using Organization Maps This profile includes access to My Timecard and My Reports functions. It does not include access to any manager functions. Time Stamp Employee This profile is for employees who only use the Time Stamp view. This profile is included only in kdemo databases. Enterprise eTIME System Administrator’s Guide A-15 Appendix A A-16 Predefined Data ADP, Inc. Appendix B Function Access Profiles Enterprise eTIME is used by people in many different jobs having many different timekeeping responsibilities; for example, hourly employees, salaried employees, managers, and IS specialists. To support this diversity of use, you must customize Enterprise eTIME to meet the access requirements of your company and individual job responsibilities. Function Access Profiles are the mechanism with which Enterprise eTIME defines what different types of users can see and do in each area of the Enterprise eTIME system. The following predefined Function Access Profiles define access for typical Enterprise eTIME users: ! Super Access—This profile provides access to all settings. TLM Support uses the Super Access profile. ! IS—This profile is for technical IS personnel who are involved with all aspects of the system. Predefined data for the IS profile includes access to most functions, including Application Program Interface (API), System Configuration component, and Enterprise eTIME Setup. This profile does not include access to wage information. ! IS Using Organizational Maps—This profile is the IS profile with the ability to use jobs effectively within the system. ! Payroll Manager—This profile is for managers who are involved with various aspects of the payroll function. Predefined data for this profile includes access to most functions, including Timecard Editor, Enterprise eTIME QuickNavs, Scheduler, Enterprise eTIME Setup, and access to wages for others and oneself. This profile does not include access to the APIs or the System Configuration component. ! Payroll Manager Using Organizational Maps—This profile is the Payroll Manager profile with the ability to use jobs effectively within the system. Appendix B B-2 Function Access Profiles ! Other Manager—This profile is for managers who are not involved with payroll, for example, department or scheduling managers. Predefined data for this profile includes access to all timecard and scheduling functions. It does not include access to the APIs, the System Configuration component, Enterprise eTIME Setup, or any wage information. ! Other Manager Using Organizational Maps—This profile is the Other Manager profile with the ability to use jobs effectively within the system. ! Professional Employee—This profile is for non-management personnel who can enter their own timecard information, using an hourly or project view, and produce selected reports. This profile includes access to My Timecard, My Schedule, and My Reports. It does not include access to any manager functions. ! Professional Employee Using Organizational Maps—This profile is the Professional Employee profile with the ability to use jobs effectively within the system. ! Salaried Professional Employee—This profile contains most of the same settings as the Professional Employee profile, and is used primarily for demonstration purposes. This profile is included only in kdemo databases. ! Scheduling Manager—Intended for managers using Enterprise Scheduler. Predefined data for this profile includes access to schedule functions, such as availability, schedule rules, and Workload setup. ! Time Stamp and Hourly Employee—This profile is for non-management personnel who can enter their own timecard information, using a Time Stamp view, and produce selected reports. This profile includes access to My Timecard, My Schedule, and My Reports. It does not include access to any manager functions. ! Time Stamp and Hourly Employee Using Organizational Maps—This profile is the Time Stamp and Hourly Employee profile with the ability to use jobs effectively within the system. ADP, Inc. ! Time Stamp Employee—This profile is for employees who only use the Time Stamp view. This profile is included only in kdemo databases. ! Default—This profile does not include any rights or online access. You can modify these predefined profiles or create new profiles by defining individual access control points that make up each Function Access Control profile. Note: The function access point tables in the “Function Access Profile Tables” section contain the base set of function access points. Asterisks (*) in the function access point columns followed by a new abbreviation code indicate settings that are different when organization maps are used. Enterprise eTIME System Administrator’s Guide B-3 Appendix B Function Access Profiles Accessing Function Access Profiles You create or modify Function Access Profiles in Enterprise eTIME Setup. You then assign a profile to each user in the Role workspace of the People Editor. To access the Function Access Profiles: 1. Start Enterprise eTIME Setup. 2. Double-click the Access Profiles icon. 3. In the left pane of the Access Profiles Setup dialog box, click Function Access Profiles. The predefined Function Access Profiles are listed in the right pane of the dialog box. 4. Click a predefined profile to view its function access points. In addition to organizing the function access points, the Function Access Profile categories contain default settings for typical Enterprise eTIME users. 5. Click the plus sign (+) next to each of the Function Access Profile categories to expand the function access points. 6. Click the corresponding Access column to view a drop-down list of available access rights settings. Each access point is assigned the access rights of Allowed or Disallowed. Additional access rights of None, Various, Only Self, and All but Self exist on some, but not all, access points. If a type of person has access to some functions and not others under the same category, the access scope is “Various.” For some of the access points, there is an “All but Self” option, which is typically assigned to managers who may be able to edit other people’s data, but not their own. B-4 ADP, Inc. Understanding Timecard Access Understanding Timecard Access The following table defines the timecard access when a person is an employee, a manager only, or both an employee and a manager: Employee Only Manager Only Person is Employee and Manager Manager’s Timecard Access is “All but Self” Manager’s Timecard Access does not apply Manager’s Timecard Access is “All” Manager’s Timecard Access is “All but Self” Manager’s Timecard Access is “All” My Timecard Enterprise eTIME Professional access N/A N/A Enterprise Enterprise eTIME eTIME Manager access Professional access Person’s own timecard, accessed via QuickNavs N/A Enterprise N/A eTIME Manager access An employee’s timecard, accessed via QuickNavs N/A Enterprise Enterprise Enterprise Enterprise eTIME eTIME eTIME eTIME Manager access Manager access Manager access Manager access Enterprise eTIME System Administrator’s Guide Enterprise N/A eTIME Manager access B-5 Appendix B Function Access Profiles Function Access Profile Tables The tables in the following sections describe the each of the Function Access Profile categories and their corresponding access control points: ! Everyone Category—Access to items that all users may need; for example, ad hoc entries. ! Enterprise eTIME Professional Category—Access to Enterprise eTIME as an employee; for example, timecards. ! Enterprise eTIME Manager - Department Manager Category—Access to Enterprise eTIME as a manager; for example, schedules. ! Enterprise eTIME Manager - Common Setup Category—Access to set up and configure Enterprise eTIME; for example, HyperFind. ! Enterprise eTIME Manager - System Configuration Category—Access to configure and maintain Enterprise eTIME system settings and Enterprise eTIME Setup. ! APIs Category—Access to the Application Program Interface, which allows clients to integrate their systems into Enterprise eTIME; for example, access to the XML interface. Note: The gold function access profiles for use with Organizational Maps and Jobs are not installed automatically for upgrade installations, but are automatically installed for new installations. B-6 ADP, Inc. Function Access Profile Tables Table Conventions For the tables in the remainder of this appendix, abbreviations for access rights settings are: Access Rights Setting Abbreviation Allowed A Disallowed D All ALL All but Self AB Only Self O Various V None N Table Legend For the tables in the remainder of this appendix, the table legend is: ! IS=Technical IS personnel ! PM=Payroll Manager ! OM=Other Manager ! PE=Professional Employee ! SPE=Salaried Professional Employee ! SM=Scheduling Manager ! TSHE=Time Stamp and Hourly Employee ! TSE=Time Stamp Employee ! Asterisks (*) in the function access point description columns indicate settings that are not available for the Enterprise eTIME Professional - HTML Client application. ! Asterisks (*) in the function access point columns followed by a new abbreviation code indicate settings that are different when organization maps are used. Enterprise eTIME System Administrator’s Guide B-7 Appendix B Function Access Profiles Everyone Category These access control points control access to functionality available to manager users and employee users. Function Access Point Ad Hoc Labor Level entries—Controls whether the employee can add entries to a labor level that is configured to accept ad hoc entries. Wages—Controls access to wage information. You must then define the type of access. Select from the following: Edit—Select from the following: -All—The employee can edit all wage information. -All but Self—The employee can edit wage information for everyone except himself or herself. -None—The employee cannot edit any wage information. View—Select from the following: -All—The employee can view all wage information. -All but Self—The employee can view wage information for everyone except himself or herself. -None—The employee cannot view any wage information. B-8 IS A PM A OM A PE SPE SM TSHE TSE D D A D D D A V D D V D D N ALL AB N N ABS N N N ALL ALL N N ALL N N ADP, Inc. Function Access Profile Tables Enterprise eTIME Professional Category These access control points control employee access to functionality in Enterprise eTIME. Function Access Point Time Stamp for Employees—Controls the employee’s access to Time Stamp. Select from the following: Transfers in Time Stamp—Controls the employee’s access to transfers in Time Stamp. If access is set to “Allowed,” the Transfers box is visible in the Time Stamp. You then must then define the type of transfers. Select from the following: Perform account transfers—Controls the employee’s ability to transfer to a different labor account in the Time Stamp. Perform work rule transfers—Controls the employee’s ability to transfer to a different work rule in the Time Stamp. Perform job transfers—Controls the employee’s ability to perform job transfers in the Time Stamp. Cancel meal deductions in Time Stamp— Controls the employee’s ability to cancel automatic meal deductions in the Time Stamp. If access is set to “Allowed,” the Cancel meal deduction check box is visible in the Time Stamp. Log off after stamping—Controls the employee’s ability to log off automatically after recording time using the Time Stamp. IS D PM OM D D PE SPE SM TSHE TSE D D D D D D D D D D D V D *A D D D D D D A D D D D D D D A D D D D D D D D D *A D D D D D D D D D D D D D D A V If access is set to “Allowed,” the Log off after stamping check box is visible in the Time Stamp. Enterprise eTIME System Administrator’s Guide B-9 Appendix B Function Access Profiles Function Access Point Timecard Editor for Employees (My Timecard)—Controls the employee’s access to his or her timecard. These access points do not affect a manager’s ability to access employee timecards. Select from the following: Allow negatives in My Timecard—Controls the employee’s ability to use negative amounts in his or her timecard. Approval in My Timecard—Controls the employee’s ability to access approval in his or her timecard. Select from the following: Add—If access is set to “Allowed,” the employee can approve his or her timecard. Remove—If access is set to “Allowed,” the employee can remove his or her approval of his or her timecard. Approve Overtime—If access is set to “Allowed,” the employee can approve overtime in his or her timecard. Note: This is often a manager-only function when used. Cancel meal deductions in My Timecard— Controls the employee’s ability to cancel meal deductions. Comments in My Timecard—Controls the employee’s ability to access comments in his or her timecard. Select from the following: Add—If access is set to “Allowed,” the employee can add comments to his or her timecard. Delete—If access is set to “Allowed,” the employee can delete comments to his or her timecard. B-10 IS V PM OM V V PE SPE SM TSHE TSE V V D V V A A A A A A A D V V V V V V V V A A A A A A A A A A A A A A A A D D D D D D D D A A A A D A A D A A A A V A V V A A A A A A A A A A A A D D D D ADP, Inc. Function Access Profile Tables Function Access Point Display day before and day after in My Timecard—Controls whether an extra day appears on each end of the selected time period in the employee’s timecard. This feature is used for a small subset of employees whose shift runs over the pay period boundary. In these cases, employees may need access to the in-punch of the shift that falls within the last day of a signed off previous pay period, or they may need access to the out-punch of a shift that falls into the first day of the next pay period. Duration amounts in My Timecard— Controls the employee’s ability to use durations or “Worked Hours” amounts in his or her timecard. Durations and shift override in My Timecard—Controls the employee’s ability to use durations with the new shift override amounts (“Worked Hours with Shift Override”) in his or her timecard. Historical edits in My Timecard*—Controls the employee’s ability to change his or her timecard in a signed-off period (historical edits). Select from the following: Manual Edits*—If access is set to “Allowed,” the employee can make manual historical edits in his or her timecard. Automated Edits*—If access is set to “Allowed,” the employee can make automated historical edits in his or her timecard. E-mail access in My Timecard—Controls whether e-mail is available from the employee’s timecard. Enterprise eTIME System Administrator’s Guide IS D PM OM D D PE SPE SM TSHE TSE D D D D D A A A A A A A D A A A A D A D D A A A A A V A D A A A A A A A A D D D D A A A A A A A A B-11 Appendix B Function Access Profiles Function Access Point Pay codes in My Timecard—Controls the employee’s access to pay codes in his or her timecard. Select from the following: Edit—If access is set to “Allowed,” the employee can make pay code edits in his or her timecard. View—If access is set to “Allowed,” the employee can view pay code amounts in his or her timecard. Punch edits My Timecard—Controls the employee’s ability to edit punches in his or her timecard. Sign-off in My Timecard—Controls the employee’s access to sign off his or her timecard. Select from the following: Add—If access is set to “Allowed,” the employee can sign off his or her timecard. Remove—If access is set to “Allowed,” the employee can remove his or her signoff in the timecard. Calculate totals in My Timecard—Controls whether the employee has access to the Callable Totalizer. If access is set to “Allowed,” the employee can view up-to-date totals in his or her timecard by selecting Actions > Calculate Totals. Totals breakdown in My Timecard— Controls the employee’s access to the totals breakdown information in his or her timecard. Calculate totals on-the-fly in My Timecard—Controls the automatic use of the Callable Totalizer in the employee’s timecard. IS A PM OM A A PE SPE SM TSHE TSE A A A A A A A A A A A A A A A A A A A A A A A A A D A A A A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A A A A A A D D D D D D D D If access is set to “Allowed,” the employee can view up-to-date totals immediately after making an edit and moving to the next row of a timecard. B-12 ADP, Inc. Function Access Profile Tables Function Access Point IS D View Totals by Job in My Timecard— Controls the employee’s ability to view the Job *A column in the totals breakdown area in his or her timecard. Transfers in My Timecard—Controls the V employee’s access to transfers in his or her timecard. Select from the following: View transfers—Controls the employee’s A ability to view account transfers, work rule transfers, and job transfers in his or her timecard. Perform account transfers—Controls the A employee’s ability to perform account transfers in his or her timecard. Perform work rule transfers—Controls A the employee’s ability to perform work rule transfers in his or her timecard. Perform job transfers—Controls the D employee’s ability to perform job transfers *A in his or her timecard. View Schedules in My Timecard—Controls A the employee’s ability to view his or her schedule, which appears at the bottom of his or her timecard. A Print Time Detail Report in My Timecard—Controls the employee’s ability to print the Time Detail Report from his or her timecard. A Edit non-active days in My Timecard— Controls the employee’s ability to make edits in days in which he or she is inactive or terminated. Accruals in My Timecard—Controls the D employee’s ability to access accruals in his or her timecard. Select from the following: Enterprise eTIME System Administrator’s Guide PM OM D D PE SPE SM TSHE TSE D D A D D V V V A A V D A A A A A A A A A A A A A A A A A A A A A D D D A A D A *A *A *A A A A D A A A A A A D A D D A A D D A D D D D D D D D D *A B-13 Appendix B Function Access Profiles Function Access Point Move Accruals in My Timecard— Controls the employee’s ability to move accruals in his or her timecard. If access is set to “Allowed,” the employee can move time or money from one accrual code to another; for example, move sick time to vacation time. Reset Accruals in My Timecard— Controls the employee’s ability to reset accruals in his or her timecard. View Accruals and Totals in My Timecard—Controls the employee’s ability to view accruals and totals at the same time in his or her timecard. If access is set to “Allowed,” a small Accruals window containing a subset of accrual codes automatically appears to the right of the Totals window in the timecard when the timecard is opened. Edits using scheduled amounts in My Timecard*—Controls the employee’s ability to request that the edit amounts can be calculated from a schedule. If access is set to “Allowed,” the employee can select “full sched day” or “half sched day” instead of entering a specific number of hours. The system automatically calculates hours based on the start and end time of any shift, and also takes into consideration any automatic meal deducts and any scheduled work rule transfers. Activities in My Timecard—Controls the employee’s access to the Activity Event Editor. Select from the following: Allow negatives in Activities—Controls the employee’s ability to use negative amounts in his or her own activities. B-14 IS D PM OM D D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D A D D D D D D D D D D D D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Event edits in Activities—Controls the employee’s ability to edit events in activities. Result edits in Activities—Controls the employee’s ability to edit results in activities. Approval of Activities—Controls the employee’s access to approval of activities. Select from the following: Add—If access is set to “Allowed,” the employee can approve activities. Remove—If access is set to “Allowed,” the employee can remove approval in activities. Comments in Activities—Controls the employee’s ability to use comments in activities. Select from the following: Add—If access is set to “Allowed,” the employee can add comments in activities. Delete—If access is set to “Allowed,” the employee can delete comments in activities. Pay code breakdown in Activities—Controls the employee’s access to pay code breakdown information in activities. Totals breakdown in Activities in My Timecard—Controls the employee’s access to activities totals breakdown information in their timecard. Print Activity Detail Report in My Timecard—Controls the employee’s ability to print the Activity Detail Report. Reports for Employees (My Reports)—Controls the employee’s access to employee-specific reports. Select from the following: My Time Detail—Controls the employee’s ability to run his or her Time Detail reports. My Accrual Balances—Controls the employee’s ability to run his or her Accruals Balance report. Enterprise eTIME System Administrator’s Guide IS D PM OM D D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D V V V V A V V A A A A A A A A A A A A A A A A A B-15 Appendix B Function Access Profiles Function Access Point My Schedule—Controls the employee’s ability to run his or her Schedule report. My Activity Detail—Controls the employee’s ability to run the Enterprise Activities Activity Detail Report. Earnings History for Employees—Controls the employee’s access to view their paychecks. My Availability*—Controls the employee’s ability to edit and view their own base availability. Select from the following: Edit*—If access is set to “Allowed,” the employee can edit their own base availability. View*—If access is set to “Allowed,” the employee can view their own base availability. E-mail Notification to Employees—Controls the employee’s ability to receive e-mail notifications. Select from the following: E-mail when timecard edit occurs after employee's approval—Controls whether the employee receives an e-mail message when someone edits his or her timecard after the employee approved the timecard. E-mail when timecard is approved— Controls whether the employee receives an email message when someone approves his or her timecard. E-mail when timecard is signed-off— Controls whether the employee receives an email message when someone signs off his or her timecard. E-mail when activity event edit occurs after employee’s approval—Controls whether the employee receives an e-mail message when a manager edits an employee’s activity event after the employee has approved his or her timecard. B-16 IS A PM OM A A PE SPE SM TSHE TSE A A A A A D D D D D D D D D D D D D D D D D D D D D A D D D D D D D A D D D D D D D A D D V V V V A V V A A A A A A A A A A A A A A A A A A A A A A A A A D D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point E-mail when activity event is approved— Controls whether the employee receives an email message when their activity event is approved. E-mail when activity event is signed-off— Controls whether the employee receives an email message when their activity event is signed-off. Enterprise eTIME System Administrator’s Guide IS D PM OM D D PE SPE SM TSHE TSE D D D D D D D D D D D D D B-17 Appendix B Function Access Profiles Enterprise eTIME Manager - Department Manager Category These access control points control the managers access to functionality in Enterprise eTIME. Function Access Point My QuickNavs—Controls the manager’s ability to make Time and Attendance related edits within the Enterprise eTIME QuickNavs. IS V PM V OM V PE SPE SM TSHE TSE D D V D V A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D Appearance of My QuickNavs in the navigation bar is controlled by the manager’s display profile. Select from the following: Apply group edit to self—Defines whether group edits in Enterprise eTIME QuickNavs can be applied to the timecard of the manager who makes the edit. Accruals payout—Controls the manager’s ability to use accruals payout functionality, which enables unused accrued time to be paid to employees. Accruals reset—Controls the manager’s ability to reset accruals amounts, which allows the manager to edit accrual balances. Accruals suspensions & reinstatements— Controls the manager’s ability to suspend and reinstate accruals. Select from the following: - Suspend accruals—Allows the manager to stop an employee from accruing additional time in the selected accrual codes. - Reinstate accruals—Starts accruing for the selected accrual code from the effective date. B-18 ADP, Inc. Function Access Profile Tables Function Access Point Accruals transfer—Controls the manager’s ability to transfer accruals amounts from: - Group to Employee—Transfer accruals from one or more people to one person. - Group to Pool—Transfer accruals from one or more people to a pool accrual code. - Pool to Employee—Transfer a pool accrual code to a person. Accruals update earned—Controls the manager’s ability to update earned accruals amounts. Update earned accruals allows a manager to edit the amounts of time or money that a person or group of people have earned. Allow negatives in QuickNavs—Controls the manager’s ability to use negative amounts when editing groups of timecards. Group approval of timecards—Controls the manager’s access to approval of groups of timecards. Select from the following: Add—If access is set to “Allowed,” the managers can approve groups of timecards. Remove—If access is set to “Allowed,” the manager can remove his or her approval from groups of timecards. Edit data approved by self—If access is set to “Allowed,” the manager can edit timecard information that he or she has already approved for groups of timecards. Edit data approved by others—If access is set to “Allowed,” the manager can edit timecard information that has already been approved by other managers for groups of timecards. Approve Overtime—If access is set to “Allowed,” the manager can approve overtime for a group of timecards. Enterprise eTIME System Administrator’s Guide IS A PM A OM A PE SPE SM TSHE TSE D D A D D A A A D D A D D A A A D D D D D V V V D D V D D A A A D D A D D A A A D D A D D A A A D D D D D A A A D D D D D D D D D D D D D B-19 Appendix B Function Access Profiles Function Access Point IS Comments in QuickNavs—Controls the A manager’s ability to use comments in group edits. Duration amounts in QuickNavs—Controls A the manager’s ability to use duration amounts or “Worked Hours” in group edits. A Durations and shift override in QuickNavs—Controls the manager’s ability to use duration amounts with the new shift override (“Worked Hours with Shift override”) in group edits. Filter by Selected Job Seniority—Controls D the manager’s ability to filter jobs by *A seniority date. Historical edits in QuickNavs—Controls the A manager’s ability to change a group of employee timecards in a signed-off period (historical edits). Select from the following: A Manual Edits—If access is set to “Allowed,” the manager can make manual historical edits. A Automated Edits—If access is set to “Allowed,” the manager can make automated historical edits. Select from the following: Add—If access is set to “Allowed,” A the manager can add automated historical edits. Delete—If access is set to “Allowed,” A the manager can delete automated historical edits. E-mail access in QuickNavs—Controls the A manager’s access to e-mail from an Enterprise eTIME QuickNav. Pay code edits in QuickNavs—Controls the A manager’s ability to make group edits to pay codes. B-20 PM A OM A PE SPE SM TSHE TSE D D A D D A A D D A D D A A D D A D D D D D D D D D *A *A A V D D V D D A A D D A D D A D D D D D D A D D D D D D A D D D D D D A A D D A D D A A D D A D D ADP, Inc. Function Access Profile Tables Function Access Point Payroll lock in QuickNavs—Controls the manager’s ability to set a payroll lock on the pay period in view. Pay from Schedule in QuickNavs— Controls the manager’s access to the Pay from Schedule functionality. IS A PM A OM A PE SPE SM TSHE TSE D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D V V V D D A D D A A A D D A D D With Pay from Schedule, an employee’s scheduled hours are automatically charged to his or her home account unless indicated otherwise by a pay code or transfer. Select from the following: Start Pay from Schedule—Controls the manager’s ability to start Pay from Schedule. Stop Pay from Schedule—Controls the manager’s ability to stop Pay from Schedule. Punch edits in QuickNavs—Controls the manager’s ability to edit a group of employee punches. Sign-off in QuickNavs—Controls the manager’s access to sign-off groups of employee timecards. Select from the following: Add—If access is set to “Allowed,” the manager can sign off groups of timecards. Remove—If access is set to “Allowed,” the manager can remove his or her signoff from groups of timecards. Transfers in QuickNavs—Controls the manager’s ability to transfer labor accounts, work rules, or both on groups of timecards. Select from the following: Perform account transfers—Controls the manager’s ability to transfer labor accounts on groups of timecards. Enterprise eTIME System Administrator’s Guide B-21 Appendix B Function Access Profiles Function Access Point Perform work rule transfers—Controls the manager’s ability to transfer work rules on groups of timecards. Perform job transfers—Controls the manager’s ability to transfer jobs on groups of timecards. Edits using scheduled amounts in QuickNavs—Controls the manager’s ability to request that the edit amounts be calculated from a schedule. If access is set to “Allowed,” the manager can select “full sched day” or “half sched day” instead of entering a specific number of hours. The system automatically calculates hours based on the start and end times of any shift, and also takes into consideration any automatic meal deducts and any scheduled work rule transfers. Overtime Equalization in QuickNavs— Controls the manager’s ability to access the overtime equalization menu option in QuickNavs. Only available if the global.OvertimeEqualization.enabled key is set to True. For more information, see Global Values Settings. Approval of Activities in QuickNavs— Controls the manager’s ability to approval of groups of activity employees. Edit non-active days in QuickNavs— Controls the manager’s ability to edit days in QuickNavs in which the employee is inactive or terminated. Sign-off Activities in QuickNavs—Controls the manager’s ability to sign off groups of activity employees. B-22 IS A PM A OM A PE SPE SM TSHE TSE D D A D D D D D D *A *A *A *A D D D D D D D A D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point IS PM OM Activities in QuickNavs—Controls the D D D manager’s access to perform transactions for groups of activity employees. V V V Scheduling—Allows the manager to use the schedules. Appearance of schedules in the navigation bar is controlled by the manager’s display profile. Select from the following: A A A Schedule access—Controls the manager’s ability to access Schedule Editor, Schedule Assistant, and Schedule Planner. Select from the following: Edit—Controls the manager’s ability to ALL ALL ALL edit Schedule Editor, Schedule Assistant, and Schedule Planner. Select from the following: - All - All but Self - None View—Controls the manager’s ability to A view Schedule Editor, Schedule Assistant, and Schedule Planner. Schedule Views—Controls the access to the V different views of the schedule. Select from the following: Employee View of Schedule—Controls A the ability to edit or view the employee. Group View of Schedule—Controls the A ability to edit or view the group view of the schedule. Job View of Schedule—Allows the user D to edit or view the job view of the schedule. Location Selection from Schedule Editor— D Allows the manager to access location *A selection upon entering the Schedule Editor. Enterprise eTIME System Administrator’s Guide PE SPE SM TSHE TSE D D D D D D D D D D N A D N N N ALL N N A A D N A D N V V VD D A D D A A D D A D D A A D D A D D D D D D A D D D D D D A D D *A *A B-23 Appendix B Function Access Profiles Function Access Point Pay Code Comments in Schedules— Controls the manager’s ability to use pay code comments in the Enterprise eTIME QuickNavs for Scheduling. Schedule Groups Configuration—Controls the manager’s ability to access schedule groups configuration. Select from the following: Create schedule groups—Controls the manager’s ability to create schedule groups. Delete schedule groups—Controls the manager’s ability to delete schedule groups. Edit Group Names—Controls the manager’s ability to edit the schedule group name. Edit employees in group—Controls the manager’s ability to edit employees in a schedule group. Edit schedules in group—Controls the manager’s ability to edit schedules in a schedule group. Schedule pay code edits—Controls the manager’s ability to schedule a pay code edit. View audit trails in Schedules—Controls the manager’s access to the audit trails in the Enterprise eTIME QuickNavs for Scheduling and in the Individual Schedule. View Accruals in Schedule—Controls the manager’s ability to view accruals in the Enterprise eTIME QuickNavs for Scheduling. Accruals in Schedule Editor—Controls the manager’s access to accruals in the Enterprise eTIME QuickNavs for Scheduling. Transfers in Schedules—Controls the manager’s ability to perform transfers in schedules. Select from the following: B-24 IS A PM A OM A PE SPE SM TSHE TSE D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D D D D D D A D D V V V D D A D D ADP, Inc. Function Access Profile Tables Function Access Point IS Perform account transfers—Controls A the manager’s ability to perform labor account transfers in schedules. Perform work rule transfers—Controls A the manager’s ability to perform work rule transfers in schedules. Perform job transfers—Controls the D manager’s ability to perform job transfers *A in schedules. Schedule Shift Comments—Controls the A access to edit and view comments on shifts. Mark Schedule Posted—Controls the ability D to mark a schedule posted. D Availability—Controls the ability to allow availability. D Workload Planner—Controls the access to Workload Planner profiles. Select from the following: Baseline Pattern View—Controls access D to Pattern view of baseline staffing plan. Select from the following: D Add—If access is set to “Allowed,” the manager can add the Pattern view of baseline staffing plan. Edit—If access is set to “Allowed,” D the manager can edit the Pattern view of baseline staffing plan. Delete—If access is set to “Allowed,” D the manager can edit the Pattern view of baseline staffing plan. View—If access is set to “Allowed,” D the manager can view the Pattern view of baseline staffing plan. Baseline Calendar View—Controls D access to Calendar view of baseline staffing plan. Select from the following: Edit—If access is set to “Allowed,” D the manager can edit the Calendar view of baseline staffing plan. Enterprise eTIME System Administrator’s Guide PM A OM A PE SPE SM TSHE TSE D D A D D A A D D A D D D D D D A D D *A *A A A D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D D D D D A D D B-25 Appendix B Function Access Profiles Function Access Point View—If access is set to “Allowed,” the manager can view the Calendar view of baseline staffing plan. Adjusted Pattern View—Controls access to Pattern view of adjusted staffing plan. Select from the following: Add—If access is set to “Allowed,” the manager can add the Pattern view of adjusted staffing plan. Edit—If access is set to “Allowed,” the manager can edit the Pattern view of adjusted staffing plan. Delete—If access is set to “Allowed,” the manager can edit the Pattern view of adjusted staffing plan. View—If access is set to “Allowed,” the manager can view the pattern view of adjusted staffing plan. Adjusted Calendar View—Controls access to Calendar view of adjusted staffing plan. Select from the following: Edit—If access is set to “Allowed,” the manager can edit the Calendar view of adjusted staffing plan. View—If access is set to “Allowed,” the manager can view the Calendar view of adjusted staffing plan. Group Edit Results—Controls the manager’s access to Group Edit Results. Timecard Editor for Managers—Controls the manager’s access to the Timecard Editor to edit employee timecards. Select from the following: B-26 IS D PM D OM D PE SPE SM TSHE TSE D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D A A A D D A D D V V V D D B D D ADP, Inc. Function Access Profile Tables Function Access Point IS PM OM Timecard access—Controls the manager’s ALL ALL ALL ability to access his or her own timecard using either his or her Enterprise eTIME Professional or Enterprise eTIME Manager access settings. Select from the following: - All—The manager uses his or her Enterprise eTIME Manager settings when editing employee timecards. - All but Self—The manager uses his or her Enterprise eTIME Manager settings when editing employee timecards, and uses his or her Enterprise eTIME Professional access settings when editing his or her own timecard. - None—The person in question cannot access timecards. Edit—If access is set to “Allowed,” the manager can edit his or her own timecard. Allow negatives in Timecard Editor— Controls the manager’s ability to use negative amounts in the Timecard Editor. Approval in Timecard Editor—Controls the manager’s access to approval in the Timecard Editor. Select from the following: Add—If access is set to “Allowed,” the manager can approve timecards. Remove—If access is set to “Allowed,” the manager can remove his or her approval of timecards. Edit data approved by self—If access is set to “Allowed,” the manager can edit timecard information that he or she has already approved for groups of timecards. Edit data approved by others—If access is set to “Allowed,” the manager can edit timecard information that has already been approved by other managers for groups of timecards. Enterprise eTIME System Administrator’s Guide PE SPE SM TSHE TSE N N ALL N N A A A D D A D D A A A D D A D D V V V D D V D D A A A D D A D D A A A D D A D D A A A D D D D D A A A D D D D D B-27 Appendix B Function Access Profiles Function Access Point Approve Overtime—If access is set to “Allowed,” the manager can approve overtime in timecards. Cancel meal deductions in Timecard Editor—Controls the manager’s ability to cancel meal deductions in the Timecard Editor. Comments in Timecard Editor—Controls the manager’s ability to use comments in the Timecard Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add comments in the Timecard Editor. Delete—If access is set to “Allowed,” the manager can delete comments in the Timecard Editor. Display day before and day after in Timecard Editor—Controls whether the manager can access an extra day at the beginning and end of the selected time period in the Timecard Editor. This feature is used for a small subset of employees whose shift runs over the pay period boundary. In these cases, managers may need access to the inpunch of the shift that falls within the last day of a signed off previous pay period, or they may need access to the out-punch of a shift that falls into the first day of the next pay period. Duration amounts in the Timecard Editor—Controls the manager’s ability to use duration amounts or “Worked Hours” in the Timecard Editor. Durations and shift override in Timecard Editor—Controls the manager’s ability to use duration amounts with the new shift override (“Worked Hours with Shift Override”) in the Timecard Editor. B-28 IS D PM D OM D PE SPE SM TSHE TSE D D A D D A A A D D A D D A A A D D D D D A A A D D D D D A A A D D D D D D D D D D A D D A A A D D A D D A A A D D A D D ADP, Inc. Function Access Profile Tables Function Access Point Historical Edits in Timecard Editor— Controls the manager’s ability to change signed-off timecards (historical edits) in the Timecard Editor. Select from the following: Manual Edits—If access is set to “Allowed,” the manager can make manual historical edits in the Timecard Editor. Automated Edits—If access is set to “Allowed,” the manager can make automated historical edits in the Timecard Editor. Pay codes in Timecard Editor—Controls the manager’s access to pay codes in the Timecard Editor. Select from the following: Edit—If access is set to “Allowed,” the manager can make pay code edits in the Timecard Editor. View—If access is set to “Allowed,” the manager can view pay code amounts in the Timecard Editor. Punch edits in Timecard Editor—Controls the manager’s ability to edit punches in the Timecard Editor. Sign-off in Timecard Editor—Controls the manager’s ability to sign off employee timecards in the Timecard Editor. Select from the following: Add—If access is set to “Allowed,” the manager can sign off a timecard. Remove—If access is set to “Allowed,” the manager can remove his or her signoff from a timecard. Calculate totals in Timecard Editor— Controls whether the manager has access to the Callable Totalizer. IS A PM A OM A PE SPE SM TSHE TSE D D V D D A A A D D A D D A A A D D D D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D D D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D If access is set to “Allowed,” the manager can view up-to-date totals in employee timecard by selecting Actions > Calculate Totals. Enterprise eTIME System Administrator’s Guide B-29 Appendix B Function Access Profiles Function Access Point IS E-mail access in Timecard Editor— A Controls whether the manager has access to email from the Timecard Editor. A Totals breakdown in Timecard Editor— Controls the manager’s access to totals breakdown information in the Timecard Editor. D Calculate totals on-the-fly in Timecard Editor—Controls the automatic use of the *A Callable Totalizer in the employee timecards. If access is set to “Allowed,” the manager can view up-to-date totals immediately after editing an employee timecard and moving to the next row of a timecard. D View Totals by Job in Timecard Editor— Controls the manager’s ability to view the Job column in the totals breakdown area in the Timecard Editor. Transfers in Timecard Editor—Controls V the manager’s access to transfers in employee timecards. Select from the following: View transfers—Controls the manager’s A ability to view labor account, work rule, and job transfers in the Timecard Editor. Perform account transfers—Controls A the manager’s ability to transfer labor accounts in the Timecard Editors. Perform work rule transfers—Controls A the manager’s ability to transfer work rules in employee timecards. Perform job transfers—Controls the D manager’s ability to transfer jobs in the *A Timecard Editors. A View Schedules in Timecard Editor— Controls the manager’s ability to view the employee’s schedule at the bottom of the employee’s timecard. B-30 PM A OM A PE SPE SM TSHE TSE D D A D D A A D D A D D D D D D A D D *A *A D D D D A D D V V D D A D D A A D D A D D A A D D A D D A A D D A D D D D A D D D D A D D D D *A *A A A ADP, Inc. Function Access Profile Tables Function Access Point Print Time Detail Report in Timecard Editor—Controls the manager’s ability to print an employee’s Time Detail Report. Edit non-active days in Timecard Editor— Controls the manager’s ability to edit days in which the employee is inactive or terminated. Accruals in Timecard Editor—Controls the manager’s access to accruals in employee timecards. Select from the following: Move Accruals in Timecard Editor— Controls the manager’s ability to move accrual amounts from within employee timecards. Reset Accruals in Timecard Editor— Controls the manager’s ability to reset accrual balances from employee timecards. View Accruals and Totals in Timecard Editor—Controls the manager’s ability to view accruals and totals at the same time in employee timecards. IS A PM A OM A PE SPE SM TSHE TSE D D A D D A A A D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D If access is set to “Allowed,” a small Accruals window containing a subset of accrual codes automatically appears to the right of the Totals window when the timecard is opened. Enterprise eTIME System Administrator’s Guide B-31 Appendix B Function Access Profiles Function Access Point Edits using scheduled amounts in the Timecard Editor—Controls the manager’s ability to request that the edit amounts be calculated from a schedule. If access is set to “Allowed,” the manager can select “full sched day” or “half sched day” instead of entering a specific number of hours in employee timecards. The system automatically calculates hours based on the start and end time of any shift, and also takes into consideration any automatic meal deducts and any scheduled work rule transfers. Activities in the Timecard Editor—Controls the manager’s access to the Activity Event Editor. Select from the following: Allow negatives in Activities—Controls the manager’s ability to use negative amounts in activities. Event edits in Activities—Controls the manager’s ability to edit events in activities. Result edits in Activities—Controls the manager’s ability to edit results in activities. Approval in Activities—Controls the manager’s ability to approve activities. Select from the following: Add—If access is set to “Allowed,” the manager can approve activities. Remove—If access is set to “Allowed,” the manager can remove approved activities. Comments in Activities—Controls the manager’s ability to use comments in activities. Select from the following: Add—If access is set to “Allowed,” the manager can use comments in activities. B-32 IS D PM D OM D PE SPE SM TSHE TSE D D A D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point IS Delete—If access is set to “Allowed,” the D manager can delete comments in activities. Pay Code Breakdown in Activities— D Controls the manager’s access to pay code breakdown information in activities. Totals breakdown in Activities in Timecard D Editor—Controls the manager’s access to activities totals breakdown information in the Timecard Editor. Print Activity Detail Report in Timecard D Editor—Controls the manager’s ability to print the Activity Detail Report. Reports—Controls access to reporting ALL functionality. Select from the following: Run reports—Controls the ability to run A reports. Report scheduling—Controls the ability to A schedule a report. Report setup—Controls the ability to A configure reports. A High priority reporting—Controls the priority of reports from this person. Reports generated by users with high priority are placed ahead of other reports on the report generation queue. Enterprise eTIME System Administrator’s Guide PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D V V D V V D V A A D D A D D A A D D D D D A D D D D D D A D D D D D D B-33 Appendix B Function Access Profiles Function Access Point Report status—Controls the ability to view the status of any report, including those of other users. Select from the following: - All—User can view, access, and delete reports generated by any user. (Generally limited to selected system administrators with a high security level.) Note that a user with “All” access can delete or thereby cancel any runaway report generation in progress. - Only Self—User can view, access, and delete only reports generated by himself or herself. E- mail Notifications to Managers—Controls whether a manager receives e-mail notification in any of the following circumstances. Select from the following: E-mail when a group edit is completed— Controls whether the manager receives an email message when a group edit process completes. E-mail when a group edit was not completed—Controls whether the manager receives an e-mail message when a group edit process does not complete. E-mail when event status has changed— Controls whether managers receive an e-mail message with the status of their events. B-34 IS A PM O OM O PE SPE SM TSHE TSE O O O O O A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D ADP, Inc. Function Access Profile Tables Enterprise eTIME Manager - Common Setup Category These access control points control access to product configuration functions. Function Access Point IS HyperFind—Controls access to HyperFind V maintenance functionality. Select from the following: Query Conditions—Controls access to V condition categories used in HyperFind query creation. Select from the following: D Display Organizational Map & Job Information in HyperFind—Controls *A the ability to display organization map and job information in HyperFind. A General Information category— Controls access to query conditions in the General category in HyperFind, such as employee name and home account information. Timekeeper category—Controls access A to query conditions in the Timekeeper category in HyperFind. A Time Management category—Controls access to query conditions in the Time Management category in HyperFind, such as pay rules, worked pay codes, and exceptions. D Biometric category—Controls access to query conditions in the Biometric category in HyperFind. Scheduler category—Controls access to A query conditions in the Scheduler category in HyperFind. D Enterprise Scheduler category— Controls access to query conditions in the Enterprise Scheduler category in HyperFind. Enterprise eTIME System Administrator’s Guide PM V OM V PE SPE SM TSHE TSE D D V D N V V D D A D D D D D D A D D *A *A A A D D A D D A A D D A D D A A D D A D D D D D D A D D A A D D A D D D D D D A D D B-35 Appendix B Function Access Profiles Function Access Point Activities category—Controls access to query conditions in the Activities category in HyperFind. Leave Management category—Controls access to query conditions in the Leave Management category in HyperFind, such as accruals. User Information category—Controls access to query conditions in the User Information category in HyperFind, such as user name and access profiles. Role - Timekeeper category—Controls access to query conditions in the Role Timekeeper category in HyperFind, such as accruals. Query Tabs—Controls access to the HyperFind query tabs (Assemble Query, View SQL). Select from the following: Assemble Query tab—Controls access to the Assemble Query in HyperFind. View SQL tab—Controls access to the View SQL tab in HyperFind. Query Visibility—Controls access to the types of queries that can be saved in HyperFind. Select from the following: Ad hoc queries—Controls access to saving an ad hoc query. Personal queries—Controls access to personal queries. Select from the following: Edit—If access is set to “Allowed,” the employee can edit personal queries. Delete—If access is set to “Allowed,” the employee can delete personal queries. Public queries—Controls access to public queries. Select from the following: B-36 IS D PM D OM D PE SPE SM TSHE TSE D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A D D D D D D D A D D D D D D D A D D D D D D D A A V D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A A D D A D D A A D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point IS PM OM Edit—If access is set to “Allowed,” A A D the employee can edit public queries. Delete—If access is set to “Allowed,” A A D the employee can delete public queries. Query Manager—Controls access to Query A A A Manager. Enables the ability to copy personal queries from one user to another. A A A Hide the Save and Run button—Controls the use of the Save and Run button in HyperFind. Reserved for future use. People Editor—Controls access to the People V V V Editor. Select from the following: Person—Controls the ability to add or edit a A A A person in the People Editor. Select from the following: Add—Controls the ability to add a person A A A in the People Editor. Edit—Controls the ability to edit a person ALL ALL ALL in the People Editor. Select from the following: - All - All but Self - None Delete—Controls the ability to delete Person information. Select from the following: Delete without transactions—Controls the ability to delete a person who has no transaction data. PE SPE SM TSHE TSE D D A D D D D A D D D D A D D D D A D D D N V D N D D V D D D D D D D D D N D D N N N D N N D N N N N D N N D N Select from the following: - All - All but Self - None Enterprise eTIME System Administrator’s Guide B-37 Appendix B Function Access Profiles Function Access Point Delete with transactions—Controls the ability to delete a person who has transaction data. IS N Select from the following: - All - All but Self - None D Display Organizational Map & Job Fields in the People Editor—Controls *A the ability to view the organizational map and job fields in the People Editor. Person Tab—Controls access to the V Views in the Person tab. Select from the following: A General Information view—Controls access to the General view in the People Editor. Select from the following: A Birth date—Controls access to employee birth date information in the People Editor. Select from the following: A Add—If access is set to “Allowed,” the manager can add birth date information in the People Editor. A View—If access is set to “Allowed,” the manager can view birth date information in the People Editor. Person name—Controls access to the A person’s name in the People Editor. Select from the following: A Add—If access is set to “Allowed,” the manager can add person’s name information in the People Editor. B-38 PM N OM N PE SPE SM TSHE TSE D N N D N D D A D D D D *A *A A A D D V D D A A D D V D D A A D D D D D A A D D D D D A A D D D D D A A D D D D D A A D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Person ID—Controls access to person ID information in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add person ID information in the People Editor. Hire date—Controls access to the hire date in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add a hire date in the People Editor. View—If access is set to “Allowed,” the manager can view a hire date in the People Editor. Employment status—Controls access to the employment status in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add employment status information in the People Editor. Skills & Certification view—Controls access to the skill information of a person. Select from the following: Skills on a person—Controls the ability to access skills on a person. Select from the following: Add—If access is set to “Allowed,” the manager can add skills to a person in the People Editor. Edit—If access is set to “Allowed,” the manager can edit skills to a person in the People Editor. Enterprise eTIME System Administrator’s Guide IS A PM A OM A PE SPE SM TSHE TSE D D D D D A A A D D D D D A A A D D V D D A A A D D D D D A A A D D A D D A A A D D A D D A A A D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D B-39 Appendix B Function Access Profiles Function Access Point Delete—If access is set to “Allowed,” the manager can delete skills from a person in the People Editor. Certifications on a person—Controls the ability to access certifications on a person. Select from the following: Add—If access is set to “Allowed,” the manager can add certifications to a person in the People Editor. Edit—If access is set to “Allowed,” the manager can edit certifications to a person in the People Editor. Delete—If access is set to “Allowed,” the manager can delete certifications from a person in the People Editor. Leave Management view—Controls access to the Leave Management view in the People Editor. Select from the following: Accrual profile—Controls access to the accrual profile in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add information to the accrual profile. View—If access is set to “Allowed,” the manager can view the accrual profile. Full-Time equivalency—Controls access to the full-time equivalency in the People Editor. Select from the following: B-40 IS D PM D OM D PE SPE SM TSHE TSE D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Add—If access is set to “Allowed,” the manager can add information to the full-time equivalency. View—If access is set to “Allowed,” the manager can view full-time equivalency information. User Information view—Controls access to the User Account view in the People Editor. Select from the following: Access user account—Controls access to user account information in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add account information in the People Editor. View—If access is set to “Allowed,” the manager can view account information in the People Editor. User account status—Controls access to user account status in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add account status in the People Editor. Lock out access control—Controls access to user account lock feature in the People Editor. Archive access control—Controls access to grant access to archive databases. Contacts view—Controls access to the Contacts view in the People Editor. Select from the following: Enterprise eTIME System Administrator’s Guide IS A PM A OM A PE SPE SM TSHE TSE D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D D D D D D D D D A A A D D D D D B-41 Appendix B Function Access Profiles Function Access Point Address—Controls access to employee address information in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add address information in the People Editor. View—If access is set to “Allowed,” the manager can view address information in the People Editor. E-mail—Controls access to employee e-mail information in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add email information in the People Editor. View—If access is set to “Allowed,” the manager can view e-mail information in the People Editor. Telephone—Controls access to employee telephone information in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add telephone information in the People Editor. View—If access is set to “Allowed,” the manager can view telephone information in the People Editor. Additional Information view— Controls access to the Additional Information view in the People Editor. Select from the following: B-42 IS A PM A OM A PE SPE SM TSHE TSE D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D ADP, Inc. Function Access Profile Tables Function Access Point IS A Add—If access is set to “Allowed,” the manager can add additional information in the People Editor. A View—If access is set to “Allowed,” the manager can view additional information in the People Editor. A Person’s Dates view—Controls access to the panel named “Person’s Dates” in the People Editor. Select from the following: Add—If access is set to A “Allowed,” the manager can add dates. View—If access is set to A “Allowed,” the manager can view dates. Job Assignment Tab—Controls access to the V Views in the Job Assignment Tab in the People Editor. Select from the following: Primary Account View—Controls A access to the Primary Account view in the People Editor. Select from the following: A Primary Labor Account—Controls the ability to access the Primary Labor Account. Select from the following: A Add—If access is set to “Allowed,” the manager can add Primary Labor Account information in the People Editor. A View—If access is set to “Allowed,” the manager can view Primary Labor Account information in the People Editor. D Primary Organizational Job— Controls the ability to access the *A Primary Organizational Job. Select from the following: Enterprise eTIME System Administrator’s Guide PM A OM A PE SPE SM TSHE TSE D D D D D A A D D D D D A A D D D D D A A D D D D D A A D D D D D V V D D V D D A A D D D D D A A D D D D D A A D D D D D A A D D D D D D D D D D D D *A *A B-43 Appendix B Function Access Profiles Function Access Point Add—If access is set to “Allowed,” the manager can add Primary Organizational Job information in the People Editor. View—If access is set to “Allowed,” the manager can view Primary Organizational Job information in the People Editor. Time Zone—Controls the ability to access the Time Zone. Select from the following: Add—If access is set to “Allowed,” the manager can add Time Zone information in the People Editor. View—If access is set to “Allowed,” the manager can view Time Zone information in the People Editor. Seniority Date—Controls the ability to access the Seniority Date. Select from the following: Add—If access is set to “Allowed,” the manager can add Seniority Date information in the People Editor. View—If access is set to “Allowed,” the manager can view Seniority Date information in the People Editor. Timekeeper view—Controls access to the Timekeeper view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add information to the Timekeeper view in the People Editor. B-44 IS D PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D ADP, Inc. Function Access Profile Tables Function Access Point View—If access is set to “Allowed,” the manager can view the Timekeeper view in the People Editor. Personal Overtime view—Controls the manager’s access to the Personal Overtime view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add Personal Overtime in the People Editor. Edit—If access is set to “Allowed,” the manager can edit Personal Overtime in the People Editor. View—If access is set to “Allowed,” the manager can view Personal Overtime in the People Editor. Delete—If access is set to “Allowed,” the manager can delete Personal Overtime in the People Editor. Scheduler view—Controls access to the Scheduler view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add information to the Scheduler view in the People Editor. View—If access is set to “Allowed,” the manager can view the Scheduler view in the People Editor. Activity view—Controls the manager’s access to the Activity view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add Activity information in the People Editor. Edit—If access is set to “Allowed,” the manager can edit Activity information in the People Editor. Enterprise eTIME System Administrator’s Guide IS A PM A OM A PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D A A A D D A D D A A A D D A D D A A A D D A D D D D D D D D D D D D D D D D D D D D D D D D D D B-45 Appendix B Function Access Profiles Function Access Point View—If access is set to “Allowed,” the manager can view Activity information in the People Editor. Delete—If access is set to “Allowed,” the manager can delete Activity information in the People Editor. Access Profiles view—Controls access to the Access Profiles view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add information to the Access Profiles view in the People Editor. View—If access is set to “Allowed,” the manager can view the Access Profiles view in the People Editor. Manager Role - General view—Controls access to the Manager Role - General view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add information to the Manager Role - General view in the People Editor. View—If access is set to “Allowed,” the manager can view the Manager Role - General view in the People Editor. Manager Role - Scheduler view— Controls access to the Manager Role Schedule view in the People Editor. Select from the following: Add—If access is set to “Allowed,” the manager can add information to the Manager Role - Schedule view in the People Editor. B-46 IS D PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D D D D A A A D D A D D A A A D D A D D ADP, Inc. Function Access Profile Tables Function Access Point IS A View—If access is set to “Allowed,” the manager can view the Manager Role - Schedule view in the People Editor. Employee Role view—Controls access to A the Manager Role - Schedule view in the People Editor. Select from the following: A Add—If access is set to “Allowed,” the manager can add information to the Manager Role - Schedule view in the People Editor. A View—If access is set to “Allowed,” the manager can view the Manager Role - Schedule view in the People Editor. Organizational Set Editor—Controls access to D the Employee Role view in the People Editor. *A Select from the following: D Add—If access is set to “Allowed,” the manager can add organization sets to the Employee Role view in the People Editor. D Edit—If access is set to “Allowed,” the manager can edit organization sets to the Employee Role view in the People Editor. D Delete—If access is set to “Allowed,” the manager can delete organization sets to the Employee Role view in the People Editor. View—If access is set to “Allowed,” he D manager can view organization sets to the Employee Role view in the People Editor. Labor Level Set Editor—Controls access to the A Labor Level Set Editor. Select from the following: Add—If access is set to “Allowed,” the A manager can add information to the Labor Level Set Editor. Edit—If access is set to “Allowed,” the A manager can edit information in the Labor Level Set Editor. Enterprise eTIME System Administrator’s Guide PM A OM A PE SPE SM TSHE TSE D D A D D A A D D A D D A A D D A D D A A D D A D D D D D D D D D *A *A D D D D D D D D D D D D D D D D D D D D D D D D D D D D A A D D D D D A A D D D D D A A D D D D D B-47 Appendix B Function Access Profiles Function Access Point IS Delete—Controls ability to delete A information from the Labor Level Set Editor. View—Controls ability to view information A in the Labor Level Set Editor. Jobs and Organizational Map Setup—Controls D access to jobs and organizational map setup. *A Select from the following: Location Types Tab—Controls access to the D Location Types tab in the jobs and *A organizational map setup. Select from the following: D Job & Organizational map Setup Tabs— Controls access to remaining tabs in the Jobs *A and Organization Map Setup. Select from the following: Worker Type—Controls the ability to access A worker types in configuration. Select from the following: A Add—If access is set to “Allowed,” the manager can add worker types in the configuration. A Edit—If access is set to “Allowed,” the manager can edit worker types in the configuration. A Delete—If access is set to “Allowed,” the manager can delete worker types in the configuration. View—If access is set to “Allowed,” the A manager can view worker types in the configuration. Event Manager—Controls access to Event A Manager functionality. Select from the following: A Add batch event—Controls whether or not the Batch Command field that is needed to add a Batch Event is visible in the Event Manager. B-48 PM A OM A PE SPE SM TSHE TSE D D D D D A A D D D D D D D D D D D D D D D D D D D D D D D D D D A A D D D D D A A D D D D D A A D D D D D A A D D D D D A A D D D D D A V D D D D D A D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Change user—Controls whether or not the User Name field that is needed to change the user associated with an event is visible in the Event Manager. IS A PM A OM D User Name access is necessary in two situations: 1) System manager level users who schedule reports for a department manager, and only want that department manager’s employees (Employee Group) to appear on the report, should schedule that report with the department manager’s User Name. 2) System manager level users who schedule a people import can use the “Import” User Name in order to override their own Employee Group selection of records during import, and thereby improve People Import performance. Individual events—Controls whether a user ALL ALL ALL can see all events, their own, or none in the Event Manager. Select from the following: - All - Only Self - None Table Import—Controls access to table import functionality. Select from the following: Create and run table import batches— Controls the ability to create and run table import batches. Delete table import data—Controls the ability to delete import data from tables in a batch. Schedule table import batches—Controls the ability to schedule table import batches. Stop/restart table import batches— Controls the ability to stop and restart table import batches. Enterprise eTIME System Administrator’s Guide PE SPE SM TSHE TSE D D D D D D N N D N A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D B-49 Appendix B Function Access Profiles Function Access Point Transaction Assistant—Controls the ability to access failed XML transactions in the Transaction Assistant. Select from the following: Edit—If access is set to “Allowed,” the manager can edit failed XML transactions in the Transaction Assistant. Delete—If access is set to “Allowed,” the manager can delete failed XML transactions in the Transaction Assistant. View—If access is set to “Allowed,” the manager can view failed XML transactions in the Transaction Assistant. Enterprise Archiver—Controls the ability to access Enterprise Archiver. Select from the following: Enterprise Archiver access—Controls the ability to access administrative Enterprise Archiver features. Purge Override—Controls the ability to use the Purge Override function. Cancel—Controls the ability to cancel a Enterprise Archiver process. Archive Locator—Controls the ability to use the Archive Locator. Locater Editor—Controls the ability to use the Locater Editor. Enterprise Archiver Copy Rules—Controls the ability to use the copy Rules function of Enterprise Archiver. Workforce MobileTime—Controls access to MobileTime functionality. Select from the following: Access to MobileTime Gatekeeper— Controls access to the MobileTime Gatekeeper. Access to MobileTime Configuration— Controls the ability to set up MobileTime. B-50 IS A PM A OM D PE SPE SM TSHE TSE D D D D D A A D D D D D D A A D D D D D D A A D D D D D D V V D D D D D D A V D D D D D D D D D D D D D D A D D D D D D D A A D D D D D D A D D D D D D D A D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Biometrics—Controls the ability to manage Biometric information. Select from the following: Access to Biometrics Administration— Controls access to manage people’s Biometric Administration. Schedule Configuration—Controls access to Schedule Configuration. Select from the following: Availability Template Configuration— Controls access to the availability template configuration. Select from the following: Availability Templates—Controls access to the availability templates. Select from the following: Add—If access is set to “Allowed,” the manager can add availability templates. Edit—If access is set to “Allowed,” the manager can edit availability templates. Delete—If access is set to “Allowed,” the manager can delete availability templates. View—If access is set to “Allowed,” the manager can view availability templates. Association of Availability Templates with Organization Locations—Controls the ability to access associations of availability templates with organization locations. Select from the following: Add—If access is set to “Allowed,” the manager can add associations of availability templates with organization locations. Enterprise eTIME System Administrator’s Guide IS D PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D B-51 Appendix B Function Access Profiles Function Access Point Delete—If access is set to “Allowed,” the manager can delete associations of availability templates with organization locations. View—If access is set to “Allowed,” the manager can view associations of availability templates with organization locations. Schedule Rules—Controls the ability to access schedule rules. Select from the following: Add—If access is set to “Allowed,” the manager can add schedule rules. Edit—If access is set to “Allowed,” the manager can edit schedule rules. Delete—If access is set to “Allowed,” the manager can delete schedule rules. View—If access is set to “Allowed,” the manager can view schedule rules. Schedule Assistant Criteria Sets—Controls the ability to access schedule assistant criteria. Select from the following: Add—If access is set to “Allowed,” the manager can add schedule assistant criteria. Edit—If access is set to “Allowed,” the manager can edit schedule assistant criteria. Delete—If access is set to “Allowed,” the manager can delete schedule assistant criteria. View—If access is set to “Allowed,” the manager can view schedule assistant criteria. Skills & Certifications—Controls access to the Skills & Certification editors. Select from the following: B-52 IS D PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D D D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Certifications—Controls the ability to access certifications. Select from the following: Add—If access is set to “Allowed,” the manager can add certifications. Edit—If access is set to “Allowed,” the manager can edit certifications. Delete—If access is set to “Allowed,” the manager can delete certifications. View—If access is set to “Allowed,” the manager can view certifications. Skills—Controls the ability to access skills. Select from the following: Add—If access is set to “Allowed,” the manager can add skills. Edit—If access is set to “Allowed,” the manager can edit skills. Delete—If access is set to “Allowed,” the manager can delete skills. View—If access is set to “Allowed,” the manager can view skills. Workload Setup—Controls access to various sections of Workload Setup. Select from the following: Schedule Zone Sets—Controls the ability to access schedule zone sets. Select from the following: Add—If access is set to “Allowed,” the manager can add schedule zone sets. Edit—If access is set to “Allowed,” the manager can edit schedule zone sets. Delete—If access is set to “Allowed,” the manager can delete schedule zone sets. View—If access is set to “Allowed,” the manager can view schedule zone sets. Enterprise eTIME System Administrator’s Guide IS D PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D V D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D B-53 Appendix B Function Access Profiles Function Access Point Workload Shift Sets—Controls the ability to access staffing shift sets. Select from the following: Add—If access is set to “Allowed,” the manager can add staffing shift sets. Edit—If access is set to “Allowed,” the manager can edit staffing shift sets. Delete—If access is set to “Allowed,” the manager can delete staffing shift sets. View—If access is set to “Allowed,” the manager can view staffing shift sets. Workload Planner Profiles—Controls the ability to access staff planner profiles. Select from the following: Add—If access is set to “Allowed,” the manager can add staff planner profiles. Edit—If access is set to “Allowed,” the manager can edit staff planner profiles. Delete—If access is set to “Allowed,” the manager can delete staff planner profiles. View—If access is set to “Allowed,” the manager can view staff planner profiles. Pattern Templates Configuration— Controls the manager’s access to the pattern templates configuration. Select from the following: Add—If access is set to “Allowed,” the manager can add pattern templates in the pattern templates configuration. Edit—If access is set to “Allowed,” the manager can edit pattern templates in the pattern templates configuration. B-54 IS D PM D OM D PE SPE SM TSHE TSE D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D A D D D D A D D A D D D D A D D A D D D D A D D ADP, Inc. Function Access Profile Tables Function Access Point Delete—If access is set to “Allowed,” the manager can delete pattern templates in the pattern templates configuration. Schedule Period Configuration—Controls the manager’s access to the schedule periods configuration. Select from the following: Add—If access is set to “Allowed,” the manager can add schedule periods to the schedule periods configuration. Delete—If access is set to “Allowed,” the manager can delete schedule periods to the schedule periods configuration. Shift Template Configuration—Controls the manager’s access to the shift templates configuration. Select from the following: Add—If access is set to “Allowed,” the manager can add shift templates in the shift templates configuration. Edit—If access is set to “Allowed,” the manager can edit shift templates in the shift templates configuration. Delete—If access is set to “Allowed,” the manager can delete shift templates in the shift templates configuration. Enterprise Activities—Controls access to the Activities setup functionality. Select from the following: Activity Setup view—Controls access to activity setup for activities. Access Profiles Setup view—Controls access to access profiles setup for activities. Results Setup view—Controls access to results setup for activities. Teams Setup view—Controls access to teams setup for activities. Transactions Setup view—Controls access to transaction setup for activities. Work Objects Setup view—Controls access to work objects setup for activities. Enterprise eTIME System Administrator’s Guide IS A PM D OM D PE SPE SM TSHE TSE D D A D D A D D D D A D D A D D D D A D D A D D D D A D D A D D D D A D D A D D D D A D D A D D D D A D D A D D D D A D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D B-55 Appendix B Function Access Profiles Function Access Point Configuration Setup view—Controls access to configuration, System Settings, for Enterprise Activitiess. B-56 IS D PM D OM D PE SPE SM TSHE TSE D D D D D ADP, Inc. Function Access Profile Tables Enterprise eTIME Manager - System Configuration Category These access control points control access to system administration functions. Function Access Point Set up workflow notifications—Controls the ability to set up workflow notifications for people. System Information—Controls access to System Information. Log Report—Controls access to the Log Report. System Settings—Controls access to System Settings. DCM (Windows client)—Controls access to the Data Collection Manager. Setup (Windows client)—Controls access to the Enterprise eTIME Setup. Select from the following: Access Profiles setup—Controls access to the Access Profiles component. Select from the following: Data Access Profiles—Controls access to the Data Access Profile configuration. Function Access Profiles—Controls access to the Function Access Profiles component. Logon Profiles—Controls access to Logon Profiles configuration. Accruals setup—Controls access to the Accruals component. Comments setup—Controls access to the Comment component. Display Preference setup—Controls access to the Display Preferences component. Select from the following: Display Profiles—Controls access to Display Profiles configuration. Site-defined labels—Controls access to site-defined labels configuration. Enterprise eTIME System Administrator’s Guide IS A PM OM PE SPE SM TSHE TSE D D D D D D D A D D D D D D D A A D D D D D D D D D D D D D D A D D D D D D D A D D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D A A D D D D D D B-57 Appendix B Function Access Profiles Function Access Point Labor Level Maintenance setup—Controls access to the Labor Level Maintenance component. Pay Rules setup—Controls access to the Pay Rules component. Wage Profiles setup—Controls access to the Wage Profiles application. Runs tasks in background—Controls the ability to run tasks in the background for the system. Used to control whether a user has the ability to use the TaskRunner utility to run an event for another user. Background processor access—Determines if a user has the ability to run the Background Processor. B-58 IS A PM OM A D PE SPE SM TSHE TSE D D D D D A A D D D D D D A A D D D D D D A D D D D D D D A A A D D D D D ADP, Inc. Function Access Profile Tables APIs Category These access control points control the ability to log onto the XML interface. Function Access Point XML—Controls the ability to start an XML session. API Beans—Controls the ability to use any of the XML API functions. Select from the following: Access Profile beans—Controls the ability to read and set access profile data. Accruals beans—Controls the ability to read and set accrual data. Select from the following: Edit—Controls the ability to read and set accrual data. View—Controls the ability to view accrual data. Event Manager beans—Controls the ability to configure the Event Manager. HyperFind beans—Controls the ability to read and execute HyperFind queries. View—Controls the ability to view HyperFind data. Labor Level beans—Controls the ability to read and set Labor Level Entries and Labor Accounts. Select from the following: Edit—Controls the ability to edit Labor Level Entries and Labor Accounts. View—Controls the ability to view Labor Level Entries and Labor Accounts. Person beans—Controls the ability to read and set People information. Select from the following: Edit—Controls the ability to edit People information. Delete—Controls the ability to delete People information. View—Controls the ability to view People information. Enterprise eTIME System Administrator’s Guide IS A PM OM PE SPE SM TSHE TSE D D D D D D D V D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D D D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D B-59 Appendix B Function Access Profiles Function Access Point Report beans—Controls the ability to choose, execute, and display reports. Schedule beans—Controls the ability to read and set scheduling and grouping information. Select from the following: Edit—Controls the ability to edit scheduling and grouping information. View—Controls the ability to view scheduling and grouping information. Timecard beans—Controls the ability to read and set timecards. Select from the following: Edit—Controls the ability to edit employee’s timecards. View—Controls the ability to view employee’s timecards. Workflow beans—Controls the ability to configure the Workflow Manager. Table Import beans—Controls the ability to read and set import. Audit beans—Controls the ability to read and set audit information. View—Controls the ability to view audit information. Common beans—Controls the ability to read common information. View—Controls the ability to view common information. Data Access beans—Controls the ability to read and set audit data access information. Select from the following: Edit—Controls the ability to edit audit data access information. View—Controls the ability to view audit data access information. Menu beans—Controls the ability to read menu information. View—Controls the ability to view menu information. B-60 IS A PM OM PE SPE SM TSHE TSE D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D D D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D ADP, Inc. Function Access Profile Tables Function Access Point Bulk Summary beans—Controls the ability to read summary information. View—Controls the ability to view summary information. Organizational Structure & Job Beans— Controls the ability to read and set organizational structure & job information. Select from the following: Edit—Controls the ability to edit organizational structure & job information. View—Controls the ability to view organizational structure & job information. MobileTime Maintenance beans—Controls the ability to access MobileTime maintenance information. Activity Beans—Controls the ability to read and set Activities. Deduction Rules Beans—Controls the ability to read and set deduction rules information. Fingerscan Bean—Controls the ability to read and set fingerprint information. Transaction Assistant Beans—Controls the ability to load, edit, and delete failed XML transactions through the API Bean. Select from the following: Add—Controls the ability to load failed XML transactions through the API Bean. Edit—Controls the ability to edit failed XML transactions through the API Bean. Delete—Controls the ability to delete failed XML transactions through the API Bean. Enterprise eTIME System Administrator’s Guide IS A PM OM PE SPE SM TSHE TSE D D D D D D D A D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D D A D D D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D A D D D D D D D D B-61 Appendix B B-62 Function Access Profiles ADP, Inc. Appendix C Registry Keys This chapter contains information about the registry keys that were set up when your Enterprise eTIME system was installed. This appendix contains information about: ! Windows Registry Keys ! UNIX Registry Keys Appendix C Registry Keys Windows Registry Keys The following registry keys were established during installation of the Enterprise eTIME system. ! [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC] Common Path=C:\ADP\WFC\kronoscm Help Dir=C:\ADP\wfc\help Install Path=C:\ADP ! [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\config] Web Server URL=ORASMOKE ! [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\Cross Launch\COMMENTS] Executable=comments.exe Function description=Comments Configuration Function identifier=Comments Function name=Comments Home directory=C:\ADP\wfc\cmnapps Icon Preference=LAUNCHER Launcher icon file=comments.ico Product latitude= Product name= Toolbar icon file=none C-2 ADP, Inc. Windows Registry Keys ! [HKEY_LOCAL_MACHINE\SOFTWARE\Kronos\WFC\Cross Launch\WTK] Access profile column=none Executable=nodialog.exe -iconfigApps.icx Function description=Foo Function identifier=TKCS Function name=Timekeeper CS Home directory=C:\ADP\wfc\Config Icon Preference=LAUNCHER Launcher icon file= Product latitude= Product name= Toolbar icon file=none Enterprise eTIME System Administrator’s Guide C-3 Appendix C Registry Keys UNIX Registry Keys Portions of the Windows NT registry settings are supported in Enterprise eTIME for UNIX platforms by a new properties file, Registry.properties. This file resides in the [installation directory]/wfc/properties directory. Note: UNIX commands are case-sensitive. Here is a sample Registry.properties file: LastPayPeriodUpdate = 0 OracleDBOwner = TKCSOWNER SequencePreallocationSize = 100 SqlTrace = false SqlTraceFile = sql.txt WebServerURL = cnortonnt3 ServicePack = 4.1.1 Explanations: LastPayPeriodUpdate: the Background Processor will update this number, but it defaults to 0. OracleDBOwner: this is needed because of our multiple instance database deployment. SequencePreallocationSize: the number of rows in the database’s sequence table that an application will capture at a time. SqlTrace: if true, the database calls will be written to the SQL trace file. If false, the database calls will not be recorded. SqlTraceFile: the name of the sql trace file. WebServerURL: the Web server used for Background Processor authentication. ServicePack: a string used by Enterprise eTIME Setup. C-4 ADP, Inc. Appendix D Regional Settings By default, Enterprise eTIME uses regional settings that are appropriate for most North American English-language environments. If you are in an environment where you want to modify the default regional settings, you need the information in this appendix. This appendix contains the following sections: ! Translation Concepts and Methodology ! Application Servers and Regionalization ! Database Servers ! Character Set Support ! Currency Support ! Using and Modifying Predefined Names ! Using Site-defined Text Strings in a Multilanguage Environment Appendix D Regional Settings Translation Concepts and Methodology The sections that follow describe translation concepts in Enterprise eTIME and how various applications display data and text. How Translation Works When you install Enterprise eTIME, the product installs all the English, French, and Spanish language files (including the language report files) on the application server. Additionally, the installation program prompts you for the preferred language to use. Based on your answers, Enterprise eTIME does the following: ! For browser-based features and software, the server uses the appropriate language files to display the translated user interface text and predefined names. ! Enterprise eTIME sets the appropriate language, country, and currency display information in the WFCSite.Properties file. This file is used to determine the language files as well as the date and currency display settings for the browser graphical use interface (GUI). The user’s operating system must match the locale version of the Enterprise eTIME installation. For Windows-based software such as Enterprise eTIME Setup, Enterprise eTIME installs the selected language files and the English files on the client PC. The client PC uses these files to display the translated user interface text and predefined names. At any time after you install Enterprise eTIME, you can use the Local Values section of System Settings to set regional formatting information for date and currency displays for the application server. Enterprise eTIME records this information in the WFCSite.properties file. Each language uses a different application server to connect to a single common database. D-2 ADP, Inc. Translation Concepts and Methodology When you have multi language environments, you would use one or more URLs for each application server that you have configured for each language. Individual users can then display a GUI with the correct language by entering the appropriate URL for that language’s application server. When you define text strings, Enterprise eTIME reads those strings from the database and displays the strings as you defined them, regardless of the GUI language of the application server. Language settings within the browser do not affect any displays. The display of Windows applications that run on client systems, such as Enterprise eTIME Setup, depends on the regional settings on the client PC. If the application server settings are not configured for the same language and country information as the client PC, a user working in the Windows and browser applications on the same machine might see different formatting options and different languages when using Enterprise eTIME. How Enterprise eTIME Displays Data and Text: Browser Applications The sections that follow describe how Enterprise eTIME displays various data and text elements in browser applications. Text Display and Online Help—The text for the GUI is in the following files: ! WFCStrings.properties ! WFCProduct.properties ! ClientStrings.java ! ClientProductNameStrings.java ! ClientStringsOrgMap.java The text for online Help is in a set of HTML files in the Help directory and its subdirectories. Enterprise eTIME System Administrator’s Guide D-3 Appendix D Regional Settings Date and Time Data and Display—Date and Time data associated with a punch that was entered using the Web originates from the application server. Depending on context, Enterprise eTIME uses either the time zone associated with the user’s People record or the time zone in the WFCSite.properties file. Date and Time data associated with all other actions (for example, audit trail information) originates from the regional settings of the application server’s operating system. For the Time display, Enterprise eTIME uses the employee’s Display Profile to determine whether to display the time in 12-hour or 24-hour format. The default values for Time and Date display are determined by the country selected during the installation. This information, which you can modify at any time, is stored in the WFCSite.properties file. Use the 24-hour format or two-letter time markers if the time markers have the same first letter. For example, in English, you can type 8a to indicate 8 o’clock in the morning, and 8p to indicate 8 o’clock in the evening. In Hungarian, you must enter 8de or 8 to indicate 8 o’clock in the morning, and 8du or 20 to indicate 8 o’clock in the evening. Currency Format—The currency format is based on information in Regional Settings and is stored in the WFCSite.properties file. If no information is entered in the System Settings, the currency setting is based on the country that you selected during installation. You can use only one currency setting per database. The currency setting determines the view and entry format. For example, a Canadian user who has a currency setting of United States views and enters currency in the U.S. format (for example $8.50) and not in the Canadian format (8,50$). For additional information about currency settings, see “Currency Support” later in this chapter. D-4 ADP, Inc. Translation Concepts and Methodology Number and Amount Formats—The number and amount formats, excluding currency, are based on the display that is associated with the country selected during installation. This information is stored in the WFCSite.properties file, and you can change it in System Settings. The amount formats for time (for example, durations) is based on the user’s Display Profile for displaying durations (either HH:MM or HH.hh). How Enterprise eTIME Displays Data and Text: Reports The sections that follow describe how the system displays various data and text elements in preconfigured and custom reports. Text Display—Report file sets (.rpt files) are installed in English, French, and Spanish language versions on the application server. The language that Enterprise eTIME displays is determined by the language that you selected during installation. Date and Time Formats—For displaying time in reports, Enterprise eTIME uses the format (12-hour or 24-hour) in the user’s Display Profile. If no information is available in the user’s display profile, the display format is determined by settings for time-of-day display in the application server’s operating system. The display format for dates in reports is determined by the country settings for date display in the application server’s operating system. Currency Format—The format for displaying currency in reports is based on the report file set (.rpt files) that is installed on the application server. The report file set language is determined by the language selected during installation. Number and Amount Formats—The format for displaying numbers and amounts (except for currency) in reports is based on the report file set (.rpt files) that is installed on the application server. The report file set is determined by the language that you selected during installation. Enterprise eTIME System Administrator’s Guide D-5 Appendix D Regional Settings How Enterprise eTIME Displays Data and Text: Windows Applications (Client PCs) The sections that follow describe how Enterprise eTIME displays various data and text elements in Windows applications (such as Enterprise eTIME Setup) that run on client PCs. Text and Online Help—The language of the text in the GUI and the online Help are based on the language selected in the PC’s operating system. Date and Time Formats—For displaying time in Windows applications on client PCs, Enterprise eTIME uses the format (12-hour or 24-hour) in the user’s Display Profile. If no information is available in the user’s display profile, the display format is determined by settings for time-of-day display in the PC’s operating system. The display format for dates in Windows applications on client PCs is determined by the country settings for date display in the PC’s operating system. Currency Format—The format for displaying currency in reports is based on the country settings for currency display in the PC’s operating system. Number and Amount Formats—The format for displaying numbers and amounts (except for currency) in Windows applications on the client PC is based on the number and amount formats for the country specified in the PC’s operating system. The amount formats for time (for example, durations) is based on the user’s Display Profile for displaying durations (either HH:MM or HH.hh). D-6 ADP, Inc. Translation Concepts and Methodology How Data Collection Devices Display Data and Text The sections that follow describe how the following data collection devices display various data and text elements: ! ADP 4500 Timeclock ! ADP Series 400 timeclock ! 540T ! 150/154 Timeclocks Note: The ADP 4500 Timeclock v1.2 supports English, French, or Spanish languages and the Latin 1 character set. Text Display—Data collection devices display text that is already included in the product, such as error messages, only in English. Text that you have entered in the database (for example, employee names or labor level entries) is displayed as you entered it. However, only ASCII fixed characters can display at the timeclock. Date and Time Data and Format for Punches Using a timeclock—The Date and Time associated with a punch entered using a timeclock is based on the time zone set for the timeclock in Data Collection Manager (DCM). The display format for the Date and Time is set for the timeclock in DCM. Currency Format—Data collection devices always display currency on timeclocks in U.S. format (for example, $8.50). Number and Amount Formats—The format for numbers and amounts (excluding currency) is based on the settings for the timeclock in the DCM. Enterprise eTIME System Administrator’s Guide D-7 Appendix D Regional Settings Application Servers and Regionalization In a regionalized environment, different configurations for application servers might be required, depending on the specific conditions. In each of the following cases, the application server settings connect to a single common database: D-8 ! Single Language/Single Country—A company using a single language in a single country, such as Spanish in Mexico, can use one application server. The application server is set to the appropriate regional settings for the language and country, and the correct .rpt files are installed. ! Single Language/Multicountry—A company using a single language in multiple countries, such as English in the United States and Canada, needs at least one application server for each country. Each application server is set up to use English as the language, but one server has country settings for the United States and the other server has country settings for Canada. ! Multilanguage—A company that uses multiple languages needs at least one application server for each language in each country. For example, a company that has English- and French-speaking employees in Canada and Englishspeaking employees in the United States, uses two application servers (one English, one French) that connect to a common database. Users who are connected to the French application server see the user interface in French, while those connected to the English application server see the user interface in English. The site’s data appears the same, regardless of the application server used, because data stored in the database is seen exactly as it was entered. ADP, Inc. Database Servers Database Servers A single database can serve all users. The users see the text exactly as it was entered into the system. For example, assume a company with English- and French-speaking employees uses a French application server and an English application server. If all pay codes are entered in English, they appear in English, even when viewed in the French user interface. While multiple languages within a single character set can use a single database, a database can only use one character set. For example, a company that uses English and French can use the same database for both languages since they are both Latin-1 languages. A company that uses English and Romanian languages would need to have two databases since English is part of the Latin-1 character set and Romanian is part of the Latin-2 character set. Enterprise eTIME System Administrator’s Guide D-9 Appendix D Regional Settings Character Set Support Enterprise eTIME supports the following character sets: Character Set ISO Series Application Database Server Windows Platforms Platforms Code Page Supported Supported Latin 1 (Western European) ISO-8859-1 1252 Oracle, Windows NT, SQL Server, Windows 2000 DB2 UDB Solaris, AIX Latin 2 (Central European) ISO-8859-2 1250 Oracle Windows NT, Windows 2000 Oracle, SQL Server Windows NT, Windows 2000 Latin 9 (Western European ISO-8859-15 1252 with Euro Symbol) If you use a language other than English, Spanish, or French, you may need to modify the code page setting. For more information, see “Locale Settings” in Chapter 4. If you do not use Windows Code Page 1252 for your character set, you must change the character set for e-mail to the appropriate ISO-8859-x in the site.email.language.charset key. For more information about the site.email.language.charset key, see “E-mail Settings” in Chapter 4. D-10 ADP, Inc. Currency Support Currency Support The Enterprise eTIME database supports a single currency. The display format is determined by the currency, country, and language settings specified in System Settings. If no format is specified in System Settings, then the currency setting is based on the country that you selected during installation. The currency setting determines the display format and entry format. For example, a company that has English-speaking U.S. employees and Frenchspeaking Canadian employees will use two application servers (one English, one French) that connect to a common database. Since the database only supports one currency format, the company has decided to enter all monetary units in U.S. dollars. Users who are connected to the French Canadian application server will view and enter currency in the U.S. format. (for example, $8.50) and not in the Canadian format (8,50$). ADP recommends that all applications servers be set to support the same currency format. If application servers are set to support different formats, users on different servers may become confused about the monetary information they view and enter, and the monetary amounts might be misconstrued. For example, a Mexican-American company uses two application servers (one Spanish, one English) that connect to a common database, which stores and displays monetary amounts in U.S. dollars. If the company sets up the English server to support U.S. dollars and the Spanish server to support pesos, monetary amounts entered by users in each of these countries will be stored in the database as U.S. dollars. If a US$500 bonus is entered by a Mexican user as the day’s exchange rate amount of 4,900 pesos, the amount is recorded and displayed as US$4,900 and could be paid incorrectly. Enterprise eTIME System Administrator’s Guide D-11 Appendix D Regional Settings Using and Modifying Predefined Names Enterprise eTIME includes many elements with predefined names, such as the names of individual Function Access Profiles or Reports. If you install the French or Spanish version of Enterprise eTIME, the predefined names are automatically translated into French or Spanish. You can modify the text of many of these predefined names. However, if you do, the French or Spanish version displays only the modified name and not the translated name. Preconfigured names in reports are not translated. For more information, see “How Enterprise eTIME Displays Data and Text: Browser Applications.” If you change the preconfigured names within one of the predefined elements without changing the name of the predefined elements, the translation of the predefined element name remains intact. For example, if you modify the name of one of the fields in the Time Detail Report, the name “Time Detail Report” is still correctly translated in the French or Spanish versions. The following table shows the predefined names and whether you can modify them. Element Predefined Name Modifiable? Data Access Profile All Pay Codes No All Work Rules No All Reports No All Shift Templates No All Pattern Templates No All Availability Templates (Enterprise Scheduler only) No All Schedule Groups No Default Yes Super Access Yes Display Profile D-12 ADP, Inc. Using and Modifying Predefined Names Element Predefined Name Modifiable? Function Access Profiles Default Yes IS Yes IS Using Organization Maps Yes Other Manager Yes Other Manager Using Organization Maps Yes Payroll Manager Yes Payroll Manager Using Organization Maps Yes HyperFind Labor Level Sets Logon Profile Professional Employee Yes Professional Employee Using Organization Maps Yes Salaried Professional Employee Yes Scheduling Manager Yes Time Stamp and Hourly Employee Yes Time Stamp and Hourly Employee Using Organization Maps Yes Time Stamp Employee Yes Super Access No All Home Yes All Home & Scheduled Transfers Yes All Home & Transferred-in Yes All Labor Levels No Empty No Default Yes Super Access Yes Enterprise eTIME System Administrator’s Guide D-13 Appendix D D-14 Regional Settings Element Predefined Name Modifiable? Reports Absent Employees No Accrual Balances and Projections No Accrual Carryover Limits No Accrual Codes No Accrual Date Configurations No Accrual Date Patterns No Accrual Debit Activity Summary No Accrual Detail No Accrual Earned Grants No Accrual Earning Limits No Accrual Fixed Grants No Accrual Pool Balances No Accrual Probation Periods No Accrual Profiles No Accrual Rules No Accrual Summary No Accrual Taking Limits No Activity Code Definitions No Activity Code Profiles No Actual vs. Schedule by Job No Actual vs. Schedule by Labor Account No Badge Numbers No Bonus/Deduction Rules No Break Rules No Combined Pay Codes No Comments No Core Hours Rules No Coverage - Monthly No Coverage - Weekly No ADP, Inc. Using and Modifying Predefined Names Element Predefined Name Modifiable? Device Assignments No Device Groups and Device Assignments No Employee Hours by Job No Employee Hours by Labor Account No Employee Schedule - Monthly No Employee Schedule - Weekly No Employee Sign Off No Employee Transactions and Totals No Employees Currently Earning Time (On Premises) No Exception Rules No Exceptions No Fixed Rules No Function Access Profiles No Holiday Credit Rules No Holiday Credits No Holidays No Hours by Job No Hours by Labor Account No Hours by Labor Account with Graph Summary No Import Errors No Import Statistics No Job Configuration No Labor Levels No Location Schedule - Monthly No Location Schedule - Weekly No Majority Rules No Open Shifts - Monthly No Enterprise eTIME System Administrator’s Guide D-15 Appendix D Regional Settings Element Predefined Name Modifiable? Open Shifts - Weekly No Organizational Job Configuration No Organizational Map Location Types No Organization Map Locations D-16 Organizational Sets No Overtime Equalization Detail No Overtime Rules No Pay Code Data Access Profiles No Pay Codes No Pay Rules No Person Attributes No Person Job Assignment No Primary Account Detail No Punch Origin No Report Data Access Profiles No Rounding Rules No Schedule by Labor Account - Monthly No Schedule by Labor Account - Weekly No Schedule Deviation Rules No Staffing Sheet - Daily No Staffing Sheet - Weekly No Timeclock Rules No Time Detail No Timecard Audit Trail No Timecard Signoff/Approval Audit Trail No Users Currently Locked Out No Work Rule Data Access Profiles No Work Rules No Zone Rules No ADP, Inc. Using and Modifying Predefined Names Element Predefined Name Modifiable? People SuperUser No Enterprise eTIME IS Summary QuickNav Building Blocks: Detail Column Sets Enterprise eTIME QuickNavs Enterprise eTIME QuickNav Profile Yes Pay Period Close Yes QuickFind Yes Reconcile Timecard Yes Shift Close Yes Shift Start Yes Schedule Editor Yes Schedule Assistant (Enterprise Scheduler only) Yes Schedule Planner (Enterprise Scheduler only) Yes IS Summary Yes Pay Period Close Yes Reconcile Timecard Yes Shift Close Yes Shift Start Yes QuickFind Yes Schedule Editor Yes Schedule Assistant Yes Schedule Planner Yes Super Access Yes Enterprise eTIME System Administrator’s Guide D-17 Appendix D 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, if you use a single database and have different languages installed on different application servers), the text strings that you define always appear in the single language that you used when defining the text string. For example, if you defined a pay code named “Sick,” Enterprise eTIME always displays this pay code as sick, regardless of the language of the application server. ADP recommends that clients who use multilanguage environments, use the following procedures: 1. For pay codes, work rules, and reports, create duplicate data in the alternate language. 2. Then, assign data access profiles to each user with the appropriate data in the appropriate language (assign data access profiles that use English terms to English-speaking employees, assign data access profiles that use French terms to French-speaking employees, and so on). Note: If you want to provide predefined names in multiple languages, the client should provide text in the entry in both languages. For example, assume that you have a site with English- and French-language application servers, and assume that you have a labor level that you would call “Work” in English and “Travail” in French. To accommodate both languages, you could define the text for this labor level to be “Work - Travail.” D-18 ADP, Inc. Appendix E Single Sign-On You can set Enterprise eTIME authentication to allow users to automatically log on to Enterprise eTIME without having to re-enter a username or password once they have logged onto their browser. This process is called Single Sign-on. You can set up Single Sign-on by performing the following three procedures: ! Configuring Enterprise eTIME ! Configuring JRun with Netegrity/SiteMinder ! Configuring SiteMinder Appendix E Single Sign-On Configuring Enterprise eTIME To configure Enterprise eTIME to use Single Sign-On, do the following: 1. Log on as SuperUser. 2. Select System Configuration > System Settings > Security. 3. On the Security tab, do the following: a. Set site.security.singlesignon to true b. Set site.security.singlesignon.module to com.kronos.auth.SSOSiteMinderSubject c. Set site.security.singlesignon.module.properties to {Enterprise eTIME.rootdir}/wfc/properties/ SSOSiteMinder.properties 4. In SSOSiteMinder.properties, do the following: a. Set sso.log.file to {Enterprise eTIME.rootdir}\wfc\logs\SSOSiteMinder.log b. Set sso.log.level to DEBUG. c. Set sso.principal.key to what identifies the users credentials. The default is SMUSER. 5. In WFC.properties, set com.kronos.wfc.wfp.security.logoffurl to /wfc/html/kronos-sso-restart.jsp 6. Verify that the ISAPI SiteMinder Agent Filter precedes the ISAPI JRun Filter. You can verify this using the Microsoft Management Console. 7. Configure SiteMinder to work with Enterprise eTIME. E-2 ADP, Inc. Configuring JRun with Netegrity/SiteMinder Configuring JRun with Netegrity/SiteMinder To configure JRun, do the following: 1. Select Start > Run. The Run dialog box appears. 2. Type regedit in the Open text box. The Registry Editor window appears. 3. Select HKEY_LOCAL_MACHINE > SOFTWARE > Netegrity > SiteMinder Web Agent > Microsoft IIS. 4. Right-click on Microsoft IIS and select New > DWORD Value. 5. Type legacyvariables in the new text box. 6. Right-click legacyvariables and select Modify. 7. Enter 0 in the Value data text box. 8. Close the Registry Editor window. Enterprise eTIME System Administrator’s Guide E-3 Appendix E Single Sign-On Configuring SiteMinder To configure SiteMinder, do the following: 1. Create SiteMinder Policy Server schemes for Enterprise eTIME. a. Create an anonymous authentication scheme named WFCAnon. For example, WFCAnon contains “ou=People, dc=Kronos, dc=com” for the User DN. b. Create a basic or form authentication scheme named WFCFormAuthentication 2. Create SiteMinder Policy Server Realms for Enterprise eTIME in your policy domain. a. Create a realm for Enterprise eTIME non-logon URLs named WFCRealm Set the resource Filter to /wfc/ and the authentication scheme to WFCAnon b. Create a realm for Enterprise eTIME logon URLs named WFCLogonRealm The WFCLogonRealm should be a sub-realm of WFCRealm. Set the resource Filter to logonWithUID and the authentication scheme to WFCFormAuthentication E-4 ADP, Inc. Configuring SiteMinder 3. Create SiteMinder Policy Server Rules for Enterprise eTIME. a. Create a rule that will handle all non-logon Enterprise eTIME URLs in the WFCRealm named WFCAllowAllRule Set the effective resource to the wildcard character *, select the Perform regular expression pattern matches check box, set the Actions button to Web Agent actions, and select all types of HTTP methods (Get, Post, and Put). This rule activates for all non-logon Enterprise eTIME URLs accessed by the HTTP methods Get, Post and Put. Since this rule is part of the WFCRealm, it uses anonymous authentication. Therefore, all Enterprise eTIME URLs are passed through Enterprise eTIME without an authentication check by Siteminder. Enterprise eTIME only allows access to protected non-logon URLs by previously authenticated users. b. Create a rule that will handle all logon Enterprise eTIME URLs in the WFCLogonRealm named logonWithUIDRule Set the effective resource to the wildcard character *, select the Perform regular expression pattern matches check box, set the Actions button to Web Agent actions, and select all types of HTTP methods (Get, Post, and Put). This rule activates for all logon Enterprise eTIME URLs accessed by the HTTP methods Get, Post and Put. Since this rule is part of the WFCLogonRealm, it uses basic or form authentication. Therefore, access to all logon URLs are redirected to the form identified in WFCFormAuthentication. All users are prompted for their credentials, username, and password. If SiteMinder authenticates a user accessing this logon URL, it informs Enterprise eTIME that this user has been authenticated. Enterprise eTIME System Administrator’s Guide E-5 Appendix E Single Sign-On 4. Create SiteMinder Policy Server Policies for Enterprise eTIME. a. Create a policy for Enterprise eTIME non-logon URLs called WFCAllowAllPolicy Configure this policy to contain the WFCAllowRule and your LDAP users that you want to access Enterprise eTIME. b. Create a policy for Enterprise eTIME logon URLs called AllowLogonWithUIDPolicy Configure this policy to contain the logonWithUIDRule and your LDAP users that you want to access Enterprise eTIME. E-6 ADP, Inc. Appendix F Custom LDAP Authentication Method Custom Lightweight Directory Access Protocol (LDAP) authentication is implemented in a module installed with Enterprise eTIME and can be used as an alternative to the default Enterprise eTIME LDAP authentication method. This Custom LDAP authentication module can accommodate a wide range of LDAP configurations. This appendix contains the following sections: ! Understanding Custom LDAP Authentication ! Configuring Enterprise eTIME to Use Custom LDAP ! Using the LDAPConfig Utility Appendix F Custom LDAP Authentication Method Understanding Custom LDAP Authentication Use the custom LDAP Authentication method if any of the following are true: ! All users are not contained in the same LDAP organizational unit (ou). ! Any users are not identified by the uid attribute. Users in the LDAP Directory Information Tree (DIT) are identified by their distinguishing name attribute (dn). If the uid attribute is not part of the user's dn, then custom LDAP must be used. For example, the dn for Enterprise eTIME UserAccount named Joe Smith is cn=Joe Smith, ou=People, o=airius.co. The dn uses the cn attribute, not the uid attribute to identify Joe Smith. ! Any user cannot bind to the LDAP server. ! Anonymous binding is used. ! Any Enterprise eTIME UserAccount name is not the same as the value of the attribute used to identify the user in the dn. For example, the Enterprise eTIME UserAccount name is Joe Smith, but the user's LDAP dn is encryptedcn=*9?hOlN^,ou=People,o=arius.com The encryptedcn attribute is used to identify Enterprise eTIME UserAccount for JoeSmith. ! F-2 The communication channel between Enterprise eTIME and the LDAP server uses Secure Sockets Layer (SSL) communications. ADP, Inc. Configuring Enterprise eTIME to Use Custom LDAP Configuring Enterprise eTIME to Use Custom LDAP To configure Enterprise eTIME to use the custom LDAP module, do the following: 1. Set the site.security.authsrc property from the Web browser: a. Logon as SuperUser. b. Select System Configuration > System Settings > Security tab. c. Set the site.security.authsrc property value to: OTHER://provider=com.auth.LDAP;property=<installdir>/wfc/properties/ldap.properties Where <install-dir> is the directory that Enterprise eTIME is installed in ({Enterprise eTIME.rootdir}/adp for Windows and /usr/local/kronos for UNIX). d. Click Save. 2. Run the LDAPConfig utility to generate a ldap.properties file. This utility prompts for information about the LDAP configuration and generates a ldap.properties file. For more information, see “Using the LDAPConfig Utility.” 3. Restart Enterprise eTIME using the Start Enterprise eTIME icon. Enterprise eTIME System Administrator’s Guide F-3 Appendix F Custom LDAP Authentication Method Using the LDAPConfig Utility LDAPConfig generates a ldap.properties file based on your answers to its prompts. It then attempts to connect to the LDAP server and run a small set of tests using this generated ldap.properties file. After the LDAPConfig utility successfully completes, copy the generated ldap.properties file to the Enterprise eTIME properties directory ({Enterprise eTIME.rootdir}\adp\wfc\properties for Windows and /usr/ local/Kronos/wfc/properties for UNIX). To run the LDAPConfig utility, enter the following at the command line: ! Windows: java -classpath "c:\adp\wfc\lib\apihooks.jar;c:\adp\wfc\lib\ldapWFC .jar" LDAPConfig ! UNIX: java -classpath "/usr/local/kronos/wfc/lib/ apihooks.jar:/usr/local/kronos/wfc/lib/ldapWFC.jar" LDAPConfig The properties value set in ldap.properties are set by the LDAPConfig utility in response to your input. These properties are the following: ! ldap.ldap.url—The address and port that the LDAP server is listening on. The address can be either a fully qualified domain name (FQDN) or an IP address. The port is optional and the default port is used if you do not specify one. The default port is 636 for SSL and 389 for non-SSL. Example: ldap.ldap.url=arius.com—LDAP server is listening on airius.com, the default port of 389 will be used. ldap.ldap.url=127.0.0.1:8934—LDAP server is listening on the local system port 8934. ! F-4 ldap.protocol—The protocol used to communicate with the LDAP server. Possible values are either ldap for non-SSL, or ldaps for SSL. ADP, Inc. Using the LDAPConfig Utility ! ldap.auth.method—The authentication method used to find the user in the LDAP Directory Information Tree (DIT). This is either bind or search. ! ldap.root.principal—The distinguishing name (dn) of the user that will bind to the LDAP server during the search authentication method. This value can be left empty for Anonymous binding. Example: ldap.root.principal=cn=Root User, ou=People,o=airius.com ldap.root.principal= —Anonymous bind ! ldap.root.credential—The password for the ldap.root.principal. ! ldap.user.login.uid—The name of the attribute used in dn to identify users. Example: ldap.user.login.uid=uid—Users are identified by uid=foo,ou=People,o=airius.com ldap.user.login.uid=encrypteduid—Users are identified by encrypteduid=8&j,ou=People,o=airius.com ldap.user.login.uid=cn—Users are identified by cn=foo,ou=People,o=airius.com ! ldap.user.search.path—The topmost node in the Directory Information Tree (DIT) where the search method will look for a user in the DIT. Example: ldap.user.search.path=o=arius.com—Search for users in all subgroups, ou's, of arius.com. ldap.user.search.path=ou=People,o=arius.com—Search for users in all subgroups, ou's, of ou=People, o=arius.com. Users in other subgroups will not be found. For the bind method, site.auth.method=bind, this property's value is used to form the distinguishing name (dn). For example, if ldap.user.login.uid=cn and ldap.user.search.path=ou=People,o=airius.com and Enterprise eTIME UserAccount Joe Smith is authenticating with LDAP, then the dn is cn=Joe Smith,ou=People,o=airius.com Enterprise eTIME System Administrator’s Guide F-5 Appendix F F-6 Custom LDAP Authentication Method ADP, Inc. Appendix G Diagnostic Tools The Enterprise eTIME diagnostic tools are designed to assist in diagnosing run time, Enterprise eTIME Web server, and services errors. Note: Some of the diagnostic tools require you to have the JRE Plug-in installed on the application server. This appendix contains the following sections: ! Diagnostic Tools User Interface ! Diagnostics Tools and Usage Appendix G Diagnostic Tools Diagnostic Tools User Interface To start the diagnostic tools, double-click the diagnostic tools icon. The Diagnostic Tools Logon screen appears. Diagnostic Tools Logon Screen The first time that you log on to the Diagnostic Tools main menu, you must: 1. Designate the primary diagnostic Enterprise eTIME server in the Enter Host Name box. After the initial logon, you do not need to enter this information again. 2. Enter the Superuser user name in the Enter User Name box. 3. Enter the Superuser password in the Enter Password box. 4. If your server uses SSL connection, select the SSL check box. 5. Click OK. Launching a Specific Application After you enter information in the logon screen and click OK, the Diagnostic Tools main window appears. This window contains two panes. ! The left side of the window displays a tree-type structure with folders that contain the different diagnostic and troubleshooting tools. ! The right side of the window is where instructions and information about a selected diagnostic tool appears. At the bottom of the right pane is a Launch button to start a selected diagnostic tool. To use a specific diagnostic tool: 1. Select the primary Enterprise eTIME host name in the upper left-hand corner in the left pane. 2. Click the tool name in the left pane. 3. Click Launch at the bottom of the right pane. G-2 ADP, Inc. Diagnostics Tools and Usage Diagnostics Tools and Usage The diagnostic tools for Enterprise eTIME v5.0 are: ! XML Client ! SMTP Mail Server ! SMTP Mail To Launcher ! Log file FTP ! LDAP Configuration ! Shift Builder ! Systems Resource Running the XML Client Diagnostic Tool The XML Client Diagnostic Tool verifies connectivity to an Enterprise eTIME server and an Enterprise eTIME database. You can send an XML request to an Enterprise eTIME Web server. To run the XML Client Diagnostic Tool: 1. In the left pane of the Diagnostic Tools main window, select XMLClientDiagnostic from the connectivity folder. 2. Click Launch. The XML Client Connection Tester window appears. 3. In the XML Request drop-down list, select an XML request. ! Logon—Verifies connectivity to an Enterprise eTIME server ! HyperFind—Verifies connectivity to an Enterprise eTIME database 4. Click Send. The diagnostic tool lists the results in the Reply box. Enterprise eTIME System Administrator’s Guide G-3 Appendix G Diagnostic Tools Running the Database Connection Test Utility The Database Connection Test Utility provides the following information: ! Logs on to the Enterprise eTIME Server using XML. ! Logs on to the Enterprise eTIME Server Database using Java Database Connectivity (JDBC). ! Logs on to the Enterprise eTIME Server Database using Open Database Connectivity (ODBC). ! Each test (ODBC/JDBC) returns the Enterprise eTIME database version information. To run the Database Connection Test Utility: 1. In the left pane of the Diagnostic Tools main window, select DBTestDiagnostic from the database folder. 2. Click Launch. The DBTestDiagnostic dialog box appears. 3. Click Start. The diagnostic tool lists the results in the dialog box fields. G-4 ADP, Inc. Diagnostics Tools and Usage Running the SMTP Mail Server Diagnostic Tool The SMTP Mail Server Diagnostic Tool validates SMTP connectivity. To run the SMTP Mail Server Diagnostic Tool: 1. In the left pane of the Diagnostic Tools main window, select SMTPMailServerDiagnostic from the email folder. 2. Click Launch. The STMPMailServerDiagnostic dialog box appears. 3. Enter values into each box: ! FromEmail—Enter the From e-mail address. ! SMTPHostName—Enter the mail server SMTP. The mail server SMTP is listed in the site.email.smtp_url key in Enterprise eTIME System Configuration > System Settings > Email. ! ToEmail—Enter the to e-mail address. ! Subject—Enter a test subject. ! Message—Enter a test message. 4. Click Start. The diagnostic tool sends an e-mail to the address listed in the ToEmail box and lists the results in the Results box. Enterprise eTIME System Administrator’s Guide G-5 Appendix G Diagnostic Tools Running the SMTP Mail to Launcher Diagnostic Tool The SMTP Mail to Launcher Diagnostic Tool provides the capability to test and qualify the client’s client e-mail software. Some Enterprise eTIME applications launch the client’s e-mail client using the W3C3 e-mail to url syntax. Some e-mail client software packages, such as Netscape and Novell, do not support the latest W3C emailto url format and do not work correctly with the Enterprise eTIME product. Note: This tool can only be run if the Diagnostic Tools client setup is installed at the Enterprise eTIME server. To run the SMTP Mail To Launcher Diagnostic Tool: 1. In the left pane of the Diagnostic Tools main window, select SMTPMailToLauncher from the email folder. 2. Click Launch. The MailToTester page appears. 3. Fill in the appropriate information: ! To—Enter the To e-mail address. ! Subject—Enter a test subject or accept the default. ! Body—Enter a test message. 4. Click Launch. The user’s e-mail client opens. If the e-mail client is displayed with the same information that appears on the MailToTester page, then the application works correctly. 5. In the e-mail client application, click Send. This validates that the information is parsed correctly and that the e-mail is being sent to the individual designated in the To: box. G-6 ADP, Inc. Diagnostics Tools and Usage Running the Log File FTP Diagnostic Tool The Log File FTP Diagnostic Tool is designed to retrieve a list of log files for each Enterprise eTIME service and platform, and FTP the files to the TLM Support FTP Site. Note: This tool can only be run if the Diagnostic Tools client setup is installed at the Enterprise eTIME server. Log files to be transferred include: Service/Platform Log Files Enterprise eTIME ! ! ! ! ! ! ! WFC.log WFC*.log WFCReporting1.log WFCReporting2.log StartupError.log StartupInfo.log license.log Jrun ! ! ! ! default-err.log default-event.log default-ovt.log default-*.log Apache ! ! ! ! access.log error.log httpd.log ssl.log DCM ! DCM data.logs BGP ! ! ! ! ! *.sdf files Wtkappntdump.log Walkback.log Wtktotaldump.log TotalizerN.log Enterprise eTIME System Administrator’s Guide G-7 Appendix G Diagnostic Tools To run the Log File FTP Diagnostic Tool: 1. In the left pane of the Diagnostic Tools main window, select FTPLogFilesDiagnostic from the ftplogfiles folder. 2. Click Launch. The FTPLogFilesDiagnostic dialog box appears. 3. Select the type of log files that you want by selecting the check boxes. Note: You must always select the WFCLogFiles check box. 4. In the FTPServerName box, enter the TLM Support Services FTP server name. 5. Click Start. The buttons at the bottom of the FTPLogFilesDiagnostic dialog box disappear while the tool is running. The diagnostic tool lists the results in the Message box. A restart button appears when the tool is finished running. G-8 ADP, Inc. Diagnostics Tools and Usage Running the LDAP Configuration Diagnostic Tool Lightweight Directory Access Protocol (LDAP) is a hierarchical datastore that can be used as a repository for user account information. Enterprise eTIME can be configured to delegate its user authentication to LDAP. For more information, see “Understanding Authentication” in Chapter 4. There is a wide range of possible LDAP configurations. For example, there are many ways to organize user information in the datastore. The simplest method is to have all user information kept in one group, called an organizational unit (ou) in LDAP, in the hierarchy. A more common method is to store user information in multiple organizational units. There are also different methods that LDAP can use to authenticate users. Anonymous, super/root, or individual authentication can be used. Enterprise eTIME LDAP authentication can be used with all of these LDAP configurations. The LDAP Configuration Diagnostic Tool qualifies that a client's LDAP configuration is compatible with the Enterprise eTIME LDAP implementation, and it produces an Enterprise eTIME LDAP properties file that can be installed to enable Enterprise eTIME LDAP authentication. You can use this Enterprise eTIME properties file to test that the Enterprise eTIME LDAP authentication code performs as expected using the client's LDAP datastore. Enterprise eTIME System Administrator’s Guide G-9 Appendix G Diagnostic Tools Creating a New ldap.properties File To run the LDAP Configuration Diagnostic Tool: 1. Running the LDAP Configuration Diagnostic Tool to create a new ldap.properties file. 2. Replacing the current ldap.properties file with the one created by running the LDAP Configuration Diagnostic Tool. 3. Testing the new ldap.properties file. Note: You could use the LDAP Configuration Diagnostic Tool to validate if a user is in an organizational unit (ou) in LDAP by performing the first step only. Running the LDAP Configuration Diagnostic Tool To run the LDAP Configuration Diagnostic Tool: 1. In the left pane of the Diagnostic Tools main window, select LDAPDiagnostic from the security folder. 2. Click Launch. The LDPDiagnostic dialog box appears. 3. Enter values into all of the boxes: G-10 ! LDAPHostName—Enter the host name of the LDAP server. ! LDAP_Port—Enter the LDAP port number, default=389. ! UserGroup_OU—Enter the ou entry, such as ou=people, dc=adp, dc=com. ! UserIdAttribute—Enter the attribute used to identify the user, such as uid. ! WFCUser—Enter the Enterprise eTIME case-sensitive user name. ! WFCUserPassword—Enter the Enterprise eTIME case-sensitive user name password. ! BindingUser—If you have a single ou, leave this blank. If you have multiple ou’s, enter the case-sensitive superuser name. ADP, Inc. Diagnostics Tools and Usage ! BindingUserPassword—If you have multiple ou’s, enter the superuser case-sensitive password to match the superuser name. ! AllUsersInSingleGroup—Select this check box if you have a single ou. Leave it cleared if you have multiple ou’s. ! LDAP_SSL_Enabled—Select this check box if SSL is installed on the LDAP server and you want to use it. 4. Click Save to save the file as a properties file. In the Save dialog box, save the properties file with a .dtk extension in <Enterprise eTIME.rootdir>\adp\diagnostics. Note: To load a properties file that you previously created, click Load and browse to select the file that you previously created. 5. Click Start. After the LDAP Configuration Diagnostic Tool stops running, the results appear in the LDAPDiagnostic dialog box. ! If there is an error, click Restart and Load to reload the properties file. Correct any errors, click Save to resave the file, and then run the file again. ! If the file ran correctly, the results window gives you information such as where to put the resulting file. Replacing the Ldap.properties File To replace the existing ldap.properties file with the new ldap.properties file created by the LDAP Configuration Diagnostic Tool: 1. In Windows Explorer, browse to <Enterprise eTIME.rootdir>\adp\wfc\properties. 2. Rename ldap.properties to old_ldap.properties. 3. Browse to where you saved the new ldap.properties file that you created when you ran the LDAP Configuration tool (<Enterprise eTIME.rootdir>\adp\diagnostics). 4. Copy the new ldap.properties file to <Enterprise eTIME.rootdir>\adp\Enterprise eTIME\properties. Enterprise eTIME System Administrator’s Guide G-11 Appendix G Diagnostic Tools 5. In Enterprise eTIME, select System Configuration > System Settings > Security. 6. Configure site.security.authsrv with OTHER, using the information in the LDAPDiagnostic results window. For more information about OTHER LDAP configurations, see “Understanding Authentication” in Chapter 4. 7. Click Save. Testing the New Ldap.properties File To test the new ldap.properties file: 1. Stop Enterprise eTIME by clicking the Stop Enterprise eTIME icon. 2. Start Enterprise eTIME by clicking the Start Enterprise eTIME icon. 3. Log on to Enterprise eTIME by using the Enterprise eTIME user name that you used in the LDAP Diagnostic dialog box. G-12 ADP, Inc. Diagnostics Tools and Usage Running the Shift-Builder Diagnostic Tool The Shift Builder diagnostic tool logs onto Enterprise eTIME and checks: ! The ScheduleProc database table record count ! The SchedPatrnDate next run date database table ! For failed shiftbuilder employees from the database ! The WtkGlobalSettings.properties file for XML user/password ! The WfcSite.properties file for Event Manager key/values To run the Shift-Builder diagnostic tool: 1. In the left pane of the Diagnostic Tools main window, select ShiftBuilderDiagnostic from the shiftbuilder folder. 2. Click Launch. The ShiftBuilderDiagnostic dialog box appears. 3. Click Start. The buttons at the bottom of the ShiftBuilderDiagnostic dialog box disappear while the tool is running. The diagnostic tool lists the results in the text boxes. A restart button appears when the tool is finished running. Enterprise eTIME System Administrator’s Guide G-13 Appendix G Diagnostic Tools The diagnostic tool lists the results in the text boxes as in the following table: Text box Description ScheduleProc (count) Returns the number of Shift Builder tasks that have not yet been completed. There are three types of Shift Builder tasks: A schedule group may exist that needs to have shifts built for it. An employee may have an individual schedule pattern and needs to have shifts built for that pattern. ! An employee may be added into a schedule group. In this case, that employee must get the shifts that he or she inherited from the group built. ! ! If the value in the ScheduleProc(count) text box is zero (0), the Shift Builder has finished running and has no tasks left to complete. If the value is greater than zero, then the Shift Builder is currently running, or the Shift Builder has stopped running, but was unable to complete all of its tasks. SchedPatrnDate Designates the date and time after which no shifts have been built. The user cannot call up an editable Schedule Editor for any date after the one designated in the SchedPatrnDate text box. To the right side of this text box is a zero (0) or a one (1). A zero indicates that the Periodic Shift Builder will not be run on the next startup of the system, unless the AlwaysBuildShiftsOnStartup property has been set. ! A one indicates that the Periodic Shift Builder will be run on the next startup of the system. ! FailedEmployees Lists the employee IDs of any employees who failed to run in the Shift Builder. For example, if a schedule group failed to process properly, the IDs of all the employees associated with that schedule group are listed. WtkGlobal Settings G-14 Lists the encrypted username and password that is used to log on the Enterprise eTIME server. The Event Manager can have problems if the XMLUSER username and password defaults has been changed in this location. The username/password that is returned in the WtkGlobalSettings field must match the username/password that appears in the USERACCOUNT table. ADP, Inc. Diagnostics Tools and Usage Text box Description WFCSite(Event Manager Info) Lists the site.eventmanger.enabled.required key. This should be set to true in order for the Shift Builder to run through this server’s event manager. This property is found in Enterprise eTIME System Configuration > System Settings > Event Manager. ShiftBuilder (properties) The following properties are listed: ! ! ! ! ! site.service.ShiftBuilder.AlwaysBuildShiftsOnStartup—If this property is set to true, the periodic shift builder is run every time the server starts up. This is set to true by default for KDEMO databases. This property is found in Enterprise eTIME System Configuration > System Settings > Service. Global.WtkScheduler.ShiftBuilderGovernor.Active—If this property is set to 1, a limit is placed on the number of days populated by the periodic shift builder. The default value for this property is 1. This property is found in Enterprise eTIME System Configuration > System Settings > Global Values. Global.WtkScheduler.ShiftBuilderGovernor.Days—This property designates the maximum number of days populated by the periodic Shift Builder, if the global.WtkScheduler.ShiftBuilderGovernor.Active key is set to 1. The default value for this property is 30 days. This property is found in Enterprise eTIME System Configuration > System Settings > Global Values. Global.WtkScheduler.ShiftBuilderThreads.Max—This property designates the maximum allowed number of concurrent periodic shift builder threads. The default value is 5. This property is found in Enterprise eTIME System Configuration > System Settings > Global Values. Global.WtkScheduler.MaximumDaysInFutureToCreateShifts— This property designates the maximum number of future days for which shifts will be populated, starting with the current day. The default value is 270. This property is found in Enterprise eTIME System Configuration > System Settings > Global Values. Enterprise eTIME System Administrator’s Guide G-15 Appendix G Diagnostic Tools Running the System Resource Diagnostic Tool The System Resource diagnostic tool lists system information for the Java Virtual Machine on the application server. To run the System Resource Diagnostic Tool: 1. In the left pane of the Diagnostic Tools main window, select SystemResourcesDiagnostic from the systemresources folder. 2. Click Launch.The SystemResourcesDiagnostic dialog box appears. 3. Click Start. The diagnostic tool fills in the Statistics box when it is complete. G-16 ADP, Inc. Index A All Servers system information 2-3 Applications system information 2-4 archiving system log reports 3-8 authentication LDAP custom method F-2 LDAP default method 4-65 OTHER 4-65 proprietary 4-64 understanding 4-63 WinNT, multiple domains 4-64 WinNT, single domains 4-65 B Background Processor Background Processors workspace 2-5 employees excluded 2-5, 2-6, 2-7 system information 2-5 BGP Background Processors workspace 2-5 employees excluded 2-5, 2-6, 2-7 system information 2-5 C Callable Totalizer system settings 4-7 Clock Synchronize system settings 4-9 configuration Enterprise eTIME Setup 1-3 overview 1-3 system configuration 1-4 configuration settings before editing 4-3 editing 4-3, 4-4 System Configuration 1-1, 1-2 custom LDAP authentication configuring Enterprise eTIME F-3 understanding F-2 using LDAPConfig utility F-4 D Data Source system settings adding 4-19 overview 4-18 database deleting a report 2-11 displaying a report 2-11 report display 2-10, 2-11 report status 2-9, 2-10 running a report 2-11 switching databases 4-12, 4-13 system information 2-8 system settings 4-11 viewing a report 2-11 working with reports 2-11 database reports available reports 2-8 creating DRD files 2-11, 2-12 deleting 2-11 Display workspace 2-10, 2-11 displaying 2-11 DRD creation guidelines 2-13 Index L running 2-11 Status workspace 2-9, 2-10 viewing 2-11 working with 2-11 DRD guidelines for creating 2-13 DRD files creating 2-11, 2-12 E e-mail available notifications 1-28 multiserver environment configuration 1-24, 1-25 notification types 1-27 system settings 4-21 employees excluded retroactive pay calculation 2-6, 2-7 totals calculation 2-5, 2-6 Enterprise eTIME Setup configuration 1-3 environments multiserver 1-24 Event Manager multiserver environment configuration 1-25 system settings 4-24 working with system settings 4-26 G Global Values system settings 4-30 group edits clearing results screen 4-38, 4-39 multiserver environment configuration system settings 4-37 J LDAP authentication custom configuration F-3 custom LDAPConfig utility F-4 custom method F-2 default method 4-65 Licenses system information 2-15 Local Server system information 2-16 Locale system settings 4-42 log Event Manager 4-28 reports 5-7 log file archving system log reports 3-8 enabling SQL tracing 4-69, 4-70 system settings 4-47 log on changing the relogon session timeout 1-12 overview 1-6 single sign-on 1-6 Log Reports archiving 3-8 filtering 3-7 overview 3-2 running 3-7 Log Reports overview 3-1 Logging Context system settings 4-50 logoff timer, changing 4-65, 4-66 M 1-24 Meters system information 2-17 multiserver environments configuration overview 1-24 configuring E-mail 1-24, 1-25 configuring Event Manager 1-25 configuring Group Edits 1-24 Java Plugin system settings 4-40 JRun Service updating passwords 1-10, 1-11 Index-2 ADP, Inc. Index N navigation, offline 1-7 Notification server 1-27 O offline mode 1-6, 1-7 OTHER authentication 4-65 Overtime equalization enabling in system settings 4-32 overview System Configuration 1-1, 1-2 P passwords JRun Service 1-10, 1-11 Portal system settings 4-51 predefined data data access profiles A-2 display profiles A-8 Enterprise eTIME QuickNav building blocks A-3 Enterprise eTIME QuickNav profile A-11 Enterprise eTIME QuickNavs A-6 function access profiles A-14, B-4 HyperFind Query A-10 labor level sets A-9 logon profiles A-13 people A-12 Primary Labor Account system information 2-18 printers enabling 4-56, 4-57 system settings 4-55 properties files custom property file backup 1-17 descriptions 1-19 file types 1-15 groups 1-22 Enterprise eTIME System Administrator’s Guide modifying 1-17 overview 1-15 properties validation 4-5, 4-6 property groups 1-22 proprietary authentication 4-64 R registry keys UNIX C-4 Windows C-2 relogon changing Enterprise eTIME Suite session timeout grace period 1-13, 1-14 changing the JRun relogon session timeout 1-12, 1-13 changing the relogon session timeout 1-12 relogon session timeout changing Enterprise eTIME Suite session 1-13, 1-14 changing JRun session 1-12, 1-13 overview 1-12 report terminology 5-2 reports accessing 5-8 checking status 5-9 concept overview 5-2 directory 5-4 generating 5-13 server 5-5 system settings 4-58 terminology 5-2 reports, system database report display 2-10, 2-11 database report status 2-9, 2-10 deleting a database report 2-11 displaying a database report 2-11 Log Reports 3-1, 3-2 running a database report 2-11 viewing a database report 2-11 working with database reports 2-11 Index-3 Index S security authentication 4-63 client 1-10 overview 1-9 password 1-9 single sign-on 1-10, E-2 system settings 4-61 server All Servers system information 2-3 Local Server system information 2-16 logging on and off 1-6 managing remotely 1-8 Web Server system settings 4-75 Service system settings enabling SQL tracing 4-69, 4-70 overview 4-67 settings before editing configuration settings 4-3 editing configuration settings 4-3, 4-4 System Configuration 1-1, 1-2 severity levels, Event Manager log 4-28 single sign-on configuring Enterprise eTIME E-2 configuring JRun E-3 configuring SiteMinder E-4 logging on 1-6 SQL Coverage system settings enabling SQL tracing 4-69, 4-70 overview 4-69 SQL tracing, enabling 4-69, 4-70 Startup system settings 4-71 system administration adding data source names 4-19 adding printers 4-57 changing logoff timer 4-65, 4-66 clearing Group Edit Results 4-38, 4-39 configuration 1-4 enabling printers 4-56, 4-57 enabling SQL tracing 4-69, 4-70 Index-4 offline mode 1-6, 1-7 switching databases 4-12, 4-13 understanding authentication 4-63 working with Event Manager 4-26 System Configuration Log Report 3-1, 3-2 overview 1-2, 1-4 System Information 2-1, 2-2 System Settings 4-1, 4-2 system configuration configuration 1-4 system information All Servers 2-3 Applications 2-4 Background Processors 2-5 Background Processors workspace 2-5 database report display 2-10, 2-11 database report status 2-9, 2-10 Database workspace 2-8 Database, overview 2-8 employees excluded 2-5, 2-6, 2-7 Licenses 2-15 Local Server 2-16 Meters 2-17 overview 2-2 Primary Labor Account 2-18 Threads 2-20 User 2-22 working with 2-2 system log reports archiving 3-8 filtering 3-7 overview 3-1, 3-2 running 3-7 system reports database report display 2-10, 2-11 database report status 2-9, 2-10 deleting a database report 2-11 displaying a database report 2-11 Log Reports 3-1, 3-2 ADP, Inc. Index running a database report 2-11 viewing a database report 2-11 working with database reports 2-11 system security authentication 4-63 system settings before editing 4-3 Callable Totalizer 4-7 Clock Synchronize 4-9 Data Source 4-18 Database 4-11 editing 4-3, 4-4 E-mail 4-21 Event Manager 4-24 Global Values 4-30 Group Edits 4-37 Java Plugin 4-40 Locale 4-42 Log File 4-47 Logging Context 4-50 overview 4-1, 4-2 Portal 4-51 Printers 4-55 Reports 4-58 Security 4-61 Service 4-67 SQL Coverage 4-69 Startup 4-71 task buttons 4-4 Timekeeping 4-72 Transformation 4-74 values validation 4-5, 4-6 Web Server 4-75 working with 4-4 Enterprise eTIME System Administrator’s Guide T Threads system information 2-20 Timekeeping system settings 4-72 Transformation system settings 4-74 troublshooting enabling SQL tracing 4-69, 4-70 U UNIX registry keys C-4 User system information 2-22 V validation, system settings 4-5, 4-6 W Web Server system settings 4-75 WinNT authentication mulitiple domains 4-64 single domains 4-65 Workflow Notification access 1-30 available notifications 1-28 notification types 1-27 overview 1-27 setting up 1-29 Index-5 Index Index-6 ADP, Inc.