Installation Guide. Infor HCM Workforce Management - Business Edition and higher

Transcription

1 Installation Guide Infor HCM Workforce Management - Business Edition and higher

2 Copyright 2008 Infor. All rights reserved. The word and design marks set forth herein are trademarks and/or registered trademarks of Infor and/or related affiliates and subsidiaries. All rights reserved. All other trademarks listed herein are the property of their respective owners. This document contains confidential and proprietary information of Infor and/or related affiliates and subsidiaries and is intended only for the person(s) to whom it is transmitted by Infor. Any reproduction or retransmission of this document or the information contained herein, in whole or in part, without the prior written consent of Infor is expressly prohibited. Infor reserves all right, title and interest in this document and the information contained herein. Unless otherwise set out in a written agreement between Infor and a recipient of this document, Infor makes no representations or warranties with respect to the completeness or accuracy of the information contained herein and shall not, under any circumstances, be held liable for any damages howsoever caused by reliance thereon. Infor 250 Ferrand Drive, Suite 1200 Toronto, Ontario M3C 3G8 Canada WFM PLA-E-00 11/13/08

3 Contents Introduction... 5 What is Workforce Management Business Edition?... 5 Business Edition Architecture... 6 Business Edition Components... 7 Database Server... 7 Application Server... 7 Report Server (Workforce Performance)... 7 Clocks Solution... 8 Job Scheduler Gateway... 9 License Server... 9 System Requirements Supported Platform Business Edition Pre-requisites Component Requirements Java Runtime Environment (JRE) MS SQL Server WebLogic Server Apache Server Solution License Manager (SLM) Server Using the Solution License Manager (SLM) Server What is the SLM License Server? Installing Business Edition Post-Installation SQL Server Enable TCP/IP Recovery Settings Troubleshooting Cognos ReportNet Failure Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

4 License Errors Workforce Performance Installation Failure Location of Installation Log Files Uninstalling Business Edition Appendix: Technical Reference Sheet Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

5 Introduction Introduction What is Workforce Management Business Edition? The Human Capital Workforce Management Business Edition system is a Web-based application used to automate workforce management processes. This document outlines how to install the Workforce Management Business Edition application. Please acquaint yourself with the first 2 topics before attempting topic 3. Topic 1: Business Edition Architecture on page 6 Topic 2: System Requirements on page 10 Topic 3: Business Edition Pre-requisites on page 12 Topic 4: Using the Solution License Manager (SLM) Server on page 15 Topic 5: Installing Business Edition on page 16 Topic 6: Post-Installation on page 17 Topic 7: Troubleshooting on page 19 Topic 8: Uninstalling Business Edition on page 23 Topic 9: Appendix: Technical Reference Sheet on page 26 Note This Guide is not intended to provide information on the step-by-step installation process. For information regarding the actual installation process, consult the online help provided with the Business Edition Installer. Important To use this guide, you should have basic Windows administration skills. You should be familiar with your existing server environment and security infrastructure in your organization. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

6 Business Edition Architecture Business Edition Architecture The Infor HCM Workforce Management Business Edition system is a Web-based application composed of multiple components, as shown in the image below. For a description of each component, go to Business Edition Components on page 7. * Hardware Clock (WB 6000 series only) installation available starting with Infor HCM Workforce Management Business Edition version Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

7 Business Edition Architecture Business Edition Components The Workforce Management Business Edition application is composed of the following components: Database Server The Microsoft SQL Server is used as the database server for Business Edition. The MS SQL Server is NOT installed when installing the Business Edition application and must be installed separately. For more information, go to MS SQL Server on page 13. Application Server The BEA WebLogic Server is used as the application server for Business Edition. The WebLogic Server is NOT installed when installing the Business Edition application and must be installed separately. For more information, go to WebLogic Server on page 13. Report Server (Workforce Performance) Workforce Performance is the application s reporting module based on Cognos ReportNet. Workforce Performance requires that the MS SQL and Apache Servers are installed before installing the Business Edition application. For more information, go to Business Edition Pre-requisites on page 12. The following sub-components are also installed with Workforce Performance: Server The Cognos ReportNet Server is used as the application server for Workforce Performance. The Cognos Server is installed during the Business Edition installation process. Important If Cognos ReportNet is already installed on your machine, you will need to uninstall it before installing the Business Edition application. Cognos ReportNet will be reinstalled when installing the Business Edition application. Gateway Using the Apache HTTP Server, the Workforce Performance Gateway is used to deliver data to the Workforce Performance module. The Apache Server is the HTTP server used by Workforce Performance. The Apache Server is NOT installed when installing the Business Edition application and must be installed separately. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

