EMC Documentum Business Activity Monitor

Transcription

1 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide P/N A03 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published November 2008 EMC believes the information in this publication is accurate as 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. All other trademarks used herein are the property of their respective owners.

3 Table of Contents Preface... 7 Chapter 1 Overview of Business Activity Monitor BAM server setup scenarios Important recommendation for users Prerequisites to install or deploy the BAM server Next steps Downloading the BAM product installation files Installing or deploying the BAM server Installing the Process Reporting Services Client and Crystal Reports Installing the preconfigured dashboard Chapter 2 Creating the Database System requirements Steps to install the BAM database Creating the Microsoft SQL Server database Creating the Oracle database Creating the DB2 database Troubleshooting the DB2 database Gap filler fails to start when DB2 database is used as a BAM database (164308) Sizing the database Chapter 3 Installing the BAM Server Using the BAM Installer Installing the BAM server Starting and stopping the JBoss application server Post installation guidelines Troubleshooting BAM server installation BAM Engine installer displays the connection error message BAM Engine installer fails on the Windows platform (166194) Chapter 4 Deploying the BAM Server (manual installation) Business Activity Monitor server system requirements Additional requirements Tasks to perform before deploying the BAM server Common initial steps for deploying the BAM server Creating a repository and database objects manually Updating configuration files for BAM Continuing the deployment of the BAM server Deploying the BAM server on the JBoss application server Deploying the BAM server on the Tomcat application server EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 3

4 Table of Contents Deploying the BAM server on the WebLogic application server Deploying the BAM server on the WebSphere application server Configuring the WebSphere application server Deploying the BAM server on the WebSphere application server Post deployment guidelines Chapter 5 Configuring Business Activity Monitor Configuring connection settings Activating process monitoring Chapter 6 Installing the Process Reporting Services PRS Client system requirements Installing PRS Client and Crystal Reports I18N Notes Chapter 7 Installing the Preconfigured Dashboard Prerequisites for installing the preconfigured dashboard Installing the preconfigured dashboard EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

5 Table of Contents List of Tables Table 1. Business Activity Monitor database requirements Table 2. Additional System Requirements for BAM Table 3. Microsoft SQL Server Parameters Table 4. Oracle Parameters Table 5. DB2 Parameters Table 6. Business Activity Monitoring server system requirements Table 7. BAM database connection parameters and values Table 8. PRS Client System Requirements EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 5

6 Table of Contents 6 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

7 Preface Purpose of the manual This manual contains information and instructions required to create a Business Activity Monitor (BAM) database on Oracle, MS SQL, or DB2. It also includes instructions to install the BAM server on Content Server with the JBoss application server in a Windows environment, deploy the BAM server on a Red Hat JBoss, Apache Tomcat, BEA WebLogic, or IBM WebSphere application server that runs on a separate machine, install the Process Reporting Services Client application, and install the preconfigured dashboard. It describes decisions you must make and requirements that must be met before you install the product. Intended audience This manual is intended for the person installing or deploying the BAM software that includes the BAM server and the Process Reporting Services Client. Typically, a system administrator installs the software. Documentation conventions This guide uses the following conventions: Convention Description > The angle bracket is used to separate menu options in a progression of menu choices the user must select in a graphical user interface (GUI). For example, File > Save As means, select the File menu and then choose the Save As option. code user interface label All sample code is represented in Courier New font. Bold and small text is used to represent a user interface label. For example, menus, buttons, and pages. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 7

8 Preface Convention Description [ ] Square brackets are used to enclose one or more variables for which you can substitute a value. { } Curly brackets are used to enclose at least one required item. /foldername_or_filename Bold text separated by the forward slash is used to represent the name of a file or file path. Note: The forward slash (/) in this notation has exactly the same meaning as a backslash (\) in the names of Windows files and paths. < > Angle brackets are used to enclose a variable name for which you must provide a value. % % Percentage characters are used in the Windows environment to enclose a variable or directory to obtain the value of the variable or directory. ${ } Curly brackets preceded by the $ sign are used in the UNIX environment to enclose a variable or directory to obtain the value of the variable or directory. Revision history This section contains a description of this document s revision history. Revision history Revision Date July 2008 Description Initial Publication 8 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

