DEPLOYING EMC DOCUMENTUM BUSINESS ACTIVITY MONITOR SERVER ON IBM WEBSPHERE APPLICATION SERVER CLUSTER

Transcription

1 White Paper DEPLOYING EMC DOCUMENTUM BUSINESS ACTIVITY MONITOR SERVER ON IBM WEBSPHERE APPLICATION SERVER CLUSTER Abstract This white paper describes the process of deploying EMC Documentum Business Activity Monitor (BAM) on a clustered setup of the IBM WebSphere Application Server (WAS). This paper also helps users to install WAS, configure WAS clusters, configure HTTP Server, and install the Documentum BAM server in a cluster setup. June 2011

2 Copyright 2011 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. VMware is a registered trademark of VMware, Inc. All other trademarks used herein are the property of their respective owners. Part Number : h8260 2

3 Table of Contents About this document... 4 Audience...4 Introduction...4 Installing and configuring IBM WebSphere Application Server Network Deployment Installing WebSphere Application Server Network Deployment Creating application server profiles...15 Installing the IBM Update Installer for IBM WebSphere Application Server and applying Fix Pack 9 on WebSphere Application Server...26 Installing IBM HTTP Server Updating IBM HTTP Server by applying Fix Pack Installing the IBM HTTP Server Plug-in for WebSphere Application Server...50 Adding nodes to the Deployment Manager Profile...55 Creating a cluster...57 Integrating IBM HTTP Server to the cluster environment...62 Verifying cluster setup using the default application Installing the Business Activity Monitor WAR file in a cluster setup High-availability, failover, and load balance...76 Configuring the Business Activity Monitor server to work in a cluster...76 Retaining the 6.5 SP2 BAM server in the waiting state...76 Configuring BAM in a sticky session of IBM WebSphere Application Server...76 Configuring the IBM WebSphere Application Server for BAM...77 Configuring the class loading strategy for the BAM server...91 Deploying BAM server 6.5 SP Conclusion References

4 About this document This white paper outlines the ideal way to successfully install the IBM WebSphere Application Server (WAS) and EMC Documentum Business Activity Monitor server in a clustered environment. In addition, this document describes the process of configuring IBM WAS with the Documentum Business Activity Monitor server to enable high availability and load balancing. This white paper describes the installation and configuration processes on a single machine. Since the volume of incoming requests is high in a production environment, the load can be handled in an efficient manner if the web application is deployed in a clustered environment. Audience This white paper is intended for administrators and developers who deploy the Documentum Business Activity Monitor server on the IBM WebSphere Application Server in a clustered environment. This document contains step-by-step procedures to install and configure the WAS cluster, install and configure IBM HTTP Server, and deploy and configure the Business Activity Monitor server in a clustered environment to achieve high availability and load balancing. Introduction Documentum Business Activity Monitor (BAM) collects and stores process execution data, prepares the data for reporting, and provides a real-time dashboard display environment. The Business Activity Monitor component Process Reporting Services (PRS) is a tool for generating and formatting reports and alerts displayed in the dashboard. This white paper discusses how high availability and load balancing are achieved in BAM if IBM WebSphere Application Server 7.0 is installed and configured in a clustered environment. The process of installing and configuring IBM WebSphere Application Server 7.0 on a single machine in a clustered environment includes the following steps: Installing IBM WebSphere Application Server Network Deployment 7.0 Installing IBM Update Installer for WebSphere Installing IBM HTTP Server Configuring IBM WebSphere Application Server in a cluster Deploying and configuring Documentum Business Activity Monitor in a cluster 4

5 Installing and configuring IBM WebSphere Application Server Network Deployment 7.0 This section describes the process of configuring a cluster on a single computer. The following components are installed on a single computer: Deployment manager Application server instance 1 Application server instance 2 IBM HTTP Server However, you can also use multiple computers to configure the cluster. Later, you can choose to install the components on separate computers. You must perform the following tasks to configure the IBM WebSphere cluster: 1. Install IBM WebSphere Application Server Network Deployment Create application server profiles 3. Install the IBM Update Installer for IBM WebSphere Run the IBM Update Installer and apply Fix Pack 9 on IBM WebSphere Application Server 5. Install IBM HTTP Server Update IBM HTTP Server by applying Fix Pack 9 7. Install the IBM HTTP Server Plug-in for WebSphere Application Server Note: Ensure that all IBM software installed on the computer is of the same version ( ). Installing WebSphere Application Server Network Deployment 7.0 This section lists the instructions to install WebSphere Application Server. To install WebSphere Application Server: 1. Download C1G2GML.zip and extract its contents to a temporary location. 2. Run the WebSphere Application Server installer (launchpad.exe) from the temporary location. The Welcome page appears. 5