8 Business Edition Architecture For more information, go to Apache Server on page 13. Important Workforce Management Business Edition does NOT support multiple Cognos ReportNet Servers on one Gateway. the ratio between Server and Gateway must be 1:1. Content Store The relational database, provided and created by Cognos ReportNet, used to store report related information. The Content Store runs on MS SQL Server. Clocks Solution The Business Edition Clocks solution allows the application to capture data entered from punch clocks used by employees. Clocks in use are either Software-based (virtual) or hardware-based (WB6000). The following sub-components are also installed with the Clocks solution: Clock Server The Clock Server interfaces with virtual clocks, and WB 6000 series of hardware clocks as of version , to gather punch-in and punch-out information and provide it to the Business Edition application. The Clock Server also synchronizes the time among all the clocks, transfers file updates and programs to the clocks, validates clock data entry, and stores employee data that is propagated to the clocks. Hardware Clock (WFM BE and higher only) Starting with version , the Infor HCM Workforce Management Business Edition allows you to run the WB 6000 series of hardware clocks. Business Edition supports environments that use a combination of both Virtual Clocks and Hardware Clocks. The following table lists the WB6000 series of clocks supported by Business Edition: Model Number WB-6000 WB-6001 WB-6002 WB-6003 Description WB 6000 Base Model w/ Keypad WB 6001 Barcode WB 6002 Magnetic Stripe WB 6003 Proximity - HID Note: Although the WB6000 series of hardware clocks support Biometrics, Business Edition does not currently support this functionality. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

9 Business Edition Architecture Virtual Clock Terminal The Virtual Clock Terminal is a software based punch clock used by employees to punch in and out of work. Clocks Admin Console The Administration Console, a GUI tool provided by Infor, is the main user interface to the Clocks Server. The administration console is used to remotely administer the Clock Server. Job Scheduler The Job Scheduler is the Business Edition batch server that runs workforce management tasks at specified times or intervals. Gateway The Gateway allows the Workforce Management Business Edition application to route Workforce Management messages to non-proprietary systems. License Server The SLM (Solution License Manager) License Server is used to grant the end user permission to use the Business Edition application. Before you can acquire a Business Edition license you must install the SLM License Server and Client or the application will cease to function 30 days from the time of its installation.the SLM License Server and Client are NOT installed when installing the Business Edition application and must be installed separately. For more information, go to Solution License Manager (SLM) Server on page 13. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

10 System Requirements System Requirements Business Edition supports the components listed in the Supported Platform section. You must ensure that your system meets the minimum requirements for each piece of software you are using. For example, Business Edition supports the MS SQL Server If you are using MS SQL Server 2005, you must ensure that your system meets Microsoft s list of supported configurations. Supported Platform The following table lists the client, web sever, application server and database platforms supported by Business Edition, as well as 3rd party applications required to run specific Business Edition functionality. Component Platform Version Client Browser Internet Explorer 6.0 Internet Explorer 7.0 with security update MS (KB /13/2007) Adobe Acrobat 7.0 required to view generated PDF files Firefox 1.5 Client JRE Sun JRE 1.4.2_13 Sun JRE 1.5.0_07 up to but not including 1.6 for BEA Weblogic Client Adobe Acrobat Adobe Acrobat 7.0 Client OS Windows XP SP2 Application Server BEA WebLogic 9.2 MP2 Application Server JRE Sun JRE 1.5.0_07 up to but not including 1.6 Application Server OS Windows 2003 Server Workforce Performance HTTP Server Apache Server Workforce Performance JRE Sun JRE 1.4.2_13 up to but not including 1.5 Workforce Performance Server OS Windows 2003 Server Database Server MS SQL Server 2005 Database Server OS Windows 2003 Server Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

11 System Requirements Component Job Scheduler OS Windows 2003 Server Gateway OS Windows 2003 Server Clock Server Windows 2003 Server Clock Server Admin Console Windows XP SP2 or Windows 2003 Server Virtual Clock Windows XP SP2 License Server Infor SLM License Server License Server OS Windows 2003 Server Supported Hardware Clock Platform Version As of Infor HCM Workforce Management Business Edition version , WB 6000 series hardware clocks are supported. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