9 Preface Revision Date August 2008 November 2008 Description The Guide has been updated for clarity. Updated content in the following tables: Business Activity Monitor database requirements table and the Business Activity Monitoring application server system requirements table in the Deploying the BAM Server (manual installation) chapter, and the PRS Client system requirements table in the Installing the Process Reporting Services chapter. Added the last item in the Prerequisites to install or deploy the BAM server list in the Overview of Business Activity Monitor chapter. Added Troubleshooting sections in the Creating the Database chapter and the Installing the BAM Server Using the BAM Installer chapter. Added the procedure to configure the Tomcat application server in the Deploying the BAM Server (manual installation) chapter. Added a new chapter called Configuring Business Activity Monitor. Added the To install the PRS Client procedure to the Installing the Process Reporting Services chapter. Updated the Installing the preconfigured dashboard section in the Installing the Preconfigured Dashboard chapter. Support Information EMC Documentum s technical support services and policies are available at the EMC Powerlink website ( To download the Customer Guide to EMC Software Support Services from Powerlink, select Support > Request Support > Software Customer Guide and Offerings. Note: You must register online at Powerlink before using it. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 9

10 Preface Related documentation This manual forms part of a documentation suite designed to support those who install, configure, and use Business Activity Monitor. In addition to this manual, the documentation set for Business Activity Monitor includes: Documentum Content Server Installation Guide, version 6.5 (P/N ) Documentum Business Activity Monitor Implementation Guide, version 6.5 (P/N ) Documentum Business Activity Monitor Release Notes, version 6.5 (P/N ) Documentum Administrator Deployment Guide, version 6.5 (P/N ) Documentum Process Builder Installation Guide, version 6.5 (P/N ) Documentum Forms Builder Installation Guide, version 6.5 (P/N ) Documentum Process Engine Installation Guide, version 6.5 (P/N ) Documentum TaskSpace Deployment Guide, version 6.5 (P/N ) Documentum Composer User Guide, version 6.5 (P/N ) You can go to the Documentation area of the EMC Powerlink website ( to download product documentation. To locate product documentation, select Support > Technical Documentation and Advisories > Software ~ D ~ Documentation > Documentum <First letter of your product>. Select your product and click the software version number in the Left pane of the page that is displayed. 10 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

11 Chapter 1 Overview of Business Activity Monitor Business Activity Monitor (BAM) collects and stores process execution data, prepares it for reporting, and provides a real time dashboard display environment. Another component of Business Activity Monitor is Process Reporting Services (PRS), a tool used for generating and formatting reports and alerts displayed in the dashboard. BAM enables organizations to detect problem conditions that may exist in executing processes, to diagnose these problems to determine their root cause, and to correct them. It also provides valuable historical information about process execution to enable long term process improvement. This chapter provides an overview of Business Activity Monitor (BAM), Process Reporting Services (PRS), BAM server installation scenarios, and the BAM architecture. In addition, this chapter lists the prerequisites for preparing the Documentum environment before installing the BAM server. Lastly, this chapter briefly lists the tasks that must be performed after installing the prerequisites. BAM server setup scenarios The BAM server is a JAVA web application. There are two ways of setting up the BAM server on an application server. If you work on Content Server with the JBoss application server in a Windows environment, you can run the BAM server installer to install the BAM server on the same machine as the Content Server. In this scenario, the installer automatically updates the BAM configuration files, updates the repository, creates the BAM database tables, deploys the BAM server, and installs the preconfigured dashboard DAR. Alternatively, if you choose to install the BAM server on a machine where JBoss, Tomcat, WebLogic, or WebSphere application server is installed, you must manually create the BAM database, create the BAM objects in the repository, update the BAM configuration files, deploy the BAM server on the application server, install the PRS Client, and install the preconfigured dashboard DAR. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 11

12 Overview of Business Activity Monitor Important recommendation for users Prior to installing or deploying the BAM server, it is recommended that users installing BAM, have a general understanding of the following Documentum Knowledge products: Content Server Composer Process suite Prerequisites to install or deploy the BAM server This section lists the prerequisites to prepare the Documentum environment for installing or deploying the BAM server. For every installation, log on to the operating system with a user account that has administrative rights on the operating system, such as the Administrator user. You must ensure that you install the following products and a database: 1. Content Server Documentum Administrator Process Builder Forms Builder Process Engine 6.5. Note: Ensure that the Process Engine is installed before you install the TaskSpace DAR. 6. TaskSpace 6.5. Note: Ensure that TaskSpace is installed using the DAR and not the DocApp. 7. Prepare a database instance and size it before you install the BAM server. Note: The Release Notes document of the various Documentum products, contains a complete list of Environment and System Requirements. For more information, see the Release Notes document of the relevant product. 12 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

13 Overview of Business Activity Monitor Next steps This section lists the following tasks that you must perform after preparing the Documentum environment: 1. Download the BAM product installation files. 2. Install a database, create a database user, grant appropriate access rights to the database user, and size the database. You can install an MS SQL, Oracle, or DB2 database. For instructions see, Creating the MS SQL database, Creating the Oracle database, or Creating the DB2 database. For information about database sizing, see Sizing the database. 3. Install or deploy the BAM server. 4. Install the Process Reporting Services Client and Crystal Reports. 5. Install the preconfigured dashboard. Downloading the BAM product installation files Download the following BAM product installation files from the Powerlink website ( into a local folder: bam product.zip contains installation files for the JBoss, BAM server, PRS, and SQL Data Loader products. Crystal_Designer_XI_R2_SP2.zip contains the Crystal Reports Designer XI R2 SP2 product installer. Uncompress the zipped file, which contains one seat of Crystal Reports. CR_Designer_license_key.txt file contains the Crystal Reports Designer License Key. Download this file into the same folder where you downloaded Crystal_Designer_XI_R2_SP2.zip. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 13

14 Overview of Business Activity Monitor bam product supplemental_files.zip contains the following Documentum Business Activity Monitor Product Supplemental files: Dashboard Style Utility installation files are available in the Dashboard Style Utility/ folder of the bam product supplemental_files.zip file. This utility can be used to customize the look and feel of a BAM dashboard. Preconfigured Dashboard installation file called PreconfiguredDashboard.dar is available in the Preconfigured Dashboard.zip file. The Preconfigured Dashboard.zip file can be accessed in the preconfigured Dashboard Data/ folder of the bam product supplemental_files.zip file. When the PreConfiguredDashboard DAR is installed or the InstallDAR.bat batch file is executed, all the preconfigured dashboards are installed. BAM Dashboard Sizing Calculator spreadsheet is available in the BAM Database Sizing Calculator/ folder of the bam product supplemental_files.zip file. This spreadsheet can be used to calculate the space that must be allocated to the BAM database. Installing or deploying the BAM server After downloading the product installation files, you can proceed with one of the following tasks: Installing the BAM server Use the BAM installer to install the BAM server and the PRS Client on the same machine on which the Content Server with the JBoss application server is installed on a Windows platform. For instructions, see Installing the BAM server using the BAM installer. Deploying the BAM server Use this option to manually deploy the BAM server on a machine where the JBoss, Tomcat, WebLogic, or WebSphere application server is installed. In this case, the BAM server connects to the Content Server and BAM database that may be on different machines. For instructions, see Deploying the BAM server. Note: For information about the platforms and application servers on which the BAM server can be installed or deployed, see the Business Activity Monitor Release Notes. 14 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

15 Overview of Business Activity Monitor Installing the Process Reporting Services Client and Crystal Reports After installing or deploying the BAM server, you can install the Process Reporting Services Client and Crystal Reports. For instructions, see Installing the Process Reporting Services. Installing the preconfigured dashboard If you deployed the BAM server on an application server manually, then you must install the preconfigured dashboard manually. For instructions, see Installing the preconfigured dashboard. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 15

16 Overview of Business Activity Monitor 16 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

17 Chapter 2 Creating the Database You must ensure that you have prepared and sized a database instance before you install the BAM server. This chapter discusses the process of preparing and sizing the database so that you can install the Business Activity Monitor (BAM) server. You must create the required database schema before running the database installation script. The BAM server uses its own database to process and maintain monitoring information. However, the BAM server does not require the database client for its operations. The server uses the JDBC driver for database operations. The following databases are supported: Microsoft SQL Server Oracle DB2 System requirements Table 1. Business Activity Monitor database requirements System Component Database Versions Requirement MS SQL Server 2000 SP4 MS SQL Server 2005 Enterprise Edition (SP2) Oracle 10g Enterprise Edition Release 2 ( ) DB2 Universal Database (UDB) 8.2 Enterprise Edition (Fix Pack 9) DB2 Universal Database (UDB) 9.1 Enterprise Edition (Fix Pack 4) EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 17

18 Creating the Database System Component Platform Memory Requirement Any platform supported by Microsoft SQL Server, Oracle, or DB2 At least 1 GB of memory required, although 2 GB or more is recommended Network Disk Space Network card that supports TCP/IP Database allocation size is determined by the expected throughput of your BAM deployment. A large scale enterprise deployment with high volumes of process instances and data will require a large allocation of space on the hard drive (as high as 80 GB). However, a deployment/testing environment will require significantly less disk space (perhaps 8 GB only). To estimate your storage requirements, refer to the BAM Database Sizing Calculator spreadsheet. For instructions about downloading the spreadsheet, see Downloading the BAM product installation files. Operating System For Oracle 10g Release 2 ( ): Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) Solaris 10 AIX 5L V5.3 TL7 AIX V6.1 HP UX 11i v2 Update 2 (B.11.23) HP UX 11i v3 Update 1 (B.11.31) Red Hat Enterprise Linux 4.6 Red Hat Enterprise Linux 5.1 SUSE Linux Enterprise Server 10 SP1 For SQL Server 2000 SP4: Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) For SQL Server 2005 SP2: Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) For DB2 Universal Database (UDB) 8.2 Fix Pack 9: Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) AIX 5L V5.3 TL7 18 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

19 Creating the Database System Component Requirement AIX V6.1 For DB2 Universal Database (UDB) 8.2 Fix Pack 9 and DB2 Universal Database (UDB) 9.1 Fix Pack 4: Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) AIX 5L V5.3 TL7 AIX V6.1 Browser Internet Explorer 6 for Windows XP SP2 ( ) Internet Explorer 6 for Windows Server 2003 ( ) Internet Explorer 7 for Windows XP and Windows Server 2003 ( ) Internet Explorer 7 for Windows Vista ( ) Firefox Safari Safari Table 2. Additional System Requirements for BAM System Component Database Sizing Connectivity Bandwidth and Firewall Requirement The size of the Business Activity Monitoring database must be calculated using the BAM Database Sizing Calculator spreadsheet. For information about database sizing, see Sizing the database. Database access uses JDBC over TCP/IP The default BAM connection to the Documentum repository does not run across firewalls. The preferred way to connect to this database is a LAN. For remote connections, a T1 link may be used. Performance will depend on the amount of data to be monitored. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 19

20 Creating the Database Steps to install the BAM database Perform the following steps to install the BAM database (Oracle/MS SQL/DB2): Create a Tablespace. For instructions, see the Creating the Microsoft SQL Server Database, Creating the Oracle Database, or Creating the DB2 database section. Create a database user. For instructions, see the Creating the Microsoft SQL Server Database, Creating the Oracle Database, or Creating the DB2 database section. Grant appropriate access rights to the database user. For instructions see the Creating the Microsoft SQL Server Database, Creating the Oracle Database, or Creating the DB2 database section. Size the database. For information, see the Sizing the database section. Creating the Microsoft SQL Server database This section guides you in creating the required MS SQL schema. To create a new SQL Server database: 1. Create a new database. a. Set the data file size to 500 MB. b. Set the transaction log size to 100 MB. 2. Create a new login. a. Create a new login for BAM. b. Use Microsoft SQL Server authentication and set password. 3. Associate the role db owner with the BAM user in the new database. 4. You can now create the BAM database tables. To ensure best performance, use the following initialization parameters while creating the BAM schema. Table 3. Microsoft SQL Server Parameters Parameter name Security Connections Value SQL Server And Windows Authentication Query Time Out = 0 (unlimited) Maximum Concurrent User connections = 0 (unlimited) 20 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