6 3. Click the Launch the Installation Wizard for WebSphere Application Server Network Deployment link. The Welcome screen of the IBM WebSphere Application Server Network Deployment installation wizard appears. 6

7 4. Click Next. The Software License Agreement screen appears. 5. Select the I accept both the IBM and the non-ibm terms option and click Next. The System Prerequisites Check screen appears. 7

8 6. Click Next. The Optional Features screen appears. 8

9 7. Select the Install the Sample applications checkbox and click Next. The Installation Directory screen appears. 8. Accept the default location and click Next. The WebSphere Application Server environment page appears. 9

10 9. Select Management from the Environments list and click Next. The Server Type Selection screen appears. 10

11 10. Select the Deployment manager option and click Next. The Enable Administrative Security screen appears. 11. Clear the checkbox for Enable administrative security and click Next. The Repository for Centralized Installation Managers screen appears. 11

12 12. Click Next. The Installation Summary screen appears. 12

13 13. Review the information and click Next. 13

14 14. The installation is performed and after completion, the Installation Results screen appears. 14

15 15. Click Finish. Creating application server profiles You can now create application server profiles. To create application server profiles: 1. After installing the application server, the First steps screen appears. 2. Click the Profile Management tool link. The Profile Management Tool 7.0 window appears. 15

16 3. Click Launch Profile Management Tool. The Profiles tab appears. 4. Click Create. The Environment Selection screen of the wizard that creates runtime environments appears. 16

17 5. Select Application server under WebSphere Application Server, and click Next. The Profile Creation Options screen appears. 17

18 6. Select the Typical profile creation option and click Next. The Administrative Security screen appears. 18

19 7. Clear the Enable administrative security checkbox and click Next. The Profile Creation Summary screen appears. 19

20 8. Review the summary and click Create. The Profile creation process starts. 20

21 9. The Profile Creation Complete screen appears after successful creation of the profile. 21

22 10. Clear the Launch the First Step console checkbox and click Finish. The Profiles tab listing the new profile appears. 11. Repeat Steps 4 through 7 to create additional profiles. After creating all profiles the Profile Creation Summary screen appears. 22

23 12. Click Create. The Profile Creation Progress screen appears. 23

24 When the profile is created the Profile Creation Complete page appears. 24

25 13. Clear the Launch the First step console checkbox and click Finish. 25

26 Installing the IBM Update Installer for IBM WebSphere Application Server and applying Fix Pack 9 on WebSphere Application Server You must install the IBM Update Installer for WebSphere and then run the update installer to install Fix Pack 9 on WebSphere Application Server Download and copy the WS-WAS-WinX32-FP pak file into the temp directory. Note: Ensure that none of the IBM software is running while installing the Fix pack. To install the IBM Update Installer for WebSphere and apply Fix Pack 9: 1. Download WS-UPDI-WinIA32 and extract its contents to a temporary location. 2. Run the Update installer (Install.exe) from the <temporary location>/ ws- UPDI-WinIA32/updateInstaller. The Installation Wizard appears. Note: Stop all IBM software before you install the update installer. 3. Click Next. The Software License Agreement screen appears. 26

27 4. Select the I accept both the IBM and the non-ibm terms option and click Next. 5. Click Next. The Installation Directory screen appears. 27

28 6. Click Next. The Installation Summary screen appears. 7. Review the summary and click Next. The installation starts. 28

29 When the installation is completed the Installation Complete screen appears. 29

30 8. Select the Launch IBM Update Installer for WebSphere Software on exit checkbox, and click Finish. 9. Click Next. The Product Selection page appears. Next, you can apply Fix Pack 9 on IBM WebSphere Application Server. Note: Ensure that none of the IBM software is running while installing the Fix Pack. 30