12 Business Edition Pre-requisites Business Edition Prerequisites The Workforce Management Business Edition application relies on a number of third party components which must be installed prior to running the Business Edition installer. The following section outlines the components that should be installed and any specific parameters that should be chosen during their installation process. It is recommended that prior to installing any of the prerequisites that you read this section and print out and complete the Appendix: Technical Reference Sheet on page 26 before you initiate the installation of Business Edition. Note The Workforce Management Business Edition application can be hosted on a single machine or on multiple machines. Component Requirements The following components must be installed before installing the Business Edition application. Java Runtime Environment (JRE) on page 12 MS SQL Server on page 13 WebLogic Server on page 13 Solution License Manager (SLM) Server on page 13 Apache Server on page 13 Java Runtime Environment (JRE) Sun JRE version 1.5 or higher is required for BEA WebLogic, while Sun JRE 1.4.2_13 or higher is required for Cognos ReportNet. You should download the appropriate versions (1.5 and 1.4.2_13) of the Java Software Development Kit (SDK). Each JDK package contains the required JRE s. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

13 Business Edition Pre-requisites If you chose to install Cognos ReportNet on a separate machine, be sure to install JDK 1.4.2_13 or higher where Cognos ReportNet is installed. Important! The Business Edition installation process will override the JAVA_HOME variable of JRE 1.4.2_13, if one already exists. If this variable does not already exist, the Business Edition installation process will create it. For general JRE configuration information, consult Sun Java documentation. MS SQL Server Microsoft SQL Server 2005 must be installed before you install the Business Edition application. When installing the database remotely, OSQL and SQLCMD utilities must be installed on the machine where the Workforce Management Business Edition Installer is running. Important! When installing MS SQL Server, do not choose the Named Instance option. Use the Default option instead. Be sure to install the SQL Server in SQL Server Authentication Mode (not Mixed Mode). WebLogic Server WebLogic Server 9.2 MP2 must be installed before you install the Business Edition application. If you will be using the Node Manager to remotely start your services, you will need to configure it before you install the Business Edition application. For general WebLogic Server configuration information, consult BEA WebLogic Server documentation. Apache Server Apache Server must be installed before you install the Business Edition application. For general Apache Server configuration information, consult Apache Server documentation. Solution License Manager (SLM) Server The SLM (Solution License Manager) License Server is used to grant the end user permission to use the Business Edition application. The SLM License Server must be installed if you want to run Business Edition past its 30 day trial period. Business Edition supports SLM License Server version Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

14 Business Edition Pre-requisites Note You do not need to install the SLM License Server before you install the Business Edition application, however, the application will cease to function 30 days from its installation. For more information on the Solution License Manager (SLM) Server, go to Using the Solution License Manager (SLM) Server on page 15. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

15 Using the Solution License Manager (SLM) Server Using the Solution License Manager (SLM) Server What is the SLM License Server? The Solution License Manager (SLM) Server is an application that grants the end-user permission from Infor to use the Workforce Management Business Edition application. Installation of the SLM License Server and Client is mandatory if you wish to use Infor HCM Workforce Management Business Edition past its 30-day trial period. For more information on the Solution License Manager (SLM), consult the HCM WFM License Manager User Guide. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

16 Installing Business Edition Installing Business Edition Important If Cognos ReportNet is already installed on your machine, you will need to uninstall it before installing the Workforce Management Business Edition application. Cognos ReportNet will be re-installed during the Business Edition application process. To install the Workforce Management Business Edition application and its components, simply double-click the Business Edition install executable file (InforHCMWFMInstaller<timestamp>.exe) and follow the steps provided by the installation program. Note The Business Edition Installer is equipped with online help. If you need an explanation about the contents in any of the installation panels, simply click the Help button. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

17 Post-Installation Post-Installation SQL Server Enable TCP/IP Use the SQL Server Configuration Manager tool to enable the TCP/IP on the SQL Server 2005 computer. To do this: 1 From the Windows Start menu, go to Programs > Microsoft SQL Server 2005 > Configuration Tools > SQL Server Configuration Manager. 2 Click to expand SQL Server 2005 Network Configuration and then click Protocols for MSSQLSERVER. 3 Right click the TCP/IP protocol and choose Properties. 4 Select Yes next to the Enabled item. 5 Click on the IP Addresses tab. 6 Enter 1433 next to the TCP Port items for IP1, IP2 and IP3. 7 Click OK. 8 Close the SQL Server Configuration Manager tool. For general MS SQL Server configuration information, consult MS SQL Server documentation. Recovery Settings After installation has been successfully completed, the user has the option to configure recovery scenarios in Windows if a Workforce Management (Infor HCM WFM) service(s) was to fail for some reason. If recovery settings are not configured, a service will have to be re-started manually each time it fails. To set automatic recovery of failed services in Windows: 1 Access Computer Management from Windows by clicking Start and going to SETTINGS > CONTROL PANEL. 2 Double-click Administrative Tools, and then double-click Computer Management. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