21 Creating the Database Parameter name Attributes Value Close cursor on Commit = V (enable) Autostart policies when the operating system starts Network Server Collation MS SQL collation Code page ANSI Warning = V (enable) ANSI padding = V (enable) ANSI nulls = V (enable) Autostart SQL Server (enable) Autostart SQL Server Agent (enable) Autostart MSDTC (enable) Named Pipes TCP/IP Note: If the Server is running on Windows 2003 operating system, use TCP/IP. Case sensitive SQL_Latin1_General_CP1_CS_AS for English. For other languages, select the collection that matches the relevant language. Complete the following procedure to create the new database, before running the database installation script. Creating the Oracle database This section guides you in creating the required Oracle schema. The following procedure must be completed before running the database installation script. To create a new Oracle database: 1. Verify that the Oracle server is installed and running. 2. Create a new Oracle instance. The initial recommended Oracle tablespace sizes are: User table space approximately 500 MB System table space approximately 700 MB Undo table space to 1 GB Temp table space to 1 GB Index table space to 500 MB 3. Initialize schema parameters using the Oracle Settings table found at the end of this section. 4. Create a new Oracle user and password pair. 5. Grant the following access to the new user: EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 21

22 Creating the Database For Oracle 9i databases: Grant CONNECT Grant RESOURCE For Oracle 10g databases: Grant CONNECT Grant RESOURCE Grant CREATE VIEW Table 4. Oracle Parameters Parameter Name Value Comment DB_BLOCK_SIZE 8,192 Must be set during schema creation DB_CACHE_SIZE 100,000,000 OPTIMIZER_MODE CHOOSE SHARED_POOL_SIZE 50,000,000 LOG_CHECKPOINT_ INTERVAL DML_LOCKS 1,000 PROCESSES 500 LOG_BUFFER 655,360 OPEN_CURSORS 2,000 SORT_AREA_SIZE 5,000,000 MAX_DUMP_FILE_SIZE 10,240 0 Tip: This setting is crucial. DB_FILES 121 Operating system dependent TIMED_STATISTICS TRUE Note: It is recommended that the database administrator periodically monitor the database and modify the parameters based on size changes. Creating the DB2 database This section guides you in creating the required DB2 schema. It also includes a troubleshooting section on the DB2 database. 22 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

23 Creating the Database The procedure in the following table must be completed before running the database installation script. Table 5. DB2 Parameters Step Comments 1. Verify that the DB2 Server is installed 2. Create a new database by using the Control Center. By default, three tablespaces will be created system, user, and temporary each with a page size equal to 4 KB. In addition, a default pool will be created with a page size of 4 KB. 3. Add two buffer pools. The first buffer pool must support page size 16 KB. The second buffer pool must support 32 KB. Example: CREATE DATABASE BAM ON 'C:' USING CODESET UTF 8 TERRITORY US COLLATE USING SYSTEM CATALOG TABLESPACE MANAGED BY SYSTEM USING ( 'C:\DB2\BAM\catalog_tables' ) EXTENTSIZE 16 PREFETCHSIZE 16 OVERHEAD TRANSFERRATE 0.14 USER TABLESPACE MANAGED BY SYSTEM USING ( 'C:\DB2\BAM\user_tbs_4kb' ) EXTENTSIZE 16 PREFETCHSIZE 16 OVERHEAD TRANSFERRATE 0.14 TEMPORARY TABLESPACE MANAGED BY SYSTEM USING ( 'C:\DB2\BAM\temp_tbs_4kb' ) EXTENTSIZE 16 PREFETCHSIZE 16 OVERHEAD TRANSFERRATE 0.14@ Example: CREATE BUFFERPOOL POOL16 IMMEDIATE SIZE 250 PAGESIZE 16 name=pool16 (this can be changed) SIZE = 250 (this can be changed) page size = 16K (this cannot be changed) The second buffer pool must support 32 KB. name=pool32 (this can be changed) SIZE = 250 (this can be changed) page size = 32K (this cannot be changed) EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 23

24 Creating the Database Step 4. Create 2 new User Tablespaces with page size 16 KB and 32 KB. 5. Create a new User Temporary Tablespace with page size 4 KB. 6. Create a new System Temporary Tablespace with page size 32 KB. Comments CREATE REGULAR TABLESPACE USER_TBS_16 PAGESIZE 16 K MANAGED BY SYSTEM USING ('C:\DB2\BAM\user_tbs_16kb' ) EXTENTSIZE 4 OVERHEAD 10.5 PREFETCHSIZE 4 TRANSFERRATE 0.14 BUFFERPOOL CREATE REGULAR TABLESPACE USER_TBS_32 PAGESIZE 32 K MANAGED BY SYSTEM USING ('C:\DB2\BAM\user_tbs_32kb' ) EXTENTSIZE 4 OVERHEAD 10.5 PREFETCHSIZE 4 TRANSFERRATE 0.14 BUFFERPOOL CREATE USER TEMPORARY TABLESPACE USER_TMP_4 PAGESIZE 4 K MANAGED BY SYSTEM USING ('C:\DB2\BAM\user_temp_ tbs_4kb' ) EXTENTSIZE 4 OVERHEAD 10.5 PREFETCHSIZE 4 TRANSFERRATE 0.14 BUFFERPOOL CREATE SYSTEM TEMPORARY TABLESPACE TEMPSPACE_32 PAGESIZE 32 K MANAGED BY SYSTEM USING ('C:\DB2\BAM\temp_ tbs_32kb' ) EXTENTSIZE 4 OVERHEAD 10.5 PREFETCHSIZE 4 TRANSFERRATE 0.14 BUFFERPOOL 7. Create a new user in the operating system. Then add this user to the list of Database Users. 8. Grant the following authorization to the new user: connect to database create tables create schemas implicitly create external routines register routines to execute in database manager s process In addition, grant the use of the User Tablespaces with 4 KB and 16 KB and 32 KB page sizes and Example: GRANT CREATETAB,CONNECT, CREATE_NOT_FENCED_ROUTINE,IMPLICIT_ SCHEMA, CREATE_EXTERNAL_ROUTINE ON DATABASE TO USER ALEX@ GRANT USE OF TABLESPACE USERSPACE1 TO USER 24 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

25 Creating the Database Step User Temporary Tablespace with page size 4 KB 9. Update SQL statement heap (STMTHEAP) to be equal to at least Update application control heap size configuration parameter to be equal at least You can now create the BAM database tables. Comments Example: db2 update db cfg using STMTHEAP Example: update db cfg using app_ctl_heap_sz 512 Note: It is recommended that a DBA periodically run a RUNSTATS command on all tables and indexes in the BAM database. This provides meaningful database statistics. Troubleshooting the DB2 database Gap filler fails to start when DB2 database is used as a BAM database (164308) Gap filler fails to start if the BAM database is a DB2 database. You can resolve this issue by applying the hotfix available at the following location: ftp://techsup:[email protected]/bam/bam_65_hotfix1_bug The BAM 6.5 hotfix contains the following files: bamsetup.jar bamwinsuitesetup.exe bamwinsuitesetup.jar Workaround: Perform the following steps: 1. Stop the BAM server. 2. Upgrade the BAM database schema in DB2 (Database version BAM Edition) by performing the following steps: 1. Connect to the BAM database. For example, run the following command: EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 25

26 Creating the Database db2 connect to [database name] user [user name] using [password] 2. Run the db2_functions.sql file. Note: Ensure that the DB2 client is installed on the computer before running the script. For example, run the following command: db2 svf C:\TEMP\db2_functions.sql l C:\TEMP\ Report_On_create_functions.sql 3. Check the log file for errors. Contact Technical Support to report errors. 4. After upgrading the BAM database schema, replace the original bam engine.jar and common.jar files with the new jar files available in the hotfix package. Both files are packaged in the WAR file that is available in the WEB INF\lib folder. 5. Start the BAM server. Sizing the database After you have created a database, it is important to set the size of the database accurately. This will ensure that there is adequate space in the database to accommodate all historical data. Failure to set enough space may result in loss of data or problems with the execution of the Business Activity Monitor. The size of the Business Activity Monitoring database depends on the number of processes that must be monitored, the frequency of their execution, the amount of business data that is tracked, and the duration for which the data must be retained before it is purged. The BAM Database Sizing Calculator is a spreadsheet that can help to accurately estimate the database size. For instructions about downloading the spreadsheet, see Downloading the BAM product installation files. In the Input Page sheet of the spreadsheet, enter the values that reflect the expected load of your application. The Output Summary Page sheet of the spreadsheet will provide you with database size measures. 26 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