31 10. Ensure that you specify the correct WebSphere installation root in the Directory path field. 11. Click Next. The Maintenance Operation Selection screen appears. 31

32 12. Select the Install maintenance package option and click Next. The Maintenance Package Directory Selection screen appears. 13. Click Browse and select the temp directory where the downloaded WS-WAS- WinX32-FP pak fix pack file is available and click Next. The Available Maintenance Package to Install screen appears. 32

33 14. Select the patch version and click Next. The Installation Summary screen appears. 15. Verify the installation summary and click Next. The installation process starts. 33

34 After completion of the installation, the Installation Complete screen appears. 16. Click Finish. 34

35 Installing IBM HTTP Server 7.0 You can now install IBM HTTP Server 7.0. To install IBM HTTP Server 7.0: 1. Download the HTTP Server 7.0 Installer (C1G2HML.zip) and unzip the contents into the temp folder. 2. Run the HTTP Server 7.0 installer (launchpad.exe) from the temporary location. The Welcome page appears. 3. Click the Launch the installation wizard for IBM HTTP Server link. The Welcome screen of the wizard appears. 35

36 4. Click Next. The Software License Agreement screen appears. 36

37 5. Select the I accept both the IBM and the non-ibm terms option and click Next. The System Prerequisites Check screen appears. 6. Click Next. The Enter the installation location screen appears. 37

38 7. Accept the default product installation path and click Next. (You can modify the path.) 8. Click Next. The Port Values Assignment screen appears. 9. Review the default port values. Ensure that the port numbers are unique and do not conflict with other services running on this host machine. 10. Click Next. The Windows Service Definition page appears. 38

39 11. Select the Log on as a specified user account option. 12. Provide User name and Password details. 13. Click Next. The HTTP Administration Server Authentication screen appears. 39

40 14. Select the Create a user ID for IBM HTTP Server administration server authentication checkbox. 15. Provide the User ID and Password details and click Next. The IBM HTTP Server Plug-in for IBM WebSphere Application Server screen appears. 40

41 16. Select the Install the IBM HTTP Server Plug-in for IBM WebSphere Application Server checkbox. 17. In the Web server definition field, specify the definition of the HTTP Server instance you installed. 18. In the Host name or IP address for the Application Server field specify the host name and IP address of the application server. 19. Click Next. The Installation summary page appears. 41

42 20. Verify the installation summary and click Next. The installation process starts. 42

43 After the installation is completed, the wizard indicates that IBM HTTP Server is successfully installed. 43

44 21. Click Finish. Updating IBM HTTP Server by applying Fix Pack 9 Next, you can apply Fix Pack 9 to update IBM HTTP Server. To apply Fix Pack 9 to update the IBM HTTP Server: 1. Download and copy the WS-IHS-WinX32-FP pak file into the temp directory. Note: Ensure that none of the IBM software is running while installing the Fix Pack. 2. Launch the Update Installer. The Welcome screen of the IBM Update Installer for WebSphere Software wizard appears. 44

45 3. Click Next. The Product Selection screen appears. 45

46 4. Select the path where HTTP Server is installed and click Next. The Maintenance Operation Selection screen appears. 5. Select the Install maintenance package option and click Next. The Maintenance Package Directory Selection screen appears. 46

47 6. Select the temp folder where you downloaded the Fix Pack, and click Next. The Available Maintenance Package to Install screen appears. 47

48 7. Select the WS-IHS-WinX32-FP pak option to install the package for IBM HTTP Server. 8. Click Next. The Installation Summary page appears. 9. Verify the installation summary and click Next. The installation process starts. 48

49 After the installation process is completed, the Installation Complete screen appears. 49

50 10. Click Finish. Installing the IBM HTTP Server Plug-in for WebSphere Application Server Next, you can install the IBM HTTP Server Plug-in for WebSphere Application Server. To install the IBM HTTP Server Plug-in for WebSphere Application Server: 1. Download and copy the WS-PLG-WinX32-FP pak file into the temp directory. Note: Ensure that none of the IBM software is running while installing the Fix Pack. 2. Launch the Update Installer. The Welcome screen of the IBM Update Installer for WebSphere Software wizard appears. 3. Click Next. The Product Selection screen appears. 50