18 Post-Installation 3 Locate the Infor HCM WFM services that were created under Services and Applications > Services. 4 Right-click on a chosen Infor HCM WFM service and select Properties. 5 Access the Recovery tab. 6 Configure the computer s response to the first, second or third failure. Note You might need to be logged on as an administrator or a member of the Administrators group in order to perform the above tasks. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

19 Troubleshooting Troubleshooting Cognos ReportNet Failure If the newly installed Cognos ReportNet instance does not start properly after the Business Edition installation is complete, it is possible that a previously installed Cognos ReportNet instance (in the same location) was running at the time the new installation took place. To remedy this situation: 1 Stop the Cognos ReportNet service. 2 Uninstall all instances of Cognos ReportNet that were installed during the Business Edition installation process(es) - see Workforce Performance: on page 25 3 Reinstall Cognos ReportNet using the Business Edition Installer. Remember During Cognos ReportNet installation, the Apache Server is re-configured to point to each successive Cognos ReportNet instance. License Errors If occasional license errors, such as a License server not running message, or a 404 page not found HTTP error, are displayed when accessing the application on login, ensure that all nodes in the cluster have a valid license available. The application startup log should be consulted to ensure that a node has a valid license. Workforce Performance Installation Failure All the components, except Workforce Performance, are installed in the order as they appear on the component selection panel. The installation of Workforce Performance is divided into two parts. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

20 Troubleshooting The first part installs the Cognos ReportNet application which occurs during initial file extraction, i.e., it occurs before any component is installed. The second part creates the Content Store and configures the Reportnet installation. This occurs after the Gateway component is installed. Problem: Since Workforce Performance Installation is broken-up into two parts, any failure involving the other Workforce Management components (Database, Application Server, Job Scheduler, Gateway) that occurs before the second part of Workforce Performance is installed will cause a failure in Workforce Performance installation. Any subsequent attempt to install Workforce Performance will fail. Solution: If the above situation occurs and only Cognos ReportNet is installed, the user needs to uninstall Cognos ReportNet before re-installing Workforce Performance. Component Installation Order 1 Cognos ReportNet installation - Workforce Performance (part 1) 2 Database 3 Application Server 4 Job Scheduler 5 Gateway 6 Workforce Performance (part 2) 7 Clock Server 8 Virtual Clock 9 Admin Console Location of Installation Log Files The following table lists the various log files that are generated during the Business Edition installation process. You can use these as a first step in diagnosing any problems that might occur during the installation process. All logs can be packaged together in a common directory by clicking Package Logs from the Installation Summary installation panel. Common log files fresh_installer.<time stamp>.log fresh_installer_ia.log fresh_installer_ia_stdout.log user.properties Database log files The main installer log. The error log generated by InstallAnywhere. The InstallAnywhere standard output log. This log records user input during the installation. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

21 Troubleshooting <db name>_gen_createdb.<time stamp>.txt This log records database generation and creation scripts. <db name>_01_crdb.<time stamp>.txt dataload_<time stamp>.log locview.<time stamp>.log schema_compare.<time stamp>.log <db name>_03_crfk.<time stamp>.txt Application Server log files WebLogic_Domain_Creation.<time stamp>.log WebLogic_EAR_Deployment.<time stamp>.log WFM_Admin_uninstall_service_<time stamp>.log WFM_Admin_install_service_<time stamp>.log WFM_Server_uninstall_service_<time stamp>.log WFM_Server_install_service_<time stamp>.log WFM_Admin.stdout WFM_Server.stdout This log records database creation scripts. The dataload log. The localize views log. The schema compare log generated if a schema compare is performed. This log records foreign keys created during the installation. This log records BEA Weblogic domain creation. This log records Business Edition EAR deployment log. This log records administrative server uninstallation events. It is generated if an existing service with the same name exits. This log records administrative server installation events. This log records managed server uninstallation events. It is generated if an existing service with the same name exits. This log records managed server installation events. The administrative server standard out log. The managed server standard out log Workforce Performance log files <db name>_gen_createdb.<time stamp>.txt This log records Cognos ReportNet generation and creation scripts. importcrn.log This log records imported Cognos reports. startcrn.log This log records when the Cognos server starts. Job Scheduler log files scheduler.log Gateway log files wbmail.log Virtual Clock log files: wbcs-vc_setup_windows.properties The standard Job Scheduler log. The standard Gateway log. This is the properties file passed when the Virtual Clock is installed. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