27 Chapter 3 Installing the BAM Server Using the BAM Installer This chapter discusses the procedure to run the BAM server installation. It also includes post installation guidelines. Troubleshooting tips on installing the BAM server using the BAM Engine installer are included at the end of this chapter. The BAM installer is designed to be used for installing the BAM server and the PRS Client on the same machine as the Content Server on a Windows platform. In this scenario, the BAM server connects to the Content Server and BAM database that are installed on the same machine. Note: You must ensure that you have prepared and sized a database instance before you install the BAM server. The option to install the BAM server using the installer primarily addresses the demonstration scenario where the user creates the database, installs the BAM server, installs the preconfigured dashboard, and installs Process Reporting Services. This approach is not recommended for a production installation. Note: For information about the platforms and application servers on which the BAM server can be installed, see the Business Activity Monitor Release Notes. Installing the BAM server This section provides instructions to use the BAM Engine installer to install the BAM server. You must have the administrator s access rights to perform the BAM server installation. Note: You must use administrator credentials to connect from BAM server to the repository. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 27

28 Installing the BAM Server Using the BAM Installer To install the BAM server: 1. Access the local folder where you downloaded the bam product.zip file and uncompress it into the <bam.setup.dir>\ folder. When this file is uncompressed, the following folders are created: BAM Installer folder (requires local Content Server) containing the BAM_Demo_Installer_JBoss_win.zip file. BAM Server folder with the following contents: bam server.war WebSphere folder with the xalan.jar and xercesimpl.jar files. WebLogic 9.2 folder containing the bam server.ear file. PRS folder containing the PRS win32.win32.x86.zip file. BAM Data Loader folder containing the sql loader.zip file. 2. Access the <bam.setup.dir>\bam Installer\ folder, and uncompress the BAM_Demo_Installer_JBoss_win.zip file into the <bam.setup.dir>\bam Installer\<working.dir>\ folder. All the contents of the.zip file are extracted into the folder. 3. Run <bam.setup.dir>\bam Installer\<working.dir>\bamWinSuiteSetup.exe. It may take up to a minute for the first page of the Documentum BAM Engine Installer wizard to appear. 4. Select the Business Activity Monitoring product. 5. Click Next. The Welcome page is displayed. 6. Click Next. The License Agreement page is displayed. 7. Select I accept the terms of the license agreement option, and click Next. The next page of the Documentum BAM Engine Installer wizard displays the details of the repository that the installer will update. 8. Select a repository, and specify the user credentials. 9. Click Next. 10. Specify the BAM database connection parameters. The installer validates the database connection information specified, and will display an error message if it is unable to establish connection with the BAM database. 11. Click Next. 28 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

29 Installing the BAM Server Using the BAM Installer The Products Summary page listing all the products and components that will be installed, is displayed. 12. Click Next to start the installation. The BAM server and the preconfigured dashboard DAR are installed. After the installation has completed successfully, the last page of the Documentum BAM Engine Installer wizard is displayed. 13. Click Finish to exit the Documentum BAM Engine Installer wizard. 14. Restart the Documentum Java Method Server. For instructions, see Starting and stopping the JBoss application server. Note: The BAM server and BAM database are designed to work with one Documentum repository only. The BAM server 6.5 installation program creates the following directory structures under the <documentum.home>\bam\ folder: \bin\ Contains batch files. These files help in the creation and cleanup of the BAM database or the DocApp (repository). \lib\ Contains all the required java libraries (JAR files) or binaries. \etc\api\ Contains the IAPI script required to create or cleanup the repository objects. \etc\dql\ Contains the DQL script required to create or cleanup the repository objects. \etc\sql\ Contains the SQL script required to create or cleanup BAM database objects. Starting and stopping the JBoss application server When you first install the Content Server installation, the JBoss application server is started automatically. However, starting and stopping a Content Server in the installation does not automatically start or stop the JBoss application server. The application server hosts one or more Java applications or processes. In a Content Server installation, the method server hosts, for example, the Java Method Server, ACS server, and the DmMail application. To start the application server: 1. Navigate to <JBossRoot>\server. 2. Execute startmethodserver.cmd. 3. Alternatively, start the Windows service for the server instance. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 29

30 Installing the BAM Server Using the BAM Installer For the Java method server, and the server instance hosting the Java method server, the service name is Documentum Java Method Server. Starting that service is equivalent to executing startmethodserver.cmd. Use the following procedure to stop the application server. Stopping the server stops all applications running within it. To stop the application server: 1. Navigate to <JBossRoot>\server. 2. Execute stopmethodserver.cmd. 3. Alternatively, stop the Windows service for the server instance. For the Java method server, and the server instance hosting the Java method server, the service name is Documentum Java Method Server. Stopping that service is equivalent to executing stopmethodserver.cmd. Post installation guidelines It is recommended that you check for any installation errors in the following logs after the BAM server is installed successfully: run api.log run dql.log sql loader.log create repository.log Caution: If the logs contain errors, contact EMC Technical Support. Troubleshooting BAM server installation BAM Engine installer displays the connection error message The BAM Engine installer displays the connection error message if the connection to the Internet is unavailable or extremely slow while installing the BAM Engine on the Windows platform. 30 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

31 Installing the BAM Server Using the BAM Installer Workaround: Perform the following steps: 1. Stop the Documentum Java Method Server, if it is running. 2. Create a backup copy of the web.xml file available in the following path: %DOCUMENTUM%\jboss4.2.0\server\DctmServer_MethodServer\deploy\ ServerApps.ear\DmMethods.war\WEB INF\ 3. Open the web.xml file available in the following path for editing: %DOCUMENTUM%\jboss4.2.0\server\DctmServer_MethodServer\deploy\ ServerApps.ear\DmMethods.war\WEB INF\ 4. Remove the following DOCTYPE declaration line in the file: <!DOCTYPE web app PUBLIC " //Sun Microsystems, Inc.// DTD Web Application 2.3//EN" " app_2_3.dtd"> 5. Save the web.xml file. 6. Install the BAM server using the BAM Engine installer. 7. Start the Documentum Java Method Server, if it is required. BAM Engine installer fails on the Windows platform (166194) The BAM Engine installer is unable to perform database or repository manipulations when the BAM Engine is installed on a Windows platform where Documentum 6.5 products have been installed in a folder that has a space character in the folder name. The installation fails and an error message is displayed during the installation of the BAM DAR. The BAM server cannot be started, and the PRS Client fails to connect to the BAM server. You can resolve this issue by applying the hotfix available at the following location: ftp://techsup:[email protected]/bam/bam_65_hotfix1_bug The BAM 6.5 hotfix contains the following files: bamsetup.jar bamwinsuitesetup.exe bamwinsuitesetup.jar Workaround: Perform the following steps: 1. Replace the existing installation files with the files packaged in the hotfix. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 31

32 Installing the BAM Server Using the BAM Installer 2. Execute bamwinsuitesetup.exe to run the BAM Engine installer. 32 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

33 Chapter 4 Deploying the BAM Server (manual installation) This chapter describes the process of deploying the BAM server manually on a machine where the application server is installed, while the Content Server and BAM database are installed on one or more different machines. Deploying the BAM server requires the completion of the following tasks: proper creation of the repository and database objects, and updating the BAM configuration files. You must ensure that you have prepared and sized the database instance before you install the BAM server. Finally, this chapter includes post deployment guidelines. You must have the administrator s access rights to perform the BAM server installation. In addition, you must use administrator credentials to connect from BAM server to the repository. Note: For information about the platforms and application servers on which the BAM server can be deployed, see the Business Activity Monitor Release Notes. This chapter includes the following sections: Business Activity Monitor server system requirements Additional requirements Tasks to perform before deploying the BAM server Continuing the deployment of the BAM server Post deployment guidelines EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 33