51 4. Accept the default installation path and click Next. The Maintenance Operation Selection screen appears. 51

52 5. Select the Install maintenance package option and click Next. The Maintenance Package Directory Selection screen appears. 6. Click Browse to select the temp folder where the plug-in file is available and click Next. The Available Maintenance Package to Install screen appears. 52

53 7. Select the WS-PLG-WinX32-FP pak checkbox to install the package for the IBM HTTP Server Plug-in. 8. Click Next. The Installation Summary page appears. 53

54 9. Verify the installation summary and click Next. The installation process starts. When the installation is completed, the Installation Complete screen appears. 54

55 10. Verify and click Finish. Adding nodes to the Deployment Manager Profile Follow the instructions provided in this section to add nodes to the Deployment Manager Profile. To add nodes to the Deployment Manager Profile: 1. Start the Deployment Manager. 2. Browse to the following path where Application Server instance 1 is installed: C:\Program Files\IBM\WebSphere\AppServer1\profiles\AppSrv01\bin 3. Execute the following command at the command prompt to add a new node to Deployment Manager profile 1: addnode <Dmgr host> <port> Example: addnode localhost Browse to the following path where Application Server instance 2 is installed: C:\Program Files\IBM\WebSphere\AppServer1\profiles\AppSrv02\bin 5. Execute the following command at the command prompt to add a new node to Deployment Manager profile 2: addnode <Dmgr host> <port> Example: addnode localhost Access the admin console of the Deployment Manager using the following URL: 55

56 7. Navigate to the System Administration node agent and verify whether the node agents have started. 56

57 8. Navigate to the System Administration node and verify whether the status of all nodes is Green. Creating a cluster This section provides instructions to create a cluster. To create a cluster: 1. Start the IBM WebSphere Application Server. 2. Access the following URL and log in to the IBM WebSphere Application Server administrative console. 3. In the Servers node double-click the Clusters node. The WebSphere application server clusters page appears. 4. Click New. The Enter basic cluster information page for the new cluster appears. 57

58 5. Enter the Cluster name and click Next. The Create first cluster member page appears. 6. Enter clone01 as the Member name and select Node Select the Generate unique HTTP ports checkbox. 58

59 8. Click Next. The Create additional cluster members page appears. 9. Enter the second Cluster Member name as Clone02 and select Node Select the Generate unique HTTP ports checkbox. 11. Click Add Member to add the additional cluster member to the Members list. 59

60 12. Click Next. The Summary page appears. 60

61 13. Click Finish. 14. Click the Save link in the Messages area. 61

62 Integrating IBM HTTP Server to the cluster environment You must integrate IBM HTTP Server to the cluster environment to delegate incoming requests from the client to the available application server instances. To integrate IBM HTTP Server to the cluster environment: 1. In the Deployment Manager Administrator Console, expand the Servers node and access the Application Servers node. 2. Select the Web servers node and click New in the Web servers page. 62

63 3. Enter the Server name and click Next. 4. Select the IHS template, and click Next. 5. Click Next. 63

64 6. Verify the summary of actions, and click Finish to confirm the creation of the Web server. 7. Click the Save link in the Messages area. 64

65 The new Web server is listed in the Web servers page. 8. Select the checkbox next to the new Web server and click Generate Plug-in. 65

66 9. Select the checkbox next to the new Web server and click Propagate Plug-in. 10. Select the checkbox next to the new Web server and click Start. 66

67 Verifying cluster setup using the default application You must install the default application provided by IBM and access it to verify whether the cluster setup is successful. To verify the cluster setup: 1. Expand the Clusters node and click the WebSphere application server clusters link in the left pane. 2. Select the checkbox next to the cluster and click Start. 3. Start HTTP Server. 67

68 4. Locate the Default application war file available here: <IBM Installed floder>\websphere\appserver\installableapps\defaultapplication.ear 5. Expand the Applications and Application Types nodes, and click WebSphere enterprise applications, and click Install. 6. Select the Local file system option and specify the default path of the application located, which is as follows: C:\Program Files\IBM\WebSphere\AppServer\installableApps\DefaultApplication.ear 7. Click Next. 68

