Beruflich Dokumente
Kultur Dokumente
Version 6.7
Installation Guide
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 017489103
15084351000
www.EMC.com
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.
Copyright 2011 EMC Corporation. All rights reserved.
Table of Contents
Chapter 1
Chapter 2
Chapter 3
Chapter 4
Installing the BAM Server on Red Hat JBoss Application Server ...................31
Overview of installing BAM on Red Hat JBoss....................................................31
Creating BAM database objects manually ..........................................................31
Creating Repository objects manually ................................................................32
Preparing the BAM server WAR file for deployment ............................................33
Enabling DFC connections to the Repository......................................................34
Specifying BAM database connection parameters ..............................................35
Modifying DFC session properties .....................................................................36
Modifying the location of log files .......................................................................36
Table of Contents
Chapter 6
Chapter 7
Table of Contents
Chapter 9
Chapter 10
Chapter 11
Table of Contents
Chapter 13
Chapter 14
Chapter 15
Chapter 16
Chapter 17
Chapter 18
Chapter 19
Chapter 20
Chapter 21
Appendix A
Appendix B
Appendix C
Appendix D
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 for installing the BAM
server on:
Content Server with the JBoss application server in a Windows environment using the BAM
Engine Installer (automatic installation)
Red Hat JBoss application server (manual installation)
Apache Tomcat application server (manual installation)
Oracle WebLogic application server (manual installation)
IBM WebSphere application server (manual installation)
Oracle application server (manual installation)
Sun application server (manual installation)
The final chapters of this guide are dedicated to installing the Process Reporting Services (PRS)
reporting application and the preconfigured dashboards. This installation guide describes decisions
to make and requirements to meet before BAM is installed.
Intended audience
This manual is intended for the person installing the BAM software that includes the BAM server,
the Process Reporting Services Client, and the preconfigured dashboard. Typically, a system
administrator installs the software.
Documentation conventions
This guide uses the following conventions:
Convention
Description
>
code
Preface
Convention
Description
[]
{}
\foldername_or_filename
%%
${ }
Revision history
This section contains a description of this documents revision history.
Table 2
Revision history
Revision Date
Description
April 2011
Initial Publication
Support Information
EMC Documentums technical support services and policies are available at the EMC Powerlink
website (http://powerlink.emc.com). 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.
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.7
Documentum Business Activity Monitor Implementation Guide, version 6.7
Preface
Preface
10
Chapter 1
Overview of Business Activity Monitor
This chapter discusses the following:
11
Download the following BAM product installation files from the Powerlink website
(http://powerlink.emc.com) into a local folder:
bam-product.zip: Contains installation files for all supported application servers, BAM
server, Process Reporting Services, BAM Data Loader components, and the preconfigured
dashboards. The PreConfiguredDashboard.dar is located in: bam-product.zip/BAM
Installer/BAM_Installer_JBoss_win.zip/dars.jar/.
Crystal_Designer_XI_R2_SP2.zip: Contains the Crystal Reports Designer XI R2 SP2 product
installer. Unpack the zipped file, which contains one seat of Crystal Reports.
CR_Designer_license_key.txt: Contains the Crystal Reports Designer License Key. Download this
file into the same folder where you downloaded Crystal_Designer_XI_R2_SP2.zip.
bam-product-supplemental_files.zip: Contains the following Business Activity Monitor
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.
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.
WebSphere\7.0.0.7\Required jars: Contains 5 JAR files that are used when deploying BAM on
WebSphere Application Server version 7.0.0.7.
You can now unpack the bam-product.zip file into the relevant folder.
The following BAM setup folder structure is created in [Temporary BAM setup folder] (for
example, under the C:\Temp folder):
13
The installer will also install the preconfigured dashboard. For instructions, see Installing BAM on
the Java Method Server using the installer, page 25
Installing the BAM server manually Use this option to manually install 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 more information, see the instructions relevant to your application server:
Overview of installing BAM on Red Hat JBoss, page 31
Overview of installing BAM on Apache Tomcat, page 39
Overview of installing BAM on Oracle WebLogic, page 47
Overview of installing BAM on WebSphere, page 55
Overview of installing BAM on Oracle application servers, page 65
Overview of installing BAM on Sun application servers, page 73
Note: For information about the platforms and application servers on which the BAM server can be
installed, see the Business Activity Monitor Release Notes.
15
16
Chapter 2
Preparing the Database
This chapter discusses the following:
17
2. Install the required database, prepare it, and ensure that it is running. If these tasks are not
performed, the installation of the BAM server cannot be completed. 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 by way of a TCP/IP connection.
Note: The BAM server uses its own database to process and maintain monitoring information. The
server does not require the database client for its operations. The server uses the JDBC driver for
database operations.
Parameter name
Value
Security
Connections
Attributes
18
Network
TCP/IP
Parameter name
Value
Server Collation
Case-sensitive
To avoid loss of data, the BAM database collation and the Content
Server database collation must be identical. In addition, the BAM
database collation and BAM database instance collation must be
identical. Having the same collation is required for the BAM server
to function properly on an MS SQL database.
Oracle Parameters
Parameter Name
Value
Comment
DB_BLOCK_SIZE
8,192
DB_CACHE_SIZE
100,000,000
19
Parameter Name
Value
Comment
OPTIMIZER_MODE
CHOOSE
SHARED_POOL_SIZE
50,000,000
LOG_CHECKPOINT_INTERVAL 0
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
DB_FILES
121
TIMED_STATISTICS
TRUE
Note: The database administrator should periodically monitor the database and modify the
parameters based on size changes.
20
TEMPORARY TABLESPACE
MANAGED BY SYSTEM
USING ( C:\DB2\BAM\temp_tbs_4kb )
EXTENTSIZE 16
PREFETCHSIZE 16
OVERHEAD 10.50
TRANSFERRATE 0.14@
3. Add two buffer pools. The first buffer pool must support page size 16 KB. The second buffer
pool must support 32 KB.
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)
21
EXTENTSIZE 4
OVERHEAD 10.5
PREFETCHSIZE 4
TRANSFERRATE 0.14
BUFFERPOOL IBMDEFAULTBP @
7. Create a 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
managers process
In addition, grant the use of the User Tablespaces with 4KB and 16KB and 32-KB page sizes
and User Temporary Tablespace with page size 4 KB.
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 ALEX @
22
23
24
Chapter 3
Installing the BAM Server on the Java
Method Server
This chapter discusses the following:
Post-installation guidelines
25
8. Click Next.
The License Agreement page is displayed.
9. 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 updates.
10. Select a repository, and specify the user credentials.
Note: The user name you enter is the same as the owner of the Documentum installation. If you
specify a different user name, the BAM installation fails.
11. Click Next.
12. Specify the BAM database connection parameters.
The installer validates the database connection information specified, and displays an error
message when it is unable to establish connection with the BAM database.
13. Click Next.
The Products Summary page listing all products and components is displayed.
14. 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.
15. Click Finish to exit the Documentum BAM Engine Installer wizard.
16. Restart the Documentum Java Method Server. For instructions, see Starting the Java Method
Server, page 26 and Stopping the Java Method Server, page 27.
The BAM Server 6.7 installation program creates the following directory structure under the
[documentum.home]\bam\ folder:
27
Post-installation guidelines
Checking for installation errors
Log files are available in the Documentum installation folder. For example, the log files are available
in the C:\Program Files\Documentum\bam\bin and C:\Program Files\Documentum\bam\log folders.
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
If the logs contain errors, contact EMC Technical Support.
28
29
30
Chapter 4
Installing the BAM Server on Red Hat
JBoss Application Server
This chapter discusses the following:
Post-installation guidelines
31
c. If you are using JDK 1.5, copy the ojdbc5.jar file to bam-server.war\WEB-INF\lib.
d. If you are using JDK 1.6, copy the ojdbc6.jar file to bam-server.war\WEB-INF\lib.
EMC Documentum Business Activity Monitor Version 6.7 Installation Guide
33
5. Complete the following steps if you are deploying BAM on JBoss EAP 5.1:
a. If you are installing the BAM server on the Content Server computer, replace
the first line of the dfc.properties file with the following statement:#include
[documentum_user_dir]\config\dfc.properties.
34
For example, specify the path to the dfc.properties file as follows: #include
C:\Documentum\config\dfc.properties.
b. If you are installing the BAM server on a computer other than the Content Server computer,
delete or comment the #include statement. Then, specify the required values for the following
parameters:
dfc.docbroker.host[0]=host_name
dfc.docbroker.port[0]=port_number
3. Save and close the dfc.properties file.
RDBMS
Type
Dialect
Driver Class
Connection URL
MS SQL
mssql
com.microsoft.com.microsoft.
jdbc:sqlserver://<HOST>:<PORT>;
sqlserver.jdbc.SQLServer
Driver
databasename=<DB.NAME>;
SELECTMETHOD=Cursor
Oracle
oracle
oracle.jdbc.driver.OracleDriver
jdbc:oracle:thin:@<HOST>:
<PORT>:<SID>
DB2
db2
com.ibm.db2.jcc.DB2Driver
jdbc:db2://<HOST>:<PORT>/
<DB.NAME>
35
36
37
Post-installation guidelines
Changing the default host and port from TaskSpace to
point to the BAM server URL
If the application server does not use port 8080 by default, then the BAM server port number must be
configured in the BAM Port field of the Administration tab of TaskSpace.
If the BAM server and TaskSpace are not installed on the same physical machine, change the BAM
Host URL from localhost to the IP address of the BAM server machine. This procedure is completed
in the Administration tab of TaskSpace.
For instructions, see the Configuring connection settings section of the Business Activity Monitor
Implementation Guide.
38
Chapter 5
Installing the BAM Server on Apache
Tomcat Application Server
This chapter discusses the following:
Post-installation guidelines
39
41
b. From the bam-product-supplemental_files.zip file you downloaded from the EMC Download
Center, open bam-product-supplemental_files\Oracle.
c. If you are using JDK 1.5, copy the ojdbc5.jar file to bam-server.war\WEB-INF\lib.
d. If you are using JDK 1.6, copy the ojdbc6.jar file to bam-server.war\WEB-INF\lib.
5. Modify the dfc.properties file using instructions in Enabling DFC connections to the Repository,
page 34. Perform this procedure before attempting to connect to Documentum repositories.
6. Modify the jdbc-config.xml file using instructions in Specifying BAM database connection
parameters, page 35.
7. Modify the dfc-config.xml file using instructions in Modifying DFC session properties, page 36.
8. Modify the log4j.properties file using instructions in Modifying the location of log files, page 36.
Note: Externalizing BAM configuration files, page 115 is another approach used to configure the
BAM server.
a. If you are installing the BAM server on the Content Server computer, replace
the first line of the dfc.properties file with the following statement:#include
[documentum_user_dir]\config\dfc.properties.
For example, specify the path to the dfc.properties file as follows: #include
C:\Documentum\config\dfc.properties.
b. If you are installing the BAM server on a computer other than the Content Server computer,
delete or comment the #include statement. Then, specify the required values for the following
parameters:
dfc.docbroker.host[0]=host_name
dfc.docbroker.port[0]=port_number
3. Save and close the dfc.properties file.
42
RDBMS
Type
Dialect
Driver Class
Connection URL
MS SQL
mssql
com.microsoft.com.microsoft.
jdbc:sqlserver://<HOST>:<PORT>;
sqlserver.jdbc.SQLServer
Driver
databasename=<DB.NAME>;
SELECTMETHOD=Cursor
Oracle
oracle
oracle.jdbc.driver.OracleDriver
jdbc:oracle:thin:@<HOST>:
<PORT>:<SID>
DB2
db2
com.ibm.db2.jcc.DB2Driver
jdbc:db2://<HOST>:<PORT>/
<DB.NAME>
43
Copy the bam server folder in [Temporary WAR location] to the [Tomcat server
root]\webapps\ folder.
2. Start the Tomcat application server.
3. Browse to the bam-server URL to verify whether the BAM server is up and running.
44
Post-installation guidelines
Changing the default host and port from TaskSpace to
point to the BAM server URL
If the application server does not use port 8080 by default, then the BAM server port number must be
configured in the BAM Port field of the Administration tab of TaskSpace.
EMC Documentum Business Activity Monitor Version 6.7 Installation Guide
45
If the BAM server and TaskSpace are not installed on the same physical machine, change the BAM
Host URL from localhost to the IP address of the BAM server machine. This procedure is completed
in the Administration tab of TaskSpace.
For instructions, see the Configuring connection settings section of the Business Activity Monitor
Implementation Guide.
46
Chapter 6
Installing the BAM Server on Oracle
Weblogic Application Server
This chapter discusses the following:
Post-installation guidelines
47
c. If you are using JDK 1.5, copy the ojdbc5.jar file to bam-server.war\WEB-INF\lib.
d. If you are using JDK 1.6, copy the ojdbc6.jar file to bam-server.war\WEB-INF\lib.
5. Modify the dfc.properties file using instructions in Enabling DFC connections to the Repository,
page 50. Perform this procedure before attempting to connect to Documentum repositories.
EMC Documentum Business Activity Monitor Version 6.7 Installation Guide
49
6. Modify the jdbc-config.xml file using instructions in Specifying BAM database connection
parameters, page 50.
7. Modify the dfc-config.xml file using instructions in Modifying DFC session properties, page 51.
8. Modify the log4j.properties file using instructions in Modifying the location of log files, page 52.
Note: Externalizing BAM configuration files, page 115 is another approach used to configure the
BAM server.
a. If you are installing the BAM server on the Content Server computer, replace
the first line of the dfc.properties file with the following statement:#include
[documentum_user_dir]\config\dfc.properties.
For example, specify the path to the dfc.properties file as follows: #include
C:\Documentum\config\dfc.properties
b. If you are installing the BAM server on a computer other than the Content Server computer,
delete, or comment the #include statement. Then, specify the required values for the following
parameters:
dfc.docbroker.host[0]=host_name
dfc.docbroker.port[0]=port_number
3. Save and close the dfc.properties file.
2. Modify the following BAM database connection parameters with the relevant values by editing
the XML file. You can open the XML file using a standard file editor or an XML editor. Modify
the following XML element values:
dialect: For example, in the case of MS SQL, change <dialect>$C(BAM,
DCTM_BAM_DB_DIALECT)</dialect> to <dialect>mssql</dialect>
URL
driver
username
password
Use the RDBMS Type, Dialect, and Driver Class values specified in the following table, and
specify the Connection URL based on your RDBMS environment:
Table 7
RDBMS
Type
Dialect
Driver Class
Connection URL
MS SQL
mssql
com.microsoft.com.microsoft.
jdbc:sqlserver://<HOST>:<PORT>;
sqlserver.jdbc.SQLServer
Driver
databasename=<DB.NAME>;
SELECTMETHOD=Cursor
Oracle
oracle
oracle.jdbc.driver.OracleDriver
jdbc:oracle:thin:@<HOST>:
<PORT>:<SID>
DB2
db2
com.ibm.db2.jcc.DB2Driver
jdbc:db2://<HOST>:<PORT>/
<DB.NAME>
51
$C(BAM, SECURE.DOCBASE_PASSWORD)
</password>
</session>
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 references. 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.
52
53
Post-installation guidelines
Changing the default host and port from TaskSpace to
point to the BAM server URL
If the application server does not use port 8080 by default, then the BAM server port number must be
configured in the BAM Port field of the Administration tab of TaskSpace.
If the BAM server and TaskSpace are not installed on the same physical machine, change the BAM
Host URL from localhost to the IP address of the BAM server machine. This procedure is completed
in the Administration tab of TaskSpace.
For instructions, see the Configuring connection settings section of the Business Activity Monitor
Implementation Guide.
54
Chapter 7
Installing the BAM Server on IBM
WebSphere Application Server
This chapter discusses the following:
Post-installation guidelines
55
utility is installed as part of the BAM server installer for JBoss and also resides in bam-product.zip.
To create BAM database objects:
1. Access one of the following folders:
Windows: [Temporary BAM setup folder]\BAM Data Loader\bin\
UNIX/Linux: [Temporary BAM setup folder]/BAM Data Loader/bin/
2. Execute the following batch/shell files and when prompted, provide the BAM database connection
parameters on the command line:
For Microsoft SQL-Server:
Windows: create-db-objects-mssql.cmd
UNIX/Linux: create-db-objects-mssql.sh
For DB2 database:
Windows: create-db-objects-db2.cmd
UNIX/Linux: create-db-objects-db2.sh
For Oracle database:
Windows: create-db-objects-oracle.cmd
UNIX/Linux: create-db-objects-oracle.sh
57
3. Unpack the bam-server.war file into the [Temporary WAR location]\bam-server.war folder.
For instructions about unpacking the WAR file, see Unpacking WAR Files, page 109.
4. If you are using an Oracle 10 or 11 BAM database, complete the steps below. Otherwise, proceed
to step 5.
c. If you are using JDK 1.5, copy the ojdbc5.jar file to bam-server.war\WEB-INF\lib.
d. If you are using JDK 1.6, copy the ojdbc6.jar file to bam-server.war\WEB-INF\lib.
5. Modify the dfc.properties file using instructions in Enabling DFC connections to the Repository,
page 42. Perform this procedure before attempting to connect to Documentum repositories.
6. Modify the jdbc-config.xml file using instructions in Specifying BAM database connection
parameters, page 43.
7. Modify the dfc-config.xml file using instructions in Modifying DFC session properties, page 43.
8. Modify the log4j.properties file using instructions in Modifying the location of log files, page 44.
9. If you are deploying BAM on WebSphere version 7.0.0.7, replace jaxen-full.jar
in bam-server.war\WEB-INF\lib with the jaxen-full.jar file located in
bam-product-supplemental_files.zip\WebSphere\7.0.0.7\Required jars\jaxen-full.jar.
10. Create a deployment archive bam-server.war that includes all the updated configuration file
changes.
Repack the bam-server.war file comprising the updated configuration files, and then deploy the
bam-server.war file on the IBM WebSphere application. For instructions about repacking the
WAR file, see Repacking WAR Files, page 109.
Note: Externalizing BAM configuration files, page 115 is another approach used to configure the
BAM server.
a. If you are installing the BAM server on the Content Server computer, replace
the first line of the dfc.properties file with the following statement:#include
[documentum_user_dir]\config\dfc.properties.
For example, specify the path to the dfc.properties file as follows: #include
C:\Documentum\config\dfc.properties.
58
b. If you are installing the BAM server on a computer other than the Content Server computer,
delete or comment the #include statement. Then, specify the required values for the following
parameters:
dfc.docbroker.host[0]=host_name
dfc.docbroker.port[0]=port_number
3. Save and close the dfc.properties file.
RDBMS
Type
Dialect
Driver Class
Connection URL
MS SQL
mssql
com.microsoft.com.microsoft.
jdbc:sqlserver://<HOST>:<PORT>;
sqlserver.jdbc.SQLServer
Driver
databasename=<DB.NAME>;
SELECTMETHOD=Cursor
Oracle
oracle
oracle.jdbc.driver.OracleDriver
jdbc:oracle:thin:@<HOST>:
<PORT>:<SID>
DB2
db2
com.ibm.db2.jcc.DB2Driver
jdbc:db2://<HOST>:<PORT>/
<DB.NAME>
59
Note: If you are deploying BAM on WebSphere version 7.0.0.x, the jaxen-full.jar file
in bam-server.war/WEB-INF/lib must be replaced with the jaxen-full.jar file located in
bam-product-supplemental_files.zip/WebSphere/7.0.0.7/Required jars/jaxen-full.jar. This file
replacement is done prior to repacking the bam-server.war file.
Follow the instructions in this section to configure the WebSphere application server before you deploy
the BAM application on it.
To configure the WebSphere application server:
1. Change directory to [WebSphere root]/optionalLibraries.
2. Create a folder with the name BAM.
3. Copy the following jar files to BAM directory you just created:
[Temporary WAR location]\bamserver.war\WEB-INF\lib\aspectjrt.jar
[Temporary WAR location]\bamserver.war\WEB-INF\lib\saaj-api.jar
[Temporary WAR location]\bamserver.war\WEB-INF\lib\saaj-impl.jar
[Temporary BAM setup folder]\BAM Server\WebSphere\Required JARs\xalan.jar
[Temporary BAM setup folder]\BAM Server\WebSphere\Required JARs\xercesImpl.jar.
4. In WebSphere Administration Console select Environment > Shared Libraries.
5. In the Scope list box select Cell=Cell_Name.
6. Create a shared library for each jar that was copied:
a. Select New.
b. Enter a name for the library.
c. In the Classpath field enter
${WAS_INSTALL_ROOT}/optionalLibraries/BAM/[jar_name].
61
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.
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 made to the master configuration.
i. On the Enterprise Applications page select the bam-server.war application.
j. Select Shared library references.
k. Select the bam-server.war application and click Reference shared library.
l. Transfer all libraries created during step 6 of the Configuring the WebSphere Application Server
section from the Available list to the Selected list.
m. Select OK.
n. Select OK and Save.
o. 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 http://<BAM server IP/machine name>:<port>/bam-server/.
If the BAM server is running, the BAM server Welcome page is displayed.
62
Post-installation guidelines
Changing the default host and port from TaskSpace to
point to the BAM server URL
If the application server does not use port 8080 by default, then the BAM server port number must be
configured in the BAM Port field of the Administration tab of TaskSpace.
If the BAM server and TaskSpace are not installed on the same physical machine, change the BAM
Host URL from localhost to the IP address of the BAM server machine. This procedure is completed
in the Administration tab of TaskSpace.
For instructions, see the Configuring connection settings section of the Business Activity Monitor
Implementation Guide.
EMC Documentum Business Activity Monitor Version 6.7 Installation Guide
63
64
Chapter 8
Installing the BAM Server on Oracle
Application Server
This chapter discusses the following:
Post-installation guidelines
65
BAM Repository and database objects when there are Repository- or database-related errors. This
utility is installed as part of the BAM server installer for JBoss and also resides in bam-product.zip.
To create BAM database objects:
1. Access one of the following folders:
Windows: [Temporary BAM setup folder]\BAM Data Loader\bin\
UNIX/Linux: [Temporary BAM setup folder]/BAM Data Loader/bin/
2. Execute the following batch/shell files and when prompted, provide the BAM database connection
parameters on the command line:
For Microsoft SQL-Server:
Windows: create-db-objects-mssql.cmd
UNIX/Linux: create-db-objects-mssql.sh
For DB2 database:
Windows: create-db-objects-db2.cmd
UNIX/Linux: create-db-objects-db2.sh
For Oracle database:
Windows: create-db-objects-oracle.cmd
UNIX/Linux: create-db-objects-oracle.sh
Server machine.
To create the Repository objects:
1. Access one of the following folders:
Windows: [Temporary BAM setup folder]\BAM Data Loader\bin\
UNIX/Linux: [Temporary BAM setup folder]/BAM Data Loader/bin/
2. Run one of the following batch/shell files:
Windows: create-repo-objects.cmd
UNIX/Linux: create-repo-objects.sh
3. When prompted, provide the following Repository connection parameters on the command line:
repository name
login name (repository owner or administrator name)
password
When you run the create-repo-objects command, you get the following outputs:
run-api finished with errorlevel = 0
run-dql finished with errorlevel = 1
This output is normal.
4. Verify the results of running the SQL script by viewing the following log files in the BAM Data
Loader folder:
run-api.log
run-dql.log
67
c. If you are using JDK 1.5, copy the ojdbc5.jar file to bam-server.war\WEB-INF\lib.
d. If you are using JDK 1.6, copy the ojdbc6.jar file to bam-server.war\WEB-INF\lib.
7. In <Temporary WAR location>\bam-server.war modify the dfc.properties file using instructions in
Enabling DFC connections to the Repository, page 58. Perform this procedure before attempting
to connect to Documentum repositories.
8. Modify the jdbc-config.xml file using instructions in Specifying BAM database connection
parameters, page 59.
9. Modify the dfc-config.xml file using instructions in Modifying DFC session properties, page 60.
10. Modify the log4j.properties file using instructions in Modifying the location of log files, page 60.
11. Create a deployment archive bam-server.war that includes all the updated configuration file
changes. Repack the bam-server.war file comprising the updated configuration files, and then
deploy the bam-server.war file on the Oracle 10g application.
For instructions about repacking the WAR file, see Repacking WAR Files, page 109.
Note: Externalizing BAM configuration files, page 115 is another approach used to configure the
BAM server.
a. If you are installing the BAM server on the Content Server computer, replace
the first line of the dfc.properties file with the following statement:#include
[documentum_user_dir]\config\dfc.properties.
For example, specify the path to the dfc.properties file as follows: #include
C:\Documentum\config\dfc.properties.
b. If you are installing the BAM server on a computer other than the Content Server computer,
delete or comment the #include statement. Then, specify the required values for the following
parameters:
dfc.docbroker.host[0]=host_name
dfc.docbroker.port[0]=port_number
3. Save and close the dfc.properties file.
68
RDBMS
Type
Dialect
Driver Class
Connection URL
MS SQL
mssql
com.microsoft.com.microsoft.
jdbc:sqlserver://<HOST>:<PORT>;
sqlserver.jdbc.SQLServer
Driver
databasename=<DB.NAME>;
SELECTMETHOD=Cursor
Oracle
oracle
oracle.jdbc.driver.OracleDriver
jdbc:oracle:thin:@<HOST>:
<PORT>:<SID>
DB2
db2
com.ibm.db2.jcc.DB2Driver
jdbc:db2://<HOST>:<PORT>/
<DB.NAME>
69
a. Clear the selection of the Inherit parent applications shared libraries imports option.
b. Select the Search Local Classes First option.
c. Click OK to continue.
13. Click Deploy.
The deployment process is initiated.
14. Click Return.
15. To verify whether the BAM application was installed successfully open the OC4J Administrator
Console in a browser using the following URL: http://<host>:<port>/em/console.
The default port number is 8888.
The OC4J Administrator Console is displayed.
16. In the Applications tab, select the bam-server application.
71
Post-installation guidelines
Changing the default host and port from TaskSpace to
point to the BAM server URL
If the application server does not use port 8080 by default, then the BAM server port number must be
configured in the BAM Port field of the Administration tab of TaskSpace.
If the BAM server and TaskSpace are not installed on the same physical machine, change the BAM
Host URL from localhost to the IP address of the BAM server machine. This procedure is completed
in the Administration tab of TaskSpace.
For instructions, see the Configuring connection settings section of the Business Activity Monitor
Implementation Guide.
72
Chapter 9
Installing the BAM Server on Sun
Application Servers
This chapter discusses the following:
Post-installation guidelines
73
utility is installed as part of the BAM server installer for JBoss and also resides in bam-product.zip.
To create BAM database objects:
1. Access one of the following folders:
Windows: [Temporary BAM setup folder]\BAM Data Loader\bin\
UNIX/Linux: [Temporary BAM setup folder]/BAM Data Loader/bin/
2. Execute the following batch/shell files and when prompted, provide the BAM database connection
parameters on the command line:
For Microsoft SQL-Server:
Windows: create-db-objects-mssql.cmd
UNIX/Linux: create-db-objects-mssql.sh
For DB2 database:
Windows: create-db-objects-db2.cmd
UNIX/Linux: create-db-objects-db2.sh
For Oracle database:
Windows: create-db-objects-oracle.cmd
UNIX/Linux: create-db-objects-oracle.sh
75
4. If you are using an Oracle 10 or 11 BAM database, complete the steps below. Otherwise, proceed
to step 5.
c. If you are using JDK 1.5, copy the ojdbc5.jar file to bam-server.war\WEB-INF\lib.
d. If you are using JDK 1.6, copy the ojdbc6.jar file to bam-server.war\WEB-INF\lib.
5. Modify the dfc.properties file using instructions in Enabling DFC connections to the Repository,
page 68. Perform this procedure before attempting to connect to Documentum repositories.
6. Modify the jdbc-config.xml file using instructions in Specifying BAM database connection
parameters, page 69.
7. Modify the dfc-config.xml file using instructions in Modifying DFC session properties, page 69.
8. Modify the log4j.properties file using instructions in Modifying the location of log files, page 70.
9. Create a deployment archive bam-server.warthat includes all the updated configuration file
changes.
10. Repack the bam-server.war file comprising the updated configuration files.
For instructions about repacking the WAR file, see Repacking WAR Files, page 109.
11. Deploy the bam-server.war file on either the Sun GlassFish 2.1 Application Server or the Sun
Java System Application Server 8.2.
Note: Externalizing BAM configuration files, page 115 is another approach used to configure the
BAM server.
a. If you are installing the BAM server on the Content Server computer, replace
the first line of the dfc.properties file with the following statement:#include
[documentum_user_dir]\config\dfc.properties.
For example, specify the path to the dfc.properties file as follows: #include
C:\Documentum\config\dfc.properties.
b. If you are installing the BAM server on a computer other than the Content Server computer,
delete or comment the #include statement. Then, specify the required values for the following
parameters:
76
dfc.docbroker.host[0]=host_name
dfc.docbroker.port[0]=port_number
3. Save and close the dfc.properties file.
RDBMS
Type
Dialect
Driver Class
Connection URL
MS SQL
mssql
com.microsoft.com.microsoft.
jdbc:sqlserver://<HOST>:<PORT>;
sqlserver.jdbc.SQLServer
Driver
databasename=<DB.NAME>;
SELECTMETHOD=Cursor
Oracle
oracle
oracle.jdbc.driver.OracleDriver
jdbc:oracle:thin:@<HOST>:
<PORT>:<SID>
DB2
db2
com.ibm.db2.jcc.DB2Driver
jdbc:db2://<HOST>:<PORT>/
<DB.NAME>
77
Post-installation guidelines
Changing the default host and port from TaskSpace to
point to the BAM server URL
If the application server does not use port 8080 by default, then the BAM server port number must be
configured in the BAM Port field of the Administration tab of TaskSpace.
EMC Documentum Business Activity Monitor Version 6.7 Installation Guide
79
If the BAM server and TaskSpace are not installed on the same physical machine, change the BAM
Host URL from localhost to the IP address of the BAM server machine. This procedure is completed
in the Administration tab of TaskSpace.
For instructions, see the Configuring connection settings section of the Business Activity Monitor
Implementation Guide.
80
Chapter 10
Configuring Business Activity Monitor
This chapter discusses the following:
Overview of configuration
Overview of configuration
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 connection allows monitoring to be activated.
Note: Refer to chapter 3 of the Documentum Business Activity Monitor 6.7 Implementation Guide for
additional configuration steps including turning the Audit Trail on, and making SDTs and package
object types reportable.
81
82
Chapter 11
Installing Process Reporting Services
This chapter discusses the following:
Logging in to PRS
I18N Notes
System Component
Requirement
Platform
83
System Component
Requirement
Software
At least 1 GB of RAM
Network
Disk Space
Operating system
Note: PRS is shipped with JRE Version 1.6. When installing PRS use the same Java vendor and
version that is used on the BAM server. To make these versions consistent change the Java version that
works with PRS. Changing the version of Java is completed by replacing the contents of the <PRS
Installation>\jre with the new version of Java.
jre
plugins
eclipseproduct
PRS.exe
PRS.ini
Logging in to PRS
Start the BAM server before logging in to PRS. The BAM server must be started first because PRS
consumes services provided by the BAM server.
To log in to PRS:
1. Access [PRS target folder].
2. Run PRS.exe.
The PRS Client Login dialog box is displayed.
3. Click Connect.
The Server Host Configuration dialog box is displayed.
4. Enter the Host URL.
The URL must be entered because PRS consumes services provided by the BAM server. The URL
must be specified in this format: http://<host>:<port>/bam-server
Note: The default port for the Java Method Server is 9080. Change the port when you connect
from PRS to the BAM server for the first time, if you deployed the BAM server on JMS.
5. Click OK.
6. Specify the login credentials.
7. Click OK.
85
I18N Notes
East Asian language fonts must be installed on the Windows platform, in order for users to work with
the 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.
Ensure that the database is installed with the Unicode character set.
86
Chapter 12
Installing the Preconfigured
Dashboards
This chapter discusses the following:
87
Note: Install the Process Engine before you install the TaskSpace DAR. For instructions, see the
Process Engine Installation Guide.
88
Chapter 13
Upgrading Business Activity Monitor
from 6.5 to 6.5 SP1
This chapter discusses the following:
89
90
Chapter 14
Upgrading Business Activity Monitor
from 6.5 SP1 to 6.5 SP2
This chapter discusses the following:
91
92
Chapter 15
Upgrading Business Activity Monitor
from 6.5 SP2 to 6.6
This chapter discusses the following:
93
94
Chapter 16
Upgrading Business Activity Monitor
from 6.6 to 6.7
This chapter discusses the following:
95
96
Chapter 17
Upgrading BAM Artifacts
This chapter discusses the following:
Upgrading BAM artifacts from version 6.5 and 6.5 SP1 to version 6.6
Note: The bami_rg_report_entity_field type has changed in version 6.6. This field type must be
changed in the original repository before attempting to package the DAR.
2. Open Documentum Composer version 6.6.
3. From the Preferences menu select Java > Installed JREs.
The Edit JRE window opens.
4. Click the Directory button to locate and then select the JRE to be edited.
EMC Documentum Business Activity Monitor Version 6.7 Installation Guide
97
Note: The bami_rg_report_entity_field type has changed in version 6.6. This field type must be
changed in the original repository before attempting to package the DAR.
2. Open Documentum Composer version 6.6.
3. Archive the BAM 6.5 SP2 artifacts using Composer 6.6 to generate a custom DAR file.
4. Shut down the BAM server.
5. Install the custom DAR file in the 6.6 environment using the DAR Installer 6.6.
6. Restart the BAM server.
98
99
percentWidth="1040"
height="361" percentHeight="1050"/>
<states>
<state event="no_state" dashletId="11"
contentId="0800002d80018455" contentName="SDT Report"
reportPath="/System/BAM/Report Categories/my_reports"
contentType="html" reportType="3" contentFormat="PIE3D"
isDefault="true"/>
5. Save the dashboard xml back to the repository with the same dashboard ID.
100
Chapter 18
Installation Verification
This chapter discusses the following:
Installation Verification
Installation Verification
Each of the manual installations tracks the progress of the installation and writes errors to three
different log files. These log files can be opened and used to verify that BAM has installed successfully.
In general, always search for the word Error in each log file. Error messages indicate that BAM has
not installed successfully. If you know or suspect that BAM has not installed correctly, then follow the
instructions in Dropping object types and tables from a BAM database, page 107.
The rest of this chapter includes the location of each installation log file. It also contains a description
of what to look for as evidence of a successful installation of BAM. The log files are:
data-loader.log
Location:
Windows: [Temporary BAM setup folder]\BAM Data Loader\log
UNIX:/Linux: [Temporary BAM setup folder]/BAM Data Loader/log
What to look for: Make sure that there are no Error messages.
run-api.log
Location:
Windows: [Temporary BAM setup folder]\BAM Data Loader\log
UNIX:/Linux: [Temporary BAM setup folder]/BAM Data Loader/log
What to look for: Make sure that there are no Error messages. The log file output pattern
approximates the following:
run-api.log pattern
101
Installation Verification
run-dql.log
Location:
Windows: [Temporary BAM setup folder]\BAM Data Loader\log
UNIX:/Linux: [Temporary BAM setup folder]/BAM Data Loader/log
What to look for: Make sure that there are no Error messages. Messages about connecting to a
repository and creating objects are written to the log file. The log file output pattern approximates
the following:
run-dql.log pattern
102
Chapter 19
Uninstalling BAM
This chapter discusses the following:
103
Uninstalling BAM
104
Chapter 20
Clustering Business Activity Monitor
This chapter discusses the following:
105
106
Chapter 21
Troubleshooting
This chapter discusses the following:
107
Troubleshooting
108
Appendix A
Working with WAR and EAR Files
109
110
Appendix B
Working with the data-loader.properties
file
Property
Description
bam.db.dialect
Enter the BAM database dialect. oracle, mssql, and db2 are valid
values.
bam.db.url
bam.db.driver
bam.db.user
bam.db.password
111
Property
Description
bam.db.name
bam.dataloader.input.file
To connect with the repository you can either enter the path to the dfc.properties file, or enter the
repository name, username, password, IP address, and port. The following Documentum repository
properties are entered in the data-loader.properties file:
Table B.13
Property
Description
bam.dfc.properties.path
Enter the path to the dfc. properties file. The dfc.properties file is
the preferred approach to upgrading with the Data Loader. When
a valid path is entered, the dfc.properties file is the method used
for connecting to the repository instead of connecting by way of
the properties listed below. If you choose not to enter a valid
path, then place a pound sign (#) at the beginning of the property
to comment it out.
bam.repository
bam.repository.user
bam.repository.password
bam.repository.host
bam.repository.port
Figure 4
The data-loader.properties file is shipped with the upgrade scripts made available with BAM. The
data-loader.properties file is formatted as a template that provides a list of each property, an example of
a valid value, and then a space for the user to enter the connection property. In the following figure DB
dialect is the first property listed. Within the commented (#) section is a list of valid values. Just below
the commented section is a space for the actual DB dialect to be entered. The DB dialect is entered by
substituting $C(BAM, DCTM_BAM_DB_DIALECT) with a valid value.
Note: For each property in the data-loader.properties file, the characters to the left of the equal sign
(=) must remain.
112
113
Appendix C
Externalizing BAM configuration files
115
Appendix D
Security
117
certificate is in the local path, open a command-prompt, change the directory to <PATH TO
PRS>\jre\bin and execute the following:
keytool -importcert -alias <ANY NAME> -file <PATH TO CERTIFICATE FILE>
-keystore ..\lib\security\cacerts
Security
3. If the Secure Connection Failed dialog does not appear, then the browser trusts the certificate.
Double-click the yellow lock icon on the status bar at the bottom of the browser window. Then
proceed to step 5.
4. On the Add Security Exception dialog, click View. The Certificate Viewer dialog appears.
5. On the Certificate Viewer dialog, click the Details tab.
6. Then, click Export and save the file in the default format.
Note: Make a note of the location of the saved certificate and refer to this location in the keytool
command.
119
7. Deploy TaskSpace.
120
Index
B
BAM
configuring, 81
BAM administration
activate monitoring, 82
BAM server
activate, 82
connecting to, 81
installing on Apache Tomcat application
server, 39
installing on IBM WebSphere application
server, 55
installing on JBoss application server, 31
installing on Oracle application server, 65
installing on Sun application servers, 73
installing on the WebLogic application
server, 47
post-installation
guidelines, 28, 38, 45, 54, 63, 72, 79
preconfigured dashboard
installing, 87
Process Reporting Services
installing, 83
C
configure
BAM Host URL, 28, 38, 45, 54, 63, 72, 79
BAM Port, 28, 38, 45, 54, 63, 72, 79
configuring
BAM, 81
T
troubleshooting
BAM installation using installer, 29
U
unpacking and repacking
WAR files, 109
upgrading
BAM 6.5 SP1 to 6.5 SP2, 91
BAM 6.5 SP2 to 6.6, 93
BAM 6.5 to 6.5 SP1, 89
BAM 6.6 to 6.7, 95
using BAM installer, 25
W
D
database
preparing, 17
documentation conventions, 7
WAR files
unpacking and repacking, 109
I
installing
BAM server, 25
BAM server on Apache Tomcat
application server, 39
BAM server on IBM WebSphere
application server, 55
BAM server on JBoss application server, 31
BAM server on Oracle application server, 65
BAM server on Sun application servers, 73
preconfigured dashboard, 87
Process Reporting Services, 83
M
migrating
BAM 6.5 SP1 to 6.5 SP2, 91
BAM 6.5 SP2 to 6.6, 93
BAM 6.5 to 6.5 SP1, 89
BAM 6.6 to 6.7, 95
Monitoring
activate, 82
121