34 Deploying the BAM Server (manual installation) Business Activity Monitor server system requirements Table 6. Business Activity Monitoring server system requirements System Component Platform Software Requirement IBM PC or compatible with Pentium 4, 2.4 GHz processor required, although Pentium 4, 3.0 GHz processor or later recommended. For JBoss application server 4.2.x: No additional software is required. JDK 5 For Apache Tomcat application server or : No additional software is required. JDK 5 For BEA WebLogic application server 9.2 MP2 or 10 MP1: JDK 5 must be installed for those operating systems where BEA WebLogic does not embed a JDK (for example, AIX). All JDK versions supported by each application server are supported. Note: BEA WebLogic cannot be installed in a directory that contains parentheses () or ancestor directories (for example, folder (1), folder (2), folder (3), and so on). For IBM WebSphere application server: Memory Network Disk Space IBM WebSphere Application Server version Fix Pack 19 ( ) or version 6.1 Fix Pack 13 ( ) must be installed prior to the installation of the BAM server. At least 1 GB of memory required, although 2 GB or more recommended. Network card that supports TCP/IP 1.5 GB 34 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

35 Deploying the BAM Server (manual installation) System Component Connection Requirement The connections between the Content Server and BAM requires the use of a high speed LAN. Operating Systems For JBoss application server 4.2.2: Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) Windows Server 2003 R2 with SP2 x64 Edition Windows Server 2003 SP2 x64 Edition Note: The BAM server can be run as a Windows service on the Windows 2003 Server OS only. For Apache Tomcat , Apache Tomcat , BEA WebLogic Server 9.2 MP2, and BEA WebLogic Server 10 MP1: Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) Windows Server 2003 R2 with SP2 x64 Edition Windows Server 2003 SP2 x64 Edition Solaris 10 Red Hat Enterprise Linux 4.6, 5.1 SUSE Linux Enterprise Server 10 SP1 HP UX 11i v2 Update 2 (B.11.23) HP UX 11i v3 Update 1 (B.11.31) For IBM WebSphere Application Server version Fix Pack 19 ( ): Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) Windows Server 2003 R2 with SP2 x64 Edition Windows Server 2003 SP2 x64 Edition AIX 5L V5.3 TL7 AIX V6.1 For IBM WebSphere Application Server version 6.1 Fix Pack 13 ( ): Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) Windows Server 2003 R2 with SP2 x64 Edition EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 35

36 Deploying the BAM Server (manual installation) System Component Requirement Windows Server 2003 SP2 x64 Edition Additional requirements 1. For the installation of the BAM server, the Database Server Host name, Database Name (SID in Oracle), User Name, and Password details are required to configure the BAM database connection. 2. The installation of the Server cannot be completed without the database installed and running. It is recommended that you do not install the BAM server on the same machine as the database server. Therefore, there must be access from the installation machine to the database via TCP/IP connection. Note: The BAM server does not require the database client for its operations. The server uses the JDBC driver for database operations. Tasks to perform before deploying the BAM server Ensure that you complete the following tasks before you manually deploy the BAM server on the application server: Common initial steps for deploying the BAM server Create a repository and database objects manually Update configuration files for BAM Common initial steps for deploying the BAM server This section lists the common initial steps that you must perform regardless of the application server on which you are deploying the BAM server. After you perform the steps described in this section, locate the section relevant to your application server in the Deploying the BAM server on the application server section, and follow the instructions to deploy the BAM server, manually. 1. Access the local folder where you downloaded the bam product.zip file and uncompress it into the <bam.setup.dir>\ folder. The following folder structure is created: 36 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

37 Deploying the BAM Server (manual installation) BAM Installer folder (requires local Content Server) containing the BAM_Demo_Installer_JBoss_win.zip file. BAM Server folder with the following contents: bam server.war Websphere folder with the xalan.jar and xercesimpl.jar files. WebLogic 9.2 folder containing the bam server.ear file. PRS folder containing the PRS win32.win32.x86.zip file. BAM Data Loader folder containing the sql loader.zip file. 2. Perform one of the following tasks: On WebLogic 9.2 application server, uncompress the <bam.setup.dir>\bam Server\<working.dir>\WebLogic 9.2\bam server.ear file into the <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server.ear\ folder. On WebLogic 10 and all other application servers, uncompress the <bam.setup.dir>\bam Server\bam server.war file into the <bam.setup.dir>\bam Server\<working.dir>\bam server.war\ folder. 3. Open the BAM configuration files available in one of the following paths, and modify the files: On WebLogic 9.2 application server, access the <working.dir>\weblogic 9.2\bam server.ear\ folder. On WebLogic 10 and all other application servers, access the <working.dir>\bam server.war\ folder. For instructions about working with configuration files, see Updating configuration files for BAM. Creating a repository and database objects manually You can use the BAM Data Loader utility to manually create the repository and database objects before you install the BAM server. This utility is installed as part of the BAM Installer for JBoss and also resides in bam product.zip. The BAM Data Loader utility is also used to clean up the BAM repository and database objects such as types, tables, shipping data, and so on, manually. If there are repository or database related errors, you can run this utility to cleanup the BAM database objects. To create the repository and database objects manually: 1. Uncompress the <bam.setup.dir>\bam Data Loader\sql loader.zip file into the <bam.setup.dir>\bam Data Loader\<working.dir>\ folder. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 37

38 Deploying the BAM Server (manual installation) The following folders are uncompressed: \bin Containing command files. \etc Containing the api, dql, and sql folders. \lib Containing.jar files. 2. In the <bam.setup.dir>\bam Data Loader\<working.dir>\etc\sql\ folder, edit the Crebas.xml file by modifying the datasource element and other parameters you want to replace for creating a repository and database. For example, you can modify the <datasource username="$c(bam, DCTM_BAM_ DB_USER)" url="$c(bam, DCTM_BAM_DB_URL)" password="" class="$c(bam, DCTM_BAM_DB_JDBC_DRIVER_CLASS)" name="$c(bam, DCTM_BAM_DB_DIALECT) DataSource" dialect="$c(bam, DCTM_BAM_DB_DIALECT)"/> entry as follows: On Oracle RDBMS: <datasource username="bam65" url="jdbc:oracle:thin:@localhost:1521:rex" password="" class="oracle.jdbc.driver.oracledriver" name= "My Oracle DataSource" dialect="oracle"/> On MS SQL server: <datasource username="bam65" url="jdbc:sqlserver://vm prodbs01:1876; databasename=john_d65;selectmethod=cursor" password="" class="com.microsoft.sqlserver.jdbc.sqlserverdriver" name="my MS SQL DataSource" dialect="mssql"/> However, as the password attribute is not set, it must be passed in the command line as shown in the following example: <bam.setup.dir>\bam Data Loader\<working.dir>\bin\create db.cmd p password 3. Execute create db objects.cmd on the command line to create the BAM database objects. 4. Execute create repo objects.cmd on the command line of the Content Server machine, to create BAM repository objects. When prompted, enter the required parameters such as repository name, login name, and password on the command line. The repository and database objects are created using the details you specified while executing the command. Note: Since the create repo objects.cmd must be executed on the Content Server machine, you must ensure that you copy the entire <bam.setup.dir>\bam Data Loader folder to the Content Server machine prior to executing create repo objects.cmd. Note: The BAM server and BAM database are designed to work with one Documentum repository only. 38 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

39 Deploying the BAM Server (manual installation) Updating configuration files for BAM Before deploying the BAM server on an application server, you must update the configuration files available in the following path: <bam.setup.dir>\bam Server\<working.dir>\bam server.war\web INF\classes. Note: On WebLogic 9.2 application server, update the configuration files available in the following path: <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server.ear\app INF\classes\ Modify the following configuration files: <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server.ear\app INF\classes\dfc.properties For information about the contents of this file, see the comments in the dfcfull.properties file in the same folder. \log4j.properties Modify the location of the log files. \config\common config.xml An entry point to the composite application configuration. It contains a list of other configuration sources. \config\env config.xml Contains the environment configuration preferences. \config\app config.xml Contains application specific configuration properties. \config\jdbc config.xml Contains the BAM database (JDBC) configuration properties. \config\dfc config.xml Contains the DFC session properties. To update the configuration files: 1. Open the dfc.properties file available in one of the following paths: On WebLogic 9.2 application server: <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server.ear\app INF\classes\ On WebLogic 10 and all other application servers: <bam.setup.dir>\bam Server\<working.dir>\bam server.war\web INF\classes 2. If you are deploying the BAM server on the Content Server machine, replace the first line of the dfc.properties file with this statement: #include <documentum_user_dir>\config\dfc.properties. For example, you EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 39