69 8. Select the Fast Path option and click Next. 69

70 9. Select the Precompile JavaServer Pages files option and click Next. 10. Select cluster1 and webserver1 and select the Default Web Application map module, and click Apply. 11. Click Next. 70

71 12. Click Finish. The installation process starts. 71

72 13. Click the Save link. 72

73 14. Select the checkbox DefaultApplication and click Start. 15. Verify that the application is running without error. 73

74 16. Access the following URL and verify the local port: 74

75 17. Refresh the page and check the local port. Installing the Business Activity Monitor WAR file in a cluster setup The BAM server is deployed on two nodes. However, the BAM server is passive (deactivated) on one of the nodes. The BAM cluster can work only in a sticky session configuration. 75

76 High-availability, failover, and load balance High-availability clusters (also known as HA Clusters or Failover Clusters) are web clusters that use load balancing to send requests to available servers. If a server fails, it is automatically removed from the available server s pool and your requests are sent to servers capable of serving your request. Load balancing is achieved by sharing applications load between multiple servers to decrease the needed resources on each server, and improve the performance for end users. Configuring the Business Activity Monitor server to work in a cluster You must perform the following tasks to configure high availability and load balancing on the BAM server: Retaining the 6.5 SP2 BAM server in the waiting state Configuring BAM in a sticky session of IBM WebSphere Application Server Retaining the 6.5 SP2 BAM server in the waiting state Access one of the BAM servers, and modify the value of the <activateonstartup> parameter to false in the env-config.xml, to pause the server. Note: This setting is valid for the 6.5SP2 release only. However, in later versions of BAM (post 6.5 SP2), a special automatic mechanism checks whether the other BAM server is running on the same database. At startup, the BAM server must identify if the other server is running on the same database. In this case, the server that was last started does not execute its logic and remains in the waiting state. Configuring BAM in a sticky session of IBM WebSphere Application Server Only one BAM server can work with the database that the BAM server must configure to run in a sticky session. The sticky session provides uninterrupted access to the reports functionality. The sticky_session property specifies the cluster behavior for HTTP sessions. Each request is load balanced between node1 and node2. However, when a user opens a session on one server, it is recommended to always forward this user's requests to the same server. This is called a "sticky session," since the client always uses the same server the user reached on the first request. Otherwise, the user's session data must be synchronized between both servers. Perform the steps provided in this section to configure the IBM WebSphere Application Server for BAM in a sticky session. To configure BAM in a sticky session of IBM WebSphere Application Server: 1. Navigate to the following location: <IBM Installed Directory>\HTTPServer\Plugins\config\webserver1 76

77 2. Edit the plugin-cfg.xml file as follows: <ServerCluster CloneSeparatorChange="false" GetDWLMTable="false" IgnoreAffinityRequests="false" LoadBalance=" Random" Name="cluser1" PostBufferSize="64" PostSizeLimit="-1" RemoveSpecialHeaders="true" RetryInterval="60"> Configuring the IBM WebSphere Application Server for BAM The IBM WebSphere Application Server must be configured before you deploy the BAM application. The configuration process involves copying files in the WebSphere directory. Use the WebSphere Application Server Administration Console to deploy the BAM application. Note: (Relevant only to 6.6 and 6.7) Before you deploy the BAM server on IBM WebSphere version x, you must replace the jaxen-full.jar available in the bamserver.war/web-inf/lib folder with the jaxen-full.jar file available in the bam-productsupplemental_files.zip/websphere/ /required jars folder. Ensure that you replace this file prior to repacking the bam-server.war file. Follow the instructions provided in this section to configure the IBM WebSphere Application Server before you deploy the BAM application on it. To configure the IBM WebSphere Application Server: 1. Change the directory to [WebSphere root]/optionallibraries. 2. Create the BAM folder. 3. Copy the following jar files to the BAM directory: [Temporary WAR location]\bam server.war\web-inf\lib\aspectjrt.jar [Temporary WAR location]\bam server.war\web-inf\lib\saaj-api.jar [Temporary WAR location]\bam server.war\web-inf\lib\saaj-impl.jar [Temporary BAM setup folder]\bam Server\WebSphere\Required JARs\xalan.jar and xercesimpl.jar 4. In the WebSphere Administration Console, select Environment > Shared Libraries. 5. In the Scope drop-down list, select Cell=Cell_Name. 6. Perform the following steps to create a shared library for each jar file you copied: a. Select New. b. Type the library name. c. In the Classpath field type ${WAS_INSTALL_ROOT}/optionalLibraries/BAM/[jar_name]. d. Select Apply and Save. 7. Download the Business Activity Monitor (bam-server.war) file from the ftp site. 8. Save the bam-server.war file in the temp folder. 77