22 Troubleshooting Clock Server log files: wbcs_setup_windows_express.properties This is the properties file passed when the Clock Server is installed. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

23 Uninstalling Business Edition Uninstalling Business Edition The following procedures allow you to uninstall an instance of the Workforce Management Business Edition application. You can only uninstall a Business Edition instance by uninstalling each component separately. Remove Registry Keys from the Windows Registry. For each component that you want to uninstall, be sure to remove the corresponding registry key from the Windows registry. To do this: 1 Open the Registry Editor (Click Start, click Run, type regedit, and then click OK). 2 Go to HKEY_LOCAL_MACHINE\SOFTWARE\Infor\WFM. 3 Click on the folder labelled with the name of the component. 4 Click on the child folder. This is the registry key for the component, e.g. Virtual Clock2. a Before you delete the registry key, be sure to note down the location string located in the registry key. The location string tells you where the files related to the component are stored on your hard-drive. After you delete the registry key (in step #5), you will be able to delete the folder containing the component files off your hard-drive. Note It is normal for the registry to contain multiple registry keys for each component. Only one registry key per component will contain information. this is the key that you want to delete. The extra registry keys are created for verification reasons during installation. 5 Delete the registry key of the component you want to uninstall. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

24 Uninstalling Business Edition 6 In your Windows directory, go to the location saved in the location string (see step 4a), and delete the folder containing the component files. To continue with the uninstallation process, follow the following procedures outlined for each component: Database Component: 1 Shut down the Job Scheduler, Gateway, Report Net, Admin Server and Managed Server services. 2 Access the server that hosts the Application Database and drop the application database using the SQL Server Management Studio. Application Server: 1 Shut down Application Server Managed Server and Admin Server services. 2 Go to the directory chosen for the Domain Home during installation. 3 Delete the WFM_DOMAIN_### directory (where ### is the port number of the Managed Server). 4 Run the following batch script to delete the services - substitute in the values as ********************************************************************* This script is used to uninstall Weblogic as a This script sets the following variables before WebLogic Server as a WL_HOME - The root directory of your WebLogic DOMAIN_NAME - The name of your Infor HCM WFM WebLogic SERVER_NAME - The name of the server who's service will be ********************************************************************* **** WL_HOME - Weblogic Home, ie: DOMAIN_NAME - The name of domain, ie: WFM_DOMAIN_### where ### is the managed port set WL_HOME=<enter value> set DOMAIN_NAME=<enter *** Uninstall the service "%WL_HOME%\server\bin\beasvc" -remove -svcname:"infor HCM WFM %DOMAIN_NAME% WFM_Admin" "%WL_HOME%\server\bin\beasvc" -remove -svcname:"infor HCM WFM %DOMAIN_NAME% WFM_Server" Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

25 Uninstalling Business Edition :finish ENDLOCAL Job Scheduler: 1 Close the Job Scheduler window. 2 Delete the contents of the installation folder. Gateway: 1 Close the Gateway window. 2 Delete the contents of the installation folder. Workforce Performance: 1 Shut down the ReportNet Service. 2 Access the Cognos ReportNet program group and select the Uninstall option, and proceed with uninstallation. 3 Delete the Cognos ReportNet installation folder. 4 Access the Server that hosts the Content Store database and drop the content store. 5 Delete the crnadmin database login. Clock Server: 1 Shut down Clock Server service. 2 Go to the installation directory and run \UninstallerData\Uninstall Workbrain Clock Server.exe. Virtual Clock: 1 Close the Virtual Clock window. 2 Go to the installation directory and run \UninstallerData\Uninstall Workbrain Virtual Clock.exe. Admin Console: 1 Close the Admin Console window. 2 Go to the installation directory and run \UninstallerData\Uninstall Workbrain Admin Console.exe. Confidential and Proprietary Copyright 2008 Infor. All rights reserved.

26 Appendix: Technical Reference Sheet Appendix: Technical Reference Sheet Print out this page and have the following information ready before you initiate the installation of Business Edition. JRE Directory WebLogic Home Directory Apache Directory MS SQL Server Admin User Name MS SQL Server Admin Password Database Server Name Database Server Port Number Confidential and Proprietary Copyright 2008 Infor. All rights reserved.