40 Deploying the BAM Server (manual installation) can specify the path to the dfc.properties file as follows: #include C:\Documentum\config\dfc.properties. Alternatively, you must delete or comment the first statement and specify the required values for the following parameters: dfc.docbroker.host[0]= <docbroker host> dfc.docbroker.port[0]= <docbroker port> dfc.globalregistry.repository= <repository name> dfc.globalregistry.username= <user name> dfc.globalregistry.password= <encrypted password> Note: When deploying the BAM server on the WebSphere application server, the DFC keystore must be created using IBM JDK. 3. Save and close the dfc.properties file. 4. Open the jdbc config.xml file available in one of the following paths: <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server. ear\app INF\classes\config\ <bam.setup.dir>\bam Server\<working.dir>\bam server.war\web INF\classes\config\ 5. Modify the following BAM database connection parameters with the relevant values. Use the values specified in the BAM database connection parameters and values table: dialect URL driver username password Table 7. BAM database connection parameters and values RDBMS Type Dialect Driver Class Connection URL MS SQL mssql com.microsoft. sqlserver.jdbc. SQLServerDriver jdbc:sqlserver:// <HOST>:<PORT>; databasename=<db. NAME>; SELECTMETHOD= Cursor 40 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

41 Deploying the BAM Server (manual installation) RDBMS Type Dialect Driver Class Connection URL Oracle oracle oracle.jdbc.driver. OracleDriver DB2 db2 com.ibm.db2.jcc. DB2Driver <PORT>:<SID> jdbc:db2:// <HOST>:<PORT>: <DB.NAME> Note: You must use administrator credentials to connect from BAM server to the repository. 6. Save and close the jdbc config.xml file. 7. Open the log4j.properties file available in one of the following paths and modify the location of the log files: On WebLogic application server 9.2: <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server.ear\app INF\classes\ On WebLogic 10 and all other application servers: <bam.setup.dir>\bam Server\<working.dir>\bam server.war\web INF\classes 8. Save and close the log4j.properties file. 9. Open dfc config.xml available in one of the following folders and modify the DFC session properties: <bam.setup.dir>\bam Server\Weblogic 9.2\<working.dir>\bam server. ear\app INF\classes\config\ <bam.setup.dir>\bam Server\<working.dir>\bam server.war\web INF\classes\config\ 10. Save and close the dfc config.xml file. Continuing the deployment of the BAM server This section provides additional instructions that must be followed to complete the deployment of the BAM server on the JBoss, Tomcat, WebLogic, and WebSphere application servers. Follow the instructions relevant to the application server on which you work. If the BAM server runs on the application server machine, it can support connections from many users at a time over a network. The server runs on one computer (the server machine), while client applications run on other computers (client machines). The installation of the server cannot be completed without the database installed and running. It is recommended that the application server not be installed on the same EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 41

42 Deploying the BAM Server (manual installation) machine as database server. Therefore, there must be access from the installation machine to the database server using TCP/IP connection. After the application server is installed, the BAM web application (bam server.war or bam server.ear) must be configured, and then the updated files must be deployed on the application server. Deploying the BAM server on the JBoss application server After following the instructions described in Tasks to perform before deploying the BAM server, you must perform the following tasks that are unique to the JBoss application server: 1. Deploy the BAM server web application by copying the entire bam server.war folder from the working directory to the application server s deploy directory: Copy <working.dir>\bam server.war to the <jboss.server.dir>\<jboss.domain. dir>\deploy\ folder. 2. Configure the JBoss Enterprise application server 3. Start the JBoss application server. 4. Browse to the bam server URL to verify whether the BAM server is up and running. For example, browse to server IP/machine name>:<port>/bam server/. The BAM server Welcome page is displayed if the BAM server is running. Note: If you are deploying the BAM server on the JBoss application server instance that is used by the Content Server, the domain name is DctmServer_MethodServer. Alternatively, by default, the JBoss domain name is default. To configure the JBoss application server: 1. Browse to the <jboss.root.dir>\bin\ folder. 2. Modify run.bat (on Windows) or run.sh (on Linux/UNIX). The recommended JVM parameters for BAM server are as follows: Initial Java heap size: 512 m Maximum Java heap size: 1024m Java threads stack size: 128k Initial size for the permanent generation heap: 128m Maximum size for the permanent generation heap: 256m Initial size of new generation pool: 128 m 42 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

43 Deploying the BAM Server (manual installation) Maximum size of new generation pool: 384m Use parallel GC: Number of threads used by parallel GC: 20 Deploying the BAM server on the Tomcat application server After following the instructions described in Tasks to perform before deploying the BAM server, you must perform the following tasks: 1. Copy the folder that is available under the <working.dir>\ folder. 2. Deploy the BAM server web application by copying the entire bam server.war folder from the working directory to the application server s webapps directory: Copy <working.dir>\bam server.war to the <tomcat.root.dir>\webapps\ folder. 3. Start the Tomcat application server. 4. Browse to the bam server URL to verify whether the BAM server is up and running. For example, browse to server IP/machine name>:<port>/bam server/. If the BAM server is up and running, the following console message is displayed: INFO: Server startup in XXXX ms To configure the Tomcat application server: 1. Browse to the <tomcat.root.dir>\bin\ folder. 2. Modify catalina.bat (on Windows) or catalina.sh (on Linux/UNIX). The recommended JVM parameters for BAM server are as follows: Initial Java heap size: 512 m Maximum Java heap size: 1024m Java threads stack size: 128k Initial size for the permanent generation heap: 128m Maximum size for the permanent generation heap: 256m Initial size of new generation pool: 128 m Maximum size of new generation pool: 384m Use parallel GC: Number of threads used by parallel GC: 20 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 43

44 Deploying the BAM Server (manual installation) Deploying the BAM server on the WebLogic application server After following the instructions described in Tasks to perform before deploying the BAM server, you can deploy the BAM server on the WebLogic application server using WebLogic Server Administration Console. Follow the procedures described in this section to deploy the BAM server on the WebLogic application server version 9.2 or version 10. Caution: On the WebLogic 10 application server, you must ensure that you deploy the bam server.war folder in which you modified the configuration files. Do not deploy the bam server.war file that you downloaded as part of the bam product.zip file from the EMC Download Center. Before you deploy the BAM server on the application server, perform the following steps to create an external configuration folder that the BAM application will reference. To create an external configuration folder: 1. Create a new WebLogic Server domain, or use an existing domain. For WebLogic 10, you must perform the following additional steps: a. Create an external configuration folder, <bpm.resource.dir>. For example, create the configuration folder in the following path: C:\Documentum\bam\configuration. This folder will store the BAM configuration files in the WebLogic environment. b. Extract the contents of the <bam server.war>\web INF\classes\config\ folder into the <bpm.resource.dir> folder. c. Modify the startup script of WebLogic 10 by adding the following line at the beginning of startweblogic.cmd (on Windows) or startweblogic.sh (on UNIX/Linux): On Windows: set JAVA_OPTIONS=%JAVA_OPTIONS% Dbpm.resource.dir=<bpm.resource.dir> On UNIX/Linux: JAVA_OPTIONS=${JAVA_OPTIONS} Dbpm.resource.dir=<bpm.resource.dir> In this step, you define a new Java property, bpm.resource.dir, with the value of the external configuration folder location that the BAM application will reference. For example, Dbpm.resource.dir=c:\Documentum\configuration\bam. Note: Ensure that the variable contains the absolute path of the location of the BAM configuration files. 2. Start the WebLogic Server domain. 44 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