78 9. Open the WebSphere Application Server Administration Console to access the Deployment Manager. 10. Expand Applications and Application Types, and click WebSphere enterprise applications. 11. Click Install. 12. Select the Local file system option and click Browse to select the bam-server.war file, and click Next. 78

79 13. Select the Detailed Show all installation options and parameters option and click Next. 14. Click Continue. 79

80 15. Select the Precompile JavaServer Pages files checkbox and perform the following steps: a. Enter the application name as bam-server. b. Select the Deploy Web services checkbox. c. Click Next. 80

81 16. Select the checkbox next to the bam-server module and select cluser1 and webserver Click Apply. 18. Click Next. 81

82 19. Click Next. 82

88 25. Specify bam-server as the Context Root and click Next. 88

90 27. Click Finish. 90

91 28. Click the Save link. Configuring the class loading strategy for the BAM server Perform the steps listed in this section to configure the class loading strategy for the BAM server. To configure the class loading strategy for the BAM server: 1. In the left pane, expand the Applications node, and click WebSphere enterprise applications. The Enterprise Applications page appears. 2. Select the checkbox next to the bam-server application. 91

92 3. Click the bam-server link. 4. In the General Properties page, click the Class loading and update detection link. 5. Specify 120 seconds in the Polling interval for updated files field. 6. Select the Classes loaded with local class loader first (parent last) option as the Class loader order. This option is the same as the Classes loaded with application class loader first option available in earlier versions of IBM WebSphere Application Server. 92

93 7. Click OK. The next page displays a message indicating that the changes have been made to your local configuration. 8. Click Save to save the local configuration changes to the master configuration. 9. On the Enterprise Applications page, select the bam-server application. 93

94 10. Click the Shared library references link. 11. Select the checkbox next to the bam-server application and click Reference shared libraries. 94

95 12. Move all libraries created in Step 6 of the Configuring the IBM WebSphere Application Server for BAM section from the Available list to the Selected list. The Selected list displays all libraries. 95

96 13. Click OK. The changes are saved to your local configuration. 14. Click OK and Save. Deploying BAM server 6.5 SP2 Perform the steps provided in this section to deploy BAM server 6.5 SP2. To deploy BAM server 6.5 SP2: 1. The BAM server is deployed on two nodes. Modify the env-config.xml file on one of the nodes by changing the value of the activateonstartup parameter to false. 2. Navigate to the following location: 96

97 <IBM Installed Directory> \WebSphere\AppServer\profiles\AppSrv01\installedApps\TCMQAW2K3ORA040C ell01\bam-server.ear\bam-server.war\web-inf\classes\config 3. Edit the env-config.xml file as follows: <activateonstartup>false</activateonstartup> 4. In the Enterprise Applications page, select the checkbox next to the bam-server application and click Start. 5. Access the following URLs: a. <App Server 01 host> : <http port>/bam-server Example: b. <App Server 02 host> : <http port>/bam-server Example: 97

98 c. <HTTP Server host> : <http port>/bam-server Example: Conclusion This white paper provides detailed steps to perform the following tasks: Create a IBM WebSphere Application Server Network Deployment clustered setup Deploy Documentum Business Activity Monitor on the cluster Configure the Business Activity Monitor server to work in the IBM WebSphere cluster environment. References The following web resources provide additional information: To plan the installation bm.websphere.nd.doc/info/ae/ae/crun_srvgrp.html To balance workloads with clusters bm.websphere.nd.doc/info/ae/ae/crun_srvgrp.html Web server configuration bm.websphere.nd.doc/info/ae/ae/cins_webserver.html Load balancing and high-availability o Recommended values for Web server plug-in config : 01.ibm.com/support/docview.wss?uid=swg o 98