45 Deploying the BAM Server (manual installation) 3. Open the WebLogic Server Administration Console. To deploy the BAM server on the WebLogic application server: 1. Start the WebLogic application server. 2. Open the WebLogic Server Administration Console by specifying the WebLogic Server Administration URL. The URL must be defined in this format: 3. Specify the login credentials and click Login to log in to the WebLogic Server domain. 4. In the Domain Structure pane, select Deployments. The Summary of Deployments is displayed in the Control tab of the Right pane. 5. In the Change Center pane, click Lock & Edit to disallow others from editing the domain. 6. Click Install in the Summary of Deployments page to deploy the BAM server. 7. In the next page, select bam server.war if you are working on the WebLogic 10 application server. Alternatively, select bam server.ear if you are working on the WebLogic 9.2 application server. 8. Click Next 9. Select the Install this deployment as an application option, and click Next. 10. Verify that the name of the deployment is bam server and click Next. 11. In the next page, select No, I will review the configuration later option. 12. Click Finish. After the deployment is successfully installed, you must activate the pending changes to commit the deployment and other updates to the active system. 13. Click Activate Changes in the Change Center pane. A message is displayed indicating that all changes have been activated. 14. In the Control tab of the Summary of Deployments page, select the bam server deployment. 15. In the Start drop down list, select Servicing all requests. The Start Application Assistant page is displayed. 16. Click Yes to confirm. The BAM application is started. 17. Ensure that the State of the bam server deployment is Active. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 45

46 Deploying the BAM Server (manual installation) 18. Browse to the bam server URL to verify whether the BAM server is up and running. For example, browse to server IP/machine name>:<port>/bam server/. The BAM server Welcome page is displayed if the BAM server is running. Deploying the BAM server on the WebSphere application server After following the instructions described in Tasks to perform before deploying the BAM server, you can deploy the BAM server on the WebSphere application server using WebSphere Application Server Administration Console. Follow the procedure described in this section to deploy the BAM server on the WebSphere application server. Configuring the WebSphere application server Follow the instructions in this section to configure or prepare the WebSphere application server before you deploy the BAM server on it. Modify the WAS_CLASSPATH environment variable by performing the following procedure. To configure the WebSphere application server: 1. Replace the existing aspectjrt.jar in the <websphere.root.dir>\lib\ folder with the one from the <bam.setup.dir>\bam Server\bam server.war\web INF\lib\ folder. 2. Copy saaj api.jar and saaj impl.jar from the <bam.setup.dir>\bam Server\bam server.war\web INF\lib folder to the <websphere.root. dir>\java\jre\lib\ext\ folder. 3. Copy the xalan.jar and xercesimpl.jar files from the <bam.setup.dir>\bam Server\WebSphere\ folder to the <websphere.root.dir>\lib\ext\ folder. 4. Add xalan.jar and xercesimpl.jar to the WAS_CLASSPATH environment variable as follows: Open the <websphere.root.dir>\profiles\<profile.id>\bin\setupcmdline.bat file. Add the following line before set WAS_CLASSPATH as follows: SET BAM_CLASSPATH=%WAS_HOME%\lib\ext\xalan.jar;%WAS_HOME%\lib\ext\ xercesimpl.jar; Modify the value of the WAS_CLASSPATH environment variable by inserting the value of BAM_CLASSPATH before the WAS_CLASSPATH value as follows: 46 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

47 Deploying the BAM Server (manual installation) SET WAS_CLASSPATH=%BAM_CLASSPATH%;<original.path> Deploying the BAM server on the WebSphere application server You can now deploy the BAM server on the WebSphere application server. To deploy the BAM server on the WebSphere application server: 1. Open the WebSphere Application Server Administration Console. The format of the URL is as follows: The Welcome page is displayed. 2. In the Left pane, expand the Applications node, and click Install New Application. 3. Select the Local file system option and specify the Full path of the file. 4. In the Context root box, specify bam server. 5. Click Next. The Select installation options page is displayed. 6. Select the Precompile JavaServer Pages files option. 7. Select the Deploy Web services option. 8. Click Next. The Map modules to servers page is displayed. 9. Click Next. The Map virtual hosts for Web modules page is displayed. 10. Click Next. The Summary page is displayed. 11. Click Finish. The BAM server is deployed on the WebSphere application server and in the page that is displayed, you can click Save to save changes that you made to the local configuration, to the master configuration. 12. Configure the class loading strategy for the BAM server by performing the following steps: a. In the Left pane, expand the Applications node, and click Enterprise Applications. The Enterprise Applications page is displayed. b. Select the bam server.war application. c. Click the bam server.war link. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 47

48 Deploying the BAM Server (manual installation) d. In the next page that is displayed, click the Class loading and update detection link. e. In the General Properties page that is displayed, specify 120 seconds in the Polling interval for updated files box. f. Select the Class loaded with application class loader first option as the Class loader order. g. Click OK. The next page displays a message indicating that the changes have been made to your local configuration. h. Click Save to save the local configuration changes that you made, to the master configuration. i. In the Enterprise Applications page, select the bam server.war application and click Start. 13. Restart the WebSphere application server. 14. Browse to the bam server URL to verify whether the BAM server is up and running. For example, browse to server IP/machine name>:<port>/bam server/. The BAM server Welcome page is displayed if the BAM server is running. Post deployment guidelines If BAM is deployed on an application server that does not use port 8080 by default (this is the case for both WebLogic and WebSphere), then the BAM server port number must be configured in the BAM Port field of the Administration tab of TaskSpace. In addition, if the BAM server and TaskSpace are not installed on the same physical machine, you must modify the BAM Host URL from localhost to the IP address of the machine on which the BAM server is installed, in the Administration tab of TaskSpace. For instructions, see the Configuring connection settings section of the Business Activity Monitor Implementation Guide. Note: You must use administrator credentials to connect from BAM server to the repository. 48 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

49 Chapter 5 Configuring Business Activity Monitor BAM configuration refers to a set of features that enable process execution data to be collected, formatted, and aggregated by the BAM server. Process administrators must make sure that a connection with the BAM server is established. This allows monitoring to be activated. Caution: Please refer to chapter 2 of the Documentum Business Activity Monitor 6.5 Implementation Guide for additional configuration steps including turning the Audit Trail on, and making SDTs and package object types reportable. Configuring connection settings The BAM server interacts with TaskSpace, the dashboard, and Process Builder. For example, a dashboard requests reports from the BAM server. Similarly, Process Builder communicates to the BAM server when business data is monitored. Each of these clients needs to connect with the BAM server. To help with this, the BAM server publishes its address to a specific Content Server object that is then read by each of these client applications. Configuring connection settings involves entering BAM host and port numbers. To configure connection settings: 1. Log in to TaskSpace. 2. Select the Administration tab. 3. From the left tree menu select Server Management > Business Activity Monitoring > Data Transfer Settings. 4. Within the Connection region at the bottom of the form, enter the BAM Host URL. This is the machine on which the BAM server is deployed. 5. In the BAM Port field enter the BAM server port number. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 49

50 Configuring Business Activity Monitor 6. Click OK at the bottom of the form. Note: You must use administrator credentials to connect from BAM server to the repository. Activating process monitoring Activating monitoring turns on all jobs completed by the BAM server. This includes the event pipe process, the format, aggregation and alert engines, and purging. To activate process monitoring: 1. Log in to TaskSpace. 2. Click the Administration tab. 3. Select Server Management from the left tree menu. 4. Click the Business Activity Monitor Activate button. The Status: changes from Stopped to Running. 50 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

51 Installing the Process Reporting Services Chapter 6 Process Reporting Services (PRS) is a new Eclipse based component that allows a designer to create new BAM reports, charts, and alerts. PRS offers a drag and drop capability for defining data sources. Data sources defined in Process Reporting Services can be exported to Crystal Reports for report design. One user seat of Crystal Reports XI Release 2 is packaged with every license of BAM. However, you can install as many seats of Process Reporting Services as needed. If you manually deployed the BAM server on the application server, or if you did not install PRS Client while installing the BAM server using the installer, then you must manually install the PRS Client. Note: Process Reporting Services provides the report builder functionality, previously available through the Process Analyzer product, and requires no knowledge of SQL. This chapter discusses the following topics: System requirements for installing PRS Installing PRS Client, and installing Crystal Reports for Windows I18N Notes PRS Client system requirements Table 8. PRS Client System Requirements System Component Platform Software Memory Requirement IBM PC or compatible with Pentium 1.26 GHz processor Adobe Flash Player x At least 1 GB of RAM EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 51

52 Installing the Process Reporting Services System Component Network Disk Space Operating system Requirement Network card that supports TCP/IP and network access to the Server Account Crystal Reports Designer requires at least 1 GB of disk space Windows XP SP2 (32 bit version) Windows Vista SP1 (32 bit version) Windows Server 2003 R2 with SP2 (32 bit version) Windows Server 2003 SP2 (32 bit version) Note: The following Windows Server 2003 editions are supported: Standard, Enterprise, Data Center. Business objects Crystal Reports XI Release 2 version In addition, JAVA Run Time Environment (JRE) is installed as part of the client installation. It should not be installed separately. Before logging in to the PRS Client, ensure that the BAM server is up and running, because the PRS application consumes services provided by the BAM server. Installing PRS Client and Crystal Reports You must have the administrator s access rights to perform the installation. To install the PRS Client: 1. Access the <bam.setup.dir>\bam Installer\<working.dir>\ folder. 2. Run <bam.setup.dir>\bam Installer\<working.dir>\bamWinSuiteSetup.exe. It may take up to a minute for the first page of the Documentum BAM Engine Installer wizard to appear. 3. Select the Process Reporting Services (PRS) product. 4. Click Next. The Welcome page is displayed. 5. Click Next. The License Agreement page is displayed. 6. Select I accept the terms of the license agreement option, and click Next. 52 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

53 Installing the Process Reporting Services The next page of the Documentum BAM Engine Installer wizard confirms that the Setup program will install the PRS Client. 7. Click Next to start the PRS Client installation. The PRS Client is installed. After the PRS Client installation has completed successfully, the last page of the Documentum BAM Engine Installer wizard is displayed. 8. Click Finish to exit the Documentum BAM Engine Installer wizard. You can now log on to the PRS Client. To log on to PRS Client: 1. Access the local folder where you downloaded the bam product.zip file and uncompress its contents into the <bam.setup.dir> folder. 2. Uncompress the PRS win32.win32.x86.zip file into the <bam.setup.dir>\prs\ folder. The following folders and files are uncompressed into the PRS\ folder: configuration jre plugins eclipseproduct PRS.exe PRS.ini 3. Run <bam.setup.dir>\prs\prs.exe. The PRS Client Login dialog box is displayed. 4. Click Connect. The Server Host Configuration dialog box is displayed. 5. Specify the Host URL. The URL must be specified in this format: server. You must define the Host URL, because the PRS application consumes services provided by the BAM server, and requires the URL of the BAM server at login time. 6. Click OK. 7. Specify the login credentials. 8. Click OK. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 53

54 Installing the Process Reporting Services To install Crystal Reports for Windows: 1. Access the local folder where you downloaded the Crystal_Designer_XI_R2_SP2.zip file, and uncompress it into the <bam.setup.dir>\crystal_designer_xi_r2_sp2\ folder. 2. Run <bam.setup.dir>\crystal_designer_xi_r2_sp2\ part1.exe and follow the on screen instructions to complete the installation. 3. You can obtain a valid license key of Crystal Reports from the EMC download center. I18N Notes East Asian language fonts must be installed on the Windows platform, to enable users to work with the Process Reporting Services (PRS) Client in the Japanese, Korean, and Chinese languages. To install East Asian fonts: 1. In the Control Panel, double click Regional and Language Options. 2. Click the Languages tab, and select the Install files for East Asian languages option. 3. Click Apply. 4. Click OK. Note: Ensure that the database is installed with the Unicode character set. 54 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

55 Chapter 7 Installing the Preconfigured Dashboard If you manually deployed the BAM server on an application server, then you must manually install the preconfigured dashboard. This chapter provides guidance to install the preconfigured dashboard. The installation of the preconfigured dashboard consists of installing the following two components: DQL script DAR file Note: BAM 6.5 ships with a set of preconfigured dashboards that are installed. Prerequisites for installing the preconfigured dashboard Prior to installing the preconfigured dashboard, you must ensure that you perform the following tasks: Install or deploy the BAM server. For instructions, see the Installing the BAM Server Using the BAM Installer and Deploying the BAM Server chapters. Install TaskSpace using the DAR file, and not the DocApp. For instructions, see the TaskSpace Deployment Guide. Note: Ensure that you install the Process Engine before you install the TaskSpace DAR. For instructions, see the Process Engine Installation Guide. Installing the preconfigured dashboard Follow the instructions provided in this section to execute the DQL script and install the DAR file components of the preconfigured dashboard. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 55

56 Installing the Preconfigured Dashboard After you have installed the preconfigured dashboard, you can log into PRS and open the Preconfigured Dashboard report category. All preconfigured dashboard reports are saved in their own category. Caution: The preconfigured dashboard functionality is not supported for IBM DB2 database. To install the preconfigured dashboard: 1. Uncompress the Preconfigured Dashboard.zip file available in the preconfigured Dashboard Data/ folder of the bam product supplemental_files.zip file, into the <bam.setup.dir>\preconfigured Dashboard\ folder. The following files are uncompressed into the Preconfigured Dashboard\ folder: install.properties InstallDAR.bat installdar.xml PreConfiguredDashboard.dar readme.txt 2. Run preconfigured dashboard shipping data.dql script available in the <bam.setup.dir>\bam Data Loader\<working.dir>\etc\dql\ folder. To run this DQL on Windows, execute the <bam.setup.dir>\bam Data Loader\<working.dir>\bin\createpreconfigured dashboard shipping data.cmd command. On Linux, execute the <bam.setup.dir>\bam Data Loader\<working. dir>\bin\create preconfigured dashboard shipping data.sh command. Note: This operation can be performed only if IDQL is installed. IDQL and IAPI are included and installed with Content Server. IDQL is a command line interface to the Documentum Server that enables the user to enter DQL commands. IAPI is a command line utility that enables the user to issue Documentum API calls directly to a Documentum Content Server. The IAPI functionality is also built into the Documentum Administrator and is a hidden feature of most Documentum clients such as WorkSpace and Desktop Client. For more information, see the Documentum Content Server Administration Guide. 3. Modify the repository, username, and password parameters in the <bam.setup.dir>\preconfigured Dashboard\install.properties file. For example, you can specify the following values: dctm docbase=rep_d65 dctm.username=<repository login> dctm.password=<repository password> 4. (Optional on non Content Server machines only) Modify the dfc.properties file of Documentum Composer 6.5 located in the <Composer install 56 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

57 Installing the Preconfigured Dashboard directory>\composer\plugins\com.emc.ide.external.dfc_1.0.0\documentum. config\ folder to point to the correct docbroker. 5. Modify the location of the Composer installation and its workspace in the <bam.setup.dir>\preconfigured Dashboard\InstallDAR.bat file. For example, you can specify the following values: SET ECLIPSE=D:\COMPOSER SET WORKSPACE=D:\workspaces\composer1 6. Execute the InstallDAR.bat batch file to install the preconfigured dashboard. Alternatively, you can run the PreConfiguredDashboard.dar file. For instructions on installing the DAR file, see the Documentum Composer User Guide. EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 57

58 Installing the Preconfigured Dashboard 58 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide

59 Index B BAM configuring, 49 deploying, 33 overview, 11 system requirements, 34 BAM administration activate monitoring, 50 BAM server activate, 50 connecting to, 49 C configure BAM Host URL, 48 BAM Port, 48 configuring BAM, 49 creating database, 17 D database creating, 17 sizing, 17 deploying BAM server, 33 documentation conventions, 7 I installing BAM server, 27 preconfigured dashboard, 55 M Process Reporting Services, 51 Monitoring activate, 50 O overview BAM, 11 P post deployment guidelines, 48 preconfigured dashboard installing, 55 Process Reporting Services installing, 51 S sizing database, 17 system requirements BAM, 34 T troubleshooting BAM installation using installer, 30 U using BAM installer, 27 EMC Documentum Business Activity Monitor Version 6.5 Installation Guide 59