IBM FileNet P8 Platform

Version 5.1.0

Installation Guide for installation on Microsoft Windows with Oracle, IBM WebSphere Application Server, and Windows Active Directory

GC19-3071-04

IBM FileNet P8 Platform

Version 5.1.0

Installation Guide for installation on Microsoft Windows with Oracle, IBM WebSphere Application Server, and Windows Active Directory

GC19-3071-04

Note Before using this information and the product it supports, read the information in Notices on page 295.

This edition applies to version 5.1.0 of IBM FileNet Content Manager (product number 5724-R81), version 5.1.0 of IBM FileNet Business Process Manager (product number 5724-R76), and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 2001, 2011. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents
ibm.com and related resources . . . . ix
How to send your comments . . . . . . . . ix Contacting IBM . . . . . . . . . . . . . x Installing IBM Content Search Services Client files on Content Engine servers . . . . . . Installing IBM Content Search Services Client files interactively . . . . . . . Installing IBM Content Search Services Client files silently . . . . . . . . . Installing the latest Content Search Engine Client files on Content Engine servers . . . Installing Content Search Engine Client files interactively . . . . . . . . . Installing Content Search Engine Client files silently . . . . . . . . . . . Installing the latest Process Engine Client files on Content Engine servers . . . . . . . . . Installing the latest Process Engine Client files on Content Engine servers interactively . . . Installing the latest Process Engine Client files on Content Engine servers silently. . . . . Configuring Content Engine . . . . . . . . . Resolving the names of existing data sources . . Granting directory permissions to the Configuration Manager user . . . . . . . . Configuring Content Engine instances . . . . Configuring Content Engine instances by using the graphical user interface . . . . . Starting the Configuration Manager graphical user interface . . . . . . . Changing the password save preference . . Creating a new configuration profile . . . Configuring the Global Configuration Data JDBC data source settings . . . . . . Configuring the login modules (WebSphere and JBoss only) . . . . . . . . . . Configuring Content Engine application server authentication (LDAP) settings . . Configuring the bootstrap settings . . . . Configuring instances by using the command line . . . . . . . . . . . . . . . Generating the configuration XML files for a Content Engine instance . . . . . . Editing the configuration XML files for a Content Engine instance . . . . . . . Running the configuration XML files . . . Checking the completion status of Content Engine configuration tasks . . . . . . Enabling application server connections after database failover . . . . . . . . . . . . Enabling application server connections after database failover (WebSphere 6.1) . . . . . . Enabling application server connections after database failover (WebSphere 7.0) . . . . . . Deploying Content Engine instances . . . . . . Deploying instances by using the graphical user interface . . . . . . . . . . . . . . Deploying Content Engine by using the Configuration Manager command line . . . . 29 30 30 31 32 33 33 34 34 35 37 37 38 38 39 40 40 41 43 44 45 47 47 52 55 59 62 62 62 63 63 65

Part 1. Installing a single-server IBM FileNet P8 Platform system . . . . . 1

Preparing for the installation . . . . . . 3 Running the Composite Platform Installation Tool . . . . . . . . . . . 5
Running the Composite Platform Installation Tool interactively . . . . . . . . . . . . . Running the Composite Platform Installation Tool silently . . . . . . . . . . . . . . . . 5 . 6

Verifying a successful installation . . . 9 Removing administrator passwords . . 11 Restarting components in a single-server IBM FileNet P8 environment . . . . . . . . . . . . 13
Restarting FileNet P8 system components on a Microsoft Windows server . . . . . . . . . 13

Part 2. Installing a distributed IBM FileNet P8 Platform system . . . . 15

Installing IBM FileNet P8 Platform documentation . . . . . . . . . . . 17
Installing the local information center . . Installing the IBM FileNet P8 Platform information center interactively. . . . Installing the IBM FileNet P8 Platform information center silently . . . . . Starting and verifying the IBM FileNet P8 information center . . . . . . . . . Backing up and redeploying the FileNet P8 information center . . . . . . . . . . . . . . . . . . . . 17 . 18 . 19 . 20 . 21

Installing and configuring Content Engine . . . . . . . . . . . . . . . 23

Installing Content Engine and related client software Installing Content Engine. . . . . . . . . Installing Content Engine interactively . . . Installing Content Engine silently . . . . . Installing Enterprise Manager . . . . . . . Installing Content Engine software updates. . . Installing Content Search Engine Client files . . 24 25 26 26 27 28 29

Copyright IBM Corp. 2001, 2011

iii

Generating the deployapplication.xml file . . Editing the deployment configuration files . . Running the deployapplication.xml file . . . Checking the configuration status of the deployapplication task . . . . . . . . Installing storage device source files . . . . . . Installing Tivoli Storage Manager client and adding native API library paths (WebSphere Application Server) . . . . . . . . . . . Installing Tivoli Storage Manager client . . . Copying the Tivoli Storage Manager API libraries to additional servers . . . . . . Creating a shared library definition for Tivoli Storage Manager native API library files. . . Installing or updating EMC Centera SDK library files . . . . . . . . . . . . . . . . Installing EMC Centera SDK library files . . Configuring EMC Centera SDK environment variables . . . . . . . . . . . . . Configuring file stores for high availabilty . . . . Completing Content Engine post-deployment steps Completing Content Engine post-deployment steps (WebSphere) . . . . . . . . . . . Verifying the Content Engine deployment . . . . Establishing the FileNet P8 domain and Global Configuration Data (GCD) . . . . . . . . . Creating the data sources for an object store . . . Creating the initial object store data sources by using the graphical user interface . . . . . . Creating additional object store data sources by using the graphical user interface . . . . . . Creating the data sources by using the command line . . . . . . . . . . . . . . . . Creating the initial object store . . . . . . . . Connecting to a highly available Content Engine . . Content Engine in an application server cluster by using EJB transport. . . . . . . . . . Connecting by using Content Engine Web Service Transport (CEWS) . . . . . . . . . . . Verifying the Content Engine system . . . . . .

65 67 68 68 69

69 70 70 70 70 71 72 72 73 73 74 76 79 79 81 83 85 87 88 88 89

Configuring SSL for IBM Content Search Services . . . . . . . . . . . . . 98 Encrypting data transmitted over the network . . . . . . . . . . . . 98 Performing SSL server authentication . . . 99 Installing and configuring IBM Legacy Content Search Engine . . . . . . . . . . . . . 102 Installing IBM Legacy Content Search Engine 103 Installing IBM Legacy Content Search Engine (Windows) . . . . . . . . . . . . 103 Installing IBM Legacy Content Search Engine interactively (Windows) . . . . 104 Installing IBM Legacy Content Search Engine silently (Windows) . . . . . . 105 Completing IBM Legacy Content Search Engine installation in a highly available environment (Windows) . . . . . . . 106 Setting the logon user for the K2 Administration Server service (Windows) . 107 Configuring IBM Legacy Content Search Engine 108 Configuring services on Administration Servers . . . . . . . . . . . . . 112 (optional) Installing additional locales . . . . 113 Installing additional locales (Windows) . . . 113 Creating a IBM Legacy Content Search Engine collections directory . . . . . . . . . . 115 Collections directory requirements . . . . 115 Configuring Content Engine for content-based retrieval . . . . . . . . . . . . . . 116 Enabling additional K2 index servers and search servers . . . . . . . . . . . 119 Verifying the IBM Legacy Content Search Engine installation. . . . . . . . . . . 119

Installing and configuring Process Engine . . . . . . . . . . . . . . 121

Installing Process Engine . . . . . . . . . Installing Process Engine interactively . . . . Installing the Process Engine software interactively (Windows) . . . . . . . . Installing Process Engine silently . . . . . . Installing the Process Engine software silently (Windows) . . . . . . . . . Installing Process Engine software updates . . Installing the latest Content Engine client files on Process Engine servers . . . . . . . . . . Installing the latest Content Engine client files on Process Engine servers interactively . . . . Installing the latest Content Engine client files on Process Engine servers silently . . . . . Configuring Process Engine . . . . . . . . Configuring a Process Engine virtual server and database interactively. . . . . . . . . . Configuring a Process Engine virtual server and database silently . . . . . . . . . . . Encrypting passwords for Process Engine . . . Configuring a Process Engine isolated region . . . Defining a Process Engine isolated region on the Content Engine . . . . . . . . . . . . Creating a Process Engine Connection Point . . 121 122 122 123 123 124 124 125 126 127 127 129 133 134 134 135

Installing and configuring Content Search Engine . . . . . . . . . . . 91

Installing and configuring IBM Content Search Services . . . . . . . . . . . . . . . Installing IBM Content Search Services . . . . Configuring IBM Content Search Services . . . Getting the IBM Content Search Services authentication token . . . . . . . . . Configuring Content Engine for IBM Content Search Services . . . . . . . . . . . Configuring IBM Content Search Services servers on Content Engine . . . . . . Adding index areas for IBM Content Search Services . . . . . . . . . . . . Enabling text search on the object store . . Configuring objects that can be indexed for content based retrieval. . . . . . . . Verifying the IBM Content Search Services installation . . . . . . . . . . . . 91 92 93 93 93 94 95 95 95 96

| |

iv

Installation Guide

Defining a Process Engine isolated region interactively . . . . . . . . . . . . Defining and initializing a Process Engine isolated region silently . . . . . . . . Additional configuration for cluster server environments . . . . . . . . . . . . Configuring SSL communication between Process Engine and Content Engine . . . . . . . Adding instances to a Process Engine farm . . Verifying Process Engine installation . . . . Configuring the Dispatcher service or process in WebSphere Edge Components . . . . . . .

. 135 . 136 . 138 . 138 . 139 . 139 . 141

Enabling user access to the workflow subscription wizard . . . . . . Enhanced Timezone Detection . . . Updating Application Engine settings in balanced environment . . . . . .

. . . . . . a load . . .

. 175 . 175 . 175

Configuration and startup tasks . . . 177

Configuring the Process Engine connection point for Application Engine . . . . . . . . . . Enabling SSL between the Process Engine and the Process Engine client . . . . . . . . . . . Setting up Content Engine and client transport SSL security . . . . . . . . . . . . . . . Enabling SSL for Content Engine . . . . . . Enabling SSL between Enterprise Manager and the directory service . . . . . . . . . . Setting up Application Engine SSL security . . . Setting up full SSL support on a single Application Engine . . . . . . . . . . Setting up SSL redirect on a single Application Engine server . . . . . . . . . . . . Setting up SSL redirect on two Application Engine servers . . . . . . . . . . . . Using Java Applets in an SSL Environment . . Performing additional configuration tasks . . . . 177 178 179 180 181 181 182 182 183 184 184

Installing and configuring Application Engine . . . . . . . . . . . . . . 143

Installing Application Engine . . . . . . . . Installing Application Engine interactively. . . Installing Application Engine silently . . . . Verifying your Application Engine installation Installing Application Engine software updates . . Installing the latest Content Engine Client files on Application Engine servers . . . . . . . . . Installing the latest Content Engine Client files on Application Engine servers interactively . . Installing the latest Content Engine Client files on Application Engine servers silently . . . . Installing the latest Process Engine Client files on Application Engine servers . . . . . . . . . Installing the latest Process Engine Client files interactively . . . . . . . . . . . . . Installing the latest Process Engine Client files silently . . . . . . . . . . . . . . Configuring Application Engine on the application server . . . . . . . . . . . . . . . . Configuring Application Engine on WebSphere Application Server . . . . . . . . . . Editing web.xml for container-managed authentication . . . . . . . . . . . Editing web.xml for SSO . . . . . . . Configuring Java Virtual Machine settings for JAAS login and memory . . . . . . . Configuring Lightweight Third Party Authentication (LTPA) . . . . . . . . Configuring stand-alone Lightweight Directory Access Protocol (LDAP) . . . . Configuring Lightweight Directory Access Protocol (LDAP) for federated repositories . Deploying Application Engine on the application server . . . . . . . . . . . . . . . . Deploying Application Engine on WebSphere Application Server . . . . . . . . . . Re-creating the WAR or EAR file . . . . . Deploying the application (WebSphere Application Server 6.1) . . . . . . . . Deploying the application (WebSphere Application Server 7.0) . . . . . . . . Setting Application Engine bootstrap preferences Setting the bootstrap properties on first login Verifying that a single index has been added for Application Name on the site preferences object store . . . . . . . . . . . . . . . 143 144 146 147 148 148 149 150

Optional installation tasks . . . . . . 187

151 151 152 153 153 154 156 159 161 163 164 165 167 167 168 169 171 171

| Installing and configuring IBM FileNet P8 | publishing components . . . . . . . . . . 188

Enabling the Process Engine Component Integrator Configuring and starting the Component Manager (on an Application Engine server) . . Specifying connection between Process Engine and Component Manager (on a Process Engine server). . . . . . . . . . . . . . . Installing an additional instance of Enterprise Manager . . . . . . . . . . . . . . . Creating additional file storage areas . . . . . Verifying the file storage area . . . . . . . Installing IBM FileNet Deployment Manager . . . Installing Application Integration . . . . . . . Installing Application Integration interactively Installing Application Integration silently . . . Verifying your Workplace Application Integration installation . . . . . . . . . Installing Workplace File Tracker . . . . . . . Installing the File Tracker software interactively Installing the File Tracker software silently . . Deploying multiple Application Engine instances Deploying a second instance of Workplace . . Deploying each additional Workplace instance as an EAR file . . . . . . . . . . . . Enabling Application Engine to use ISRA . . . . ISRA SSL support . . . . . . . . . . . Installing and deploying the Application Engine ISRA servlet . . . . . . . . . . . . . Configuring Workplace site preferences for ISRA Logging in to FileNet Image Services by using an LDAP account . . . . . . . . . . . 188 189

190 191 193 193 194 195 195 196 197 198 198 199 200 200 201 202 203 203 205 206

174
Contents

Accessing FileNet Image Services library documents . . . . . . . . . . . . . Installing and configuring IBM System Dashboard for Enterprise Content Management . . . . . . Modifying an Autonomy K2 server configuration Adding additional K2 administration servers Installing additional Autonomy K2 administration servers (Windows) . . . . Installing additional Autonomy K2 administration servers interactively (Windows) . . . . . . . . . . . Installing additional Autonomy K2 administration servers silently (Windows) . Configuring additional K2 administration servers . . . . . . . . . . . . . Moving Autonomy K2 servers to new hardware Moving K2 administration server software to new hardware . . . . . . . . . . . Removing K2 administration servers from your Content Search Engine configuration . . Dedicating a Verity domain to one object store Installing the COM compatibility layer (CCL) . .

206 206 206 207 207

Removing Workplace Application Integration . . . . . . . . . . . . 229

Removing or modifying Workplace Application Integration interactively . . . . . . . . . Removing Workplace Application Integration silently . . . . . . . . . . . . . . . 229 . 229

Removing Workplace File Tracker . . 231

Removing Workplace File Tracker interactively . Removing Workplace File Tracker silently . . . . 231 . 231

208 208 209 209 210 210 211 212

Part 4. Appendixes . . . . . . . . 233

Appendix A. Configuration Manager reference . . . . . . . . . . . . . 235
Overview of Configuration Manager . . . . . Configuration profile concepts. . . . . . . Using the graphical and command-line user interfaces . . . . . . . . . . . . . . Gathering Configuration Manager values by using the installation and upgrade worksheet . Handling passwords in Configuration Manager Accessing the Configuration Manager log files . . Correcting a dotnetclient configuration profile error Adding an SSL signer to the Configuration Manager keystore (WebSphere) . . . . . . . Correcting an SSL Signer Exchange Prompt error (WebSphere) . . . . . . . . . . . . . . Configuration Manager user interface reference . . Starting Configuration Manager . . . . . . Configuration Manager window . . . . . . Main toolbar . . . . . . . . . . . Profile toolbar . . . . . . . . . . . Task toolbar . . . . . . . . . . . . Console toolbar. . . . . . . . . . . Configuration Manager menus and commands Working with Configuration Manager . . . . Configuring a Content Engine instance . . . Setting the password save preference . . . Creating a profile for a new installation . . Opening and closing an existing profile or task . . . . . . . . . . . . . . Editing the application server properties . . Editing the properties for a specific task . . Editing the configure JDBC data source task . . . . . . . . . . . . . Editing the configure LDAP task . . . . Editing the configure bootstrap properties settings . . . . . . . . . . . . Editing the deploy application task . . . Applying the property settings by running a specific task . . . . . . . . . . . . Applying the JDBC data source settings Configuring the login modules . . . . Applying the LDAP settings . . . . . Applying the bootstrap properties settings Deploying the application . . . . . . Adding an additional task to your profile Deleting a task from a profile . . . . . . 236 236 238 238 239 239 240 241 242 242 243 244 244 245 245 246 247 249 250 251 251 252 252 253 253 254 254 254 255 255 255 256 256 256 257 257

Part 3. Removing software . . . . 213

Removing the IBM FileNet P8 documentation . . . . . . . . . . . 215
Removing the FileNet P8 documentation from a WebSphere Application Server. . . . . . . . 215

Removing Content Engine . . . . . . 217

Removing part or all of a Content Engine installation interactively by using the Windows control panel . . . . . . . . . . . . Removing Content Engine silently . . . . . Removing data associated with Content Engine . 217 . 217 218

Removing IBM FileNet Content Search Engine . . . . . . . . . . . . . . 219

Removing IBM Content Search Services software 219 Removing IBM Content Search Services interactively . . . . . . . . . . . . . 219 Removing IBM Content Search Services silently 220 Removing IBM Legacy Content Search Engine . . 220 Removing additional IBM Legacy Content Search Engine locales (Windows) . . . . . . 221

Removing Process Engine (Windows) 223

Removing Process Engine interactively (Windows) 223 Removing Process Engine silently (Windows) . . 224

Removing Application Engine (WebSphere). . . . . . . . . . . . 225 Removing the Application Engine ISRA servlet . . . . . . . . . . . . 227

vi

Installation Guide

Running all tasks at the same time . . . Running a single task . . . . . . . Checking the task status. . . . . . . Viewing the session log . . . . . . . Saving your changes to a task or profile . configmgr.ini parameters . . . . . . . Configuration Manager command-line reference Running Configuration Manager commands . How to read the syntax diagrams . . . checkstatus command . . . . . . . execute command . . . . . . . . . generateconfig command . . . . . . gui command . . . . . . . . . . listtasks command . . . . . . . . movetask command . . . . . . . . removetask command . . . . . . . storepasswords command . . . . . .

. . . . . . . . . . . . . . . .

258 258 258 259 259 259 260 260 261 261 265 268 274 274 277 280 282

Verifying the Content Engine server is available to Process Engine on the network . . . . . Ping the Content Engine server . . . . . Verifying that the Process Engine can connect to a FileNet Engine Web page on Content Engine . Verify the connection to the Content Engine FileNet Engine Web page . . . . . . . Verifying that Process Engine can connect to Content Engine by using the Content Engine URI . . . . . . . . . . . . . . . Verify the Content Engine connection using the Content Engine URI . . . . . . . . Recovering from errors during Content Engine upgrade . . . . . . . . . . . . . . . Recovering from errors during Global Configuration Data (GCD) upgrade . . . . . Recovering from errors during an object store upgrade . . . . . . . . . . . . . .

290 290 290 291

291 292 292 292 293

Appendix B. Troubleshooting FileNet P8 Platform installation and upgrade . 287

AddOn installation can fail with resource unavailable exception. . . . . . . . . . . 287 Application server does not start after installation and shutdown . . . . . . . . . . . . . 288 Cannot save Process Task Manager security settings . . . . . . . . . . . . . . . 289

Notices . . . . . . . . . . . . . . 295
Trademarks . . . . . . . . . . . . . . 297

Index . . . . . . . . . . . . . . . 299

Contents

vii

viii

Installation Guide

ibm.com and related resources

Product support and documentation are available from ibm.com.

Support and assistance

Product support is available on the Web. Click Support from the product Web site at: FileNet Content Manager Support http://www.ibm.com/software/data/content-management/filenet-contentmanager/support.html

Information center
You can view the product documentation in an Eclipse-based information center that you can install when you install the product. By default, the information center runs in a Web server mode that other Web browsers can access. You can also run it locally on your workstation. See the information center at http://publib.boulder.ibm.com/infocenter/p8docs/v5r1m0/index.jsp.

PDF publications
You can view the PDF files online using the Adobe Acrobat Reader for your operating system. If you do not have the Acrobat Reader installed, you can download it from the Adobe Web site at http://www.adobe.com. See the following PDF publications Web sites:
Product Web site

Product Documentation for FileNet http://www.ibm.com/support/docview.wss?rs=86 P8 Platform &uid=swg27021611

How to send your comments Your feedback is important in helping to provide the most accurate and highest quality information. Contacting IBM on page x To contact IBM customer service in the United States or Canada, call 1-800-IBM-SERV (1-800-426-7378).

How to send your comments

Your feedback is important in helping to provide the most accurate and highest quality information. Send your comments by using the online reader comment form at https://www14.software.ibm.com/webapp/iwm/web/signup.do?lang=en_US &source=swg-rcf.

Copyright IBM Corp. 2001, 2011

ix

Consumability survey
You are invited to tell IBM how to improve the consumability of software products. If you want to help IBM make IBM FileNet P8 easier to use, take the Consumability Survey at http://www.ibm.com/software/data/info/ consumability-survey/.

Contacting IBM
To contact IBM customer service in the United States or Canada, call 1-800-IBM-SERV (1-800-426-7378). To learn about available service options, call one of the following numbers: v In the United States: 1-888-426-4343 v In Canada: 1-800-465-9600 For more information about how to contact IBM, see the Contact IBM Web site at http://www.ibm.com/contact/us/.

Installation Guide

Part 1. Installing a single-server IBM FileNet P8 Platform system

You can install all of the IBM FileNet P8 Platform components on a single server, including the middleware applications such as the database and web application server software. When you provide all the installation software for the components and run the installer, the IBM FileNet Composite Platform Installation Tool installs and configures the entire IBM FileNet P8 Platform environment automatically. The Composite Platform Installation Tool requires a server with no existing IBM FileNet P8 Platform components or middleware software installations. For AIX servers, you must configure network ports for Process Engine before you run the Composite Platform Installation Tool. See the topic Modifying /etc/rc.dt for AIX 5.3 and 6.1 in the Planning and Preparing for IBM FileNet P8 guide for details. Preparing for the installation on page 3 To prepare for the single-server installation, you must create a download directory with all the software packages that are required for a full FileNet P8 Platform installation. You can download the installation packages from the IBM Passport Advantage web site. Running the Composite Platform Installation Tool on page 5 The Composite Platform Installation Tool uses the software images you downloaded to install and configure the IBM FileNet P8 Platform environment on your server. You can choose to run the tool interactively by using a wizard, or silently by specifying installation values in a silent input file. Verifying a successful installation on page 9 After you install and configure your single-server IBM FileNet P8 Platform environment, you can use the Content Engine Health Page and the Workplace XT application to verify the success of your installation. Removing administrator passwords on page 11 The single-server installation used the administrator password that you supplied or the default administrator password to install and configure all of the software components. As a security measure, after you have verified that your system works correctly, you can remove the plain text passwords from the installation scripts. Restarting components in a single-server IBM FileNet P8 environment on page 13 Server maintenance and software updates sometimes require a server reboot. You can use these tasks to restart the components in your IBM FileNet P8 environment.

Copyright IBM Corp. 2001, 2011

Installation Guide

Preparing for the installation

To prepare for the single-server installation, you must create a download directory with all the software packages that are required for a full FileNet P8 Platform installation. You can download the installation packages from the IBM Passport Advantage web site. The Composite Platform Installation Tool uses a set of predetermined software installation packages. To see a list of the specific packages by part number that are required for this installation tool, see the IBM FileNet P8 Hardware and Software Requirements. In the guide, search for "Composite Platform Installation Tool." Use the part numbers specified in that guide to create the download directory, as shown in this task. To prepare for the installation: 1. Log on as an administrator to the server where you plan to run the Composite Platform Installation Tool. 2. Create a directory for the installation packages on the server where you plan to install, for example, Platform_Downloads. You must have at least 20 GB of space available. 3. Download the software packages for all components for your platform to the download directory that you created on the server. Important: Make a note of each file name and component as you download or copy the file into the download directory. Files that are named as part numbers might be difficult to identify when you rename them to the names used by the installation tool. Download the installation packages as compressed files, but do not extract the installation packages in the download directory. v Content Engine v Content Engine Client v Process Engine v Process Engine Client v Workplace XT v WebSphere Application Server v WebSphere service pack v Tivoli Directory Server v DB2 v DB2 Restricted License 4. Rename the compressed files to the names that are used by the installation tool. The installation tool looks for these new names when it installs and configures the software components. Do not change the file extensions. Important: Do not rename the WebSphere Application Server fix pack. Use the following names:

Copyright IBM Corp. 2001, 2011

Table 1. Names for installation images Component compressed file (partnumber.fileextension) Content Engine Content Engine Client Process Engine Process Engine Client Workplace XT WebSphere Application Server WebSphere update installer Tivoli Directory Server DB2 DB2 Restricted License Rename to this: (newname.fileextension) ce cec pe pec wpxt was wasupdi tds db2 db2lic

For example, the Tivoli Directory Server compressed file: CZKG4ML.zip must be renamed to tds.zip. 5. Create a backup of your server. You can use this backup in case you need to re-run the Composite Platform Installation Tool. Related information IBM FileNet P8 Hardware and Software Requirements Download the IBM FIleNet P8 Hardware and Software Requirements from the IBM support documentation web site. Passport Advantage Online Search for software installation images by part number.

Installation Guide

Running the Composite Platform Installation Tool

The Composite Platform Installation Tool uses the software images you downloaded to install and configure the IBM FileNet P8 Platform environment on your server. You can choose to run the tool interactively by using a wizard, or silently by specifying installation values in a silent input file. Running the Composite Platform Installation Tool interactively After you have prepared the download directory, you can run the Composite Platform Installation Tool interactively. When you start the installation program and provide the necessary values, the tool runs the installation automatically. Running the Composite Platform Installation Tool silently on page 6 If you choose to run the Composite Platform Installation Tool silently, you must specify the appropriate values in the silent input text file. When you run the command and specify the silent input text file, the tool runs the installation and configuration automatically.

Running the Composite Platform Installation Tool interactively

After you have prepared the download directory, you can run the Composite Platform Installation Tool interactively. When you start the installation program and provide the necessary values, the tool runs the installation automatically. On UNIX systems, ensure that the gunzip program is available in /usr/bin before you run the installation task. To run the Composite Platform Installation Tool interactively: 1. Log on to the server, as appropriate for your operating system:
Option Windows Description Log on as a member of the local Administrators group.

| |

2. Navigate to the Composite Platform Installation Tool software. 3. Edit the license agreement values in a text file in the package. This editing step accepts the license agreements for all the software components that are installed by the Composite Platform Installation Tool. a. If the CDroot/cpit.properties file is on a CD or DVD device, copy the file to a local file system. b. Open the CDroot/cpit.properties file on the local file system, and change the LICENSE_ACCEPTED_# parameter to TRUE for each software component. c. Save and close the file. 4. Run the installation tool that is appropriate for your operating system:
Option AIX

Description 5.1.0-CPIT-AIX.BIN 5.1.0-CPIT-LINUX.BIN 5.1.0-CPIT-WIN.EXE

Linux Windows

5. Accept the license agreement.

Copyright IBM Corp. 2001, 2011

6. On the Specify Download Directory window, click Choose to browse to the directory that contains the downloaded software packages. 7. Enter and confirm the Administrator password. 8. Review the Preinstallation summary, and click Install to begin the installation. The installation processes can take approximately two to three hours. You can ignore or close any component administrative tools that display during the installation. (Windows only) During the installation, you might encounter a security warning for the java.exe. You can accept this benign error and continue. 9. If the installation does not complete, check the IBM\cpit\ cpit_install_log_5.1.0.txt log file for details.

Running the Composite Platform Installation Tool silently

If you choose to run the Composite Platform Installation Tool silently, you must specify the appropriate values in the silent input text file. When you run the command and specify the silent input text file, the tool runs the installation and configuration automatically. On UNIX systems, ensure that the gunzip program is available in /usr/bin before you run the installation task. To run the Composite Platform Installation Tool silently: 1. Log on to the server, as appropriate for your operating system:
Option Windows Description Log on as a member of the local Administrators group.

| |

| | | | | | | | |

2. Navigate to the Composite Platform Installation Tool software. 3. Edit the license agreement values in a text file in the package. This editing step accepts the license agreements for all the software components that are installed by the Composite Platform Installation Tool. a. If the CDroot/cpit.properties file is on a CD or DVD device, copy the file to a local file system. b. Open the CDroot/cpit.properties file on the local file system, and change the LICENSE_ACCEPTED_# parameter to TRUE for each software component. c. Save and close the file. 4. If the cpit_silent_install.txt file is on a CD or DVD device, copy the file to a local file system. 5. Edit the cpit_silent_install.txt file on the local file system with the values for your installation: a. Open cpit_silent_install.txt for editing. b. In the file, set LICENSE_ACCEPTED=TRUE. c. Set USER_SELECTED_FOLDER to the full path for the download directory you created, for example, /download_path/Platform_Downloads. d. Save and close the file. 6. Run the installation tool:
Option Windows Description 5.1.0-CPIT-WIN.EXE -i silent -f path_to_file\cpit_silent_install.txt

Installation Guide

The installation processes can take approximately two to three hours. You can ignore or close any component administrative tools that display during the installation. 7. If the installation does not complete, check the cpit_install_stderr.txt and cpit_install_stdout.txt log files for details. These files are located in the /tmp directory on UNIX, or in the TEMP folder on Windows.

Running the Composite Platform Installation Tool

Installation Guide

Verifying a successful installation

After you install and configure your single-server IBM FileNet P8 Platform environment, you can use the Content Engine Health Page and the Workplace XT application to verify the success of your installation. To verify the installation: 1. Check the Content Engine installation by accessing the following URL: http://cpit_server:9080/P8CE/Health Verify that all status indicators on the Content Engine Health page are green. 2. Verify the Workplace XT installation: a. Access the following URL: http://cpit_server:9080/WorkplaceXT b. Log in with the credentials provided in install_path/IBM/cpit/ accounts.txt. c. Use Workplace XT to browse, search, add a document, and view the Tasks page. 3. After you have verified that your installation is successful, delete two installation directories to free up space on your server. Delete the following directories: v install_path/IBM/cpit/decompressed v The download directory you created for the installation packages, for example, Platform_Downloads.

Copyright IBM Corp. 2001, 2011

10

Installation Guide

Removing administrator passwords

The single-server installation used the administrator password that you supplied or the default administrator password to install and configure all of the software components. As a security measure, after you have verified that your system works correctly, you can remove the plain text passwords from the installation scripts. To remove the administrator passwords: 1. Make a copy of the install_path/IBM/cpit/accounts.txt file, put it in a secure or encrypted location, and then delete the file from the original location. 2. Run the pwdreset tool by entering the following commands:
Operating System Windows Description Run these commands: cd C:\Program Files\IBM\cpit\install-scripts pwdreset administrator_password

All installation script files show obscured password values.

Copyright IBM Corp. 2001, 2011

11

12

Installation Guide

Restarting components in a single-server IBM FileNet P8 environment

Server maintenance and software updates sometimes require a server reboot. You can use these tasks to restart the components in your IBM FileNet P8 environment. Restarting FileNet P8 system components on a Microsoft Windows server On a Microsoft Windows server, most components are configured as Windows services. These components restart automatically when the server is restarted. Use the Process Task Manager to restart the Process Engine server instance.

Restarting FileNet P8 system components on a Microsoft Windows server

On a Microsoft Windows server, most components are configured as Windows services. These components restart automatically when the server is restarted. Use the Process Task Manager to restart the Process Engine server instance. To restart the Process Engine server instance: 1. Start Process Task Manager by clicking Start > All Programs > IBM FileNet P8 Platform > Process Engine > Process Task Manager. 2. In the left pane under Instances, right-click your server name and click Start. 3. Optional: Set your Process Engine server to start automatically. a. In the left pane, select your Process Engine server. b. In the right pane, check the Automatically Started check box. c. Click Apply.

Copyright IBM Corp. 2001, 2011

13

14

Installation Guide

Part 2. Installing a distributed IBM FileNet P8 Platform system

To set up IBM FileNet P8 Platform you install and configure the software and documentation for a number of core components, including Content Engine, Content Search Engine, Process Engine, and Application Engine. As an alternative to the Application Engine component and its Workplace user application, you can set up Workplace XT. See the Workplace XT documentation for details. Installing IBM FileNet P8 Platform documentation on page 17 IBM FileNet P8 Platform documentation is distributed as part of a larger IBM FileNet P8 information center. From the various user and administrative applications, you can either link to the online version of the information center on www.ibm.com or link to a local copy of the information center that you install and deploy. Installing and configuring Content Engine on page 23 Content Engine is the content-management component of IBM FileNet P8 platform. To set up Content Engine, you install the content-management server software on an application server, and then configure and deploy the Content Engine web application. You must also configure the Global Configuration Data (GCD), create the FileNet P8 domain, and create at least one object store. The GCD contains system information about your particular configuration. The object stores contain information about the documents, records, forms, and other business objects that you store in your IBM FileNet P8 system. Installing and configuring Content Search Engine on page 91 You can install the server for one or both of the search engine options that are supported by IBM FileNet Content Engine, IBM Content Search Services or IBM Legacy Content Search Engine. Installing and configuring Process Engine on page 121 Installing and configuring Process Engine is a process requiring multiple steps, and the steps must be followed in sequence. Installing and configuring Application Engine on page 143 Application Engine provides a client application called Workplace that you can use to access the information managed by Content Engine. After you install the server, you must also configure your application server to work with Application Engine, and deploy the application. Configuration and startup tasks on page 177 After you install the IBM FileNet P8 components, there are some additional steps to configure the IBM FileNet P8 system. After you configure the IBM FileNet P8 components, familiarize yourself with IBM FileNet P8 system startup and shutdown procedures. See the Administering IBM FileNet P8 > Starting and stopping IBM FileNet P8 components help topic. Optional installation tasks on page 187 You can install the additional or optional IBM FileNet P8 components in any order.

Copyright IBM Corp. 2001, 2011

15

16

Installation Guide

Installing IBM FileNet P8 Platform documentation

IBM FileNet P8 Platform documentation is distributed as part of a larger IBM FileNet P8 information center. From the various user and administrative applications, you can either link to the online version of the information center on www.ibm.com or link to a local copy of the information center that you install and deploy. The advantages of linking to the ibm.com information center are: v You do not have to maintain a documentation server and information center. v You do not have to install any documentation in your environment, except for what is automatically installed within some of the IBM FileNet P8 software components. v The documentation is always up to date. If you want to use the online information center, during the installation of your IBM FileNet P8 Platform components, provide the following link for your FileNet P8 documentation URL: http://publib.boulder.ibm.com/infocenter/p8docs/ v5r1m0/ The format of the link to the online information center can vary in configuration and preference settings. This format is appropriate for IBM FileNet P8 installation values. If you want to access the documentation locally in your FileNet P8 environment, you must install and deploy the information center WAR file as a Web application on a supported application server. Then you designate that Web application location as the documentation URL when you install and configure each IBM FileNet P8 software component. 1. Installing the local information center You can install interactively or silently and deploy the IBM FileNet P8 documentation as an information center. The information center documentation package is deployed as a WAR file on an application server. 2. Starting and verifying the IBM FileNet P8 information center on page 20 After you install and deploy the IBM FileNet P8 information center on the application server, verify that you can access its URL address and run its search feature. These tests ensure that the installed information center can be used as a help system in the various IBM FileNet P8 component applications. 3. Backing up and redeploying the FileNet P8 information center on page 21 After you verify the installation of your FileNet P8 information center, you should store a backup copy. With a backup copy, you can more quickly recover from a disaster and redeploy to other servers.

Installing the local information center

You can install interactively or silently and deploy the IBM FileNet P8 documentation as an information center. The information center documentation package is deployed as a WAR file on an application server. Installing the IBM FileNet P8 Platform information center interactively on page 18 You must install the IBM FileNet P8 Platform information center as a Web
Copyright IBM Corp. 2001, 2011

17

application on a supported application server to view and search product documentation. When you install the information center interactively, you run a wizard that prompts you for an installation path for the information center WAR file. Installing the IBM FileNet P8 Platform information center silently on page 19 You must install the IBM FileNet P8 Platform information center as a Web application on a supported application server to view and search product documentation. When you install the information center silently, you run a command that references parameters in an installation text file.

Installing the IBM FileNet P8 Platform information center interactively

You must install the IBM FileNet P8 Platform information center as a Web application on a supported application server to view and search product documentation. When you install the information center interactively, you run a wizard that prompts you for an installation path for the information center WAR file. Before you install the FileNet P8 information center, you must ensure that you have Java support enabled on the application server you choose. You can collocate the documentation information center on an application server with either Application Engine or Content Engine server components installed. You can also install it on a separate application server. Depending on your operating system and application server levels, your options might be slightly different from the options that are documented. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install the IBM FileNet P8 Platform information center interactively: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only documentation installation values, filter by P8 Info Center Installer in the Installation or Configuration Program column. 2. Log on to the application server where you are installing the information center:
Option Windows Description Log on as a member of the local Administrators group or a user with equivalent permissions.

3. Access the information center software package. 4. Run the installation program:
Option Windows Description 5.1.0-P8IC-WIN.EXE

5. Complete the installation program screens by using the values from your worksheet.

18

Installation Guide

6. When the installation completes, check for errors in the information center error log file ic_install_path/p8ic_install_log_5.1.0.txt, where ic_install_path is the location where the information center p8docs.war file is installed. 7. Deploy the p8docs.war on your application server. The deployment might take several minutes because of the size of the documentation files.
Option WebSphere Application Server Description From the WebSphere administrative console, install the p8docs.war file as a Web application by using p8docs as the context root. Tip: In the configuration windows, you can accept the default values for all choices. In addition, ensure that you save to the primary configuration when prompted.

Installing the IBM FileNet P8 Platform information center silently

You must install the IBM FileNet P8 Platform information center as a Web application on a supported application server to view and search product documentation. When you install the information center silently, you run a command that references parameters in an installation text file. Before you install the FileNet P8 information center, you must ensure that you have Java support enabled on the application server you choose. You can collocate the documentation information center on an application server with either Application Engine or Content Engine server components installed. You can also install it on a separate application server. Depending on your operating system and application server levels, your options might be slightly different from the options that are documented. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install the IBM FileNet P8 Platform information center silently: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only documentation installation values, filter by P8 Info Center Installer in the Installation or Configuration Program column. 2. Log on to the application server where you are installing the information center:
Option Windows Description Log on as a member of the local Administrators group or a user with equivalent permissions.

3. Access the information center software package. 4. Edit the p8ic_silent_install.txt file to reflect the installation choices in your worksheet.
Installing IBM FileNet P8 Platform documentation

19

5. Run one of the following commands, depending on your operating system:

Option Windows Description 5.1.0-P8IC-WIN.EXE -f p8ic_silent_install.txt

6. When the installation completes, check for errors in the information center error log file ic_install_path/ic_install_log_5.1.0.txt, where ic_install_path is the location where the information center p8docs.war file is installed. 7. Deploy the p8docs.war on your application server. The deployment might take several minutes because of the size of the documentation files.
Option WebSphere Application Server Description 1. Copy the IBM FileNet P8 p8docs.war file to the local hard drive. 2. From the WebSphere administrative console, install the p8docs.war file as a Web application by using p8docs as the context root. Tip: In the configuration windows, you can accept the default values for all choices. In addition, ensure that you save to the primary configuration when prompted.

Starting and verifying the IBM FileNet P8 information center

After you install and deploy the IBM FileNet P8 information center on the application server, verify that you can access its URL address and run its search feature. These tests ensure that the installed information center can be used as a help system in the various IBM FileNet P8 component applications. To verify the information center installation and deployment: 1. From the application server, start the information center Web application named p8docs. 2. From a Web browser, access the documentation URL by using the application server name and port number for your Web environment, for example:
Option IBM WebSphere Application Server Description http://yourdocserver:9080/p8docs/index.jsp

Because of the size of the documentation package, the frames within the information center take a few minutes to load the first time. 3. Make note of the base URL for your application server. You must enter the base URL as the documentation URL for the IBM FileNet P8 components while running installation programs or setting site preferences later, for example, in Workplace or Workplace XT. The base URL is the path up to and including the com.ibm.p8.doc plug-in, for example, http://yourdocserver:port/p8docs/topic/ com.ibm.p8.doc/. 4. Index the information center by performing a search. Indexing can take 5-10 minutes, and takes place automatically when the first search is performed.

20

Installation Guide

Backing up and redeploying the FileNet P8 information center

After you verify the installation of your FileNet P8 information center, you should store a backup copy. With a backup copy, you can more quickly recover from a disaster and redeploy to other servers. To back up your FileNet P8 information center for easy recovery or redeployment: 1. Create a p8docs.war or p8docs compressed file that contains the entire p8docs directory structure. 2. Place the file in a safe storage area that you can readily access to redeploy the FileNet P8 information center to new or updated application servers.

Installing IBM FileNet P8 Platform documentation

21

22

Installation Guide

Installing and configuring Content Engine

Content Engine is the content-management component of IBM FileNet P8 platform. To set up Content Engine, you install the content-management server software on an application server, and then configure and deploy the Content Engine web application. You must also configure the Global Configuration Data (GCD), create the FileNet P8 domain, and create at least one object store. The GCD contains system information about your particular configuration. The object stores contain information about the documents, records, forms, and other business objects that you store in your IBM FileNet P8 system. You install the Content Engine software once on each web application server in your environment. You can configure and deploy one or more Content Engine application instances on that server. A single Content Engine application instance equates to one deployed application on your application server. When you deploy Content Engine in a WebSphere Application Server non-managed environment, install and configure Content Engine on a single server in the environment. After deploying the bootstrapped Content Engine EAR file on the initial server, copy the bootstrapped EAR file to the other servers. On each additional server, configure the LDAP provider, the JDBC data sources, and the login modules. Then deploy the bootstrapped EAR file that was copied from the initial server. 1. Installing Content Engine and related client software on page 24 You must install the Content Engine software and related client software to place the binary files for its components on the server. 2. Configuring Content Engine on page 35 You can configure and deploy all of your Content Engine instances with Configuration Manager. Configuration Manager prepares the Content Engine application for deployment on the application server. A single Content Engine application instance equates to one deployed application on your application server. 3. Enabling application server connections after database failover on page 62 If the database fails over in your environment, your application server must be able to reconnect. 4. Deploying Content Engine instances on page 63 Depending on your environment, you can use the Configuration Manager graphical user interface, or the command line, to deploy Content Engine instances. 5. Installing storage device source files on page 69 If your IBM FileNet P8 system includes Tivoli Storage Manager or EMC Centera devices, you must install files on the Content Engine server. 6. Configuring file stores for high availabilty on page 72 File store content is managed from the Content Engine application. 7. Completing Content Engine post-deployment steps on page 73 You must complete the post-deployment web application server configuration before you can put an IBM FileNet P8 system into production. 8. Verifying the Content Engine deployment on page 74 You can verify that the Content Engine deployment was successful by accessing the IBM FileNet P8 System Health page.

Copyright IBM Corp. 2001, 2011

23

9. Establishing the FileNet P8 domain and Global Configuration Data (GCD) on page 76 With Content Engine installed and deployed, you must use IBM FileNet Enterprise Manager to create a FileNet P8 domain. You can also use Enterprise Manager to set a URL to the FileNet P8 online help if you did not specify the location when you ran the Content Engine installation program. 10. Creating the data sources for an object store on page 79 Each object store in your site requires its own JDBC data sources. You can configure the data sources by using the Configuration Manager graphical user interface or the command line. 11. Creating the initial object store on page 85 You create an initial object store in Content Engine to store your documents and other objects. After an object store is created, you can refine its definition and add content to it. 12. Connecting to a highly available Content Engine on page 87 The configuration of the Content Engine connection in a highly available environment depends on the type of application you want to connect to the Content Engine. You can configure administrative applications or user applications to connect to the Content Engine. 13. Verifying the Content Engine system on page 89 You can verify the Content Engine system by using IBM FileNet Enterprise Manager to create a folder and a document in each object store and then check the new document out and in. You also need to retrieve and view the contents of an existing document.

Installing Content Engine and related client software

You must install the Content Engine software and related client software to place the binary files for its components on the server. 1. Installing Content Engine on page 25 You must install the Content Engine software to place the binary files for its components on the server. You can install the software interactively with a wizard or silently from the command line. 2. Installing Enterprise Manager on page 27 You must install IBM FileNet Enterprise Manager to administer content in an Enterprise Content Management system. You install this software by running the Content Engine installation program on a supported Windows system. 3. Installing Content Engine software updates on page 28 You must install the latest software updates, fix packs, or interim fixes for the Content Engine software to ensure optimal operation. 4. Installing Content Search Engine Client files on page 29 You can install the client application for one or both of the search engine options that are supported by IBM FileNet Content Engine,IBM Content Search Services or IBM Legacy Content Search Engine. 5. Installing the latest Process Engine Client files on Content Engine servers on page 33 Install the Process Engine Client files on the Content Engine to enable communication between Content Engine and Process Engine. You can install the files interactively by using the installation wizard or silently by using the command line and a silent input file.

24

Installation Guide

Installing Content Engine

You must install the Content Engine software to place the binary files for its components on the server. You can install the software interactively with a wizard or silently from the command line. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. You can install the Content Engine components shown in the following table. Note that some of the components can be installed only on Windows.
Table 2. Content Engine components Component Content Engine Server Required Platform UNIX or Windows Description Install this software as the major Content Engine component. When you install Content Engine Server, Configuration Manager is also installed. Install this software as the primary tool to configure and maintain Content Engine installations. When you install Content Engine Server, Configuration Manager is also installed. Install this software only on machines where you intend to run either the Enterprise Manager administrative client or a customized client application. Install this software only if you are upgrading Content Engine data from version 3.5.2 and want to run a command-line upgrade instead of the GUI-based Content Engine Web Upgrade Tool (which is automatically installed with Content Engine Server) to do so. Install this tool if you intend to either use this system with IBM Case Manager or deploy test systems into full production. See the IBM FileNet P8 help topic Deploying IBM FileNet applications > Get Started with FileNet Deployment Manager for details about how you might use this tool.

Configuration Manager

UNIX or Windows

.NET Clients (including Enterprise Manager)

Windows only

Content Engine Upgrader

Windows only

FileNet Deployment Manager Windows only

Installing Content Engine interactively on page 26 To install Content Engine interactively, you run a wizard that prompts you for an installation path and the Content Engine components to be installed.
Installing and configuring Content Engine

25

Installing Content Engine silently When you install Content Engine silently, you run a command in the Content Engine software package that references parameters in an installation text file. Related concepts Installation and upgrade worksheet See the information about the worksheet in Plan and Prepare Your Environment for IBM FileNet P8.

Installing Content Engine interactively

To install Content Engine interactively, you run a wizard that prompts you for an installation path and the Content Engine components to be installed. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install Content Engine: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Installer in the Installation or Configuration Program column. 2. Log on as ce_install_user to the application server machine where you are going to install Content Engine software. 3. Navigate to the Content Engine software package in the installation media. 4. Run one of the following programs in the software package, depending on your operating system:
Platform Windows Command 5.1.0-P8CE-WIN.EXE

5. Complete the Content Engine installer screens by using the values from your worksheet. 6. Review the status messages in the final wizard screen, and close the wizard. 7. When the installation completes, click Done and check for errors in the Content Engine ce_install_path/ce_install_log_5.1.0.txt error log file, where ce_install_path is the location where Content Engine is installed. Related concepts Installation and Upgrade Worksheet For more information about Content Engine parameter values, see Plan and Prepare Your Environment for IBM FileNet P8.

Installing Content Engine silently

When you install Content Engine silently, you run a command in the Content Engine software package that references parameters in an installation text file. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install Content Engine: 1. Open your completed Installation and Upgrade Worksheet file.

26

Installation Guide

Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Installer in the Installation or Configuration Program column. 2. Log on as ce_install_user to the application server machine where you are going to install Content Engine software. 3. Navigate to the Content Engine software package in the installation media. 4. Edit the ce_silent_install.txt file to reflect the installation choices in your worksheet. 5. Run one of the following commands in the software package, depending on your operating system:
Platform Windows Command 5.1.0-P8CE-WIN.EXE -f ce_silent_install.txt

6. When the installation completes, check for errors in the Content Engine error log file ce_install_path/ce_install_log_5.1.0.txt, where ce_install_path is the location where Content Engine is installed. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing Enterprise Manager

You must install IBM FileNet Enterprise Manager to administer content in an Enterprise Content Management system. You install this software by running the Content Engine installation program on a supported Windows system. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. If you did not install Enterprise Manager when you installed the Content Engine software, you can install it now on the same Windows server or on some other Windows computer. Tip: An icon labeled FileNet Enterprise Manager Administration Tool on the desktop of the Content Engine server indicates that Enterprise Manager has been installed. Important: You cannot install Enterprise Manager on a UNIX machine. To install Enterprise Manager: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Installer in the Installation or Configuration Program column. 2. On the machine where you install Enterprise Manager, log on as a member of the Local Administrators group or the Power Users group. 3. If you have not already done so, install the required Windows components.

Installing and configuring Content Engine

27

Option Content Engine version 5.1.0 with Microsoft Windows Vista, Microsoft Windows Server 2008, or Microsoft Windows 7

Description Microsoft .NET Framework 3.0 and Windows Communication Foundation (WCF) To run FileNet Enterprise Manager without SSL configured on the same computer, you must have Microsoft Web Services Enhancements (WSE) 3.0 installed there. See the Microsoft support website for details about the impending end of general support for .NET Framework 2.0 and, by extension, WSE 3.0. If the support for WSE 3.0 ends, you must configure SSL on the Enterprise Manager computers to ensure a fully supported FileNet Content Manager environment To run FileNet Enterprise Manager with SSL configured on the same computer, you must have Microsoft Windows Communication Foundation (WCF), which is the successor to WSE, installed there.

4. 5.

Access the Content Engine software package. Start the Enterprise Manager installation.
Description 1. Run the following command in the software package: 5.1.0-P8CE-WIN.exe. 2. Complete the installation program wizard.

Option To install interactively

To install silently

1. Open the ce_silent_install.txt file in the software package for editing. 2. Set the parameter values in the ce_silent_install.txt file for your site. Be sure to set the CHOSEN_INSTALL_FEATURE_LIST parameter value to: DotNetClients,AdminTools 3. Save your edits. 4. Run the following command in the software package on a single line: 5.1.0-P8CE-WIN.EXE -f ce_silent_install.txt

Installing Content Engine software updates

You must install the latest software updates, fix packs, or interim fixes for the Content Engine software to ensure optimal operation.

28

Installation Guide

If no Content Engine software updates are available, skip this procedure. To install the Content Engine software updates: 1. Access the IBM FileNet P8 Platform support site to obtain the latest Content Engine software updates. 2. Open the readmes for the Content Engine software updates and perform the installation procedures in the readmes on each Content Engine instance. Related information IBM FileNet P8 Platform documentation and support Obtain the latest Content Engine software updates, as well as the rest of the IBM FileNet P8 Platform documentation.

Installing Content Search Engine Client files

You can install the client application for one or both of the search engine options that are supported by IBM FileNet Content Engine,IBM Content Search Services or IBM Legacy Content Search Engine. Installing IBM Content Search Services Client files on Content Engine servers The IBM Content Search Services Client files enable the IBM Content Search Services server to communicate with the Content Engine servers. Installing the latest Content Search Engine Client files on Content Engine servers on page 31 The Content Search Engine Client files make it possible for the Content Search Engine server component to communicate with the Content Engine servers.

Installing IBM Content Search Services Client files on Content Engine servers
The IBM Content Search Services Client files enable the IBM Content Search Services server to communicate with the Content Engine servers. When you run the Content Search Engine Client installation program on Content Engine and select the IBM Content Search Services Client option, the installation program updates the Content Engine server EAR file. These updates to the EAR file include Oracle Outside In Search Export filtering technology. You must redeploy the EAR file on the Content Engine server to apply the updates. To verify that the updates were installed, test searching for content after you install the IBM Content Search Services Client and redeploy the EAR file. Attention: For information on the supported versions of Oracle Outside In Search Export, see IBM FileNet P8 Hardware and Software Requirements. You need the Oracle Outside In Search Export version number to lookup up the supported document types on the Oracle web site. In a Content Engine server cluster environment, you only must run the IBM Content Search Services Client installation one time. The installation updates the EAR file for all of the Content Engine servers in the server cluster. For instructions on how to obtain the latest IBM Content Search Services Client software updates, access the IBM FileNet P8 Platform support site. Installing IBM Content Search Services Client files interactively on page 30 You can install IBM Content Search Services Client files interactively by running the installation program on the application server computers where the Content Engine Server is installed.

Installing and configuring Content Engine

29

Installing IBM Content Search Services Client files silently You can install IBM Content Search Services Client files silently by editing a silent input file and running the installation program from a command line. You must install IBM Content Search Services Client files on all application server computers where Content Engine server is installed. Installing IBM Content Search Services Client files interactively: You can install IBM Content Search Services Client files interactively by running the installation program on the application server computers where the Content Engine Server is installed. Be sure that you have the Installation and Upgrade Worksheet that you completed during your planning activities. To install IBM Content Search Services Client files interactively: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only IBM Content Search Services values, filter by CSS Installer in the Installation or Configuration Program column. 2. On the computer where Content Engine is to be deployed, log on as ce_install_user. 3. Locate the IBM Content Search Services Client installation software. The Client software must be the same version as your IBM Content Search Services Server software. You must install IBM Content Search Services and Content Engine software on the same operating system. For example, if Content Engine runs on Windows, locate the IBM Content Search Services Client installation software that runs on Windows. 4. Start the installation program. Important: Both of the Content Search Engine options, IBM Content Search Services and IBM Legacy Content Search Engine, use the same installation program to install their client files.
Table 3. IBM Content Search Services Client interactive installation programs by operating system Operating system Windows Installation program 5.1.0-P8CSE-CLIENT-WIN.EXE

Complete the IBM Content Search Services Client installation program by using the installation values from your worksheet. 6. Review the following IBM Content Search Services Client log files to verify a successful installation: 5.
Option Windows Description cse_client_install_path\ CSEClient_install_log_5.1.0.log

Installing IBM Content Search Services Client files silently:

30

Installation Guide

You can install IBM Content Search Services Client files silently by editing a silent input file and running the installation program from a command line. You must install IBM Content Search Services Client files on all application server computers where Content Engine server is installed. Be sure that you have the Installation and Upgrade Worksheet that you completed during your planning activities. To install IBM Content Search Services Client files silently: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only IBM Content Search Services values, filter by CSS Installer in the Installation or Configuration Program column. 2. On the computer where Content Engine is to be deployed, log on as ce_install_user. 3. Locate the IBM Content Search Services Client installation software. The Client software must be the same version as your IBM Content Search Services Server software. You must install IBM Content Search Services and Content Engine software on the same operating system. For example, if Content Engine runs on Windows, locate the IBM Content Search Services Client installation software that runs on Windows. 4. Locate the cseclient_silent_install.txt file in the directory that contains the IBM Content Search Services Client installation software and edit the file to reflect the appropriate responses for your installation by using the values from your worksheet. Specify the location where you want to install the IBM Content Search Services Client files. The default installation paths are as follows:
Option Windows Description C:\Program Files\IBM\FileNet\ ContentEngine\CSEClient

5. Start the IBM Content Search Services Client installation program.

Table 4. IBM Content Search Services Client silent installation programs by operating system Operating system Windows Installation program 5.1.0-P8CSE-CLIENT-WIN.EXE f cseclient_silent_install.txt -i silent

6. Review the following IBM Content Search Services Client log files to verify that the installation was successful:
Option Windows Description cse_client_install_path\ CSEClient_install_log_5.1.0.log

Installing the latest Content Search Engine Client files on Content Engine servers
The Content Search Engine Client files make it possible for the Content Search Engine server component to communicate with the Content Engine servers.

Installing and configuring Content Engine

31

Important: Content Search Engine Client files are included in the Content Engine installation. You do not have to manually install these client files on a new Content Engine server. If fix packs for these client files are released, use the instructions in this section to install them manually before you use Configuration Manager to configure and deploy Content Engine. For instructions on how to obtain the latest Content Search Engine Client software updates, access the IBM FileNet P8 Platform support site. 1. Installing Content Search Engine Client files interactively You can install the Content Search Engine Client files interactively by running the installation program on all of the application server machines where Content Engine Server is installed. 2. Installing Content Search Engine Client files silently on page 33 You can install the Content Search Engine Client files silently by editing a silent input file and running the installation program from a command line. You must install Content Search Engine Client files on all application server machines where Content Engine Server is installed. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Installing Content Search Engine Client files interactively: You can install the Content Search Engine Client files interactively by running the installation program on all of the application server machines where Content Engine Server is installed. Be sure that you have available the Installation and Upgrade Worksheet that was filled out during your planning activities. To install Content Search Engine Client files: 1. On the machine where Content Engine is to be deployed, log on as ce_install_user. 2. Locate the Content Search Engine Client installation software. It must be the same version as your Content Search Engine Server software. You must install Content Search Engine and Content Engine software on the same operating system. For example, if Content Engine runs on Windows, locate the Content Search Engine Client installation software that runs on Windows. 3. Start the installation program.
Operating System Windows Install Program 5.1.0-P8CSE-CLIENT-WIN.EXE

Complete the Content Search Engine Client installation screens by using the values from your worksheet. 5. Review the following Content Search Engine Client log files: 4. v Windows - cse_client_install_path\CSEClient_install_log_5.1.0.log

32

Installation Guide

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Installing Content Search Engine Client files silently: You can install the Content Search Engine Client files silently by editing a silent input file and running the installation program from a command line. You must install Content Search Engine Client files on all application server machines where Content Engine Server is installed. Be sure that you have available the Installation and Upgrade WorksheetInstallation and Upgrade Worksheet that was filled out during your planning activities. To install Content Search Engine Client files: 1. On the machine where Content Engine is to be deployed, log on as ce_install_user. 2. Locate the Content Search Engine Client installation software. It must be the same version as your Content Search Engine Server software. You must install Content Search Engine and Content Engine software on the same operating system. For example, if Content Engine runs on Windows, locate the Content Search Engine Client installation software that runs on Windows. 3. Locate the CSE_silent_install.txt file within the directory that contains the Content Search Engine Client installation software, and edit the file to specify the location where you want to install the Content Search Engine Client files. The default installation paths are as follows: Windows C:\Program Files\IBM\FileNet\ContentEngine\CSEClient 4. Start the Content Search Engine Client installation program.
Operating System Windows Installation Program 5.1.0-P8CSE-CLIENT-WIN.EXE f cseclient_silent_install.txt

5. Review the following Content Search Engine Client log files: v Windows - cse_client_install_path\CSEClient_install_log_5.1.0.log Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Process Engine Client files on Content Engine servers
Install the Process Engine Client files on the Content Engine to enable communication between Content Engine and Process Engine. You can install the files interactively by using the installation wizard or silently by using the command line and a silent input file. Installing the latest Process Engine Client files on Content Engine servers interactively on page 34 The installation wizard provides an interactive way to install the Process Engine
Installing and configuring Content Engine

33

Client files. You can use the values you collected on your worksheet to fill in the required value for each field on the wizard screens. Installing the latest Process Engine Client files on Content Engine servers silently You can install the Process Engine Client software on the Content Engine server by using a silent input text file and running the installation program from the command line. Use the values in your installation worksheet to edit the silent input text file before you run the installation.

Installing the latest Process Engine Client files on Content Engine servers interactively
The installation wizard provides an interactive way to install the Process Engine Client files. You can use the values you collected on your worksheet to fill in the required value for each field on the wizard screens. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Except where noted, the following steps apply to IBM WebSphere Application Server, Oracle WebLogic Server, and JBoss Application Server. To install the Process Engine Client files: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by PE Client Installer in the Installation or Configuration Program column. 2. On the machine where Content Engine is to be deployed, log on as ce_install_user. 3. Locate the Process Engine Client installation software. The version of the Process Engine Client software must match the version of Process Engine software. 4. Expand the TAR or ZIP file of the Process Engine Client installation software. 5. Start the installation program by running the following command.
Operating System Windows Install Program 5.0.0-P8PE-CLIENT-WIN.EXE

6. Complete the Process Engine Client installation screens by using the values from your worksheet. 7. If the Process Engine is configured to use the IPv6 network protocol, locate and edit the taskman.properties file and add the following lines to that file:
-Djava.net.preferIPv6Addresses=true -Djava.net.preferIPv4Stack=false

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Process Engine Client files on Content Engine servers silently
You can install the Process Engine Client software on the Content Engine server by using a silent input text file and running the installation program from the

34

Installation Guide

command line. Use the values in your installation worksheet to edit the silent input text file before you run the installation. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Except where noted, the following steps apply to IBM WebSphere Application Server, Oracle WebLogic Server, and JBoss Application Server. To install the Process Engine Client files: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by PE Client Installer in the Installation or Configuration Program column. 2. On the machine where Content Engine is to be deployed, log on as ce_install_user. 3. Locate the Process Engine Client installation software. The version of the Process Engine Client software must match the version of Process Engine software. 4. Expand the TAR or ZIP file of the Process Engine Client installation software. 5. Edit the peclient_silent_install.txt file using the values from your Installation and Upgrade Worksheet. 6. Start the installation program by running the following command:
Operating System Windows Install Program 5.0.0-P8PE-CLIENT-WIN.EXE -f peclient_silent_install.txt

7. If the Process Engine is configured to use the IPv6 network protocol, locate and edit the taskman.properties file and add the following lines to that file:
-Djava.net.preferIPv6Addresses=true -Djava.net.preferIPv4Stack=false

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Configuring Content Engine

You can configure and deploy all of your Content Engine instances with Configuration Manager. Configuration Manager prepares the Content Engine application for deployment on the application server. A single Content Engine application instance equates to one deployed application on your application server. Configuration is a multiple step process. You must provide information about your Content Engine application environment, then you apply the settings by running the configuration tasks, and then you deploy the application. You can configure multiple instances before you deploy any of them, or you can configure and deploy one instance at a time.

Installing and configuring Content Engine

35

You use Configuration Manager to define the following information for the Content Engine instance: v Application server properties v Java Database Connectivity (JDBC) data source properties for the Global Configuration Data (GCD) database v Java Database Connectivity (JDBC) data source properties for each object store database v Directory service (LDAP) provider properties v Content Engine application login modules v Content Engine bootstrap properties Remember the following points when you prepare to configure Content Engine: v (WebSphere Application Server only) For best results, configure no more than one Content Engine instance in a WebSphere profile. v If you need an accessible software version of Configuration Manager for people with disabilities, use the command-line version of Configuration Manager. v If your FileNet P8 domain uses multiple non-managed application servers, then use a copy of a single EAR file with the bootstrap settings on all the servers. After you complete the tasks on the initial server, copy the EAR file with the bootstrap settings to the additional servers. Important: If you specified an incorrect value for the .NET API COM Compatibility Layer (CCL) server URL during Content Engine installation, you cannot correct the URL by using Configuration Manager to edit the dotnetclient configuration profile. Instead, correct the value by completing the following steps: 1. Open the configmgr.properties file for editing. This file is located in the path ce_install_path/tools/configure/configuration/. Find the line in the file that starts with CCL_URL and replace the URL with the correct value: 2. Find the line in the file that starts with CCL_URL
CCL_URL=http\://localhost\:port_number/wsi/FNCEWS40MTOM/

and replace the URL with the correct value. 3. Run Configuration Manager to reexecute the dotnetclient profile (which the Content Engine installation program automatically ran when it installed Content Engine). You can reexecute the profile using either the graphical user interface. Or you can reexecute the profile using the command-line interface:
configmgr_cl execute -task configureDotNetAPI -profile dotnetclient

1. Resolving the names of existing data sources on page 37 You must create data sources for the Global Configuration Data (GCD) database and your object store databases. Configuration Manager will not create a new data source with the same name as that of an existing data source. If you want to reuse a data source name, you must resolve data source naming conflicts before you configure the JDBC data sources. 2. Granting directory permissions to the Configuration Manager user on page 37 You must grant file and directory permissions to config_mgr_user, which is the user who runs Configuration Manager, to allow this user to run the program and create files in the ce_install_path/tools/configure directory. 3. Configuring Content Engine instances on page 38 You can configure and deploy all of your Content Engine instances with Configuration Manager. A single Content Engine application instance equates to

36

Installation Guide

one deployed application on your application server. You can use the graphical user interface or the command-line interface for Configuration Manager.

Resolving the names of existing data sources

You must create data sources for the Global Configuration Data (GCD) database and your object store databases. Configuration Manager will not create a new data source with the same name as that of an existing data source. If you want to reuse a data source name, you must resolve data source naming conflicts before you configure the JDBC data sources. Perform this procedure only if you already created data source names by using your application server administration tools and you want to use Configuration Manager to create the data sources. To resolve data source name reuse issues: 1. Use your application server administration tools to determine if the data source names that you selected already exist. 2. If you have a duplicate data source name that you want to use, manually delete the existing data source from your application server. See your application server documentation for more information.

Granting directory permissions to the Configuration Manager user

You must grant file and directory permissions to config_mgr_user, which is the user who runs Configuration Manager, to allow this user to run the program and create files in the ce_install_path/tools/configure directory. To grant permissions to the Configuration Manager user: 1. Log on as ce_install_user to the server where you installed Content Engine. 2. Grant permissions to the config_mgr_user user for the executable file that you intend to use:
Option Windows - graphical user interface Windows - command line Description Grant read and execute permission to configmgr.exe Grant read and execute permission to configmgr_cl.exe

3. Grant write permission to the directory where you want Configuration Manager to place the configuration XML files that it creates. If you do not specify the profile directory when you run Configuration Manager, grant write permission on the default directory ce_install_path/ tools/configure and all its files and subdirectories. 4. Log off the Content Engine server and log on again as config_mgr_user.

Installing and configuring Content Engine

37

Related tasks IBM FileNet P8 accounts See the P8 account information for details on how to specify the required accounts and their permissions in the Plan and Prepare Your Environment for IBM FileNet P8.

Configuring Content Engine instances

You can configure and deploy all of your Content Engine instances with Configuration Manager. A single Content Engine application instance equates to one deployed application on your application server. You can use the graphical user interface or the command-line interface for Configuration Manager. Remember the following points when you prepare to configure Content Engine: v (WebSphere Application Server only) For best results, configure no more than one Content Engine instance in a WebSphere profile. v If you need an accessible software version of Configuration Manager for people with disabilities, use the command-line version of Configuration Manager. v If your FileNet P8 domain uses multiple non-managed application servers, then use a copy of a single EAR file with the bootstrap settings on all the servers. After you complete the tasks on the initial server, copy the EAR file with the bootstrap settings to the additional servers. Ensure that the application server is running or stopped, depending on its type:
Option WebSphere Application Server Description Start the application server if it is not already running.

Configuring Content Engine instances by using the graphical user interface You use the graphical user interface version of Configuration Manager to configure and deploy a Content Engine application instance on an application server. Configuring instances by using the command line on page 47 You can configure a Content Engine instance on a web application server by using the command-line version of Configuration Manager.

Configuring Content Engine instances by using the graphical user interface

You use the graphical user interface version of Configuration Manager to configure and deploy a Content Engine application instance on an application server. First, you create a configuration profile that defines: v The JDBC data source settings v The login modules for the Content Engine application v The directory service provider (LDAP) settings v The Content Engine bootstrap settings You can follow the recommended order to edit and run the individual configuration tasks. However, you can edit and run the Configure GCD JDBC Data Sources, Configure Login Modules, Configure LDAP properties, and Configure Bootstrap tasks in any order. You do not need to complete work on one configuration task before starting another. You can save your edits, switch between tasks, close the tasks, and reopen tasks as needed. However, you must complete all of these tasks before you deploy the application.

38

Installation Guide

1. Starting the Configuration Manager graphical user interface You can start the graphical interface version of Configuration Manager to configure a Content Engine application instance on a web application server. 2. Changing the password save preference on page 40 By default, any passwords that you enter in the graphical user interface in Configuration Manager are not saved to a file. The passwords are stored in memory as long as you have the profile open in Configuration Manager. You can change the password save preference to save the passwords each time that you save your changes to a profile. 3. Creating a new configuration profile on page 40 Configuration Manager stores your settings for deploying a Content Engine application instance in a configuration profile. The profile defines the application server settings, the JDBC data source settings, the login modules settings, the directory service provider (LDAP) settings, the Content Engine bootstrap settings, and the application deployment settings. You must create a new profile for each Content Engine instance that you are configuring. 4. Configuring the Global Configuration Data JDBC data source settings on page 41 You must provide property information about the JDBC data sources for the Global Configuration Data (GCD) database. Content Engine uses the data source information to connect to and update the GCD database. 5. Configuring the login modules (WebSphere and JBoss only) on page 43 You must configure the login modules for the Content Engine application. The login modules provide authentication information for the Content Engine application. 6. Configuring Content Engine application server authentication (LDAP) settings on page 44 You must configure the Content Engine application server's authentication settings. These settings define the (LDAP) repository and search mechanism, which the application server uses to authenticate a user requesting Content Engine service. 7. Configuring the bootstrap settings on page 45 You must configure the bootstrap settings. The bootstrap information is needed for creating the Global Configuration Data (GCD) and for starting Content Engine. Starting the Configuration Manager graphical user interface: You can start the graphical interface version of Configuration Manager to configure a Content Engine application instance on a web application server. See the appendix Configuration Manager user interface reference on page 242 for complete information about using the graphical user interface. If you need an accessible version of Configuration Manager, use the command-line interface instead of the graphical user interface. To start Configuration Manager: 1. Start Configuration Manager by running one of the following commands, depending on the operating system that runs on the machine where you installed Content Engine:

Installing and configuring Content Engine

39

Option Windows

Description Perform one of the following actions: v Double-click the FileNet Configuration Manager desktop shortcut. v Click Start > All Programs > IBM FileNet P8 Platform > FileNet Configuration Manager. v Run the following command: ce_install_path\tools\configure\configmgr.exe

The first time that you start Configuration Manager, the Welcome is displayed. 2. Select one of the links in the Welcome to learn more or to start working in a wizard, or close the Welcome by clicking the X in the tab at the upper left. You can reopen the Welcome later, as needed, from the Help menu. Changing the password save preference: By default, any passwords that you enter in the graphical user interface in Configuration Manager are not saved to a file. The passwords are stored in memory as long as you have the profile open in Configuration Manager. You can change the password save preference to save the passwords each time that you save your changes to a profile. When you close the profile, the passwords are erased from memory. Each time that you start Configuration Manager or open a saved profile, the passwords are reset to blank (unless you previously changed the preferences setting). Before you can run a task, you must specify the passwords required by the task and the application server properties; otherwise, the task will not run successfully. If your site security requirements permit you to save passwords to a file, you can change the password save preference setting. To change the password save preference: 1. Click Window > Preferences. 2. Complete one of the following actions:
Option To save passwords to file To prevent writing passwords to file Description Select the Save all passwords to file when saving a task or profile check box. Clear the Save all passwords to file when saving a task or profile check box.

3. Click OK. Creating a new configuration profile: Configuration Manager stores your settings for deploying a Content Engine application instance in a configuration profile. The profile defines the application server settings, the JDBC data source settings, the login modules settings, the directory service provider (LDAP) settings, the Content Engine bootstrap settings, and the application deployment settings. You must create a new profile for each Content Engine instance that you are configuring.

40

Installation Guide

The information for a profile is collected in XML files in the form of properties and values that describe the associated configuration and deployment tasks. You must provide values for the profile properties that are specific to each configuration at your site, such as the application server name. The XML files are stored in a directory that is unique to a given profile. Because the profile name is used for the directory name and for the configuration profile file name, you must provide a profile name that is a valid directory name for your operating system. By default, the profiles are stored in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where Content Engine is installed. For more information on profiles, see Configuration profile concepts on page 236. Tip: For more information on the properties and values that you set in Configuration Manager, roll your mouse over the property name to view the tool tip help for the property. To create a configuration profile: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values, filter by CM: Create New Installation Profile in the Installation or Configuration Program column. 2. Start the Create New Installation Profile wizard by selecting File > New Installation Profile. 3. Complete the wizard screens by using the values in your worksheet. Attention: WebSphere Application Server and Oracle WebLogic Server: If you are creating the profile for a highly available clustered environment, use the profile for the WebSphere Application Server deployment manager, or the domain for the Oracle WebLogic Server administrative server. 4. Optional: WebSphere Application Server and Oracle WebLogic Server only. In the Set Properties for Application Server screen, click Test Connection to test the connection between Configuration Manager and the application server by using the information that you provided. The test is optional, and you can proceed in the wizard even if the test fails. If the test fails, make sure that the application server is running and that the application server property values that you entered match the values that are defined in your application server. The profile you created is displayed as an icon in the profile pane (left pane), along with icons for the tasks you selected. By default, the Deploy Application task is disabled. You must enable the task later in the configuration process. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Configuring the Global Configuration Data JDBC data source settings:

Installing and configuring Content Engine

41

You must provide property information about the JDBC data sources for the Global Configuration Data (GCD) database. Content Engine uses the data source information to connect to and update the GCD database. | | | | | | | | Ensure that the application server instance is running or stopped, depending on its type:
Table 5. Required application server state Option WebSphere Application Server Description Start the application server instance if it is not already running.

To configure the JDBC settings: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values, filter by CM: Configure GCD JDBC Data Sources in the Installation or Configuration Program column. 2. If your configuration profile is not open in Configuration Manager, open the profile. 3. Right-click Configure GCD JDBC Data Sources in the profile pane and select Edit Selected Task. 4. Enter the property values for your database by using the values in your worksheet. 5. In a high availability environment, enter the following additional information for the Configure GCD JDBC Data Sources task: Database server name If you are using a highly available database for the Global Configuration Data (GCD), use the virtual server name. Database server name RAC node n If you are using Oracle RAC, then you must enter the database information for two nodes in the RAC cluster. Configuration Manager uses the values that you provided to create the JDBC URL in the format shown in the following table:
Table 6. JDBC URL format for Oracle RAC Server WebSphere Description jdbc:oracle:@ (DESCRIPTION = (load_balance=yes) (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP) (HOST = rac node 1) (PORT = 1521))(ADDRESS = (PROTOCOL = TCP)(HOST = rac node 2) (PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = DB service name) (failover_mode = (type=select) (method=basic) (retries=retry number)(delay= delay value)))) Example jdbc:oracle: @(DESCRIPTION =(load_balance=yes) (ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP)(HOST = testrac1) (PORT = 1521)) (ADDRESS = (PROTOCOL = TCP) (HOST = testrac2)(PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = testracdb)(failover_mode = (type=select)(method=basic) (retries=32)(delay=4))))

42

Installation Guide

6. Optional: (WebSphere and WebLogic only) Click Test Database Connection to test the connection to the database by using the database user name, database server name, database name, port number, and password that you provided. The test does not create the data sources. a. Start the WebLogic Server administrative console. b. Click Lock & Edit > Services > JDBC Data Sources. c. Select the check box for the data source and then click Delete. d. Click Release. 7. Select File > Save to save your changes. 8. Ensure that the task is enabled. When the task is disabled, the task name includes the text (disabled). To enable the task, select Configure GCD JDBC Data Sources (disabled) in the profile pane, and then either right-click and choose Enable Selected Task from the context menu, or click the Enable the Selected Task icon in the task toolbar. 9. Apply the JDBC property settings by right-clicking Configure GCD JDBC Data Sources in the profile pane, and selecting Run Task. Running the configuration task can take several minutes. The task execution status messages are displayed in the console pane below the JDBC properties. 10. Close the Configure GCD JDBC Data Sources task pane. In this step, you created the GCD data sources. You create the initial object store data sources later in the configuration process. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Configuring the login modules (WebSphere and JBoss only): You must configure the login modules for the Content Engine application. The login modules provide authentication information for the Content Engine application. | | | | | | | | Ensure that the application server instance is running or stopped, depending on its type:
Table 7. Required application server state Option WebSphere Application Server Description Start the application server instance if it is not already running.

To configure the login module settings: 1. If your configuration profile is not open in Configuration Manager, open the profile. 2. If the Configure Login Modules task does not exist in the profile, add the task. Ensure that the task is enabled. When the task is disabled, the task name
Installing and configuring Content Engine

43

includes the text (disabled). To enable the task, select Configure Login Modules (disabled) in the profile pane, and then either right-click and choose Enable Selected Task from the context menu, or click the Enable the Selected Task icon in the task toolbar. 3. Create the login modules by right-clicking Configure Login Modules in the profile pane, and selecting Run Task. Running the configuration task can take several minutes. The task execution status messages are displayed in the console pane below the login modules properties. 4. Close the Configure Login Modules task pane. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Starting or stopping an application server instance Configuring Content Engine application server authentication (LDAP) settings: You must configure the Content Engine application server's authentication settings. These settings define the (LDAP) repository and search mechanism, which the application server uses to authenticate a user requesting Content Engine service. Important: Be aware that the changes you make to directory service provider settings overwrite the global security settings in the application server where Content Engine is to be deployed. Run the Configure LDAP task only if you need to change the security settings. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. If you plan to configure Content Engine to use the directory server's e-mail attribute or, for Active Directory, the userPrincipalName (UPN) to be the user short name used for login, then you must perform additional configuration steps and enter specific values for your LDAP settings. For detailed steps, see the IBM FileNet P8 help topic Security > IBM FileNet P8 security > How to... > Configure Content Engine to use e-mail or UPN for login. Manual procedures to configure multiple realms for application server authentication can be found in the IBM FileNet P8 help topic Security > IBM FileNet P8 Security > How to... > Configure multiple realms. To configure the LDAP settings: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values, filter by CM: Configure LDAP in the Installation or Configuration Program column.

44

Installation Guide

2. If your configuration profile is not open in Configuration Manager, open the profile. 3. Enter property values for the LDAP provider: a. Right-click Configure LDAP in the profile pane, and select Edit Selected Task. b. Enter the property values for your LDAP provider, by referring to the values from your worksheet. 4. Optional: (WebSphere and WebLogic only) Click Test LDAP Connection to test the connection to the directory service provider by using the directory service bind user name, host name, port number, and password that you provided. 5. Click File > Save to save your changes. 6. Ensure that the task is enabled. When the task is disabled, the task name includes the text (disabled). To enable the task, select Configure LDAP (disabled) in the profile pane, and then either right-click and choose Enable Selected Task from the context menu, or click the Enable the Selected Task icon in the task toolbar. 7. Apply the LDAP property settings by right-clicking Configure LDAP in the profile pane and selecting Run Task. Running the configuration task can take several minutes. The task execution status messages are displayed in the console pane below the LDAP properties. 8. Close the Configure LDAP task pane. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Configuring the bootstrap settings: You must configure the bootstrap settings. The bootstrap information is needed for creating the Global Configuration Data (GCD) and for starting Content Engine. Be sure that you have available the Installation and Upgrade Worksheet that was filled out during your planning activities. If you plan to configure Content Engine to use the directory server's e-mail attribute or, for Active Directory, the userPrincipalName (UPN) to be the user short name that is used for login, then you must perform additional configuration steps and enter specific values for your bootstrap settings. For detailed steps, see the IBM FileNet P8 help topic Security > IBM FileNet P8 Security > How to... > Configure Content Engine to use e-mail or UPN for login. If your FileNet P8 domain uses multiple non-managed application servers, then complete this procedure only on the initial server. You use a copy of the same EAR file with the bootstrap settings on all the servers. To edit the bootstrap settings:
Installing and configuring Content Engine

45

1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values, filter by CM: Configure bootstrap properties in the Installation or Configuration Program column. 2. If your configuration profile is not open in Configuration Manager, open the profile. 3. Right-click Configure Bootstrap Properties in the profile pane and select Edit Selected Task. 4. In the Bootstrap operation field, select Configure New. 5. Enter the property values for your database by using the values in your worksheet. 6. Click File > Save to save your changes. 7. Ensure that the task is enabled. When the task is disabled, the task name includes the text (disabled). To enable the task, select Configure Bootstrap Properties (disabled) in the profile pane, and then either right-click and choose Enable Selected Task from the context menu, or click the Enable the Selected Task icon in the task toolbar. 8. Apply the bootstrap property settings by right-clicking Configure bootstrap properties in the profile pane, and select Run Task. Running the configuration task can take a few minutes. The task execution status messages are displayed in the console pane below the bootstrap properties. 9. Optional: Click View Bootstrapped EAR Information to display the bootstrap information from the modified EAR file. 10. Close the Configure Bootstrap Properties task pane. 11. If your FileNet P8 domain uses multiple non-managed application servers, then copy the ce_install_path/ContentEngine/tools/configure/profiles/ my_profile/ear/Engine-app_server_type.ear file to each additional Content Engine server. ce_install_path The location where Content Engine is installed. my_profile The directory for the Configuration Manager profile that you created. Engine-app_server_type.ear The EAR file for your application server type: Engine-ws.ear, Engine-wl.ear, or Engine-jb.ear. Important: Only run the Configure bootstrap properties task on the initial server.

46

Installation Guide

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task.

Configuring instances by using the command line

You can configure a Content Engine instance on a web application server by using the command-line version of Configuration Manager. Begin by generating the configuration XML files that define the application server settings, the Global Configuration Data (GCD) data source JDBC data source settings, the login modules for the Content Engine application, the directory service provider (LDAP) settings, and the Content Engine bootstrap settings. Next, edit the files to provide values for your environment. Then, apply the settings by executing the tasks from a command prompt. You must generate, edit, and run a complete set of configuration XML to configure a Content Engine application. If you are deploying multiple Content Engine application instances on the same application server, you must generate, edit, and deploy a complete set of configuration files for each instance. Store the configuration files for each instance in a separate directory. You can complete the configuration tasks by generating all the configuration XML files before editing, running, or verifying any of them; or you can generate, edit, run, and verify one file at a time. 1. Generating the configuration XML files for a Content Engine instance The configuration XML files contain the properties and values for the various configuration tasks. From the command line, you can generate all of the XML files at the same time, or you can generate a single configuration XML file at a time. 2. Editing the configuration XML files for a Content Engine instance on page 52 You must edit each configuration XML file to provide the property values for your environment. You can use any text editor to open and edit the files. 3. Running the configuration XML files on page 55 Running the configuration XML files applies the settings. You use the execute command to apply your configuration settings from the command line. 4. Checking the completion status of Content Engine configuration tasks on page 59 Task execution messages are displayed in the console when you run a task, and you can view the status of a specific task at any time by running the checkStatus command. From the command line, you can check the status of all the configuration tasks or check the status of a single task. Generating the configuration XML files for a Content Engine instance: The configuration XML files contain the properties and values for the various configuration tasks. From the command line, you can generate all of the XML files at the same time, or you can generate a single configuration XML file at a time.
Installing and configuring Content Engine

47

The following table lists the configuration XML files that you need to generate to configure a new Content Engine instance.
Table 8. Configuration XML files File Name applicationserver.xml Description Settings for the application server, including the location of the application server software and the name of the server. This file is generated when any other configuration file is generated (either all at the same time or individually) and is used by all of the configuration tasks. If you generate the files one at a time, this file is created only once. Settings for creating the Global Configuration Data (GCD) and starting Content Engine. Settings for configuring JDBC connections to the databases used by Content Engine. You must generate, edit, and run the configure the JDBC task once for the data sources for the Global Configuration Data (GCD) and then again for the data sources for each object store. For information about creating the additional data sources for the object store, see Creating the data sources by using the command line on page 83. If you generate a second JDBC configuration file, then it is named configurejdbc.2.xml. The file name increments for each new file that you generate. configureldap.xml configureldap.n.xml , where n is an integer starting with 2 Settings for connecting to and searching within a directory server. If your site uses multiple LDAP providers, you can generate an additional file for each provider. If you generate a second LDAP configuration file, then it is named configureldap.2.xml. The file name increments for each new file that you generate. Settings for creating the application server login modules for Content Engine.

configurebootstrap.xml configurejdbcgcd.xml configurejdbcgos.xml configurejdbcos.n.xml , where n is an integer starting with 2

configureloginmodules.xml

You must eventually generate each of the required configuration XML files to configure a Content Engine instance. Generating all of the configuration XML files at the same time From the command line, you can generate all of the required configuration XML files for Content Engine at the same time with a single command. Generating one configuration XML file at a time (WebSphere) on page 50 From the command line, you can generate each of the required configuration XML files for Content Engine one file at a time. Generating all of the configuration XML files at the same time: From the command line, you can generate all of the required configuration XML files for Content Engine at the same time with a single command.

48

Installation Guide

When you run the generateconfig command, all the required configuration XML files are created. To generate all the configuration XML files at the same time: 1. Log on to the Content Engine server as config_mgr_user, the user who runs Configuration Manager. 2. Change the current directory to ce_install_path/tools/configure, where ce_install_path is the location where the Content Engine software is installed. 3. Run the following command. Do not type any line breaks when you enter the command. WebSphere Application Server
configmgr_cl generateconfig -appserver app_server_type -repositorytype ldap_repository_type -db db_type -ldap ldap_type -bootstrap bootstrap_operation -deploy deploy_type -profile myprofile

Where: -appserver appserver_name The -appserver appserver_type parameter specifies the type of application server and must be WebSphere, WebLogic, or JBoss. -repositorytype ldap_repository_type WebSphere Application Server only. The -repositorytype ldap_repository_type parameter specifies the type of LDAP repository to use and must be standalone or federated. -db database_type The -db database_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurejdbcgcd or configurejdbcos option. This parameter specifies the type of database to be used by Content Engine and must be mssql, oracle, oracle_rac, db2, or db2zos. -ldap ldap_type The -ldap ldap_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configureldap option. This parameter specifies the type of directory service repository that Content Engine uses for authenticating users and must be activedirectory, adam, ca, edirectory, oid, oracledirectoryse, or tivoli. The adam value applies to both Microsoft ADAM and AD LDS. -bootstrap bootstrap_operation The -bootstrap bootstrap_operation parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurebootstrap option. This parameter specifies the bootstrap operation for the profile and must be new, modify, or upgrade. -deploy deploy_type The -deploy deploy_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the deployapplication option. This parameter specifies the type of Content Engine deployment. The value must be standard, cluster, or netdeploy (network deployment). Specify standard if you are deploying Content Engine to a stand-alone (that is, a server that is neither managed nor clustered) WebSphere Application Server, Oracle WebLogic Server, or JBoss Application Server.
Installing and configuring Content Engine

49

Specify cluster if you are deploying Content Engine to a WebSphere Application Server, Oracle WebLogic Server, or JBoss Application Server cluster. | | | Specify netdeploy if you are deploying Content Engine to a managed WebSphere Application Server instance. That is, you are using Network Deployment to manage individual servers that are not in a cluster. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The fully qualified path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg". For example, the following command generates all the configuration XML files for a new installation profile for a standard deployment on WebSphere with IBM Tivoli Directory Server that uses a stand-alone LDAP repository and DB2 in the ce_install_path/tools/configure/profiles/wstdb2 directory:
configmgr_cl generateconfig -appserver WebSphere -repositorytype standalone -db db2 -ldap tivoli -bootstrap new -deploy standard -profile wstdb2

| |

| | |

Generating one configuration XML file at a time (WebSphere): From the command line, you can generate each of the required configuration XML files for Content Engine one file at a time. You must generate the configuration XML files for each of these required configuration tasks: v Create the XML file for the bootstrap properties file by using the configurebootstrap option. v Create the XML file for configuring the JDBC Data Sources for the Global Configuration Data (GCD) database by using the configurejdbcgcd option. v Create the XML file for configuring the JDBC Data Sources for a single object store database by using the configurejdbcos option. v Create the XML file for configuring the LDAP provider by using the configureldap option.

50

Installation Guide

v WebSphere Application Server and JBoss Application Server only. Create the XML file for configuring the login modules by using the configureloginmodules option. To generate a single configuration XML file: 1. Log on to the application server as config_mgr_user, the user who will run Configuration Manager. 2. Change the current directory to ce_install_path/tools/configure. 3. Run the appropriate command for the task you need. Do not type any line breaks when you enter the command. WebSphere Application Server only. Generate the configurebootstrap.xml file for the configurebootstrap task:
configmgr_cl generateconfig -appserver app_server_type -repositorytype ldap_repository_type -task configurebootstrap -bootstrap bootstrap_operation -profile myprofile

Generate the configurejdbcgcd.xml file for the configurejdbcgcd task for the GCD data sources:
configmgr_cl generateconfig -appserver app_server_type -repositorytype ldap_repository_type -db db_type -task configurejdbcgcd -profile myprofile

Generate the configureldap.xml file for the configureldap task:

configmgr_cl generateconfig -appserver app_server_type -repositorytype ldap_repository_type -ldap ldap_type -task configureldap -profile myprofile

Generate the configureloginmodules.xml file for the configureloginmodules task:

configmgr_cl generateconfig -appserver app_server_type -repositorytype ldap_repository_type -task configureloginmodules -profile myprofile

where: -appserver appserver_name -appserver appserver_type specifies the type of application server and must be WebSphere. -repositorytype ldap_repository_type WebSphere Application Server only. The -repositorytype ldap_repository_type parameter specifies the type of LDAP repository to use and must be standalone or federated. -db database_type The -db database_type parameter is required only when you are generating files by using the configurejdbcgcd or configurejdbcos option. This parameter specifies the type of database to be used by Content Engine and must be mssql, oracle, oracle_rac, db2, or db2zos. -ldap ldap_type The -ldap ldap_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configureldap option. This parameter specifies the type of directory service repository that Content Engine uses for authenticating users and must be activedirectory, adam, ca, edirectory, oid, oracledirectoryse, or tivoli. The adam value applies to both Microsoft ADAM and AD LDS. -bootstrap bootstrap_operation The -bootstrap bootstrap_operation parameter is required only when you are
Installing and configuring Content Engine

51

generating all the files at the same time or when you are generating a single file by using the configurebootstrap option. This parameter specifies the bootstrap operation for the profile and must be new, modify, or upgrade. - myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The fully qualified path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg". 4. Repeat as needed to generate all the required XML configuration files. Editing the configuration XML files for a Content Engine instance: You must edit each configuration XML file to provide the property values for your environment. You can use any text editor to open and edit the files. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. If you plan to configure Content Engine to use the directory server's e-mail attribute or, for Active Directory, the userPrincipalName (UPN) to be the user short name that is used for login, then you must perform additional configuration steps and enter specific values for your LDAP and bootstrap settings. For detailed steps, see the IBM FileNet P8 help topic Security > IBM FileNet P8 security > How to... > Configure Content Engine to use e-mail or UPN for login. Note: In high availability environments, make sure to use values appropriate to your configuration: Database server name If you are using a highly available database for the Global Configuration Data (GCD), use the virtual server name. Database server name RAC node n If you are using Oracle RAC, then you must enter the database information for two nodes in the RAC cluster. Configuration Manager uses the values that you provided to create the JDBC URL in the format shown in the following table:

| |

| | |

52

Installation Guide

Table 9. JDBC URL format for Oracle RAC Server WebSphere Description jdbc:oracle:@ (DESCRIPTION = (load_balance=yes) (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP) (HOST = rac node 1) (PORT = 1521))(ADDRESS = (PROTOCOL = TCP)(HOST = rac node 2) (PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = DB service name) (failover_mode = (type=select) (method=basic) (retries=retry number)(delay= delay value)))) Example jdbc:oracle: @(DESCRIPTION =(load_balance=yes) (ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP)(HOST = testrac1) (PORT = 1521)) (ADDRESS = (PROTOCOL = TCP) (HOST = testrac2)(PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = testracdb)(failover_mode = (type=select)(method=basic) (retries=32)(delay=4))))

To edit values in the configuration XML files: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values, in the Installation or Configuration Program column filter by each of the following items, depending on which XML file you are editing: v CM: Set Application Server properties v CM: Configure GCD JDBC Data Sources v CM: Configure LDAP v CM: Configure Bootstrap Properties 2. Use a text editor or XML editor to open one of the following configuration XML files that you generated: v applicationserver.xml v configurejdbcgcd.xml for the Global Configuration Data (GCD) v configureldap.xml v configurebootstrap.xml Do not edit the configureloginmodules.xml, configurejdbcos.xml, or deployapplication.xml files at this time. 3. Make the following changes to each XML configuration file: a. Replace each occurrence of ****INSERT VALUE**** with a value appropriate for your site. See the descriptions in the file for more information. Important: You do not need to supply values for passwords. You can run the storepasswords command later to add encrypted passwords to the file. b. Verify that the default values for the remaining properties are correct for your site. c. Set the enabled attribute value in the <configuration> tag to true in any configuration XML file you edit if you want to run the configuration task. 4. (WebSphere Application Server only) If you created XA and non-XA data sources that you want to use for the Global Configuration Data (GCD) database, make the following edits: a. In the configurejdbcgcd.xml file, set the enabled attribute value to false in the <configuration> tag to avoid creating another pair (XA and non-XA) of data sources.
Installing and configuring Content Engine

53

b.

In the configurebootstrap.xml file, set the <JDBCDataSourceXAFileName> and <JDBCDataSourceFileName> values to the XA and non-XA JNDI names, respectively, that are associated with the GCD database.

5. Save your edits and close the XML file. 6. Optional: Add encrypted passwords to the XML files by running the storepasswords command. Tip: If the storepasswords command prompts you to store passwords in configuration files on disk, you must respond with yes or no (instead of y or n). . a. Enter the following command on one line:
configmgr_cl storepasswords [-task task_type | -taskfile task_file_name] -profile myprofile

where: -task task_type The -task task_type parameter is optional and specifies a task for which to encrypt passwords. The task_type value is not case sensitive. The following table lists each valid task name, its associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 10. task_type values Task omitted Configuration file applicationserver.xml configurebootstrap.xml configurejdbc.xml configureldap.xml deployapplication.xml configurebootstrap configurebootstrap.xml Description When you omit the -task task_type parameter, you are prompted to enter the passwords for each configuration XML file in the profile. Each password is encrypted before it is added to the XML file. Encrypts the password for the BootstrapPassword property that is used to create the Global Configuration Data and to start Content Engine. Encrypts the password for the DatabasePassword property that Content Engine uses to access the GCD database.

configurejdbcgcd

configurejdbcgcd.xml

configurejdbcos

configurejdbcos.xml

Encrypts the password for the DatabasePassword configurejdbcos.n.xml, property that Content Engine where n is an integer starting uses to access the object store with 2 database. If you have more than one configurejdbcos.n.xml file, run the command for each task file.

54

Installation Guide

Table 10. task_type values (continued) Task configureldap Configuration file configureldap.xml Description

Encrypts the password for the LDAPBindPassword configureldap.n.xml, where property that Content Engine n is an integer starting with 2 uses to connect to the directory server for authenticating Content Engine users. If you have more than one configureldap.n.xml file, run the command for each task file.

-taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/ configure/profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg". 7. Repeat this procedure as needed until you have edited all the required files. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Running the configuration XML files:

| |

| | |

Installing and configuring Content Engine

55

Running the configuration XML files applies the settings. You use the execute command to apply your configuration settings from the command line. If you need to run the configuration XML files for a profile that was created or edited in the Configuration Manager graphical user interface, verify that the XML files contain values for the required passwords before you attempt to run the files. See Handling passwords in Configuration Manager on page 239 for more information. To run the configuration XML files: 1. Start or stop the application server instance.
Option WebSphere Application Server Description Start the application server instance if it is not already running.

| | | | | | |

2. Run the configuration XML files, either all at the same time or one file at a time. Running all the configuration XML files at the same time From the command line, you can run all of the required configuration XML files for Content Engine at the same time with a single command. Any configuration XML file that has the <TaskEnbled> element set to false is skipped. Running one configuration XML file at a time on page 57 From the command line, you can run each of the required configuration XML files one file at a time. You must run each of the required files to complete the Content Engine configuration. Related tasks Starting or stopping an application server instance Running all the configuration XML files at the same time: From the command line, you can run all of the required configuration XML files for Content Engine at the same time with a single command. Any configuration XML file that has the <TaskEnbled> element set to false is skipped. If your FileNet P8 domain uses multiple non-managed application servers, then you use a copy of a single EAR file with the bootstrap settings on all the servers. After you run all the tasks on the initial server, you copy the EAR file with the bootstrap settings to the additional servers. Then, when you run the tasks for the additional servers, do not use this procedure to run all tasks at once on the additional servers. Instead, only run the tasks for configuring the JDBC data sources for the GCD, configuring the JDBC data sources for the object stores, and configuring the LDAP provider. For all other configurations, you can run all the tasks at once on each Content Engine server. To run all the configuration XML files at the same time: 1. Change the current directory to ce_install_path/tools/configure, where ce_install_path is the location where the Content Engine software is installed. 2. Run the following command.
configmgr_cl execute -profile myprofile

56

Installation Guide

| |

where the -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". 3. If your FileNet P8 domain uses multiple non-managed application servers, then copy the ce_install_path/ContentEngine/tools/configure/profiles/ my_profile/ear/Engine-app_server_type.ear file to each additional Content Engine server. install_dir The location where Content Engine is installed. my_profile The directory for the Configuration Manager profile that you created. Engine-app_server_type.ear The EAR file for your application server type: Engine-ws.ear, Engine-wl.ear, or Engine-jb.ear. Important: For each additional non-managed server, only run the tasks for configuring the JDBC data sources for the GCD, configuring the JDBC data sources for the object stores, and configuring the LDAP provider. The task execution status messages are displayed. Running one configuration XML file at a time: From the command line, you can run each of the required configuration XML files one file at a time. You must run each of the required files to complete the Content Engine configuration. If you are running tasks for a profile that was created or edited in the Configuration Manager graphical user interface, verify that the XML files contain values for the required passwords before you attempt to run the configuration XML files. See Handling passwords in Configuration Manager on page 239 for more information. You must run the configuration XML files for each of the required configuration tasks: v Apply the bootstrap properties file by using the configurebootstrap option. If your FileNet P8 domain uses multiple non-managed application servers, then you use a copy of a single EAR file with the bootstrap settings on all the servers.
Installing and configuring Content Engine

| |

57

After you apply the bootstrap properties file on the initial server, you copy the EAR file with the bootstrap settings to the additional servers. Then, when you run the tasks for the additional servers, do not use the configurebootstrap option. Only run the tasks for configuring the JDBC data sources for the GCD, configuring the JDBC data sources for the object stores, and configuring the LDAP provider. For all other configurations, you can run all the tasks on each Content Engine server. Configure the JDBC Data Sources for the Global Configuration Data (GCD) database by using the configurejdbcgcd option. Configure the JDBC Data Sources for a single object store database by using the configurejdbcos option. Configure the LDAP provider by using the configureldap option. Configure the login modules by using the configureloginmodules option.

v v v v

To run the configuration XML files one file at a time: 1. Change the current directory to ce_install_path/tools/configure, where ce_install_path is the location where Content Engine is installed. 2. Run the appropriate command for the task you need to complete. Do not type any line breaks when you enter the command. Run the configurejdbcos.xml file in a profile with one configurejdbcos task:
configmgr_cl execute -task configurejdbcos -profile myprofile

Run the configurejdbc.2.xml file in a profile with multiple configurejdbcos tasks:

configmgr_cl execute -taskfile configurejdbc.2.xml -profile myprofile

Run the configureldap.xml file in a profile with one configureldap task:

configmgr_cl execute -task configureldap -profile myprofile

Run the configureldap.3.xml file in a profile with multiple configureldap tasks:

configmgr_cl execute -taskfile configureldap.3.xml -profile myprofile

Run the configureloginmodules.xml file:

configmgr_cl execute -task configureloginmodules -profile myprofile

Run the configurebootstrap.xml file in a profile with one configurebootstrap task:

configmgr_cl execute -task configurebootstrap -profile myprofile

Where: -taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional, but do not use the -task task_type parameter with the -taskfile task_file_name parameter. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items:

58

Installation Guide

| |

| | |

v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The fully qualified path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg". Remember: The values that you entered for the configurejdbcgcd task were for the Global Configuration Data (GCD) data sources. You must edit and run the configurejdbcos task once for each object store later in the installation process. 3. If your FileNet P8 domain uses multiple non-managed application servers, then copy the ce_install_path/ContentEngine/tools/configure/profiles/ my_profile/ear/Engine-app_server_type.ear file to each additional Content Engine server. install_dir The location where Content Engine is installed. my_profile The directory for the Configuration Manager profile that you created. Engine-app_server_type.ear The EAR file for your application server type: Engine-ws.ear, Engine-wl.ear, or Engine-jb.ear. Important: For each additional non-managed server, only run the tasks for configuring the JDBC data sources for the GCD, configuring the JDBC data sources for the object stores, and configuring the LDAP provider. When you run the tasks for the additional servers, do not use the configurebootstrap option on the additional servers. 4. Repeat this procedure as needed to run one of the other configuration XML files until you run the files for each of the four required tasks on this server. The task execution status messages are displayed. Checking the completion status of Content Engine configuration tasks: Task execution messages are displayed in the console when you run a task, and you can view the status of a specific task at any time by running the checkStatus command. From the command line, you can check the status of all the configuration tasks or check the status of a single task. The following table lists the status results and their descriptions.
Installing and configuring Content Engine

59

Table 11. checkstatus command results Status Result COMPLETED INCOMPLETE NO STATUS AVAILABLE FAILED Description The task ran successfully. The task is incomplete. The task has not been run. The task failed to complete. Additional information about the failure is displayed.

Checking the completion status of all configuration tasks at once From the command line you can check the status of all the configuration tasks with a single command. Checking the completion status does not validate the information in the XML files. Checking the completion status of one configuration task at a time From the command line you can check the status of a single task. Checking the completion status of all configuration tasks at once: From the command line you can check the status of all the configuration tasks with a single command. Checking the completion status does not validate the information in the XML files. To check the status of a configuration task: 1. Change the current directory to ce_install_path/tools/configure, where ce_install_path is the location where the Content Engine software is installed. 2. Run the following command:
configmgr_cl checkstatus -profile myprofile

where the -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The fully qualified path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". The task execution status messages are displayed. Checking the completion status of one configuration task at a time: From the command line you can check the status of a single task. To check the status of a configuration task:

| |

| |

60

Installation Guide

1. Change the current directory to ce_install_path/tools/configure, where ce_install_path is the location where the Content Engine software is installed. 2. Run one of the following commands. Do not type any line breaks when you enter the command. v To check the status of the configurejdbc.xml file in a profile with one configurejdbcos task:
configmgr_cl checkstatus -task configurejdbcos -profile myprofile

To check the status of the configurejdbcos.n.xml file in a profile with multiple configurejdbcos tasks:
configmgr_cl checkstatus -task configurejdbcos -taskfile task_file_name -profile myprofile

To check the status of the configureldap.xml file in a profile with one configureldap task:
configmgr_cl checkstatus -task configureldap -profile myprofile

To check the status of the configureLDAP.n.xml file in a profile with multiple configureldap tasks:
configmgr_cl checkstatus -task configureldap -taskfile task_file_name -profile myprofile

To check the status of the configureloginmodules.xml file for the configureloginmodules task:
configmgr_cl checkstatus -task configureloginmodules -profile myprofile

To check the status of the configurebootstrap task:

configmgr_cl checkstatus -task configurebootstrap -profile myprofile

where: -taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional, but do not use the -task task_type parameter with the -taskfile task_file_name parameter. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfiletask_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg.

| |

| | |

Installing and configuring Content Engine

61

Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg". 3. Repeat the previous step as needed to check status on one of the other configuration XML files. The task execution status messages are displayed.

Enabling application server connections after database failover

If the database fails over in your environment, your application server must be able to reconnect. Complete the task for your application server. Enabling application server connections after database failover (WebSphere 6.1) You can enable a WebSphere Application Server 6.1 connection to the Global Configuration Data (GCD) and object store databases after failover. Enabling application server connections after database failover (WebSphere 7.0) You can enable a WebSphere Application Server 7.0 connection to the Global Configuration Data (GCD) and object store databases after failover.

Enabling application server connections after database failover (WebSphere 6.1)

You can enable a WebSphere Application Server 6.1 connection to the Global Configuration Data (GCD) and object store databases after failover. To configure database connections for failover: 1. Log on to the WebSphere Application Server Administrative Console. 2. Navigate to JDBC Providers > JDBC Providers for GCD Datasource > Data sources > Data Source Name > WebSphere Application Server data source properties. 3. Select both Pretest connection properties check boxes in WebSphere to enable and accept the default parameter values for pretest connection retry interval and pretest SQL string. Example SQL string for DB2: SELECT 1 FROM sysibm.sysdummy1 4. (Oracle RAC only) Navigate to JDBC Providers for GCD Datasource > Data sources > Data Source Name > custom properties , and remove the serverName and portNumber properties. 5. Save your changes.

Enabling application server connections after database failover (WebSphere 7.0)

You can enable a WebSphere Application Server 7.0 connection to the Global Configuration Data (GCD) and object store databases after failover. To configure database connections for failover: 1. Log on to the WebSphere Application Server Administrative Console. 2. Navigate to Resources > JDBC > Data sources > Data Source Name > WebSphere Application Server data source properties.

62

Installation Guide

3. Select the Validate New Connections check box. Set the number of retries to 100, and set the retry interval to 3. 4. Select the Validate existing pooled connections check box. Set the retry interval to 0. 5. Under the validation options, enter an appropriate query for your database type. For DB2, enter: SELECT 1 FROM sysibm.sysdummy1 6. (Oracle RAC only) Navigate to Resources > JDBC > Data sources > Data Source Name > Custom properties, and remove the serverName and portNumber properties. 7. Save your changes.

Deploying Content Engine instances

Depending on your environment, you can use the Configuration Manager graphical user interface, or the command line, to deploy Content Engine instances. Perform the procedures in this topic after you have performed the configuration tasks in Configuring Content Engine on page 35 and you have installed the latest version of the Process Engine client files on the Content Engine. Restriction: Use must use the command line version of Configuration Manager if any of these conditions are true: v You need an accessible software version of Configuration Manager for people with disabilities to use. Deploying instances by using the graphical user interface You can deploy a Content Engine Server instance on the web application server by using the graphical user interface. Deploying makes the Content Engine application available for use. Deploying Content Engine by using the Configuration Manager command line on page 65 From the command line you can deploy the Content Engine application on the application server.

Deploying instances by using the graphical user interface

You can deploy a Content Engine Server instance on the web application server by using the graphical user interface. Deploying makes the Content Engine application available for use. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Tip: For more information on the properties and values you set in the Configuration Manager, roll your mouse over the property name to view the hover help for the property. To deploy Content Engine: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager deployment values for this task, filter by CM: Deploy Application in the Installation or Configuration Program column.

Installing and configuring Content Engine

63

2. Log on to the application server machine as config_mgr_user, which is the Configuration Manager user. 3. Start Configuration Manager.
Option Windows Description Complete one of the following actions: v v Double-click the FileNet Configuration Manager desktop shortcut. Select Start > All Programs > IBM FileNet P8 Platform > FileNet Configuration Manager. Run ce_install_path \tools\configure\configmgr.exe. where ce_install_path is the location where the Content Engine server software is installed

4. Select File > Open Configuration Profile. 5. Enter the path to the profile for this Content Engine instance, or click Browse to locate the profilename.cfgp profile file. 6. Click OK. 7. Right-click the Deploy Application task in the profile pane (left pane), and select Edit Selected Task. 8. Provide the property values for your deployment by using the values in your worksheet. 9. (Application server cluster configurations only) Make sure the following settings are used in a high availability environment using cluster configurations: Deployment type Verify that Deployment type is set to Cluster. Application server name Enter the name of the highly available cluster that you have configured. This configures the GCD data sources and security settings at the administrative level so that all cluster nodes have access to this vital configuration information. 10. Select File > Save. 11. Enable the task. When the task is disabled, the task name includes the text (Disabled). To enable the task, select Deploy Application (Disabled) in the profile pane, and then either right-click and choose Enable Selected Task from the context menu, or click the Enable the Selected Task icon in the task toolbar. 12. Right-click the Deploy Application task in the left pane, and select Run Task . Running the deploy task might take several minutes. The task status messages are displayed in the Console pane below the deploy application properties.

64

Installation Guide

Related concepts Installation and Upgrade Worksheet Locate the Installation and Upgrade Worksheet in the IBM FileNet P8 Platform Information Center. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. IBM FileNet P8 accounts See the P8 account information for details on how to specify the required accounts and their permissions in the Plan and Prepare Your Environment for IBM FileNet P8.

Deploying Content Engine by using the Configuration Manager command line

From the command line you can deploy the Content Engine application on the application server. You must generate the deployapplication.xml file, edit the file to provide values for your environment, and then execute the deploy task. If you are deploying multiple Content Engine instances on the same machine, you must generate, edit, and execute a separate deployapplication.xml file for each instance. Store the deployapplication.xml file for each instance in a separate profile. Complete the following tasks: 1. Generating the deployapplication.xml file The deployapplication.xml file contains settings for deploying the Content Engine application. You must use the generateConfig command to create the XML file. 2. Editing the deployment configuration files on page 67 You must edit the applicationserver.xml and deployapplication.xml configuration XML files to provide the property values for your environment. You can use any text editor to open and edit the files. 3. Running the deployapplication.xml file on page 68 From the command line, you can run the execute command on the deployapplication.xml configuration XML file to deploy the Content Engine application on the web application server. 4. Checking the configuration status of the deployapplication task on page 68 From the command line you can check the status of a single task, such as the deployapplication task. Checking the completion status does not validate the information in the XML files.

Generating the deployapplication.xml file

The deployapplication.xml file contains settings for deploying the Content Engine application. You must use the generateConfig command to create the XML file. The deployapplication.xml file is created when you generate all files at the same time or when you generate the deployapplication task. If you generated all the files at the same time, you already have deployapplication.xml file and you a can skip this procedure.
Installing and configuring Content Engine

65

To generate the deployapplication.xml file: 1. Log on to the application server as config_mgr_user, the user who will run Configuration Manager. 2. Change the current directory to ce_install_path/tools/configure , where ce_install_path is the location where is Content Engine is installed. 3. Enter the following command without line breaks to generate the deployapplication.xml file:
configmgr_cl generateconfig -appserver app_server_type -deploy deploy_type -task deployapplication -profile myprofile

Where: -appserver appserver_name The -appserver appserver_type specifies the type of application server and must be WebSphere, WebLogic, or JBoss. -deploy deploy_type The -deploy deploy_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the deployapplication option. This parameter specifies the type of Content Engine deployment. The value must be standard, cluster, or netdeploy (network deployment). Specify standard if you are deploying Content Engine to a stand-alone (that is, a server that is not managed or clustered) WebSphere Application Server, Oracle WebLogic Server, or JBoss Application Server. Specify cluster if you are deploying Content Engine to a WebSphere Application Server, Oracle WebLogic Server, or JBoss Application Server cluster. | | | Specify netdeploy if you are deploying Content Engine to a managed WebSphere Application Server instance. That is, you are using Network Deployment to manage individual servers that are not in a cluster. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg".

| |

| | |

66

Installation Guide

Editing the deployment configuration files

You must edit the applicationserver.xml and deployapplication.xml configuration XML files to provide the property values for your environment. You can use any text editor to open and edit the files. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To edit the values in the configuration XML files: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values, filter by the task you are editing in the Installation or Configuration Program column: v CM: Set Application Server properties v CM: Deploy Application 2. If you have not already edited the applicationserver.xml file in Configuring Content Engine on page 35, set the application server property values for your site. a. Use a text editor or XML editor to open the applicationserver.xml file. b. Replace each occurrence of ****INSERT VALUE**** with a value appropriate for your site. See the descriptions in the file for more information. c. Verify that the default values for the remaining properties are correct for your site. (Application server cluster configurations only): Make sure the following settings are used in a high availability environment using cluster configurations: Deployment type Verify that Deployment type is set to Cluster. Application server name Enter the name of the highly available cluster that you have configured. This configures the GCD data sources and security settings at the administrative level so that all cluster nodes have access to this vital configuration information. d. Save your edits. 3. Set the deployment property values for your site. a. Use a text editor or XML editor to open the applicationserver.xml file. b. Replace each occurrence of ****INSERT VALUE**** with a value appropriate for your site. See the descriptions in the file for more information. c. Set the enabled attribute value in the <configuration> tag to true. By default, the enabled value is set to false. For deployment to occur, you must enable the task. d. Verify that the default values for the remaining properties are correct for your site. WebSphere Application Server only: | | 1) For standard deployment or non-cluster network deployment, specify values for <applicationservername> and <applicationservernode>. 2) For cluster deployment, specify values for <applicationservername>, <applicationservernode>, and <applicationserverclustername>.
Installing and configuring Content Engine

67

e. Save your edits. 4. Run the storepasswords command to encrypt and store the web application server administrator password.
configmgr_cl storepasswords -profile myprofile

Tip: If the storepasswords command prompts you to store passwords in configuration files on disk, you must respond with yes or no (instead of y or n). Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Running the deployapplication.xml file

From the command line, you can run the execute command on the deployapplication.xml configuration XML file to deploy the Content Engine application on the web application server. To run the deployapplication.xml file: 1. Navigate to ce_install_path/tools/configure , where ce_install_path is the path where you installed Content Engine. 2. Run the following command:
configmgr_cl execute -task DeployApplication -profile myprofile

where the -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The fully qualified path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg".

| |

| |

Checking the configuration status of the deployapplication task

From the command line you can check the status of a single task, such as the deployapplication task. Checking the completion status does not validate the information in the XML files. To check the status 1. Set the current directory to ce_install_path/tools/configure, where ce_install_path is the location where Content Engine is installed. 2. At the command prompt, run the following command:
configmgr_cl checkStatus -task deployapplication -profile myprofile

68

Installation Guide

| |

where the -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The fully qualified path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". The task execution status messages are displayed.

| |

Installing storage device source files

If your IBM FileNet P8 system includes Tivoli Storage Manager or EMC Centera devices, you must install files on the Content Engine server. Installing Tivoli Storage Manager client and adding native API library paths (WebSphere Application Server) The client software and the native API library paths enable you to use Tivoli Storage Manager to access a fixed content device. Installing or updating EMC Centera SDK library files on page 70 EMC Centera SDK library files enable access between the IBM FileNet P8 environment and EMC Centera fixed content devices. You need to update the EMC Centera SDK library files if EMC Centera fixed content devices are in your existing environment or if EMC Centera fixed content devices will be added to your IBM FileNet P8 environment.

Installing Tivoli Storage Manager client and adding native API library paths (WebSphere Application Server)
The client software and the native API library paths enable you to use Tivoli Storage Manager to access a fixed content device. Installing Tivoli Storage Manager client on page 70 Install the Tivoli Storage Manager client software on each application server where Content Engine is deployed. Copying the Tivoli Storage Manager API libraries to additional servers on page 70 If you are running a Content Engine server farm, the Tivoli Storage Manager API libraries must be on each server in the farm. Creating a shared library definition for Tivoli Storage Manager native API library files on page 70 The shared library definition specifies the location of the Tivoli Storage Manager JAR file.

Installing and configuring Content Engine

69

Installing Tivoli Storage Manager client

Install the Tivoli Storage Manager client software on each application server where Content Engine is deployed. To install Tivoli Storage Manager client software: 1. Download the Tivoli Storage Manager client software from the IBM Support site at http://www.ibm.com/support/docview.wss?uid=swg24019757. 2. Complete the platform-specific installation instructions included with each Tivoli Storage Manager client download package.

Copying the Tivoli Storage Manager API libraries to additional servers

If you are running a Content Engine server farm, the Tivoli Storage Manager API libraries must be on each server in the farm. To copy the Tivoli Storage Manager API libraries to additional servers: Copy the entire tsm100 directory structure from the Content Engine installation directory to each of the servers in the farm. It is a best practice to use the same directory structure on each server in the farm. For example:
Option Windows Description C:\Program Files\IBM\FileNet\ ContentEngine\tsm100

Creating a shared library definition for Tivoli Storage Manager native API library files
The shared library definition specifies the location of the Tivoli Storage Manager JAR file. To create a shared library definition for Tivoli Storage Manager native API library files: 1. Log on to the WebSphere administrative console. 2. Create a shared library definition according to the type of deployment (stand-alone or clustered), the version of WebSphere, and the operating system on which WebSphere runs, as shown in the following substeps. a. Specify a Node scope for the library. b. In a server farm, if you installed the tsm100 directory in different locations, choose Server scope and add a Shared Library entry for each server in your server farm. c. Provide a name for the shared library, for example TSMAPLIB. 3. Navigate to the deployed FileNetEngine application and then set the created shared library reference. 4. Save the change to the master configuration. Related information WebSphere Application Server Library

Installing or updating EMC Centera SDK library files

EMC Centera SDK library files enable access between the IBM FileNet P8 environment and EMC Centera fixed content devices. You need to update the EMC

70

Installation Guide

Centera SDK library files if EMC Centera fixed content devices are in your existing environment or if EMC Centera fixed content devices will be added to your IBM FileNet P8 environment. Installing EMC Centera SDK library files EMC Centera SDK library files enable access between the IBM FileNet P8 environment and EMC Centera fixed content devices. Configuring EMC Centera SDK environment variables on page 72 You must specify values for the environment variables so that Content Engine can access the EMC Centera SDK library files.

Installing EMC Centera SDK library files

EMC Centera SDK library files enable access between the IBM FileNet P8 environment and EMC Centera fixed content devices. To install EMC Centera SDK library files: 1. Log on to the Content Engine Server machine as ce_install_user. 2. Back up or delete any existing EMC Centera SDK library files, which are located in the Default Destination Installation Location column of the following table:
Operating System Windows Default Destination Installation Location C:\Centera_SDK

3.

The Centera directory in the Content Engine software package contains the EMC Centera SDK installation files. As shown in the following table, copy the appropriate directory to a location on the Content Engine Server machine, such as /tmp (UNIX) or C:\Temp (Windows).
Directory To Be Copied Copy the entire Centera directory

Operating System AIX, Solaris, Windows

4.

On the Content Engine Server machine, navigate within the Centera directory (at its copied location) to the install subdirectory, which contains the installer script. 5. Run the installer script corresponding to the operating system on the Content Engine Server machine. On UNIX, the installer script will prompt you for the install directory. On Windows, specify the install directory, such as C:\Centera_SDK , on the command line.
Description install.bat C:\Centera_SDK

Option Windows

6.

The installer script creates both 32-bit and 64-bit library directories, and puts them in a default installation directory, depending on your operating system (as shown in the following table). Accept or change the default when prompted by the script.
Subdirectories of extracted EMC Centera SDK Directory Description lib lib has the native library files that are to be installed.

Operating System AIX, Solaris, and Windows

Installing and configuring Content Engine

71

Configuring EMC Centera SDK environment variables

You must specify values for the environment variables so that Content Engine can access the EMC Centera SDK library files. To configure EMC Centera SDK environment variables: 1. Locate the sample setup script on the Content Engine installation media. The file name of the sample setup script depends on your operating system:
Option Windows Description setCenteraLibPath.bat

2. Modify the sample setup script as indicated in the following table: Note that the CENTERA_LIB_PATH variable needs to point to the library directory, not just the installation directory that contains the library directory. For example, if you have a 64-bit AIX system, and you change the destination installation path (install_path in the table below) from: /usr/local/Centera_SDK (the default) to: /usr/local/Centera/SDK3.2.607 then change the installation path of the AIX script to: /usr/local/Centera/SDK3.2.607/lib/64 Note that the actual location is appended with either lib/32 or lib/64 because the installation script creates both 32-bit and 64-bit library directories, and places them inside the lib directory.
Operating System Windows Script Revisions From: set CENTERA_LIB_PATH=C:\Centera_SDK\lib\32 set PATH=%PATH%;%CENTERA_LIB_PATH% to: set CENTERA_LIB_PATH=install_path \lib\32 set PATH=%PATH%;%CENTERA_LIB_PATH or: set CENTERA_LIB_PATH=install_path \lib\64 set PATH=%PATH%;%CENTERA_LIB_PATH

3. Copy the modified script text into one of the application server startup scripts shown in the following table, or save the updated script and call it from the application server startup script.
Application Server WebSphere Application Server Startup Script (UNIX) setupCmdLine.sh Startup Script (Windows) setupCmdLine.cmd

4. Stop and start the application server instance.

Configuring file stores for high availabilty

File store content is managed from the Content Engine application.

72

Installation Guide

Ensure that the file store data is highly available and that access to content in file stores is not interrupted. All file stores File systems that are used for file stores must be shared or mounted through the NFS or CIFS protocol. Each Content Engine instance in a farm must have access to the same shares or mount points. Standard file stores Standard file stores must be installed in file systems that are highly available. Fixed File Stores The front end of the file system must be made highly available, as indicated previously, and the remote device must be made highly available by using its built-in capability. See your fixed file store documentation for details. Tip: v A fixed file store comprises a file system-based front-end, similar to a standard file store, and a remote storage system such as Centera or NetApp/IBM N-Series SnapLock. v The method and technology used to make file store data highly available can vary greatly, from file servers built on general-purpose hardware and cluster technology, such as IBM HACMP, to specialized devices with built-in high availability such as NAS- and SAN-based offerings from EMC, NetApp or IBM. v The implementation and use of these technologies vary, but they can all be used to provide highly available access to data so long as they meet the criteria discussed in this section.

Completing Content Engine post-deployment steps

You must complete the post-deployment web application server configuration before you can put an IBM FileNet P8 system into production. Completing Content Engine post-deployment steps (WebSphere) You must complete the post-deployment web application server configuration before you can put an IBM FileNet P8 system into production.

Completing Content Engine post-deployment steps (WebSphere)

You must complete the post-deployment web application server configuration before you can put an IBM FileNet P8 system into production. To complete the post-deployment configuration: 1. Log in to the WebSphere Application Server administrative console. 2. Navigate to Security > Global security. 3. If you configured Content Engine to use federated user repositories, complete the following substeps: a. Click Configure. b. Specify a unique user for the Primary administrative user name. Use the short name. The user name must exist in one of the realms and must be unique.

Installing and configuring Content Engine

73

c. Specify the Server user identity. You can select Automatically generated server identity or specify a name that exists in one of the repositories. The user name must be unique. d. Save your changes to the master configuration. 4. Configure security settings: Important: Enabling the security settings must be done manually. Deploying Content Engine does not enable or check these settings. a. Enable WebSphere administrative security to secure the WebSphere administration console. b. Disable Java 2 security. Otherwise, Content Engine cannot start or process requests. 5. Complete the following substeps to verify that the HTTP port used by the Content Engine is defined in the default_host host aliases table. By default the host alias is defined only for HTTP port 9080. If you are using any other HTTP port (common in network deployments) you must add that port to the list of host aliases for default_host. a. Navigate to Environment > Virtual Hosts > default host > Host Aliases. b. Add your HTTP port in the host aliases table. | | c. Click OK, and then click Save. 6. Restart the WebSphere application server instance where Content Engine is deployed, as follows:
Option Description Stop and start the application server instance. Stop and start the application server instance where Content Engine is deployed, including the Deployment Manager and all managed nodes. Stop and start the cluster, as well as the deployment manager and all of its managed nodes.

| | | | | |

Stand-alone server Network Deployment

Cluster

Related tasks Starting or stopping an application server instance

Verifying the Content Engine deployment

You can verify that the Content Engine deployment was successful by accessing the IBM FileNet P8 System Health page. In a highly available environment, verify that the Content Engine application is running on the cluster or farm. 1. Browse to the IBM FileNet P8 System Health page: http://server:port/P8CE/Health where: server is the host name of the machine where Content Engine is deployed. In a highly available environment, server is the name of one of the servers in the farm. port is the WSI port used by the Web application server on the machine where Content Engine is deployed.

74

Installation Guide

The following table lists an example address for your application server:
Table 12. Example FileNet P8 System Health page address Application Server Type IBM WebSphere Application Server Web Page Address http://server:9080/P8CE/Health

2. Verify that the FileNet P8 System Health page contains the Content Engine instance host name and port number. The FileNet P8 System Health page provides status for the items in the following table. Tip: At this point, red icons appear on the page at the left of those entries that do not yet exist. In particular, if you are upgrading from version 3.5.2, a red icon appears before the GCD, directory configurations, object stores, storage areas, and sites entries. Also, if you are upgrading from version 3.5.2, no domain name appears yet in the Domain entry.
Table 13. FileNet P8 System Health page contents Section Domain Global Configuration Database Description Displays the FileNet P8 domain name if a domain was found. Verifies that the GCD contains a valid domain object, that the XA and non-XA data sources are defined and have unique names, and that the bootstrap user name and password are defined. If any of these verification tests fail, then the failed icon is displayed. Verifies that at least one directory service is configured and lists the number of configured directory service providers. Displays the number of Process Engine connection points. Displays the number of Process Engine isolated regions. Lists the number of fixed content devices (FCDs) For each FCD listed, there is at least one associated fixed storage area that is in the open state. Verifies that at least one object store exists and lists the number of object stores. Verifies that at least one storage area is defined, lists the number of storage areas, and the status for each storage area, such as online or offline. Displays the number of content cache areas. Verifies that at least one site is defined and lists the number of sites. For each site listed, at least one virtual server or server instance exists.

Directory Configurations PE Connection Points PE Isolated Regions Fixed Content Devices

Object Stores Storage Areas

Content Cache Areas Sites

3. Optional: Bookmark the FileNet P8 System Health page Web page address in your browser for later use. 4. Browse to the Content Engine Startup Context (Ping Page): http://server:port/FileNet/Engine where: server is the host name of the machine where Content Engine is deployed. In a highly available environment, server is the name of one of the servers in the farm. port is the HTTP port used by the application server where Content Engine is deployed.
Installing and configuring Content Engine

75

The following table lists an example address for your application server:
Table 14. Example Content Engine Startup Context (Ping Page) address Application Server Type IBM WebSphere Application Server Web Page Address http://myserver:9080/FileNet/Engine

5. Verify that the Content Engine Startup Context (Ping Page) contains the following information: v Verify the value in the Startup Message key. The Content Engine build and version (for example, dap452.097), must match the build and version in the ce_install_path/ce_version.txt file, where ce_install_path is the location where the Content Engine software is installed. v Verify the value in the Process Engine key. The Process Engine Client build and version (for example, pui451.075), must match the build and version in the version.txt file in the TAR or ZIP file of the Process Engine Client installation software. v Verify that the values for JDBC driver, server instance, operating system, and other properties match the values that you entered when you configured Content Engine. 6. Optional: Bookmark the Content Engine Startup Context (Ping Page) in your browser for later use. 7. (Highly available environments): View the startup context name of the load-balancer or proxy device to verify the functionality of the load-balanced environment, or the name of the physical server to verify a single server. 8. (Highly available environments): Verify Content Engine access through the load balancer. a. Browse to:
http://ce_load_balancer:port/FileNet/Engine

where ce_load_balancer is name of the load-balancer or proxy device to verify the functionality of the load balanced environment and port is the port used to access Content Engine on the load balancer or server running Content Engine. b. Load the Content Engine Startup Context page and verify that Content Engine is accessed correctly by using the load balancer. c. View the startup context.name of the load-balancer or proxy device to verify the functionality of the load-balanced environment, or the name of the physical server to verify a single server. Tip: v Depending on your configuration you can connect to the load balanced Content Engine installation, and after confirming that Content Engine is up and running, you can refresh your browser to have the load balancer cycle through all managed nodes for verification.

Establishing the FileNet P8 domain and Global Configuration Data (GCD)

With Content Engine installed and deployed, you must use IBM FileNet Enterprise Manager to create a FileNet P8 domain. You can also use Enterprise Manager to set a URL to the FileNet P8 online help if you did not specify the location when you ran the Content Engine installation program.

76

Installation Guide

Remember: Create only one FileNet P8 domain per highly available environment. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Restriction: Using a load-balancer for the Enterprise Manager connection is not supported. Important: If you run Enterprise Manager as a limited (non-administrative) user account, you cannot update the Base URL for the FileNet P8 Platform help files field in the General tab of the Enterprise Manager Properties dialog box. However, you can update the field later by logging on to Enterprise Manager as the gcd_admin user. Tip: You can also use the Web-based IBM Administrative Console for Content Engine to accomplish this task. To do so, access http://ce_server_name:port/ acce/login.jsp. from a Web browser client, log on as the gcd_admin user, and review the embedded assistance as needed. ce_server_name is the name of the system where Content Engine is deployed. port is the WSI port that is used by the application server on which Content Engine is deployed. For prerequisite information on using ACCE, see Administering IBM FileNet P8 > Administering Content Engine > Administrative Console for Content Engine > Starting Administrative Console for Content Engine. 1. Create a FileNet P8 domain: a. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Create FileNet P8 domain in the Installation or Configuration Program column. b. Start Enterprise Manager by double-clicking the Enterprise Manager icon on the desktop, or by clicking Start > All Programs > IBM FileNet P8 Platform > Enterprise Manager Administration Tool. c. Complete the wizard screens by using the values in your worksheet. The values displayed in the screens are default values that you must change to match your site. 2. Configure directory service authentication. Important: For multi-realm authorization, run the Create a Directory Configuration wizard once for each realm. See the IBM FileNet P8 help topic Security > IBM FileNet P8 Security > How to... > Configure multiple realms. a. Return to your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Create a Directory Configuration in the Installation or Configuration Program column. b. In the FileNet P8 Logon dialog box, click Connect. c. In the Add Domain Configuration window, enter the values from your worksheet. d. In the Create P8 Domain window, enter the name for a new FileNet P8 domain from your worksheet and click Continue to start the Create a Directory Configuration wizard.
Installing and configuring Content Engine

77

If an error occurs, check the application server log file on the machine where Content Engine is deployed.
Application server type IBM WebSphere Application Server Path to log file WAS_install_path/AppServer/profiles/ profile_name/logs/server_name/ SystemOut.log

e. Complete the wizard screens by using the values in your worksheet. The values displayed in the screens are default values that you must change to match your site. The Create a Directory Configuration wizard prompts you for many of the same parameters that you provided to Configuration Manager when you edited the Configure LDAP task. See the topic for your directory service provider in the IBM FileNet P8 help topic Security > IBM FileNet P8 Security > Directory service providers. f. In the Configure New Domain Permissions message box, click OK to acknowledge that the directory configuration is complete but remains in restricted mode. The Configure New Domain Permissions wizard automatically starts the first time you start Enterprise Manager if you have not defined any Global Configuration Data (GCD) administrators. 3. Configure permissions for the FileNet P8 domain. a. Return to your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Configure New Domain Permissions in the Installation or Configuration Program column. b. Complete the wizard screens by using the values in your worksheet. c. In the Configure New Domain Permissions message box, click OK. After you complete this step, every other Content Engine server instance that starts in a farm or application server cluster can see the FileNet P8 domain. 4. Check for errors in the p8_server_error.log file on the application server. 5. Navigate to the level (domain, site, virtual server, or server instance) at which trace logging is configured, right-click the node at that level, and choose Properties. 6. Click the Trace Control tab. 7. If the current value of the Log File Output Location parameter is not consistent with the version of the application server, then edit the value as needed. The following table shows default locations, at the server instance level, for the trace log file, starting at install_root, the installation path for the application server.
Application Server Type IBM WebSphere Application Server Path to Trace Log File install_root /profiles/profile_name/ FileNet/server_name/ p8_server_trace.log

8. Click OK. 9. Close Enterprise Manager.

78

Installation Guide

Related concepts Connecting to a highly available Content Engine on page 87 The configuration of the Content Engine connection in a highly available environment depends on the type of application you want to connect to the Content Engine. You can configure administrative applications or user applications to connect to the Content Engine.

Creating the data sources for an object store

Each object store in your site requires its own JDBC data sources. You can configure the data sources by using the Configuration Manager graphical user interface or the command line. You created the JDBC data source for the Global Configuration Data (GCD) earlier in the configuration process. You must add the data sources now for at least one object store. You can create additional object store data sources as needed either immediately after you create the initial object store data sources or after you have confirmed your Content Engine configuration. Restriction: Configuration Manager cannot create a data source that uses the same name as an existing data source. If you manually configured a data source by using your web application server administration tools, and you want to reuse the name, then you must manually delete the existing data source before you attempt to create the data source in Configuration Manager. See your web application server documentation for more information. Creating the initial object store data sources by using the graphical user interface You must create the JDBC data sources for each object store that Content Engine uses. Content Engine uses the data source information to connect to and update the object store database. By default, each profile includes a task for creating the data sources for a single object store. Creating additional object store data sources by using the graphical user interface on page 81 You must create the JDBC data sources for each object store that Content Engine uses. Content Engine uses the data source information to connect to and update the object store database. By default, each profile includes a task for creating the data sources for a single object store, and you can add additional tasks as needed for each additional object store. Creating the data sources by using the command line on page 83 You must create the JDBC data sources for each object store that Content Engine uses. You must generate, edit, and execute a new configurejdbc-os.xml file for each object store in your environment.

Creating the initial object store data sources by using the graphical user interface
You must create the JDBC data sources for each object store that Content Engine uses. Content Engine uses the data source information to connect to and update the object store database. By default, each profile includes a task for creating the data sources for a single object store. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities.

Installing and configuring Content Engine

79

Tip: For more information on the properties and values you set in Configuration Manager, roll your mouse over the property name to view the hover help for the property. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values for this task, filter by CM: Configure Object Store JDBC Data Sources (object store 1) in the Installation or Configuration Program column. 2. Start or stop the application server, depending on its type.
Table 15. Required application server state Option WebSphere Application Server Description Start the application server if it is not already running.

3. If your configuration profile is not open in Configuration Manager, open it by selecting File > Open and navigating to your profilename.cfgp file. 4. Right-click Configure Object Store JDBC Data Sources in the profile pane, and select Edit Selected Task. 5. Enter the property values for your data sources by using the values in your installation worksheet. 6. In highly available environments, provide the following additional information for the object store data sources: Database server name If you are using a highly available database cluster, use the virtual name of the cluster. Database server name RAC node n If you are using Oracle RAC, then you must enter the database information for two nodes in the RAC cluster. Configuration Manager uses the values that you provided to create the JDBC URL in the format shown in the following table:
Table 16. JDBC URL format for Oracle RAC Server WebSphere Description jdbc:oracle:@ (DESCRIPTION = (load_balance=yes) (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP) (HOST = rac node 1) (PORT = 1521))(ADDRESS = (PROTOCOL = TCP)(HOST = rac node 2) (PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = DB service name) (failover_mode = (type=select) (method=basic) (retries=retry number)(delay= delay value)))) Example jdbc:oracle: @(DESCRIPTION =(load_balance=yes) (ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP)(HOST = testrac1) (PORT = 1521)) (ADDRESS = (PROTOCOL = TCP) (HOST = testrac2)(PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = testracdb)(failover_mode = (type=select)(method=basic) (retries=32)(delay=4))))

7. Select File > Save to save your changes. 8. Optional: WebSphere and WebLogic only. Click Test Database Connection to test the connection to the database by using the database user name, database

80

Installation Guide

server name, database name, port number, and password that you provided. The test does not create the data sources. 9. Ensure that the task is enabled. When the task is disabled, the task name includes the text (disabled). To enable the task, right-click Configure Object Store JDBC Data Sources (disabled) in the profile pane, and choose Enable Selected Task from the context menu. 10. Apply the JDBC property settings by right-clicking Configure Object Store JDBC Data Sources in the profile pane, and selecting Run Task. Running the configuration task can take several minutes. The task execution status messages are displayed in the Console pane below the bootstrap properties. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Creating a new configuration profile on page 40 Configuration Manager stores your settings for deploying a Content Engine application instance in a configuration profile. The profile defines the application server settings, the JDBC data source settings, the login modules settings, the directory service provider (LDAP) settings, the Content Engine bootstrap settings, and the application deployment settings. You must create a new profile for each Content Engine instance that you are configuring. Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Starting or stopping an application server instance

Creating additional object store data sources by using the graphical user interface
You must create the JDBC data sources for each object store that Content Engine uses. Content Engine uses the data source information to connect to and update the object store database. By default, each profile includes a task for creating the data sources for a single object store, and you can add additional tasks as needed for each additional object store. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. The default configuration profile contains one task for configuring a single object store. You must create and run a new task for each additional object store in that Content Engine uses. To configure the JDBC settings for additional object stores: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CM: Configure JDBC data sources (object store 2) in the Installation or Configuration Program column. 2. Start or stop the application server instance, depending on its type.
Installing and configuring Content Engine

81

Table 17. Required application server state Option Description Start the application server instance if it is not already running.

| |

WebSphere Application Server

3. If your configuration profile is not open in Configuration Manager, open it by selecting File > Open and navigating to your profilename.cfgp file. 4. Create a task for the additional object store. Tip: If the object store data sources you are creating share common information such as database server and port, you can copy an existing Configure Object Store JDBC Data Sources task and edit it instead of entering the information again. a. Right-click any task name in the profile pane, such as Configure Object Store JDBC Data Sources, and select Add New Task > Configure JDBC Data Sources. The New_Configure JDBC Data Sources task is added to the profile. b. Right-click New_Configure JDBC Data Sources, and select Rename Task. c. Enter a useful name for the task, such as Configure Object Store 2 JDBC Data Sources. d. Click OK. 5. Right-click the Configure Object Store 2 JDBC Data Sources task in the profile pane, and select Edit Selected Task. 6. Provide the property values for the JDBC data sources for the object store by using the values in your worksheet for your additional object store. 7. In highly available environments, provide the following additional information for the object store data sources: Database server name If you are using a highly available database cluster, use the virtual name of the cluster. Database server name RAC node n If you are using Oracle RAC, then you must enter the database information for two nodes in the RAC cluster. Configuration Manager uses the values that you provided to create the JDBC URL in the format shown in the following table:
Table 18. JDBC URL format for Oracle RAC Server WebSphere Description jdbc:oracle:@ (DESCRIPTION = (load_balance=yes) (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP) (HOST = rac node 1) (PORT = 1521))(ADDRESS = (PROTOCOL = TCP)(HOST = rac node 2) (PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = DB service name) (failover_mode = (type=select) (method=basic) (retries=retry number)(delay= delay value)))) Example jdbc:oracle: @(DESCRIPTION =(load_balance=yes) (ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP)(HOST = testrac1) (PORT = 1521)) (ADDRESS = (PROTOCOL = TCP) (HOST = testrac2)(PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = testracdb)(failover_mode = (type=select)(method=basic) (retries=32)(delay=4))))

82

Installation Guide

8. Select File > Save to save your changes. 9. Optional: WebSphere and WebLogic only. Click Test Database Connection to test the connection to the database by using the database user name, database server name, database name, port number, and password that you provided. The test does not create the data sources. 10. Ensure that the task is enabled. When the task is disabled, the task name includes the text (disabled). To enable the task, right-click Configure Object Store 2 JDBC Data Sources (disabled) in the profile pane, and choose Enable Selected Task from the context menu. 11. Apply the JDBC property settings by right-clicking Configure Object Store 2 JDBC Data Sources in the profile pane, and selecting Run Task. Running the configuration task can take a few minutes. The task execution status messages are displayed in the Console pane below the bootstrap properties. 12. Optional: Repeat this procedure as needed to add the data sources for each object store in your environment. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Starting or stopping an application server instance

Creating the data sources by using the command line

You must create the JDBC data sources for each object store that Content Engine uses. You must generate, edit, and execute a new configurejdbc-os.xml file for each object store in your environment. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. If you generated all of the configuration profiles at the same time, you have already created an initial configurejdbc-os.xml file for the initial object store data sources. If you have an existing configurejdbc-os.xml file, you can generate another file for each additional object store. Each additional file that you add is named configurejdbc-os.n.xml. You can generate multiple configurejdbcos.n.xml files as needed, depending on the number of object stores in your environment. For best results, create an additional file for each object store. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Configuration Manager values for this task, filter by CM: Configure Object Store JDBC Data sources (object store 1) in the Installation or Configuration Program column. 2. Log on to the application server as config_mgr_user, the user who runs Configuration Manager.

Installing and configuring Content Engine

83

3. If you did not generate all the configuration files at the same time or if you must create another file, generate the configurejdbc-os.n.xml file by running the following command:
configmgr_cl generateConfig -appserver app_server_type -db -task configurejdbcos -profile myprofile db_type

where: -appserver appserver_name The -appserver appserver_type specifies the type of application server and must be WebSphere, WebLogic, or JBoss. -db database_type The -db database_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurejdbcgcd or configurejdbcos option. This parameter specifies the type of database to be used by Content Engine and must be mssql, oracle, oracle_rac, db2, or db2zos. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg". 4. Use a text editor to open the configurejdbc-os.n.xml file and edit it as follows: a. Provide the entries that are required for your environment by using the values in your worksheet. In highly available environments, provide the following additional information for the object store data sources: Database server name If you are using a highly available database cluster, use the virtual name of the cluster. Database server name RAC node n If you are using Oracle RAC, then you must enter the database information for two nodes in the RAC cluster. Configuration Manager uses the values that you provided to create the JDBC URL in the format shown in the following table:

| |

| | |

84

Installation Guide

Table 19. JDBC URL format for Oracle RAC Server WebSphere Description jdbc:oracle:@ (DESCRIPTION = (load_balance=yes) (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP) (HOST = rac node 1) (PORT = 1521))(ADDRESS = (PROTOCOL = TCP)(HOST = rac node 2) (PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = DB service name) (failover_mode = (type=select) (method=basic) (retries=retry number)(delay= delay value)))) Example jdbc:oracle: @(DESCRIPTION =(load_balance=yes) (ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP)(HOST = testrac1) (PORT = 1521)) (ADDRESS = (PROTOCOL = TCP) (HOST = testrac2)(PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = testracdb)(failover_mode = (type=select)(method=basic) (retries=32)(delay=4))))

b. Replace each occurrence of ****INSERT VALUE**** with a value appropriate for your site. See the descriptions in the file for more information. c. Verify that the default values for the remaining properties are correct for your site. d. Set the enabled attribute value in the <configuration> tag to true so that you can run the configuration task in 6. e. Save your edits. 5. Run the storepasswords command to encrypt and store the required passwords.
configmgr_cl storepasswords -profile myprofile

6. Run the following command to execute the configurejdbc.n.xml file:

configmgr_cl execute -task configurejdbcos -profile myprofile

Tip: If the storepasswords command prompts you to store passwords in configuration files on disk, you must respond with yes or no (instead of y or n). 7. Optional: Check the completion status by running the following command:
configmgr_cl checkStatus -task configurejdbcos -task configurejdbc.n.xml -profile myprofile

Where configurejdbc.n.xml is the task file for the object store. 8. Repeat step 3 on page 84 through step 6 as needed for each additional object store. Related concepts Specifying accounts For details on accounts and required permissions, see Plan and Prepare Your Environment for IBM FileNet P8. Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Creating the initial object store

You create an initial object store in Content Engine to store your documents and other objects. After an object store is created, you can refine its definition and add content to it.

Installing and configuring Content Engine

85

Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. If you have not already done so, you must complete the following preparation tasks before you create the initial object store. v Set up the initial storage area for the object store. v Install the latest Content Engine service pack, as indicated in Installing Content Engine software updates on page 28. v Create XA and non-XA data sources for the object store, as indicated in Creating the data sources for an object store on page 79). v Read the FileNet P8 help topic System Administration > Content Engine Administration > Object stores > Concepts. You can use the Create Object Store wizard in IBM FileNet Enterprise Manager to create the object store. Tip: You can also use the Web-based IBM Administrative Console for Content Engine to create the object store. To do so, access http://ce_server_name:port/ acce/login.jsp. from a Web browser client, log on as the gcd_admin user, and review the embedded assistance as needed. ce_server_name is the name of the system where Content Engine is deployed. port is the WSI port that is used by the application server on which Content Engine is deployed. For prerequisite information on using ACCE, see Administering IBM FileNet P8 > Administering Content Engine > Administrative Console for Content Engine > Starting Administrative Console for Content Engine. Important: The Create Object Store wizard fails to complete if you try to assign a new object store to a tablespace that already contains tables for an object store. To create an object store using the Create Object Store wizard: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Create Object Store in the Installation or Configuration Program column. 2. Start Enterprise Manager by double-clicking the Enterprise Manager desktop icon, or by choosing Start > All Programs > FileNet P8 Platform > Enterprise Manager . 3. In the FileNet P8 Logon screen, select the FileNet P8 domain in which you will create an object store, and then click Connect. 4. In the tree view, right-click the Object Stores container and choose New Object Store to start the Create an Object Store wizard. 5. Complete the wizard screens by using the values in your worksheet. 6. Check for errors in the p8_server_error.log file on the application server.

86

Installation Guide

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related tasks Storage areas for object stores For more information about object stores, see Plan and Prepare Your Environment for IBM FileNet P8.

Connecting to a highly available Content Engine

The configuration of the Content Engine connection in a highly available environment depends on the type of application you want to connect to the Content Engine. You can configure administrative applications or user applications to connect to the Content Engine. Administrative applications, such as IBM FileNet Enterprise Manager and IBM FileNet Deployment Manager, modify metadata and GCD information such as property templates, class and property definitions, and domain level objects such as sites, object stores, and file storage areas. Due to the built-in lag in metadata synchronization across the Content Engine nodes, changes made on one node are not synchronized immediately after a configuration change is made via an administrative application. To ensure your administrative applications always get a consistent view of the system metadata, you must configure them all to point to a single Content Engine node (the same node), rather than a virtual server. In the event the configured Content Engine fails you must reconfigure your administrative applications to point to a different Content Engine node. For information, go to the IBM FileNet P8 online help and navigate to Administering IBM FileNet P8 > Administering Content Engine > FileNet P8 Domains > Logging on to a domain. User applications such as Workplace and Workplace XT are content and process centric applications used in everyday production to check documents in and out and access workflows, for example. For user applications, the Content Engine connection in a highly available environment differs depending on your HA configuration, but in any case must be configured to connect to the virtual server, so that it will be redirected automatically to another Content Engine node in the event of a Content Engine node failure. v If a Java application server cluster is used, EJB connections must use a specific format for establishing connections to Content Engine. v Applications that use the Web service (CEWS) protocol to connect to Content Engine must use the virtual server name of the hardware or software that is load balancing the connection. Content Engine in an application server cluster by using EJB transport on page 88 You can configure clients, such as Application Engine, that use EJB transport to communicate with the Content Engine in an application server cluster.
Installing and configuring Content Engine

87

Connecting by using Content Engine Web Service Transport (CEWS) You can use load-balancers to manage requests to the Content Engine in a highly available configuration by connecting the to Content Engine using the Web Services (CEWS, previously seen as WSI) transport.

Content Engine in an application server cluster by using EJB transport

You can configure clients, such as Application Engine, that use EJB transport to communicate with the Content Engine in an application server cluster. For clients such as Application Engine that use an EJB transport to communicate with Content Engine in an application server cluster configuration, you must use an URL with a format different from non-highly available configurations. Restriction: In these examples, the cemp portion at the beginning of the URI is required by IBM FileNet P8 applications, such as Workplace and Workplace XT. If you are developing and using your own applications, the cemp prefix is not required. When Content Engine is made highly available through an application server cluster configuration the Content Engine URL should have the following form (with no carriage returns):

WebSphere Application Server

cemp:corbaloc::node1_hostname:BOOTSTRAP_ADDRESS, :node2_hostname:BOOTSTRAP_ADDRESS/cell/clusters/ your_websphere_cluster_name/FileNet/Engine

This configuration requires the WebSphere cluster name in addition to the node names as part of the URL. The bootstrap port for a cluster configuration (by default, port 9810) is usually different from the bootstrap port on a non-cluster (standalone) configuration (by default, port 2809). Only one URL is used regardless of SSL use. WebSphere EJB over SSL is automatically established if EJB security is enabled. Example:
cemp:corbaloc::testnode1:9810,:testnode2:9810/cell/clusters/ testwascluster/FileNet/Engine

If the EJB client is deployed into the same WebSphere Network Deployment cell as Content Engine, you can use the following, simpler corbaloc URL:
cemp:corbaloc:rir:/cell/clusters/your_websphere_cluster_name/FileNet/Engine

Connecting by using Content Engine Web Service Transport (CEWS)

You can use load-balancers to manage requests to the Content Engine in a highly available configuration by connecting the to Content Engine using the Web Services (CEWS, previously seen as WSI) transport. Applications like Process Engine use the Content Engine CEWS transport to connect to the Content Engine. This transport can utilize load-balancers to balance

88

Installation Guide

requests to Content Engine servers in a highly available configuration. In this type of configuration a virtual server name is used by clients to access the Content Engine. Use the virtual server name of the load-balancing device when configuring a connection to Content Engine to ensure that applications will function in the event of a Content Engine failure. Use the following format for the Content Engine URL:
http://virtual server name:virtual port number/wsi/FNCEWS40MTOM/

Example:
http://testvirtual1:7001/wsi/FNCEWS40MTOM/

Verifying the Content Engine system

You can verify the Content Engine system by using IBM FileNet Enterprise Manager to create a folder and a document in each object store and then check the new document out and in. You also need to retrieve and view the contents of an existing document. To perform this system test, you must have installed Content Engine and have created at least one object store. You also need a file saved in a network location that you can navigate to, for example on the local drive. If you can complete the steps in this verification test, you will verify that Content Engine is successfully installed, including the following configurations: v Content Engine is successfully using the ce_service_user account to communicate with the configured directory server. v Content Engine is successfully using the ce_db_user account to communicate with configured database. v Content Engine can access the configured storage location. To verify the Content Engine system: 1. Logon to Enterprise Manager as object_store_admin. 2. Create a document: a. Right-click the Root Folder and select New Document. b. Enter the Document Title (for example, system_test), click With content, and click Next. Click Browse/Add, navigate to and select the file, and click Open, and then click Create. Notice that a new document with a containment name matching the document title you entered is now in the folder. The new documents content file will be stored according to how the document class is configured, for example, in a file storage area or in the database. If you have more than one storage area, you should create a document in each of them as part of this verification test. 3. Optional: delete the document object you just created. 4. In high availability environments, verify failover for all nodes in your configuration. a. Browse to the Content Engine Startup Context page: c.
http://ce_server:port/FileNet/Engine

b. Fail one of the Content Engine nodes.

Installing and configuring Content Engine

89

c. Verify that you can reload the Startup Context page, and that you can access your object stores by using Enterprise Manager. d. Restart all nodes that you failed during this test. If you were able to complete these steps, then Content Engine is working properly. If you were not able to complete these steps, see Troubleshooting IBM FileNet Content Engine.

90

Installation Guide

Installing and configuring Content Search Engine

You can install the server for one or both of the search engine options that are supported by IBM FileNet Content Engine, IBM Content Search Services or IBM Legacy Content Search Engine. Installing and configuring IBM Content Search Services You can install and configure IBM Content Search Services for a single server configuration or a multiple server configuration on Windows, AIX, Linux, and Solaris operating systems. Installing and configuring IBM Legacy Content Search Engine on page 102 This topic explains how to install and configure IBM Legacy Content Search Engine.

Installing and configuring IBM Content Search Services

You can install and configure IBM Content Search Services for a single server configuration or a multiple server configuration on Windows, AIX, Linux, and Solaris operating systems. Remember: Any time you install IBM Content Search Services into a FileNet P8 environment, you must also install the IBM Content Search Services Client files on the Content Engine servers, as documented in the Content Engine installation instructions. IBM FileNet Content Engine preprocesses documents and sends them to the IBM Content Search Services index server for indexing. Depending on the size and configuration of your system, you might want to have multiple server instances of IBM Content Search Services installed on your system. In a single server configuration, a single instance of the IBM Content Search Services server performs both the indexing and searching tasks for the Content Engine. In a multiple server configuration, you assign different roles to your IBM Content Search Services server instances to distribute the load for both indexing and searching tasks. You can run multiple server instances of IBM Content Search Services on the same computer for vertical scaling or you can run them on different computers for horizontal scaling. Each server instance of IBM Content Search Services can be designated to do only indexing tasks, searching tasks, or both. You designate which tasks each IBM Content Search Services server does by assigning it a specific server mode: Index Content Engine sends only indexing tasks to servers in this mode. You can have multiple, dedicated index servers to distribute the indexing load for high volume scenarios. Multiple index servers also allow failover capability for the Content Engine. If one indexing server goes offline, the Content Engine automatically distributes the indexing load to the remaining indexing servers. Search Content Engine sends only searching tasks to servers in this mode. You can have multiple, dedicated search servers to distribute the searching load when you have many indexes to search. Multiple search servers also allow
Copyright IBM Corp. 2001, 2011

91

failover capability for the Content Engine. If one search server goes offline, the Content Engine automatically selects an alternate search server to perform its tasks. IndexAndSearch Content Engine sends both indexing and searching tasks to servers in this mode. The IndexAndSearch server mode is typically used in a single server configuration. | | | | | Tip: When considering how to balance available CSS servers, it is important to take into consideration the expected indexing and search scenario. The following table presents possible scenarios and the suggested server mode assignments. Note that even a heavy search load is generally lighter compared to the indexing/ingestion load.
Table 20. Choosing the server mode Expected scenario A heavy indexing load (for example, an indexing rate of two million documents per day) A heavy search load Suggested server mode Configure more CSS servers in Index mode.

Configure one or more servers in Search mode. If you are limited to two or three servers, configure one server in Search mode and the other servers in Index mode or IndexAndSearch mode. Configure all CSS servers in IndexAndSearch mode.

A heavy indexing load and a light search load, and you are limited to two or three servers

Set up the site to contain the object store and the IBM Content Search Services servers. All of the documents and other objects are indexed in the same site as the object store. Installing IBM Content Search Services You can install IBM Content Search Services either interactively or silently by using the information about the Installation and Upgrade Worksheet that was completed during your planning activities. Configuring IBM Content Search Services on page 93 You must configure IBM Content Search Services to run on Content Engine to manage your indexing and searching tasks.

Installing IBM Content Search Services

You can install IBM Content Search Services either interactively or silently by using the information about the Installation and Upgrade Worksheet that was completed during your planning activities. The vendor software that is used to install IBM Content Search Services does not support the use of extended (non-English) characters in the installation path. You must use only English characters (not extended characters) in the installation path for IBM Content Search Services. After you successfully install IBM Content Search Services, you must configure the IBM Content Search Services software to run as an IBM Search server on Content Engine. You must complete the installation of the IBM Content Search Services

92

Installation Guide

Client files on the IBM FileNet Content Engine. See Installing Content Engine and related client software on page 24 for more information.

Configuring IBM Content Search Services

You must configure IBM Content Search Services to run on Content Engine to manage your indexing and searching tasks. You can also configure IBM Content Search Services to communicate with IBM FileNet Content Engine over a secure connection by using the Secure Sockets Layer protocol. Getting the IBM Content Search Services authentication token The IBM Content Search Services server uses the authentication token as a security device to identify itself as authorized to communicate with Content Engine. The authentication token is displayed on the last window of the IBM Content Search Services installation program for each server that you install. Configuring Content Engine for IBM Content Search Services You must configure IBM Content Search Services as a IBM Content Search Services server on Content Engine by using Enterprise Manager. Verifying the IBM Content Search Services installation on page 96 You can verify that the IBM Content Search Services installation was successful by using Enterprise Manager to create a search index job and checking to see whether the job returns the correct index objects. Configuring SSL for IBM Content Search Services on page 98 IBM Content Search Services can communicate with Content Engine on both secure and nonsecure channels. You can configure IBM Content Search Services to communicate over a secure connection by using the Secure Sockets Layer (SSL) protocol.

Getting the IBM Content Search Services authentication token

The IBM Content Search Services server uses the authentication token as a security device to identify itself as authorized to communicate with Content Engine. The authentication token is displayed on the last window of the IBM Content Search Services installation program for each server that you install. To find the authentication token for an installed IBM Content Search Services server: 1. Log on to the host computer as css_os_user. 2. From a command prompt, navigate to the css_install_location/server_name/ bin directory. 3. To find the authentication token, enter configTool printToken -configPath "css_install_location/server_name/config". 4. To generate a new authentication token, enter configTool generateToken -configPath "css_install_location/server_name/config" -seed token_name. 5. Store the authentication token and the encryption key in the database if applicable.

Configuring Content Engine for IBM Content Search Services

You must configure IBM Content Search Services as a IBM Content Search Services server on Content Engine by using Enterprise Manager. The IBM Content Search Services server that is configured on Content Engine contains the connection and configuration information for a single IBM Content

Installing and configuring Content Search Engine

93

Search Services server. The IBM Content Search Services server is associated with a site and can be used by any object store in the same site to create and search indexes. When filtering text from a document, Content Engine places the document in a temporary work directory. This work document is given the same file name extension as the original document. The file system must support the characters that are used in the file name extension. Without this character support, Content Engine generates an error and does not index the document. For example, if the file name extensions of the Content Engine documents that you want to index contain Japanese characters, you must set the code page of the operating system to support these characters. Configuring IBM Content Search Services servers on Content Engine You can configure IBM Content Search Services servers on Content Engine in Index mode, Server mode, or IndexAndServer mode to search for and index documents, custom objects, folders, and annotations. Adding index areas for IBM Content Search Services on page 95 Index areas contain the IBM Search indexes for the content-based retrieval data that is created, updated, and queried by IBM Content Search Services. You must add index areas to be used by IBM Content Search Services for text search. Enabling text search on the object store on page 95 You can enable text search on any object store that resides in the same site as the IBM Content Search Services server. Configuring objects that can be indexed for content based retrieval on page 95 You can configure documents, custom objects, folders, and annotations for content based retrieval by using Enterprise Manager. Configuring IBM Content Search Services servers on Content Engine: You can configure IBM Content Search Services servers on Content Engine in Index mode, Server mode, or IndexAndServer mode to search for and index documents, custom objects, folders, and annotations. Ensure that the Content Engine server is running before you proceed. To configure IBM Content Search Services servers on Content Engine: 1. Log on to Enterprise Manager as the GCD Administrator and expand the Enterprise Manager tree. 2. Right-click Enterprise Manager [domain], choosing Select Properties, and on the IBM Content Search Servers tab, clicking Create. 3. At the Create an IBM Content Search Services Server window, enter the following server settings: v Host name - enter the IP address or host name of the IBM Content Search Services server. v Port - the port number the IBM Content Search Services server uses to communicate with IBM FileNet Content Engine server v Authentication token - the authentication token used to identify the IBM Content Search Services server to Content Engine server. v Mode - select the server mode for the tasks you want the server to perform; Index, Search, or IndexAndSearch. v Status - select Enabled. 4. Click the IBM Search Configuration tab and make sure Dispatcher is Enabled.

94

Installation Guide

5. Click OK again. 6. Assign an Indexing Language value to an object store. Restriction: If the Indexing Language property is not set on an object store, the error message Index Language property is null displays when you try to create an index area. a. In the Enterprise Manager tree, open the Object Store folder. b. Right-click the object store on which you want to enable text properties and select Properties. c. Click the IBM Content Search Services tab. d. Ensure that the IBM Content Search Services Enabled check box is cleared. If the check box is selected, clear it and click Apply. e. In the Indexing Language text field, select the desired language code from the list. If you do not want to select a specific Language code, you can use auto. f. Click OK. g. Verify that you can successfully create an index area. h. Select the IBM Content Search Services Enabled check box to enable text search on the object store. Adding index areas for IBM Content Search Services: Index areas contain the IBM Search indexes for the content-based retrieval data that is created, updated, and queried by IBM Content Search Services. You must add index areas to be used by IBM Content Search Services for text search. To add index areas for IBM Content Search Services: 1. Log on to Enterprise Manager as the GCD Administrator and expand the Object Store tree. 2. Open the Index Area folder and right-click to select New Index Area. 3. At the New Index Area window, enter the name and other values for the new index area. 4. Click OK to add the index area. 5. Repeat these steps to create additional index areas with different names. Enabling text search on the object store: You can enable text search on any object store that resides in the same site as the IBM Content Search Services server. To enable text search on the object store: 1. Log on to Enterprise Manager as the GCD Administrator and expand the Enterprise Manager tree. 2. Open the Object Store folder. 3. Right-click the object store on which you want to enable text search and select Properties. 4. Click the CBR IBM tab, select IBM Content Search Services Enabled and click OK. 5. At the Do you want to continue prompt, click OK. Configuring objects that can be indexed for content based retrieval:
Installing and configuring Content Search Engine

95

You can configure documents, custom objects, folders, and annotations for content based retrieval by using Enterprise Manager. To enable content-based retrieval (CBR) for all document classes or some subclasses, you can either enable CBR at the document class level or at the level of the individual subclasses. To enable CBR for annotations, folders, and custom objects, you must do so on each of these object classes under the Other Classes node. To configure objects that can be indexed for content based retrieval: 1. Log on to Enterprise Manager as the GCD Administrator and expand the Enterprise Manager tree. 2. Expand the Object Store node. 3. Right-click the object store to display the object classes that you can configure for content based retrieval: v Document v Annotation v Folder v Custom Object 4. Right-click the class that you want to enable content-based retrieval and select Properties. Important: Nothing is indexed unless you enable CBR on the associated classes. You can index object content for Document and Annotation classes only. You can index property values for all supported CBR enabled object classes, which are noted in the previous step. To designate property values for indexing, you must CBR enable the property definition and the object class. 5. On the Document Class Properties window, select CBR Enabled. 6. Click OK. Related information Indexable object text You can configure various index object types for content based retrieval. Setting the CBR-enabled status for a class You can configure the class of a selected index object for content based retrieval. Setting the CBR-enabled status for a property You can configure the properties of a selected index object class for content based retrieval. | | | | | | | | | |

Verifying the IBM Content Search Services installation

You can verify that the IBM Content Search Services installation was successful by using Enterprise Manager to create a search index job and checking to see whether the job returns the correct index objects. In this verification test you send a query that searches for text that you know is in a document. If the query successfully finds the document, then you know that your IBM Content Search Services configuration is working properly. If the query fails, there are some steps at the bottom of the verification test to help you fix the problem. To verify the IBM Content Search Services installation:

96

Installation Guide

| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

1. Make sure that you performed the tasks explained in Configuring Content Engine for IBM Content Search Services on page 93. 2. Make sure that you have installed IBM Content Search Services client files, as explained in Installing Content Search Engine Client files on page 29. 3. Logon to Enterprise Manager as gcd_admin or object_store_admin. 4. In Enterprise Manager, open a subfolder that contains a document that contains text that you will search on later. If you do not have such a document, you can create one for the purposes of this test, and then delete it later. Make sure that the account you logged on as has at least the View content access level to the document, since the security check performed on a query is done using the access rights of the documents that are found by the query. 5. Right-click the document and select All Tasks > Index for Content Search. A notice indicates that a content search index job was created successfully. 6. Right-click the Object Store node for the document that you set to index for content search and select All Tasks > Index Jobs Management. In the Index Jobs Manager, check that the Job Status indicates the job ended normally. Depending on the size of the indexing job, it might take a few minutes for the indexing job to complete. If the Job Status indicates that the indexing is in progress, wait a few minutes to give the job time to complete. If the Job Status does not indicate progress, check the p8_server_error.log file on the application server. 8. Expand the Object Store node. 9. Right-click on Search Results and select New Search. 10. In the Content Engine Query Builder, click View. 7. 11. Select SQL View. 12. Remove the default query text in the SQL Text field. 13. In the SQL Text field, enter the following query and click OK:
SELECT d.this, d.Id, vcs.ContentSummary FROM your_class_name d INNER JOIN ContentSearch vcs ON d.This = vcs.QueriedObject WHERE CONTAINS (d.*, your_search_string)

14. In the Query Status dialog, verify that objects are returned for your search, then click OK. 15. In the Search Results pane, verify that the listed objects are the correct objects for the content in your search. If your query finds the document you were looking for, then IBM Content Search Services is working properly. If it does not find the document, check the SQL Text query syntax and issue it again. If it still fails, see Checking IBM Content Search Services for common errors to carry out initial steps to try to fix the problem. After you verify the IBM Content Search Services installation, you can create synonyms for your search terms to improve the results of your search queries. By using synonyms, you can search for words that are specific to your organization, such as acronyms and technical jargon.

Installing and configuring Content Search Engine

97

| | | | | | | |

Related information Setting synonyms You can create synonyms for your search terms to improve the results of your search queries. Checking CSS for common errors If your IBM Content Search Services verification test fails or you experience other kinds of content search errors, there are some basic things you can check before accessing the troubleshooting system.

Configuring SSL for IBM Content Search Services

IBM Content Search Services can communicate with Content Engine on both secure and nonsecure channels. You can configure IBM Content Search Services to communicate over a secure connection by using the Secure Sockets Layer (SSL) protocol. Secure Sockets Layer (SSL) is a commonly used protocol that provides secure connections by letting applications that connect over a network authenticate their identity to each other. SSL also encrypts the data that is exchanged between the applications. With IBM FileNet Content Engine, you can configure secure channels for IBM Content Search Services on different levels. Based on your specific requirements, you can configure SSL on the following levels: v Encrypt the data that is transmitted over the network v Perform SSL server authentication v Verify the host name of the IBM Content Search Services server in Enterprise Manager Restriction: Each of these levels is dependent on the previous levels. For example, to perform level 3, you must first configure level 1 and level 2. The person responsible for configuring SSL for IBM Content Search Services must understand SSL and know how to use the Java keytool.exe file.. Encrypting data transmitted over the network To encrypt the data that is transmitted over the network, you must set up a secure port on the IBM Content Search Services server. Then, you must use Enterprise Manager to specify the secure port number and enable SSL. Performing SSL server authentication on page 99 To perform SSL server authentication, you must deploy certificates on the IBM Content Search Services server and the Content Engine server that are used in the connection. Encrypting data transmitted over the network: To encrypt the data that is transmitted over the network, you must set up a secure port on the IBM Content Search Services server. Then, you must use Enterprise Manager to specify the secure port number and enable SSL. You can encrypt the data that is transmitted between IBM Content Search Services and IBM FileNet Content Engine without creating keystores and deploying certificates. With this configuration, the data that is transmitted between the servers is encrypted, but SSL authentication and host validation are not performed. To encrypt data that is transmitted over the network:

98

Installation Guide

1. Set up a secure port on the IBM Content Search Services server: a. Log on to the host computer as the css_install_user user. b. Stop the IBM Content Search Services server if it is running. c. Open a command prompt and navigate to the folder YourCSSfolder\bin where YourCSSfolder is the folder where you installed the IBM Content Search Services server. d. Enable a secure port by entering the following command: configTool.bat configureParams -configPath "YourCSSfolder\config" -securePort 8199 where 8199 is the secure port number. For example, if YourCSSfolder is C:\Program Files\IBM\Content Search Services\CSS Server\, enter configtool.bat configureParams -configPath "C:\Program Files\IBM\Content Search Services\CSS Server\config" -securePort 8199 For UNIX users, if YourCSSfolder is /opt/IBM/Content Search Services/CSS Server/, enter configtool.bat configureParams -configPath "/opt/IBM/Content Search Services/CSS Server/config" -securePort 8199 e. Optional: Disable the nonsecure port after completing all SSL configuration changes. To set the nonsecure port number to 0, enter configTool.bat configureParams -configPath "YourCSSfolder\config" -adminHTTPPort 0. f. Start the IBM Content Search Services server. 2. Specify the secure port number and enable SSL on the IBM Content Search Services server. a. In the Enterprise Manager navigation pane, right-click on the domain node and click Properties. b. Click the IBM Search Servers tab, select the IBM Content Search Services server and click Edit. c. In the Port field, enter the secure port number. d. Select Enable SSL. e. Clear the Validate Server Certificate and Validate Certificate Host checkboxes. f. Click OK. Performing SSL server authentication: To perform SSL server authentication, you must deploy certificates on the IBM Content Search Services server and the Content Engine server that are used in the connection. You can deploy either self-signed certificates or certificates that are signed by an external third-party Certificate Authority (CA). To perform SSL server authentication, complete the following steps after the data encryption procedures are done: 1. Deploy a server certificate to the keystore on IBM Content Search Services and configure IBM Content Search Services to use this keystore. 2. Deploy a CA certificate to the keystore on IBM FileNet Content Engine and configure Content Engine to use this keystore. 3. Validate the certificates for IBM Content Search Services by using Enterprise Manager. Deploying server certificates on IBM Content Search Services server on page 100 You must secure the IBM Content Search Services server end of the connection.

Installing and configuring Content Search Engine

99

Deploy server certificates to the keystore on the IBM Content Search Services server and configure the IBM Content Search Services server to use this keystore. Validating certificates in Enterprise Manager on page 102 After you deploy the certificates on IBM Content Search Services and Content Engine, you must validate these certificates for IBM Content Search Services in Enterprise Manager. Verifying the host name of the IBM Content Search Services server on page 102 After you encrypt data and perform SSL server authentication, you might want to verify the host name of the IBM Content Search Services server matches the host name you specified on the server certificate. Deploying server certificates on IBM Content Search Services server: You must secure the IBM Content Search Services server end of the connection. Deploy server certificates to the keystore on the IBM Content Search Services server and configure the IBM Content Search Services server to use this keystore. Select the type of server certificate to deploy on the IBM Content Search Services server. 1. Deploying a self-signed server certificate: a. Stop the IBM Content Search Services server if it is running. b. Set the path to your JRE bin directory by entering the following command: set PATH=C:\YourJRE\bin;%PATH% where the bin location is C:\YourJRE\bin. c. Open a command prompt and navigate to the folder YourCSSFolder\bin where YourCSSfolder is the folder where you installed the IBM Content Search Services server. d. Generate a self-signed server certificate by entering the following command: keytool -genkey -alias cssSelfsigned -keypass YourKeyPassword -keystore selfsignedServerStore -storepass YourStorePassword -validity NumberOfDays -dname "CN=YourHostName, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown". Restriction: If you plan to verify the host name later, you must include the following parameter: -dname "CN=YourHostName,OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown". For example, if you want to set the keystore password and the certificate password to changeit, the certificate valid time to 3650 days (10 years), and the host name to Host1, enter keytool -genkey -alias cssSelfsigned -keypass changeit -keystore selfsignedServerStore -storepass changeit -validity 3650 -dname "CN=Host1, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown" e. Verify that the certificate was created in the keystore by entering the following command: keytool -list -v -keystore selfsignedServerStore -storepass YourStorePassword. f. Deploy the keystore to IBM Content Search Services by entering the following command: configTool.bat configureParams configPath YourCSSfolder\config keyStoreName selfsignedServerStore -keyStorePassword YourStorePassword. For example, if YourCSSfolder is C:\Program Files\IBM\Content Search Services\CSS Server and your keystore password is changeit, enter configTool.bat configureParams -configPath "C:\Program Files\IBM\Content Search Services\CSS Server\config" -keyStoreName selfsignedServerStore -keyStorePassword changeit

100

Installation Guide

g. Start the IBM Content Search Services server. 2. Deploying a third-party server certificate: a. Stop the IBM Content Search Services server if it is running. b. Set the path to your JRE bin directory by entering the following command: set PATH=C:\YourJRE\bin;%PATH% where the bin location is C:\YourJRE\bin. c. Open a command prompt and navigate to the folder YourCSSfolder\bin where YourCSSfolder is the folder where you installed the IBM Content Search Services server. d. Generate a third-party server certificate by entering the following command: keytool -genkey -alias cssThirdParty -keypass YourKeyPassword -keystore thirdPartyServerStore -storepass YourStorePassword -validity dname "CN=YourHostName, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown" Restriction: If you plan to verify the host name later, you must include -dname "CN=YourHostName,OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown". For example, if you want to set the keystore password and the certificate password to changeit, the certificate valid time to 3650 days (10 years), and the host name to Host1, enter keytool -genkey -alias cssThirdParty keypass changeit keystore thirdPartyServerStore -storepass changeit validity 3650 -dname "CN=Host1, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown" e. Verify that the certificate was created in the keystore by entering the following command: keytool -list -v -keystore thirdPartyServerStore -storepass YourStorePassword. f. Generate a certificate request, by entering the following command: keytool -certreq -alias cssThirdParty -keypass YourKeyPassword -keystore thirdPartyServerStore storepass YourStorePassword -dname "CN=YourHostName, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown" -file certRequest.txt g. Go to a Certificate Authority (CA) website and use this request to get a server certificate. h. Save the server certificate on the IBM Content Search Services server in the YourCSSfolder\bin directory. For example, save the certificate file as certnew.p7b. i. Open a command prompt and navigate to the YourCSSfolder\bin folder. j. Import the certificate to keystore thirdPartyServerStore, by entering the following command: keytool -import -alias cssThirdParty -keystore thirdPartyServerStore storepass YourStorePassword -file certnew.p7b. k. Verify that the certificate was imported in the keystore by entering the following command: keytool -list -v -keystore thirdPartyServerStore -storepass YourStorePassword. l. Deploy the keystore to the IBM Content Search Services server by entering the following command: configTool.bat configureParams -configPath YourCSSfolder\config -keyStoreName thirdPartyServerStore -keyStorePassword YourStorePassword. For example, if YourCSSfolder is "C:\Program Files\IBM\Content Search Services\CSS Server" and your keystore password is changeit, you enter configTool.bat configureParams -configPath "C:\Program Files\IBM\Content Search Services\CSS Server\config" -keyStoreName thirdPartyServerStore keyStorePassword changeit. m. Start the IBM Content Search Services server.
Installing and configuring Content Search Engine

101

Validating certificates in Enterprise Manager: After you deploy the certificates on IBM Content Search Services and Content Engine, you must validate these certificates for IBM Content Search Services in Enterprise Manager. To validate certificates for IBM Content Search Services: 1. In Enterprise Manager navigation pane, right-click the domain node and click Properties. 2. Click the IBM Search Servers tab and select the IBM Content Search Services server. 3. Select Validate Server Certificate. 4. Clear Validate Certificate Host. 5. Click OK. Verifying the host name of the IBM Content Search Services server: After you encrypt data and perform SSL server authentication, you might want to verify the host name of the IBM Content Search Services server matches the host name you specified on the server certificate. You validated the host during authentication by specifying the host name in the SSL server certificate when you generated it. You must also enable host validation in Enterprise Manager. To verify the host name of the IBM Content Search Services server: 1. Ensure that you specified the host name by adding the -dname option to the keytool command when you generated the server certificate on IBM Content Search Services. 2. In Enterprise Manager navigation pane, right-click the domain node and click Properties. 3. Click the IBM Search Servers tab and select the IBM Content Search Services server. 4. In the Host name field, select the host name of the IBM Content Search Services server and ensure that it matches the host name in your server certificate. 5. Select the following check boxes: v Enable SSL v Validate Server Certificate v Validate Certificate Host 6. Click OK.

Installing and configuring IBM Legacy Content Search Engine

This topic explains how to install and configure IBM Legacy Content Search Engine. Installing IBM Legacy Content Search Engine on page 103 Use this procedure to install and configure IBM Legacy Content Search Engine, an optional component based on the Autonomy K2 product. Configuring IBM Legacy Content Search Engine on page 108 Use this procedure to configure services required on the K2 Master Administration Server, and on additional Administration Servers you might

102

Installation Guide

install for IBM Legacy Content Search Engine. All servers are configured through the Master Administration Server Dashboard. (optional) Installing additional locales on page 113 You must install the locale files on all Autonomy K2 Administration Server machines only if you need more than basic content search locale functionality, for example, indexing and searching in languages other than English, Englishv, or basic UNI. Creating a IBM Legacy Content Search Engine collections directory on page 115 Use this procedure to configure the storage location and related security for your K2 collections. Configuring Content Engine for content-based retrieval on page 116 You must use Enterprise Manager to configure an index area and enable the content-based retrieval (CBR) feature provided by IBM Legacy Content Search Engine. Verifying the IBM Legacy Content Search Engine installation on page 119 To verify that the IBM Legacy Content Search Engine installation and configuration succeeded, perform the following procedure.

Installing IBM Legacy Content Search Engine

Use this procedure to install and configure IBM Legacy Content Search Engine, an optional component based on the Autonomy K2 product. Installing IBM Legacy Content Search Engine (Windows) Install the Autonomy K2 software on each machine in your IBM Legacy Content Search Engine configuration. You must complete an installation of the Master Administration software before you can install additional K2 Administration Servers. The Master Administration Server dashboard is the central control point for configuring IBM Legacy Content Search Engine for single-server or multiserver installations.

Installing IBM Legacy Content Search Engine (Windows)

Install the Autonomy K2 software on each machine in your IBM Legacy Content Search Engine configuration. You must complete an installation of the Master Administration software before you can install additional K2 Administration Servers. The Master Administration Server dashboard is the central control point for configuring IBM Legacy Content Search Engine for single-server or multiserver installations. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. You must designate each installation as either a Master Administration Server software installation or an Administration Server software installation. Important: Only one K2 Master Administration Server can be installed for each Content Engine domain. You can install Autonomy K2 software either interactively or silently. Installing IBM Legacy Content Search Engine interactively (Windows) on page 104 To install IBM Legacy Content Search Engine interactively, you run a program wizard. Installing IBM Legacy Content Search Engine silently (Windows) on page 105 When you install IBM Legacy Content Search Engine silently, you run a
Installing and configuring Content Search Engine

103

command in the IBM Legacy Content Search Engine software package that references parameters in an installation text file. Completing IBM Legacy Content Search Engine installation in a highly available environment (Windows) on page 106 In a highly available environment, you need to perform additional post-installation steps after installing IBM Legacy Content Search Engine. Setting the logon user for the K2 Administration Server service (Windows) on page 107 To avoid problems when indexing documents using UNC, or viewing UNC-indexed documents, the k2_os_user needs to run the K2 Administration Server service. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Installing IBM Legacy Content Search Engine interactively (Windows): To install IBM Legacy Content Search Engine interactively, you run a program wizard. Note: If you are installing IBM Legacy Content Search Engine in a high availability environment, you must run the IBM Legacy Content Search Engine installer on each node, selecting the shared directory as the IBM Legacy Content Search Engine installation path. Verify that your cluster is running before starting the installation procedure. To install IBM Legacy Content Search Engine interactively: 1. Verify that you have performed the required preparation tasks as shown in the Plan and Prepare Your Environment for IBM FileNet P8 guide. 2. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only IBM Legacy Content Search Engine values, filter by CSE Installer in the Installation or Configuration Program column. 3. Log on to the host machine as k2_os_user. 4. Access the IBM Legacy Content Search Engine installation package and run the 5.0.0-P8CSE-WIN.EXE file. 5. Complete the installation program screens by using the values in your worksheet. In a highly available environment, use the following additional information: v Use the shared binary location as the installation location (verity_install_path). This must be a local shared cluster disk. v In the Select Autonomy K2 Server Type screen, select Master Administration Server. v In the Specify Master Administration Server Information screen, use the host name of the cluster rather than the host name of the local cluster node. Important: For Windows 2008 MSCS, use the virtual name defined for the Service or Application resource when specifying the Master Administration Server Information.

104

Installation Guide

v When the installer has finished, K2 will be running. Stop the Verity K2 Administration Server and the Verity K2 Administration Web Server services before failing to another node. 6. Review the following IBM Legacy Content Search Engine log files for installation errors. The files are located in the verity directory of the installation path: v verity_install_path\cse_install_log_5.0.0.log v verity_install_path\vconfig.log It is a best practice to review log files even if the IBM Legacy Content Search Engine installation program does not indicate any errors. Some errors noted in the log files are benign. If an error is not benign (that is, you cannot subsequently index or search for documents), refer to the log file for help in determining the cause. 7. If you are installing in a highly available environment, fail over to another node and repeat the install process with the same parameters until you have installed IBM Legacy Content Search Engine on all nodes. 8. After the installation finishes, complete the following substeps: a. Verify that the Verity K2 Administration Web Server service (Tomcat server) is installed and has started. b. Verify that the Verity K2 6.2.1 Administration Server service exists. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Installing IBM Legacy Content Search Engine silently (Windows): When you install IBM Legacy Content Search Engine silently, you run a command in the IBM Legacy Content Search Engine software package that references parameters in an installation text file. Note: If you are installing IBM Legacy Content Search Engine in a high availability environment, you must run the IBM Legacy Content Search Engine installer on each node, selecting the shared directory as the IBM Legacy Content Search Engine installation path. Verify that your cluster is running before starting the installation procedure. To install IBM Legacy Content Search Engine silently: 1. Verify that you have performed the required preparation tasks as shown in the Plan and Prepare Your Environment for IBM FileNet P8 guide. 2. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only IBM Legacy Content Search Engine values, filter by CSE Installer in the Installation or Configuration Program column. 3. Log on to the host machine as k2_os_user. 4. Edit the cse_silent_install.txt file to reflect the appropriate responses for your installation by using the values from your worksheet. In a highly available environment, use the following additional information: v Use the shared binary location as the installation location (verity_install_path). This must be a local shared cluster disk.
Installing and configuring Content Search Engine

105

v In the Select Autonomy K2 Server Type screen, select Master Administration Server. v In the Specify Master Administration Server Information screen, use the host name of the cluster rather than the host name of the local cluster node. Important: For Windows 2008 MSCS, use the virtual name defined for the Service or Application resource when specifying the Master Administration Server Information. v When the installer has finished, K2 will be running. Stop the Verity K2 Administration Server and the Verity K2 Administration Web Server services before failing to another node. 5. Run the IBM Legacy Content Search Engine installation program by executing the following command:
5.0.0-P8CSE-WIN.EXE -f cse_silent_install.txt -i silent

6. Review the following IBM Legacy Content Search Engine log files for installation errors. The files are located in the verity directory of the installation path: v verity_install_path\cse_install_log_5.0.0.log v verity_install_path\vconfig.log It is a best practice to review log files even if the IBM Legacy Content Search Engine installation program does not indicate any errors. Some errors noted in the log files are benign. If an error is not benign (that is, you cannot subsequently index or search for documents), refer to the log file for help in determining the cause. 7. If you are installing in a highly available environment, fail over to another node and repeat the install process with the same parameters until you have installed IBM Legacy Content Search Engine on all nodes. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Completing IBM Legacy Content Search Engine installation in a highly available environment (Windows): In a highly available environment, you need to perform additional post-installation steps after installing IBM Legacy Content Search Engine. Important: If you are configuring a cluster, do not start and stop Windows Services on individual nodes directly. Configure the cluster software to manage the Windows Services, then start and stop the Windows Services using the cluster software. To complete the IBM Legacy Content Search Engine installation in a highly available environment: 1. Configure local files to point to the cluster address. After the installation has been completed on all nodes, the following files will contain local host names and must be edited to have the local node names changed to the cluster virtual host name: v verity_install_path/_cseuninst/installvariables.properties v verity_install_path/config.vcnf v verity_install_path/data/docs/WEB-INF/web.xml

106

Installation Guide

v verity_install_path/k2/common/base.xml v verity_install_path/k2/common/verity.cfg v verity_install_path/data/host/admin/adminN.xml Where the value of N is stored in verity_install_path/data/admin/ admin.dat. 2. Configure the Microsoft Cluster Server (MSCS) IBM Legacy Content Search Engine Resource Group. After installing IBM Legacy Content Search Engine on your cluster, you must configure the following cluster resources. These should all be placed in the same Resource or Service group so that they fail over together: v Network name v Binary File Share v Temporary File Share (if local to the cluster rather than mounted from a remote highly-available storage location) v Collections File Share Follow the instructions in Creating a IBM Legacy Content Search Engine collections directory on page 115 to create a temporary directory and to create a collections directory. v IBM Legacy Content Search Engine services: Verity K2 Administration Server (required) Verity K2 Administration Web Server (optional) 3. Add the following resource dependencies: Collections File Share Network name Collections mount point K2 Administration Server / Administration Web Server Binary and temporary file shares (if these are clustered resources. If they are mounted from a remote highly available location, this is not necessary) Collections File Share Network Name Setting the logon user for the K2 Administration Server service (Windows): To avoid problems when indexing documents using UNC, or viewing UNC-indexed documents, the k2_os_user needs to run the K2 Administration Server service. To set the logon user for the K2 Administration Server service: 1. Open the Windows Services window (for example, on Windows Server 2003, right-click My Computer and choose Manage > Services and Applications > Services select Manage Services and Applications | Services). Important: In a highly available clustered server environment, complete this task on the Microsoft Cluster Server, instead of on the service control panel on each node. 2. Select and double-click the Verity K2 6.1 Administration Server service. 3. Click the Log On tab, enter the k2_os_user user and password under which Autonomy K2 services will run, and click OK.
Installing and configuring Content Search Engine

107

Important: Whenever you change the password for the k2_os_user account, you must update the password on this tab as well. Otherwise, the K2 Administration Server will not start when you restart the machine. Also, depending on your domain controller group policy settings, the password for this account may be reset, which will result in logon failures for the K2 Administration Server service when the machine is restarted. To avoid these failures, contact your Windows administrator. 4. Restart the Verity K2 6.1 Administration Server service.

Configuring IBM Legacy Content Search Engine

Use this procedure to configure services required on the K2 Master Administration Server, and on additional Administration Servers you might install for IBM Legacy Content Search Engine. All servers are configured through the Master Administration Server Dashboard. v When you name the servers that you create, it is a best practice to indicate the type of server in the server name. Otherwise, when you configure Content Engine by using Enterprise Manager, it can be difficult to determine which server to select for an action. For example, use server_name_broker to indicate a Broker Server service. v Record the server names, port numbers, and settings that you define. Much of the following information will be required later when you configure the IBM FileNet P8 Content Engine for content-based retrieval later. v A range of ports is recommended in the Verity K2 Dashboard for each service you create. You do not have to choose a port number from within that range. v Repeat the related step in the procedure below to add additional services. Some guidelines must be adhered to when adding additional services: Multiple brokers can be assigned, so that if one goes down the others will be used. However, each broker must have all K2 Servers (search servers) attached that are needed to access collections (index areas). The Content Engine Server will not call multiple brokers and merge the results. If you add additional Index Servers and K2 Servers (search servers), they will not be activated until you enable them through Enterprise Manager. See Configure Content Engine for content-based retrieval for details. Each K2 Administration Server must contain a Ticket Server for Content Engine. For good stability and performance, Broker Servers must be attached to local Ticket Servers for security on each machine. v In the following procedure you must import the IBM FileNet Styleset only once, regardless how many K2 Administration Server machines you install. To configure IBM Legacy Content Search Engine: 1. (Optional) Configure the Autonomy K2 Dashboard to use SSL security. The Autonomy K2 Dashboard web application, by default, uses a non-SSL web site and sends username and password information in plain text. For information on how to modify your Tomcat web applications to use SSL, access the following address: http://tomcat.apache.org/tomcat-5.5-doc/ssl-howto.html 2. Access the K2 Dashboard by launching your browser and entering: http://Master Administration Server hostname:9990/verity_dashboard/main.jsp Note: In a highly available environment, use the cluster name for the K2 Dashboard URL entry.

108

Installation Guide

3. Create a K2 Index Server, as follows: a. Click K2 Index Servers under System View. b. Click Add a K2 Index Server on the K2 Index Server Summary page. c. Enter the following information on the Configure basic settings for the new K2 Index Server page: v Service Alias: server_name _index_server v Port: 9960 - 9979 (suggested range) d. Click Next to continue with the installation. e. Enter the following information on the Configure threads for the K2 Index Server page: v Synchronous Threads: 25 v Asynchronous Threads: 3 v Access Type: Authorized Administrator f. Click Finish to continue with the installation. 4. Set the Index Server logging properties: a. Click the Index Server, under System View, that you want to adjust. b. Click Edit Properties under Actions. c. Click the Logging tab. d. For Status Log Nominal Size, enter the following value: 9000 kilobytes e. Click Modify. 5. Create a K2 Broker Server: a. Click K2 Brokers under System View. b. Click Add a K2 Broker on the K2 Broker Summary page. c. Enter the following information on the Configure basic settings for the new K2 Broker page:

v Service Alias: server_name _broker v Port: 9900 - 9909 (suggested range) d. Click Finish. 6. Create a K2 Server (search server) and attach the Broker: a. Click K2 Servers under System View. b. Click Add a K2 Server under Actions on the K2 Server Summary page. c. Enter the following information on the Configure basic settings for the new K2 Server page: v Service Alias: server_name _search_server v Port: 9920 - 9949 (suggested range) d. Click Next. e. Click Next on the Set security options for this service page. f. Enter the following information on the Attach to K2 Brokers page: v Select the K2 Brokers that will provide access to this service: Select the K2 Broker you created in step 3 from the drop-down menu, server_name _broker. g. Click Finish. 7. Import the IBM FileNet Styleset. a. Click Collections under System View. b. Click Manage Style Sets under Actions on the Collection Summary page.
Installing and configuring Content Search Engine

109

c. Click Import on the Manage Style Sets page (top right). d. Enter the following information on the Import page: v Style Set Alias: FileNet_FileSystem_PushAPI v Gateway Type: --Auto-detect-v Source Administration Server. If multiple servers are installed, choose the server to which you will import the Styleset. v Source Path: Windows verity_install_path\data\stylesets\ FileNet_FileSystem_PushAPI e. Click Import. Tip: The K2 Dashboard displays a notification that the StyleSet Editor web application cannot be accessed. You can ignore this message because it relates to a function that is not used by IBM Legacy Content Search Engine. 8. Import the IBM P8CSE50 style set by completing the following substeps: a. Create modified copies of the IBM P8CSE50 Styleset to enable the features that are required for your object stores. For details on how to modify P8CSE50, see the IBM FileNet P8 5.1.0 Information Center topic Administering IBM FileNet P8 > Administering Content Engine > Content-based retrieval > Finding objects: CBR with IBM Legacy Content Search Engine > Concepts > P8CSE50 style set reference. b. Click Collections under System View. c. Click Manage Style Sets under Actions on the Collection Summary page. d. Click Import on the Manage Style Sets page (top right). e. Enter the following information on the Import page:
Parameter Style Set Alias Value A name that is relevant to the object store and index areas where this style set is applied. --Auto-Detect-The Master Administration Server verity_install_path\data\stylesets\ modified_copy_of_P8CSE50

Gateway Type Source Administration Server Source Path (Windows)

f. Click Import. 9. Create a K2 Ticket Server. a. Click K2 Ticket Servers under System View. b. Click Add a K2 Ticket Server under Actions on the K2 Ticket Server Summary page. c. Enter the following information on the Configure basic settings for the new K2 Ticket Server page: v Service Alias: server_name _ticket_server v Port: 9910 - 9919 (recommended range) d. Click Next. e. Enter the following information on the Configure the login module to use with this K2 Ticket Server page:

110

Installation Guide

v Select which Login Module type to use with this K2 Ticket Server: Windows UNIX Restriction: LDAP Ticket Servers are not currently supported. v Default Domain (Windows only): Enter the domain on which this user and K2 Server are authenticated. If the server is in a workgroup, leave this field blank. Click Next. Enter the following information on the Configure the persistent store module to use with this K2 Ticket Server page: v Select the Persistent Store Module type to use with this K2 Ticket Server: Choose File and Memory. Click Finish. (Windows only) Specify local login settings: 1) Click Edit Properties. 2) Click Windows Login Module. 3) Check Use Local Credentials:. 4) Check Enable Built-in Groups. 5) Click Modify. 10. Set Autonomy K2 Administration Security. a. Click the K2 Ticket Server you created. b. Click Manage Administration Security under Actions. c. Enter the following information on the Manage Administration Security page: v Select a K2 Ticket Server to configure for administration security: From the drop-down menu, select the K2 Ticket Server you just created. v User Name: Enter the k2_os_user. v Password: Enter the authentication password. v Default Domain (Windows only): Enter the domain on which this user and K2 Server are authenticated. If the server is in a workgroup, leave this field blank. d. Click Modify. The K2 software will authenticate the user based on the information you entered. If the check fails, an error message will indicate what failed and request that you re-enter the information. If administrator access is successful, Autonomy K2 will close the Dashboard and require that you log on again as the Dashboard Administrator to complete the configuration. 11. Launch the K2 Dashboard and log on. 12. Restart K2 services: a. Under Notifications on the K2 Dashboard Home page, a number of servers are listed as requiring a restart. Click Start/Stop this Service to access the settings page and follow the instructions listed there. Choose Full Restart to ensure that all services start as expected. b. Click Home in the top-left corner of the page after each restart to view the remaining notifications. Repeat the process until there are no notifications remaining. 13. Enable additional K2 Admin Users (optional).
Installing and configuring Content Search Engine

f. g.

h. i.

111

From the K2 Dashboard home page, click Administration Servers. Click Manage K2 Administrative Users. Click Add User on the Manage K2 Administrative Users page. Enter the name of an authenticated user on the directory service that you want to make a K2 Administrator and click Add. 14. Enable security on the K2 services you have created. a. From the K2 Dashboard home page, click K2 Ticket Servers. b. Click your ticket server server_name_ticket_server. a. b. c. d. c. Click Manage K2 Broker/K2 Server Security in the Services Secured by this K2 Ticket Server section of the page (bottom right). d. Click the K2 Servers button on the Manage K2 Broker/K2 Server Security page. e. Click the service you just created which is listed in the window on the right to enable security. Important: If you have a multi-server configuration, numerous services, installed on other machines, will be listed also. Select only the service to which you want to attach a broker. Brokers must be attached to local ticket servers for IBM Legacy Content Search Engine. f. Click the K2 Brokers button on the Manage K2 Broker/K2 Server Security page. g. Click the Broker in the window on the right that you want to attach to the local K2 ticket server you selected above. h. Click Modify to save your changes. 15. Restart K2 services, as follows: a. Click Home in the top left corner of the page. b. Under Notifications on the Verity K2 Dashboard Home page, a number of servers are listed as requiring a restart. Click Start/Stop this Service to access the settings page and follow the instructions listed there. Choose Full Restart to ensure that all services start as expected. Click Home in the top left corner of the page after each restart to view the remaining notifications. Repeat the process until there are no notifications remaining. Configuring services on Administration Servers Use this procedure to create and configure services on specific IBM Legacy Content Search Engine machines (Administration Servers), other than the Master Administration Server. Services for all machines in your IBM Legacy Content Search Engine configuration are configured through the Master Administration Server Dashboard. Related concepts Specifying accounts For details on accounts and required permissions, see Plan and Prepare Your Environment for IBM FileNet P8.

Configuring services on Administration Servers

Use this procedure to create and configure services on specific IBM Legacy Content Search Engine machines (Administration Servers), other than the Master Administration Server. Services for all machines in your IBM Legacy Content Search Engine configuration are configured through the Master Administration Server Dashboard. To configure services on Administration Servers:

112

Installation Guide

1. Click Administration Servers under System View. 2. Click the Administration Server to which you want to add services. 3. Click Add a Service under K2 Services on this Administration Server. 4. Select the service you want to add. 5. Follow the instructions and guidelines for the appropriate service in Configuring IBM Legacy Content Search Engine on page 108 to complete the service addition.

(optional) Installing additional locales

You must install the locale files on all Autonomy K2 Administration Server machines only if you need more than basic content search locale functionality, for example, indexing and searching in languages other than English, Englishv, or basic UNI. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. You need to know k2_os_user (the user who installed IBM Legacy Content Search Engine), and verity_install_path (the installation path of Autonomy K2) from your installation of IBM Legacy Content Search Engine. Important: v A Locales installer screen indicates that the installer is compatible only with Autonomy K2 version 6.2.0. However, the Locales installer is compatible with version 6.2.1, the version you installed with IBM FileNet P8 IBM Legacy Content Search Engine 5.0.0. v When the Locales installer prompts you for your installed version of Autonomy K2 from a dropdown menu, select K2 6.2.0. v Although the Locales installer offers the option of installing to a location other than the Verity install location, do not choose this option. For IBM Legacy Content Search Engine, you must install the locales to the k2 directory of the Autonomy K2 installation path. To install additional locales: 1. Open your completed Installation and Upgrade worksheet. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Locales installer values, filter by CSE: Verity Locales 6.2.0 Installer in the Installation or Configuration Program column. 2. Run the Locales installation, depending on your operating system. Installing additional locales (Windows) You can install additional, non-English locales if you need them.

Installing additional locales (Windows)

You can install additional, non-English locales if you need them. To install additional locales: 1. Access the Autonomy K2 Master Administration Server machine and log on as k2_os_user. 2. Copy the 5.0.0-P8CSE-Locales.zip file for your platform from the installation package to the machine and extract its contents to a local directory. 3. Stop the Autonomy K2 services, as follows:
Installing and configuring Content Search Engine

113

a. Access Component Services. b. Stop the Verity K2 Administration Server service and the Verity K2 Administration Web Server service. 4. Navigate to the decompressed Locales installer location and run the following command to start the Locales installer: setupwin32.exesetupwin32.exe 5. At the Welcome screen, click Cancel, and then click Yes to exit. Important: By opening the Welcome screen, the Locales installer creates the _vpddb directory (and parent directories), which will contain the vpd.script file. This file contains a parameter that allows the Locales installer to find the existing Autonomy K2 installation. The path to the _vpddb directory has the following form: 32 bit: C:\Program Files\Common Files\InstallShield\Universal\WinVersion\ x86\host_name\Gen1\_vpddb 64-bit: C:\Program Files (x86)\Common Files\InstallShield\Universal\ WinVersion\x64\host_name\Gen1\_vpddb where WinVersion is the name of the Windows operating system, and host_name is the name of the K2 Master Administration Server machine. 6. Locate the vpd.script file in verity_install_path, open the file in a text editor, and make the following edits: v Replace the instance of <K2InstallDir> with your verity_install_path. For example: C:\Program Files\IBM\FileNet\ContentEngine\verity. v Replace both instances of <myHostName> with the Master Administration Server machine name. v Replace both instances of <WinVersion> with the value of WinVersion that the Locales installer generated in 5. 7. Copy the vpd.script file that you edited in 6 to the _vpddb directory that the Locales installer created in 5, overwriting the existing vpd.script file in that location. 8. Navigate to the decompressed Locales installer location and run the following command to start the Locales installer. The installer will locate the K2 installation based on the settings you specified in 6. setupwin32.exe Important: If the installer prompts you to choose whether to overwrite files that are newer than those to be installed, click No to All. 9. When prompted, select the Install all platform binaries option for the licensed language locales. 10. When prompted, specify the following license key: 2UV4MPT-2KPEQBJ1D6A6KT-2KPE6KT-2KPE6KS. 11. If the languages that you need are supported by IBM FileNet P8 but are not in the default list for the Autonomy K2 uni locale, complete the following substeps for those languages. For full details refer to the Autonomy K2 version 6.1 Verity Locale Configuration Guide in the section Configuring Locales > Making Other Language-Related Settings > Configuring Language Identification > Adjusting the Set of Languages to Identify. a. Back up the original langlist.cfg file.

114

Installation Guide

b. Open the langlist.cfg file for editing. c. Open the productDir/common/langlist.all file and copy either all its contents, or just the relevant lines for the languages you need, into the productDir/common/langid/langlist.cfg file. For example, if you need Turkish, these are the relevant lines to copy:
tr-1254.lm tr-utf8.lm

d. From the langlist.cfg file remove the lines for the languages that you do not need. This action improves the accuracy of the language filter. e. Save your edits to the langlist.cfg file. 12. Start the Autonomy K2 services that you stopped in 3 on page 113. 13. Ensure that the locale license information is synchronized with the Master Administration Server by running the following command: rcadmin -update

Creating a IBM Legacy Content Search Engine collections directory

Use this procedure to configure the storage location and related security for your K2 collections. Collections directory requirements The task of creating a collections directory includes setting up security permissions to allow read and write access.

Collections directory requirements

The task of creating a collections directory includes setting up security permissions to allow read and write access. Important: Contrary to information outlined in the Autonomy-supplied documentation set, remote collections are not supported for use with IBM FileNet P8 Content Search Engine. Collections must be written locally to the Autonomy K2 server. Using a remote-mounted disk that is accessed via the network (NFS, PCNFS, or CIFS) will cause stability problems under load and corrupt your collections. Any existing configurations that contain non-local collections directories must be re-configured. For performance reasons, create one collections directory for each index area that you create in IBM FileNet P8 Content Engine. Each collections directory you create must be set to provide proper security access as outlined below. The path to both the collections directory and collections temp directory must be entered in the index area properties when you create the index area. Security and communication between Autonomy K2 Content Engine, and the collections directory is handled through the user accounts and permissions provided to those accounts. For detailed information on security, see the IBM FileNet P8 help topic Security > IBM FileNet P8 Security > Authorization > Security for integrated components and third-party products > Security for IBM Legacy Content Search Engine. To create a collections directory: 1. On the Autonomy K2 server, create a directory in which you will store K2 collections. Give read, write, and execute permissions to the k2_os_user.

Installing and configuring Content Search Engine

115

This path must be local to the index server that will be assigned to write collections. This is the same index server that you created when you configured Content Search Engine. Create a temp directory on the Autonomy K2 machine on which you created the collections directory. The temp directory will be used by the K2 Index Server and Content Engine Server during operations. This path must be visible to both the Content Engine and the Content Search Engine servers. If the K2 Master Administration Server and Content Engine are not installed on the same machine, they both must be on a network-mounted file system. 3. Record the collections directory path in the Autonomy K2 configuration file. 2.
Option Windows Description 1. Open the following K2 configuration file in a text editor: verity_install_path\k2\common\ verity.cfg 2. Modify the next available alias settings by adding the collections path, where new collections will be written. For example, change alias6, mapping6, and dirmode6 to the following: alias6=path1 mapping6=C:\Collections_Directory dirmode6=wr 3. Save our edits.

Related concepts Specifying accounts For details on accounts and required permissions, see Plan and Prepare Your Environment for IBM FileNet P8.

Configuring Content Engine for content-based retrieval

You must use Enterprise Manager to configure an index area and enable the content-based retrieval (CBR) feature provided by IBM Legacy Content Search Engine. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Take the following issues into account before you configure Content Engine. v Various server names and related ports assigned during the installation and configuration of Autonomy K2 are required during this procedure. For a record of the servers created and the ports that have been assigned, log on to the Autonomy K2 dashboard. v If you unimport the style set, the original files are deleted from your system. In this scenario, if you want to reimport the style set, you must recover it from your installation disk. v Where machine name variables are required, IP addresses cannot be specified. In these cases, you must enter the host name for the machine.

116

Installation Guide

For more detail on content-based retrieval and Content Engine, see the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Content-based retrieval > Finding objects: CBR with IBM Legacy Content Search Engine > How to... > Configure CBR. To configure Content Engine for content-based retrieval: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Verity Domain Configuration Tab in the Installation or Configuration Program column. 2. Start Enterprise Manager and log on as the GCD Administrator. 3. Create one or more Verity configuration domains by completing the following substeps: a. Right-click Enterprise Manager [domain] in the Enterprise Manager tree and select Properties. b. Click the Verity Domain Configurations tab. c. Click Create. d. Click Next at the Welcome screen of the Create a Verity Domain Configuration wizard. e. Enter a value for the Enter Verity Domain Configuration Display Name field and then click Next. f. Enter the following K2 Master Administration Server access information and then click Next. v Host Name - the name of the host of the K2 Master Administration Server. Important: For highly available clustered server environments, this is the cluster host name rather than the host name of an individual node. v v Port - the K2 Master Administration Server port. The default port number is 9950.

User Domain - the authentication domain in which your K2 services are installed. v User Group - K2 Security Group. v Verity Username - K2 Security User.

v Password - the K2 Security User password. g. Enter values in the Specify the Performance Tuning Parameters screen and then click Next. h. Click Finish to complete the Verity Domain Configuration wizard. 4. To assign a CBR locale to the object store for which you want to enable indexing, complete the following substeps: a. Right-click the object store in the left pane of Enterprise Manager and choose Properties from the context menu. b. In the Properties dialog box, click the CBR Verity tab. c. Select the Verity domain configuration that you want to configure from the Verity Domain Configuration drop down box. d. Specify one of the following locales (which are installed by default with IBM Legacy Content Search Engine software) in the CBR Locale box: v uni (multi-language and slower indexing)
Installing and configuring Content Search Engine

117

v v

englishv (enhanced word-stemming and faster indexing) english (limited capabilities and fast indexing)

If you click Set to Default CBR Locale, the CBR locale is set to englishv. e. Click Apply or OK. 5. To access the Verity Locale Configuration Guide, complete the following substeps. Important: For information about how the K2 product uses locales and about performance and indexing options, review the Verity Locale Configuration Guide in the Autonomy-supplied documentation set. a. Open the Autonomy K2 Dashboard and click Help. b. Click Library (top right of the screen) to access the Autonomy K2 product guides. Each guide is available in HTML or PDF format. 6. Create an index area. a. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Create an Index Area in the Installation or Configuration Program column. b. In the Enterprise Manager tree view, expand the Object Stores container. c. Right-click the object store to which you want to add an index area and select New > Index Area. d. Complete the Create an Index Area wizard by using the values from your worksheet. For more information about creating indexes, see the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Content-based retrieval > Finding objects: CBR with IBM Legacy Content Search Engine > How to... > Create a Verity index area. 7. Enable CBR for one or more document class definitions: a. Right-click the class you want to configure, such as a document class that your site has created, in the Enterprise Manager tree and click Properties. b. Select the CBR Enabled check box and click OK. 8. Enable CBR for one or more string properties of the document classes or custom object classes that you want to use for content-based retrieval: a. Right-click the class and click Properties. b. Click the Property Definitions tab. c. Click the string property you want to enable for CBR indexing and click Edit. d. Check CBR Enabled and click OK. e. Click OK. 9. Repeat 4 on page 117 through 8 for each additional object store to which you want to assign a CBR locale. Enabling additional K2 index servers and search servers on page 119 If you add additional K2 Index Servers or Search Servers to an existing configuration, you must enable them through Enterprise Manager to utilize them.

118

Installation Guide

Enabling additional K2 index servers and search servers

If you add additional K2 Index Servers or Search Servers to an existing configuration, you must enable them through Enterprise Manager to utilize them. 1. Log on to Enterprise Manager as the GCD Administrator and expand the Enterprise Manager tree. 2. Open the Index Area folder. 3. Right-click the index area that you want to add the new services to and select Properties . 4. Enable the new Search Servers as follows: a. Click Edit Search Servers. b. In the Search Servers Available pane, highlight any servers you want to enable for this index area and click Add to add the server to the Search Servers Selected list. c. Click OK to save the settings and enable the new servers. Enable the new Index Servers as follows: a. Click Edit Index Servers. b. In the Index Servers Available pane, Highlight any servers you want to enable for this index area and click Add to add the server to the Index Servers Selected list. c. Click OK to save the settings and enable the new servers.

5.

Verifying the IBM Legacy Content Search Engine installation

To verify that the IBM Legacy Content Search Engine installation and configuration succeeded, perform the following procedure. To verify the IBM Legacy Content Search Engine installation: 1. In Enterprise Manager, access the Root Folder and open a subfolder that contains a document. The document must contain text; it cannot be an image. 2. Right-click a document and select All Tasks > Index for Content Search. A Notice indicates that a content search index job was created successfully. 3. Right-click the object store node for the document you set to index for content search and select All Tasks > Index Jobs Management. 4. In the Index Jobs Manager, check to see that the Job Status indicates the job has terminated normally. Depending on the size of the indexing job, it might take a few minutes for the indexing job to complete. If the Job Status indicates that the indexing is in progress, wait a few minutes to give the job time to complete. If the Job Status does not indicate progress, check the p8_server_error.log file on the application server.

Installing and configuring Content Search Engine

119

120

Installation Guide

Installing and configuring Process Engine

Installing and configuring Process Engine is a process requiring multiple steps, and the steps must be followed in sequence. The following steps must be completed in order to install Process Engine software, configure Process Engine on the IBM FileNet P8 Platform, and install the latest software updates. 1. Installing Process Engine You can install Process Engine software either interactively or silently. A number of configuration steps follow the execution of the Process Engine installation program. 2. Installing the latest Content Engine client files on Process Engine servers on page 124 Installing the Content Engine Client files on all Process Engine servers enables communication between the Content Engine and the Process Engine. You can install these files interactively by using the installation wizard or silently by using the command line and a silent input file. 3. Configuring Process Engine on page 127 You can configure the Process Engine interactively using Process Task Manager or silently using the peinit command-line tool. In a farmed configuration, do this on only one node. In a cluster configuration, do this on every node. 4. Configuring a Process Engine isolated region on page 134 You can configure a Process Engine isolated region interactively using Process Task Manager or silently using the peinit command-line tool. In either case, you must define the isolated region and connection point on the Content Engine first. In a farmed or cluster configuration, do this on only one node. 5. Additional configuration for cluster server environments on page 138 You must configure a cluster Generic Application for Process Engine in a cluster server environment. 6. Configuring SSL communication between Process Engine and Content Engine on page 138 Add the CA certificate to the Process Engine private JRE keystore and set the Content Engine URI for the https protocol 7. Adding instances to a Process Engine farm on page 139 Start the Process Task Manager and add additional instances to Process Engine farm. 8. Verifying Process Engine installation on page 139 You can verify your Process Engine installation by creating a workflow. 9. Configuring the Dispatcher service or process in WebSphere Edge Components on page 141 If you are configuring a Process Engine server farm to use WebSphere Edge Components as a software load balancer, the Dispatcher service or process in WebSphere Edge Components must be running on the target server. The Dispatcher is used as the software load balancer.

Installing Process Engine

You can install Process Engine software either interactively or silently. A number of configuration steps follow the execution of the Process Engine installation program.
Copyright IBM Corp. 2001, 2011

121

Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Remember: If you are using a hardware load balancer in a highly available environment, verify that your hardware load balancer is set up to forward and monitor TCP ports assigned to the Process Engine Naming Service and Process Engine Main ports, 32776 and 32777 by default. Important: In farm and cluster environments, install Process Engine on all nodes. Installing Process Engine interactively Use these procedures to install Process Engine using the installation wizard screens included with the installation package. Installing Process Engine silently on page 123 Modify the silent installation response file according to the values in the installation worksheet before installing the software. Installing Process Engine software updates on page 124 You can install software updates such as modified releases, fix packs, or interim fixes to Process Engine.

Installing Process Engine interactively

Use these procedures to install Process Engine using the installation wizard screens included with the installation package. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Installing the Process Engine software interactively (Windows) You can install Process Engine by using the Process Engine installation wizard.

Installing the Process Engine software interactively (Windows)

You can install Process Engine by using the Process Engine installation wizard. Install the Process Engine software. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Process Engine values, filter by PE Installer in the Installation or Configuration Program column. 2. Log on to the Process Engine server as pe_install_user. 3. Navigate to the Process Engine software package, and start the 5.0.0-P8PE-WIN.EXE installation program. Choose to automatically start the Process Engine Manager if prompted. 4. Check for the IBM_FileNet_Process_Engine_5.0.0_InstallLog.log file in the installation directory. The default installation directory is C:\Program Files(x86)\IBM\FileNet\ProcessEngine\. 5. If errors occur during installation, check the following files in the Temp directory as identified by the TEMP or TMP environment variable. v pe500_install_stderr.txt v pe500_install_stdout.txt 6. If you received a message during installation that you were installing as a non-Administrator, log on as an Administrator after the installation and run the following commands to modify the Windows registry and create the Process Engine Manager service. Enter the following commands at a command prompt:

122

Installation Guide

>cd Process_Engine_program_files_install_location\installer >CreateVWServicesPE.bat

7. Log out and log back in as an Administrator. 8. Start the Process Engine Manager service and verify it is set to autostart. 9. In a farmed or cluster configuration, if you are on node 1, make a copy of the installation_path/data/peseed.jar file. Copy the peseed.jar file from node 1 into the installation_path/data directory on every other node. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing Process Engine silently

Modify the silent installation response file according to the values in the installation worksheet before installing the software. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Installing the Process Engine software silently (Windows) Complete the following procedures to silently install Process Engine.

Installing the Process Engine software silently (Windows)

Complete the following procedures to silently install Process Engine. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Process Engine values, filter by PE Installer in the Installation or Configuration Program column. 2. Log on to the Process Engine server as pe_install_user. 3. Navigate to the Process Engine software package. 4. Edit the pe_silent_install.txt file to reflect the appropriate responses for your installation. 5. Save the edited response file to your temporary directory. 6. Navigate to the temporary directory on the local disk. 7. Open a command prompt and start the installation program:
5.0.0-P8PE-WIN.EXE -f pe_silent_install.txt

8. Check for the IBM_FileNet_Process_Engine_5.0.0_InstallLog.log file in the installation directory. The default installation directory is C:\Program Files(x86)\IBM\FileNet\ProcessEngine\. 9. If errors occur during installation, check the following files in the Temp directory as identified by the TEMP or TMP environment variable. v pe500_install_stderr.txt v pe500_install_stdout.txt 10. If you were installing as a non-Administrator, log on as an Administrator after the installation and run the following commands to modify the Windows registry and create the Process Engine Manager service. Enter the following commands at a command prompt:
>cd Process_Engine_program_files_install_location\installer >CreateVWServicesPE.bat

11. Log out and log back in as an Administrator.

Installing and configuring Process Engine

123

12. Start the Process Engine Manager service and verify it is set to autostart. 13. In a farmed or cluster configuration, if you are on node 1, make a copy of the installation_path/data/peseed.jar file. Copy the peseed.jar file from node 1 into the installation_path/data directory on every other node. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing Process Engine software updates

You can install software updates such as modified releases, fix packs, or interim fixes to Process Engine. Important: In farm and cluster environments, install Process Engine software updates on all nodes. In cluster server environments, you need to completely install and configure Process Engine, install the Content Engine client, and configure Process Task Manager on the first node before starting installation on any other node. To install the Process Engine software updates: 1. Contact your service representative to obtain the latest Process Engine software updates, and to determine whether additional interim fixes are needed. 2. Open the readmes for the Process Engine software updates and perform the installation procedures in the readmes on the Process Engine.

Installing the latest Content Engine client files on Process Engine servers
Installing the Content Engine Client files on all Process Engine servers enables communication between the Content Engine and the Process Engine. You can install these files interactively by using the installation wizard or silently by using the command line and a silent input file. In farm and cluster environments, install Content Engine client files on Process Engine on all nodes. In cluster server environments, you need to completely install and configure Process Engine, install the Content Engine client, and configure Process Task Manager on the first node before starting installation on any other node. Installing the latest Content Engine client files on Process Engine servers interactively on page 125 The installation wizard provides an interactive way to install the Content Engine Client files. You can use the values from your worksheet to fill in the required value for each field on the wizard screens. Installing the latest Content Engine client files on Process Engine servers silently on page 126 The command line method provides a way to silently install the Content Engine Client files. You can use the values in your installation worksheet to edit the silent input text file before you run the installation.

124

Installation Guide

Related concepts Installation and Upgrade Worksheet For more information about Content Engine parameter values, see Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Content Engine client files on Process Engine servers interactively
The installation wizard provides an interactive way to install the Content Engine Client files. You can use the values from your worksheet to fill in the required value for each field on the wizard screens. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Important: Be sure that Content Engine is running before you start installing Content Engine Client files. To install the Content Engine Client files: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Client Installer in the Installation or Configuration Program column. 2. To download the latest software updates, and to determine which of these updates might be required for use with other components and expansion products, contact your service representative. 3. On the machine where Process Engine is installed, log on as pe_install_user, with these permissions: v Read and write permission to a temporary directory, such as temp (Windows) or tmp (UNIX), on the machine where Process Engine is installed v Execute permission on the Content Engine Client installation software v (Windows) Read & Execute and Write permission on the folder that is to contain the installed Content Engine Client 4. Verify that there is a current backup of Process Engine. 5. Copy the Content Engine Client installation software from the Content Engine installation software to the temporary directory. The version of the client installation software must match the version of Content Engine. 6. Expand the compressed Content Engine Client installation software file in the temporary directory. 7. Access the IBM FileNet Content Engine Client update software in the temporary directory. 8. Run the following command:
Operating System Windows Install Program 5.1.0-P8CE-CLIENT-WIN.EXE

9. Complete the installation program wizard by using the values from your worksheet. 10. When the installation completes, check the Content Engine Client log file for errors. The path to the log file depends on the type of operating system on the machine where you installed the Content Engine Client files:
Installing and configuring Process Engine

125

Operating System

Path to Log File C:\Program Files\IBM\FileNet\CEClient\ ceclient_install_log_5.1.0.txt

| |

Windows

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Content Engine client files on Process Engine servers silently
The command line method provides a way to silently install the Content Engine Client files. You can use the values in your installation worksheet to edit the silent input text file before you run the installation. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Important: Be sure that Content Engine is running before you start installing Content Engine Client files. To install the Content Engine Client files: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Client Installer in the Installation or Configuration Program column. 2. To download the latest software updates, and to determine which of these updates might be required for use with other components and expansion products, contact your service representative. 3. On the machine where Process Engine is installed, log on as pe_install_user with these permissions: v Read and write permission to a temporary directory, such as temp (Windows) or tmp (UNIX), on the machine where Process Engine is installed v Execute permission on the Content Engine Client installation software v (Windows) Read & Execute and Write permission on the folder that is to contain the installed Content Engine Client 4. Verify that there is a current backup of Process Engine. 5. Copy the Content Engine Client installation software from the Content Engine installation software to the temporary directory. The version of the client installation software must match the version of Content Engine. 6. Expand the compressed Content Engine Client installation software file in the temporary directory. 7. Make a backup copy of the ceclient_silent_install.txt input file in the temporary directory. 8. Open the silent input file in a text editor. Follow the instructions in the silent input file to edit the file to reflect the appropriate responses for your update. Use the values from your worksheet. 9. Navigate to the temporary directory path containing the Content Engine Client installation program, and run the following command, where: path is the path that contains the installation program.

126

Installation Guide

Operating System Windows

Install Program 5.1.0-P8CE-CLIENT-WIN.EXE -f path\CEClient.Windows\ ceclient_silent_install.txt -i silent

10. When the installation completes, check the Content Engine Client log file for errors. The path to the log file depends on the type of operating system on the machine where you installed the Content Engine Client files:
Operating System Path to Log File C:\Program Files\IBM\FileNet\CEClient\ ceclient_install_log_5.1.0.txt

| |

Windows

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Configuring Process Engine

You can configure the Process Engine interactively using Process Task Manager or silently using the peinit command-line tool. In a farmed configuration, do this on only one node. In a cluster configuration, do this on every node. Configuring a Process Engine virtual server and database interactively Start the Process Task Manager, define the virtual server, and set initial configuration parameters on the Process Engine server. Configuring a Process Engine virtual server and database silently on page 129 Configure a Process Engine virtual server and database silently by using the peinit command-line tool. Encrypting passwords for Process Engine on page 133 Several passwords are required to configure Process Engine components. To accommodate your security requirements, you can encrypt these passwords before you enter them into the configuration files.

Configuring a Process Engine virtual server and database interactively

Start the Process Task Manager, define the virtual server, and set initial configuration parameters on the Process Engine server. Use the procedures in this task to configure and start a virtual server instance for Process Engine. Complete these procedures on only one node in a Process Engine farm. If you are in a Microsoft cluster server environment, configure all additional Process Engines to use the same database as the initial Process Engine. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Process Task Manager values, filter by Process Task Manager in the Installation or Configuration Program column. 2. Log on to the Process Engine server as pe_install_user. 3. Start the Process Task Manager, as follows:

Installing and configuring Process Engine

127

Option Windows creating the virtual server with a name of default Windows creating a virtual server with a specific name

Description Select Start > Programs > IBM FileNet P8 Platform > Process Engine > Process Task Manager. At a command prompt, change to the installation directory, by default C:\Program Files\IBM\FileNet\ProcessEngine, and enter vwtaskman virtual_server_name where virtual_server_name is the virtual server name.

| | | | | | | | | | | | | | | | | | |

4. In the Database subtab, enter the Database Type, Database version (for DB2 only), Database Name, Database User Name and password, Database Host and Database Port from the installation worksheet. If you are using DB2 for z/OS, enter the DB2 for z/OS instance name in Database Name field. As an alternative to entering the Database Host, Port, and Database Name, the JDBC Driver URL can be manually configured. If the Process Engine is using IBM DB2 pureScale, you must manually enter the JDBC URL as follows. Enter the URL as a single line.
jdbc:db2://pureScaleServer1:port/ db2Instance:connectionCloseWithInFlightTransaction=2; enableSysplexWLB=true;clientRerouteAlternateServerName=pureScaleServer2; clientRerouteAlternatePortNumber=port

where pureScaleServer1 and pureScaleServer2 are the names of pureScale servers. Only two pureScale server names are required in the URL, even if there are additional pureScale servers in the configuration. The port is the database instance port number and db2Instance is the name of the database instance.If the Process Engine is using Oracle RAC, you must enter the JDBC URL manually in the JDBC Driver URL field to connect to the Process Engine database. 5. Click Next. Process Task Manager will connect to the database. If you cannot connect to the database with the information provided here, or the JDBC driver cannot be accessed, you will get an error and must resolve it before continuing. 6. Enter the tablespace information for DB2 or Oracle databases or the filegroup information for SQL Server databases using the values from your installation worksheet. If you are using DB2 for z/OS, enter the real DB2 for z/OS database name in the Data Tablespace field. Click Next to proceed. 7. Accept or change the default Process Engine Main Port and Process Engine Naming Service Port and click Next to proceed with configuration. These port numbers must be unique for each virtual server on a machine. 8. Provide the Content Engine URI, Service Username and password, Administrator Group, and optional Configuration Group names identified on your installation worksheet. The value for the Content Engine URI defaults using information entered when the Content Engine client software was installed. If there is no value in this field you might need to reinstall and configure the Content Engine client software. 9. Click Test connection to verify that all information entered in this screen is correct and that you can connect to the Content Engine using the provided authentication information. If there are errors returned they must be resolved before proceeding. After testing the connection returns a message indicating success, click Next 10. Click Finish to save the security and database information to the Process Engine database. Information is written to the database and an initial set of

128

Installation Guide

11. 12. 13.

14.

tables are created in the database. If there are errors trying to create the tables or write to the database they must be resolved before proceeding. In a farmed configuration, return to the General tab and enter the load balancer virtual name in the Process Engine Server Virtual Host field. After all parameters have been entered, click OK. When prompted by Process Task Manager to restart the software, click Yes. Process Task Manager will restart the software automatically on all servers in the farm. Check Automatically Restart to have the Process Engine software automatically restart when the server is restarted.

Configuring a Process Engine virtual server and database silently

Configure a Process Engine virtual server and database silently by using the peinit command-line tool. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Configure a Process Engine virtual server and database silently by using the peinit command with appropriate parameters. These activities are broken into steps which you must run in the following order. 1. Configure the virtual server. This step creates the vwserver.ini configuration file. This configuration file identifies basic database configuration information to each host, including where the Process Engine database is located and how to log on to it. 2. Configure and initialize the Process Engine database. This step includes configuring the database table spaces and file groups, the connection to Content Engine and all user authentication information. This configuration information is stored in the Process Engine database. Create two input parameter files. To configure a Process Engine virtual server and database silently: 1. Log on to the Process Engine server. Any user can create the input parameter files. To run the commands in the peinit tool, you must enter the pe_service_user user name and password. 2. Create the virtual server: a. Change the current directory to pe_install_path\data where pe_install_path is the location of the program files that was specified during the Process Engine installation. b. Make a copy of the PEInitV.properties.sample file and save it as PEInitV.properties. c. Using a text editor, edit the PEInitV.properties file by providing the parameter values for your configuration. d. Enter the parameters, one parameter per line in the following format:
parameter name=value

Installing and configuring Process Engine

129

Parameter DBType

Description Define the database type. Valid values are: v DB2 v Oracle v MSSQL Enter the database type as defined by the DBType property in the worksheet. This parameter is required. You distinguish between DB2 for z/OS and DB2 for Linux, UNIX and Windows by using the DBVersion parameter.

DBName

Enter the name of the Process Engine database that is defined by the DBName property in the worksheet. This parameter is required. If you are using the PEInitV.properties file, set DBName to the DB2 for z/OS instance name. Enter the server host name where the Process Engine database resides. The host is identified by the DBHost property in the worksheet. If the parameter is not provided, the default value is localhost. This parameter is not required if you provide the DBConnectURL. If the default URL format is not acceptable, enter the DBConnectURL instead of the DBHost and DBPort in the PEInitV.properties file. Enter the value for the database port as identified by the DBPort property in the worksheet. Default values are: 1433 The default value for an SQL Server database instance. The port number is used to identify the SQL Server instance, and the instance name is not required in the configuration parameters. 60000 The default port number for a DB2 database. 1521 The default port number for an Oracle database. If no alternative port is identified, the default value for the port is assigned. This parameter is not required if you provide the DBConnectURL. If the default URL format is not acceptable, enter the DBConnectURL instead of the DBHost and DBPort in the PEInitV.properties file.

DBHost

DBPort

130

Installation Guide

Parameter

Description This parameter is the optional database connection URL to be used to configure the database connection. Use this URL or use the DBHost and DBPort. If you specify the DBHost and DBPort, the DBConnectURL is automatically created for SQL Server, DB2, and Oracle databases as follows: v jdbc:sqlserver:// DBhost:DBport;DatabaseName=DBName v jdbc:db2://DBhost:DBport/DBName v jdbc:oracle:thin:@DBhost:DBport:DBName If the default URL format that is specified is not acceptable, enter the DBConnectURL instead of the DBHost and DBPort. If the default URL is acceptable, enter only the DBHost and DBPort values in the PEInitV.properties file. If the Process Engine is using IBM DB2 pureScale, you must manually enter the JDBC URL as follows. Enter the URL as a single line. jdbc:db2://pureScaleServer1:port/db2Instance: connectionCloseWithInFlight Transaction=2; enableSysplexWLB=true; clientRerouteAlternateServerName =pureScaleServer2; clientRerouteAlternatePortNumber =port where pureScaleServer1 and pureScaleServer2 are the names of pureScale servers. Only two pureScale server names are required in the URL, even if there are additional pureScale servers in the configuration. The port is the database instance port number and db2Instance is the name of the database instance.

| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

DBConnectUrl

DBUserName

This parameter is the database user name that was identified by the pe_db_user parameter in the installation worksheet. This value is required. This parameter is the password for the database user. This value is required. If the password is encrypted, enter the value as @encrypted_pe_db_password. To encrypt the password, see the information in Encrypting passwords for Process Engine. If you enter the password as a non-encrypted value in the PEInitV.properties file, the password will be automatically encrypted in the vwserver.ini file. If you enter the password as a non-encrypted value in the PEInitV.properties file, delete the PEInitV.properties file after the configuration is complete.

DBpw

e. Configure a single virtual server by running the following command, entered as a single line:
peinit virtual_server_name -V PEInitV.properties

Installing and configuring Process Engine

131

where virtual_server_name is the name of the virtual server you are defining. If you do not specify the virtual server name, this server name is defined as default. 3. Configure the database. These steps initialize the database, create the global tables (the ones not specific to an isolated region), store the table space information that is used to create the global tables, and store the Content Engine connection information. a. Make a copy of the PEInitD.properties.sample file and save it as PEInitD.properties. b. Using a text editor, edit the PEInitD.properties file by providing the parameter values for your configuration. c. Enter the parameters, one parameter per line in the following format:
parameter name=value Parameter PEServerVirtualHost Description Enter the host name of the machine that contains the load balancer. This parameter is needed only for virtual servers with more than one machine. Enter the Process Engine server port number that is used to handle public API requests. Port 32777 is used by default. Enter the port number as defined by the PEServerMainPort property in the worksheet. This parameter is required and must be unique for each virtual server on a machine. Enter the Process Engine server port number that is used to handle naming service requests. Port 32776 is used by default. Enter the port number as defined by the PEServerNamingServicePort property in the worksheet. This parameter is required and must be unique for each virtual server on a machine. This parameter is the LDAP name that is used by Process Engine to connect to Content Engine. Enter the short name for this user, which is defined by the pe_service_user in the worksheet. This value is required. Enter the password for the pe_service_user. If the password is encrypted, enter the value as @pe_service_user_password. To encrypt the password, see the information in Encrypting passwords for Process Engine. This value is required. Enter the URL that is used by Process Engine to connect to Content Engine This value is required and corresponds to the value that was entered when the Content Engine Client software was installed. This value is identified as the Content Engine Client Software URL (WSI) parameter in the worksheet. When used here, do not include the cemp in the string from the worksheet value. Enter the value as defined by the CEURL in the worksheet. Enter the Process Engine administrators group name, which is defined by the pe_admin_group parameter in the worksheet. This value is required. Enter the Process Engine configuration group name, which is defined by the pe_config_group in the worksheet. This value is optional.

PEServerMainPort

PEServerNamingServicePort

ServiceUser

ServicePW

CEURL

SysAdminGroup

SysConfigGroup

132

Installation Guide

Parameter pe_data

Description The name of the data table space for DB2 for Linux, UNIX and Windows or Oracle or the name of the file group for SQL Server. When using the PEInitD.properties file, specify only the pe_data information. Use the real DB2 for z/OS database name for the data tablespace name. The name of the optional index table space

pe_index

d. Configure the database by running the following command, entered as a single line:
peinit virtual_server_name -D PEInitD.properties -Y pe_service_user+pe_service_user_password

where virtual_server_name is the name of the virtual server you are defining. If you do not specify the virtual server name, this server name is defined as pesvr.default. 4. Log off and log back on before running any other Process Engine program, such as Process Task Manager or Process Configuration Console. Before the Process Engine database is ready for use you must configure an isolated region and, if the configuration is for IBM Case Manager, create a link between the region and a Content Engine object store. Related tasks Defining and initializing a Process Engine isolated region silently on page 136 Define and initialize a Process Engine isolated region and, if the configuration is for IBM Case Manager, configure the link between the region and a Content Engine object store silently by using the peinit command-line tool. Encrypting passwords for Process Engine Several passwords are required to configure Process Engine components. To accommodate your security requirements, you can encrypt these passwords before you enter them into the configuration files.

Encrypting passwords for Process Engine

Several passwords are required to configure Process Engine components. To accommodate your security requirements, you can encrypt these passwords before you enter them into the configuration files. Ensure that Java is installed and that the location to your Java runtime environment (JRE) is in your PATH environment variable. Do the following steps to encrypt a password: 1. From a command prompt, change working directory to the installation location for the Process Engine software. 2. Run the following command:
genseed password

where password is the password you want to encrypt. 3. An encrypted password is generated and displayed in the encrypted password field. For example:
password=!v2!4YHsRLq8JknqjP6wHjqoe2J2CyznTjP8ClehHxV084k=

Installing and configuring Process Engine

133

4. Copy and paste the encrypted password string into the appropriate configuration file. The string to copy starts after the first equal sign and includes all of the remainder of the characters. 5. Enter the string in the password field of the configuration file, preceded by the @ character. In this example, the string to enter in the configuration file would be:
@!v2!4YHsRLq8JknqjP6wHjqoe2J2CyznTjP8ClehHxV084k=

Configuring a Process Engine isolated region

You can configure a Process Engine isolated region interactively using Process Task Manager or silently using the peinit command-line tool. In either case, you must define the isolated region and connection point on the Content Engine first. In a farmed or cluster configuration, do this on only one node. Defining a Process Engine isolated region on the Content Engine Process Engine clients communicate to isolated regions in the database and to the Process Engine server by using a connection point. Each connection point is associated with an isolated region. In this task, you define an isolated region on the Content Engine. You will later create the same region on the Process Engine. Creating a Process Engine Connection Point on page 135 A connection point identifies a specific isolated region of the workflow database, and gives it a name that workflow-related applications use to access the region. Follow these procedures to create a connection point. Defining a Process Engine isolated region interactively on page 135 Start the Process Task Manager and define an isolated region. If the region is defined in Process Task Manager, it must be initialized later using Process Configuration Console After installing Application Engine. Alternatively use the command line tool peinit to define and initialize the region. Defining and initializing a Process Engine isolated region silently on page 136 Define and initialize a Process Engine isolated region and, if the configuration is for IBM Case Manager, configure the link between the region and a Content Engine object store silently by using the peinit command-line tool.

Defining a Process Engine isolated region on the Content Engine

Process Engine clients communicate to isolated regions in the database and to the Process Engine server by using a connection point. Each connection point is associated with an isolated region. In this task, you define an isolated region on the Content Engine. You will later create the same region on the Process Engine. In this task, you create an isolated region. You must next define a connection point to this isolated region. To define a Process Engine isolated region: 1. Start Enterprise Manager by double-clicking the FileNet Enterprise Manager SnapIn on the desktop, or by navigating to Start > All Programs > FileNet P8 Platform > FileNet Enterprise Manager Administration Tool. Log on as a GCD administrator. 2. Connect to the FileNet P8 domain that you created previously. 3. Right-click PE Region ids > New PE Region ids. 4. On the Specify a Site screen, click Next to select a site named initial site.

134

Installation Guide

5. Enter the DNS name for the Process Engine server. This value is the Process Engine server name. In a farmed configuration, this value is the name of the Process Engine Virtual Server Host. In a cluster configuration, this value is the network virtual name of Process Engine. 6. Enter the region ID. 7. Modify the Naming Service Port if needed. This port identifies which Process Engine virtual server to create the region on. This port must match the port that was entered in the Process Task Manager for the Naming Service Port. 8. Click Next. 9. Enter a password for the isolated region. This password is temporary and it is overwritten by the region key when the region is configured in Process Task Manager. 10. Click OK on the Confirmation Window. 11. Click Finish to finish creating a new isolated region for Process Engine. Create the connection point for the isolated region.

Creating a Process Engine Connection Point

A connection point identifies a specific isolated region of the workflow database, and gives it a name that workflow-related applications use to access the region. Follow these procedures to create a connection point. Define an isolated region in Enterprise Manager before creating a connection point. Use the following procedure to create a Process Engine connection point: 1. Start Enterprise Manager by double-clicking the FileNet Enterprise Manager SnapIn on the desktop, or by navigating to Start > All Programs > FileNet P8 Platform > Enterprise Manager SnapIn. Log in as a GCD administrator. 2. Connect to the FileNet P8 domain that you created previously. 3. Right-click PE Connection Points > New PE Connection Points. 4. Enter a Process Engine Connection Point name and click Next. Process Engine Connection Point names must not contain whitespace characters. 5. Choose a region and click Next. 6. 7. Click Finish to finish creating the Connection Point. Click OK.

Related tasks Defining a Process Engine isolated region on the Content Engine on page 134 Process Engine clients communicate to isolated regions in the database and to the Process Engine server by using a connection point. Each connection point is associated with an isolated region. In this task, you define an isolated region on the Content Engine. You will later create the same region on the Process Engine.

Defining a Process Engine isolated region interactively

Start the Process Task Manager and define an isolated region. If the region is defined in Process Task Manager, it must be initialized later using Process Configuration Console After installing Application Engine. Alternatively use the command line tool peinit to define and initialize the region. Define an isolated region by taking the following steps. Note that the region must already exist on the Content Engine and that the region is not initialized by defining it here. To initialize the region and create a link between the region and a
Installing and configuring Process Engine

135

Content Engine object store, you will need to run Process Configuration Console after installing Application Engine or Workplace XT. As an alternative, define and initialize the isolated region using the peinit command. Complete these procedures on only one node in a Process Engine farm or cluster. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Process Task Manager values, filter by Process Task Manager in the Installation or Configuration Program column. 2. Log on to the Process Engine server as pe_install_user. 3. Start the Process Task Manager, as follows:
Option Windows starting with the default virtual server Windows starting with a named virtual server Description Select Start > Programs > IBM FileNet P8 Platform > Process Engine > Process Task Manager. At a command prompt, change to the installation directory, by default C:\Program Files\IBM\FileNet\ProcessEngine, and enter vwtaskman virtual_server_name where virtual_server_name is the virtual server name.

4. Right-click on Region in the left pane and choose New. Fill in a region number on the General subtab. Use any number between 1 and 999 that has not already been used. See the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Isolated Regions for information on isolated regions. 5. Select a region from the list. 6. On the Security Settings subtab enter the pe_region_admin user name and password. 7. After all parameters have been entered, click Apply. 8. When prompted by Process Task Manager to restart the software, click Yes. Process Task Manager will restart the software automatically on all servers in the farm.

Defining and initializing a Process Engine isolated region silently

Define and initialize a Process Engine isolated region and, if the configuration is for IBM Case Manager, configure the link between the region and a Content Engine object store silently by using the peinit command-line tool. Complete the steps to configure the Process Engine using either the silent or interactive procedures. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Configure and initialize a Process Engine isolated region silently by using the peinit command with appropriate parameters. In this task, you run the commands to:

136

Installation Guide

v Configure a single isolated region v (Case Management only) Configure the symbolic link between an object store and isolated region. These activities are broken into two steps which you must run in the following order. The second step is only required for IBM Case Manager configurations: To configure Process Engine silently: 1. Log on to the Process Engine server. Any user can create the input parameter files. To run most of the commands in the peinit tool, you must enter either the pe_service_user user name and password. To create or modify a region you will need the pe_region_admin user name and password. 2. Run the following command to configure and initialize the isolated region. Enter as a single line:
peinit virtual_server_name -R region_id -p PE_server_DNS name -Y pe_region_admin+pe_region_admin_password

where: region_id identifies the isolated region number to be created and initialized on the Process Engine. virtual_server_name is the name of the virtual server you are defining. If you do not specify the virtual server name, this server name is defined as pesvr.default. If the configuration is for IBM Case Manager, create only one isolated region per database. The region is created and the base classes are transferred to the region. PE_server_DNS name is the DNS name of the Process Engine server. This is the same name used to define the region on the Content Engine. Important: Running this command removes all data in the region. 3. For IBM Case Manager, run the following command to set the link between an object store and the isolated region. Enter as a single line:
peinit virtual_server_name -A region_id -n object_store_symbolic_name -Y pe_region_admin+pe_region_admin_password

where: region_id identifies the isolated region number to be created and initialized on the Process Engine. virtual_server_name is the name of the virtual server you are defining. If you do not specify the virtual server name, this server name is defined as pesvr.default. If the configuration is for IBM Case Manager, create only one isolated region per database. object_store_symbolic_name is the name of the object store you are linking to the isolated region. 4. Log off and log back on before running any other Process Engine program, such as Process Task Manager or Process Configuration Console.

Installing and configuring Process Engine

137

Additional configuration for cluster server environments

You must configure a cluster Generic Application for Process Engine in a cluster server environment. Before beginning this task, make sure you have completed the steps for installing and configuring all Process Engine nodes in the cluster. In a cluster server environment running on Windows, start the Windows Cluster Manager and add a Generic Application to the cluster for the Process Engine Server. 1. Create a Generic Application. a. For the command line value, enter the following:
Process_Engine_installation_directory\startpesvr.bat

where Process_Engine_installation_directory is, by default, C:\Program Files\IBM\FileNet\ProcessEngine. b. For the parameter, enter the name of the Process Engine virtual server. c. Make the resource dependent on the following: v The Process Engine Server Virtual Host name, as entered in Process Task Manager v The IP address of the Process Engine Virtual Server host d. Bring the Process Engine Server online. 2. Take the Process Engine Server offline and install and configure the next node in the cluster. 3. In a clustered configuration, return to the General tab and enter the network cluster virtual name in the Process Engine Server Virtual Host field. On the Advanced tab, change the value on the cluster configuration property name to true.

Configuring SSL communication between Process Engine and Content Engine

Add the CA certificate to the Process Engine private JRE keystore and set the Content Engine URI for the https protocol Use the procedures in this task to configure SSL communication between Process Engine and Content Engine. Complete these procedures on all nodes in a Process Engine farm. 1. On the Process Engine server, add the CA certificate to Process Engine private JRE keystore, if it does not already contain it. This is the Content Engine application server SSL certificate. The private JRE keystore is typically located in the following location:
Option Windows Description \Program Files\IBM\FileNet\Process Engine\java\jre\lib\security

2. Use the keytool to import the CA certificate to the Java keystore. Enter the following as a single line:
\PE_installation_directory\java\jre\bin\keytool -import -file cert_file_name -alias alias -keystore cacerts -storepass password

138

Installation Guide

where: cert_file_name is the full path and file name of the SSL Certificate file you exported from the Content Engine. alias is a unique name identifying the keystore entry. password is the keystore password. The default password is changeit. cacerts is the default keystore for Process Engine and is located in the ../security directory. 3. Change the protocol in the Content Engine URI in Process Task Manager Security settings from http to https and set an appropriate port for the https protocol. For example:
Default Protocol Port App Server HTTPS 9443 WebSphere Application Server Sample URL https://CE_server:9443/wsi/ FNCEWS40MTOM/

Adding instances to a Process Engine farm

Start the Process Task Manager and add additional instances to Process Engine farm. Use the procedures in this task to add instances for Process Engine. Complete these procedures on only one node in a Process Engine farm. The Process Engine software must be installed and the server accessible on the network before starting this procedure. 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Process Task Manager values, filter by Process Task Manager in the Installation or Configuration Program column. 2. Log on to the Process Engine server as pe_install_user. 3. Start the Process Task Manager, as follows:
Option Windows starting with the default virtual server Windows starting with a named virtual server Description Select Start > Programs > IBM FileNet P8 Platform > Process Engine > Process Task Manager. At a command prompt, change to the installation directory, by default C:\Program Files\IBM\FileNet\ProcessEngine, and enter vwtaskman virtual_server_name where virtual_server_name is the virtual server name.

4. In the left pane, right-click Instances and select New. 5. Enter the host name for the new server instance and click Create. | | | |

Verifying Process Engine installation

You can verify your Process Engine installation by creating a workflow. Before starting this task you must install Content Engine and either Workplace or Workplace XT.

Installing and configuring Process Engine

139

| | | | | | | | | | | | | | | | | | | | | | | | | | | | |

If you can complete the steps in this verification test, you will verify that Process Engine is successfully installed, including the following configurations: v Process Engine is successfully using the pe_db_user account to communicate with configured database. v Process Engine is communicating with the client, either Workplace or Workplace XT. v Process Engine is successfully using the pe_service_user account to communicate with Content Engine. To verify Process Engine installation: 1. Verify that you have created an isolated region and a connection point to that region. Remember: When creating the region ID specify the DNS name of the network virtual name for the Process Engine server. 2. Log on to Workplace or Workplace XT. 3. In Site Preferences, select a connection point to use for Tasks functionality. 4. Start the Process Configuration Console and verify that the region has been initialized, the default queues (Inbox, Tracker, Conductor, etc) are setup, and the default roster (DefaultRoster) exists. 5. Create a workflow with Process Designer and start a workflow. 6. Fail over Process Engine in the cluster. 7. Access the user's inbox and retrieve workflow information during/after the failover. There might be a slight delay, but eventually the connection point automatically connects to the Process Engine after the failover. 8. Complete a step in a workflow. 9. Create and start another workflow. 10. Verify that you can access the user's inbox and retrieve workflow information. If you were able to create the workflow, then Process Engine is working properly. If you were not able to create the workflow, see Troubleshooting IBM FileNet Process Engine.

140

Installation Guide

| | | | | | | | | | | | | | | | | | | | | | |

Related tasks Defining a Process Engine isolated region on the Content Engine on page 134 Process Engine clients communicate to isolated regions in the database and to the Process Engine server by using a connection point. Each connection point is associated with an isolated region. In this task, you define an isolated region on the Content Engine. You will later create the same region on the Process Engine. Configuring the Process Engine connection point for Application Engine on page 177 Before users can access Process Engine tasks and work items from Workplace, you must configure the connection point on the Application Engine. Creating a Process Engine Connection Point on page 135 A connection point identifies a specific isolated region of the workflow database, and gives it a name that workflow-related applications use to access the region. Follow these procedures to create a connection point. Defining a Process Engine isolated region interactively on page 135 Start the Process Task Manager and define an isolated region. If the region is defined in Process Task Manager, it must be initialized later using Process Configuration Console After installing Application Engine. Alternatively use the command line tool peinit to define and initialize the region. Defining and initializing a Process Engine isolated region silently on page 136 Define and initialize a Process Engine isolated region and, if the configuration is for IBM Case Manager, configure the link between the region and a Content Engine object store silently by using the peinit command-line tool.

Configuring the Dispatcher service or process in WebSphere Edge Components

If you are configuring a Process Engine server farm to use WebSphere Edge Components as a software load balancer, the Dispatcher service or process in WebSphere Edge Components must be running on the target server. The Dispatcher is used as the software load balancer. Attention: If the WebSphere Edge Components are installed on a Windows server, add the IP address of the Process Engine farm virtual server to the list of IP addresses in the Windows network adapter's Advanced settings. To run the Dispatcher service: 1. Configure and administer the Dispatcher. a. Start the WebSphere Edge Components Load Balancer administration tool to configure the Dispatcher. b. Right-click on Dispatcher and select Connect to Host. c. Click OK. d. Right-click on the Host node and select Start Executor on the server that hosts the WebSphere Edge Components. e. Right-click on the Executor node to add a cluster. f. In the Cluster field, enter the load balancer virtual name. g. In the Cluster Address field, enter the load balancer virtual IP address. h. Click OK. i. Right-click on the cluster and add the Process Engine Main Port and the Process Engine Naming Service Port values. The default values are 32777 and 32776 respectively.
Installing and configuring Process Engine

141

j. Right-click on the Process Engine Main Port number entry to add the Process Engine server nodes that will part of the farm. k. Right-click on the Process Engine Naming Service Port number entry to add the Process Engine server nodes that will be part of the farm. 2. Configure the Process Engine Server Virtual Host. a. On each of the Process Engine servers that you are configuring for load balancing, alias the loopback address to the address of the cluster. This enables the load balanced server to accept requests that were forwarded to its MAC address by the Dispatcher. Follow the steps in the Configuring the server machines section at http://publib.boulder.ibm.com/infocenter/ wasinfo/v7r0/index.jsp?topic=/com.ibm.websphere.edge.doc/lb/info/ae/ tcfg_configservers.html Tip: For more information on aliasing the loopback device on Windows 2008, see http://www.ibm.com/support/docview.wss?rs=250 &context=SSBQMN&dc=DB560&dc=DB520&uid=swg21304795&loc=en_US &cs=UTF-8&lang=en&rss=ct250websphere] 3. Start the connect advisors for ports 32776 and 32777. a. Right-click the Host node under the Dispatcher node and select Start Manager. b. Right-click on the Manager node and select Start Advisor to display a dialog box where you enter advisor information. c. From the Advisor name list box, select Connect. d. In the Cluster name field, enter the load balancer virtual name. e. In the Port Number box, enter 32776 or Process Engine Naming Service Port number. f. Repeat these steps to set up a connector advisor for port 32777 or Process Engine Main Port number. 4. Validate the connect advisor connection. a. Select the advisor for each configured port b. Select the Current Statistics tab in the Dispatcher Administration tool. c. Check the load values of the servers. A load value of -1 indicates the server is not running or the Process Engine node is configured improperly.

142

Installation Guide

Installing and configuring Application Engine

Application Engine provides a client application called Workplace that you can use to access the information managed by Content Engine. After you install the server, you must also configure your application server to work with Application Engine, and deploy the application. 1. Installing Application Engine To enable the web client application, Workplace, install Application Engine on a supported web application server. To complete the installation, provide the necessary parameter values to enable Workplace to access the information that is managed by Content Engine. 2. Installing Application Engine software updates on page 148 If any required fix packs and interim fixes exist for Application Engine, you must install these software updates. 3. Installing the latest Content Engine Client files on Application Engine servers on page 148 The Content Engine Client software enables communication between the Application Engine and the Content Engine. Install the latest release or fix pack version of the Content Engine Client files on all Application Engine servers. 4. Installing the latest Process Engine Client files on Application Engine servers on page 151 The Process Engine Client software enables communication between the Application Engine and the Process Engine. Install the Process Engine Client files on all Application Engine servers. 5. Configuring Application Engine on the application server on page 153 After you complete the Application Engine installation, you must configure Application Engine files and your application sever to enable communication between Application Engine and Content Engine. You can choose the appropriate configuration tasks for your application server type and environment. 6. Deploying Application Engine on the application server on page 165 After you install and configure Application Engine, you must deploy your client application, Workplace, on your application server. You might be required to re-create the WAR or WAR and EAR files before you deploy. 7. Setting Application Engine bootstrap preferences on page 171 By successfully signing in to Workplace and saving the bootstrap preferences, you verify basic Application Engine functionality such as user authentication as well as communication and storing of data in Content Engine. 8. Updating Application Engine settings in a load balanced environment on page 175 You can update Application Engine settings in a load balanced Application Engine environment consisting of a load balancer or proxy device, several HTTP servers and several application server instances.

Installing Application Engine

To enable the web client application, Workplace, install Application Engine on a supported web application server. To complete the installation, provide the necessary parameter values to enable Workplace to access the information that is managed by Content Engine.
Copyright IBM Corp. 2001, 2011

143

Important: In a high availability environment, you must install Application Engine on all nodes in the application server configuration. Even in an application server cluster configuration the Application Engine provides components that run outside of the application server such as the Component Manager. These are only available through an Application Engine installation. If you plan to install and use the IBM FileNet Workplace XT product, you do not need to install Application Engine. To ensure proper functionality and performance, only install one instance of Application Engine per application server (or virtual machine or WebSphere Application Server LPAR). You can, however, deploy multiple instances of a single Application Engine version per application server. Before logging on to Workplace for the first time, at least one object store must exist on the Content Engine to hold the site preferences. See Creating the initial object store on page 85 for more information. You can install a new Application Engine 4.0.2 server within an existing 4.0 IBM FileNet P8 environment if your Content Engine is at version 401.006 or later and your Process Engine is at 403-000.001 or later. The Content Engine and Process Engine client files you install on the Application Engine must match the version of your Content Engine and Process Engine. Note: Verify that the Content Engine and Application Engine clusters have different names. Important: Do NOT install this component unless it is supported at the release levels of your FileNet P8 environment. For information, see the IBM FileNet P8 Hardware and Software Requirements and the IBM FileNet P8 Compatibility Matrix documents. Installing Application Engine interactively You can use the installation wizard to install Application Engine. To complete the installation, provide the necessary parameter values to enable the Application Engine client application, Workplace, to access the information that is managed by Content Engine. Installing Application Engine silently on page 146 You can include the parameters for your Application Engine installation in a silent input file, and then run the installation from a command line. Verifying your Application Engine installation on page 147 You can verify your Application Engine installation by using Workplace. Related information Configuring JBoss Application Server clusters JBoss Application Server servers can be grouped together into a cluster for performance or to provide high availability.

Installing Application Engine interactively

You can use the installation wizard to install Application Engine. To complete the installation, provide the necessary parameter values to enable the Application Engine client application, Workplace, to access the information that is managed by Content Engine. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities.

144

Installation Guide

Important: In a high availability environment, you must install Application Engine on all nodes in the application server configuration. Even in an application server cluster configuration the Application Engine provides components that run outside of the application server such as the Component Manager. These are only available through an Application Engine installation. To install the Application Engine software interactively: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by AE Installer in the Installation or Configuration Program column. 2. In a highly available environment, mount the shared configuration directory from all nodes in the application server configuration. When the location of the shared configuration directory is decided, that directory must be mounted and accessible from all servers in the application server configuration. Also, ensure that the same directory path is used on all systems. If the path on the first system is: //home/AE/Config make sure this same path is available on all other systems. 3. (Highly available environments using IBM WebSphere Application Server or Oracle WebLogic Server) Verify that your application farm or cluster configuration is running. 4. Log on to the application server, as appropriate for your operating system:
Option Windows Description Log on as a member of the local Administrators group or a user with equivalent permissions.

5. Access the IBM FileNet P8 Application Engine 4.0.2.0 installation software. 6. Start the installation program.
Platform Windows Command P8AE-4.0.2.0-WIN.exe

7. Complete the Application Engine installer screens by using the values from your worksheet. Note: In high availability environments, specify the location to hold the Application Engine shared configuration data on the Specify Configuration Directory screen. On the Content Engine API Configuration screen, make sure to specify the proper Content Engine URLs following the format and examples shown in Content Engine in an application server cluster by using EJB transport on page 88. 8. View the app_engine_install_log_4_0_2.txt file, located in AE_install_path/AE/Logs. Verify that no errors or failures were logged. Look for the ERROR designation at the start of a line. Correct any errors before you proceed. 9. In highly available environments, you need to synchronize the UTCryptoKeyFile.properties file across your Application Engine nodes.

Installing and configuring Application Engine

145

Each participating Application Engine server must use the same encryption key file. Copy the UTCryptoKeyFile.properties file installed on the first Application Engine server in your farm to all the other servers in your farm. For information, see the FileNet P8 Developer Help topic Developing IBM FileNet applications > Workplace Development > Workplace Customization Guide > User Tokens > Configuring Applications to Use Tokens. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related information Creating a local or shared directory for the shared configuration files You can create a local or shared directory for the shared configuration files in highly available environments.

Installing Application Engine silently

You can include the parameters for your Application Engine installation in a silent input file, and then run the installation from a command line. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Important: In a high availability environment, you must install Application Engine on all nodes in the application server configuration. Even in an application server cluster configuration the Application Engine provides components that run outside of the application server such as the Component Manager. These are only available through an Application Engine installation. To install the Application Engine software silently: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by AE Installer in the Installation or Configuration Program column. 2. In a highly available environment, mount the shared configuration directory from all nodes in the application server configuration. When the location of the shared configuration directory is decided, that directory must be mounted and accessible from all servers in the application server configuration. Also, ensure that the same directory path is used on all systems. If the path on the first system is: //home/AE/Config make sure this same path is available on all other systems. 3. (Highly available environments using IBM WebSphere Application Server or Oracle WebLogic Server) Verify that your application farm or cluster configuration is running. 4. Log on to the application server, as appropriate for your operating system:
Option Windows Description Log on as a member of the local Administrators group or a user with equivalent permissions.

146

Installation Guide

5. Locate the IBM FileNet P8 Application Engine 4.0.2 installation software package, and copy the appropriate AE_silent_input.txt file to a local directory. 6. Follow the instructions in the silent input file to edit the file to reflect the appropriate responses for your installation. Use the values in your worksheet. Important: If you are modifying the silent input file to perform an upgrade from Application Engine 3.5 to Application Engine 4.0.2 you must modify all instances of AE_install_path in the script as follows: Windows Change ..\FileNet\AE to ..\FileNet Change ..\\Filenet\\AE to ..\\FileNet Note: In high availability environments, specify the location to hold the Application Engine shared configuration data. For Content Engine configuration, make sure to specify the proper Content Engine URLs following the format and examples shown in Content Engine in an application server cluster by using EJB transport on page 88. 7. From a command prompt, navigate to and run the installer. Windows
P8AE-4.0.2.0-Win.exe -options path_to_edited_input_file\AE_silent_input.txt -silent

8. View the app_engine_install_log_4_0_2.txt file, located in AE_install_path/AE/Logs. Verify that no errors or failures were logged. Look for the ERROR designation at the start of a line. Correct any errors before you proceed. 9. In highly available environments, you need to synchronize the UTCryptoKeyFile.properties file across your Application Engine nodes. Each participating Application Engine server must use the same encryption key file. Copy the UTCryptoKeyFile.properties file installed on the first Application Engine server in your farm to all the other servers in your farm. For information, see the FileNet P8 Developer Help topic Developing IBM FileNet applications > Workplace Development > Workplace Customization Guide > User Tokens > Configuring Applications to Use Tokens. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8. Related information Creating a local or shared directory for the shared configuration files You can create a local or shared directory for the shared configuration files in highly available environments.

Verifying your Application Engine installation

You can verify your Application Engine installation by using Workplace. To verify Application Engine installation: 1. Sign in to Workplace: a. On any computer, open a browser and type: http://ApplicationEngineServerName:port#/Workplace
Installing and configuring Application Engine

147

Important: ApplicationEngineServerName cannot be localhost or an IP address. b. Enter a user name and password, and then click Sign in. 2. Use Workplace to browse, search, add a document, and view the Tasks page. 3. In a high availability environment, by using the application server administration tool, verify that the Application Engine application is running. a. Open a Web browser and type in the URL for the Application Engine application. v If you are using a load-balancer or proxy server the URL has the form: Application Engine http://virtual_name:port_number/Workplace v If connecting to an individual cluster node the URL would have the form: Application Engine http://clustered_server_name:port_number/Workplace/ Sign-in by using the virtual name to properly set the base Application Engine URL. If it is not set correctly you must change it in Site Preferences. b. Verify that the sign-in page displays, and log in as a user. c. Fail one of the nodes. d. Verify that you can reload the sign-in page, and log in as the same user. 4. To verify Application Engine is running on a single server installation: a. Access the following URL: http://cpit_server:9080/Workplace b. Log in with the credentials provided in install_path/IBM/cpit/readme.txt. c. Use Workplace to browse, search, add a document, and view the Tasks page.

Installing Application Engine software updates

If any required fix packs and interim fixes exist for Application Engine, you must install these software updates. Remember: In farm and cluster environments, install Application Engine software updates on all nodes. To install the Application Engine software updates: 1. Access the IBM FileNet P8 Platform support site to obtain the latest Application Engine software updates. 2. Open the readmes for any subsequent fix packs or interim fixes (typically optional) and perform the installation procedures provided.

Installing the latest Content Engine Client files on Application Engine servers
The Content Engine Client software enables communication between the Application Engine and the Content Engine. Install the latest release or fix pack version of the Content Engine Client files on all Application Engine servers. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities.

148

Installation Guide

Installing the latest Content Engine Client files on Application Engine servers interactively The installation wizard provides an interactive way to install the Content Engine Client files. You can use the values from your worksheet to fill in the required value for each field on the wizard screens. Installing the latest Content Engine Client files on Application Engine servers silently on page 150 The command-line method provides a way to silently install the Content Engine Client files. You can use the values in your installation worksheet to edit the silent input text file before you run the installation. Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Content Engine Client files on Application Engine servers interactively
The installation wizard provides an interactive way to install the Content Engine Client files. You can use the values from your worksheet to fill in the required value for each field on the wizard screens. Important: Be sure that Content Engine is running before you start installing Content Engine Client files. To install the Content Engine Client files interactively: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Client Installer in the Installation or Configuration Program column. 2. On the machine where Application Engine is installed, log on as any user who has the following permissions: v Read and write permission to a temporary directory, such as temp (Windows) or tmp (UNIX), on the machine where Application Engine is installed v Execute permission on the Content Engine Client install software 3. Copy the Content Engine Client installation software from the Content Engine installation software to the temporary directory. The version of the client installation software must match the version of Content Engine. 4. Expand the compressed Content Engine Client installation software file in the temporary directory. 5. Access the IBM FileNet Content Engine Client update software in the temporary directory. 6. Run the following command:
Operating System Windows Install Program 5.1.0-P8CE-CLIENT-WIN.EXE

7. Complete the installation screens by using the values from your worksheet. 8. Complete the installation program wizard by using the values from your worksheet.

Installing and configuring Application Engine

149

9. When the installation completes, check the Content Engine Client log file for errors. The path to the log file depends on the type of operating system on the machine where you installed the Content Engine Client files:
Operating System Path to Log File C:\Program Files\IBM\FileNet\CEClient\ ceclient_install_log_5.1.0.txt

| |

Windows

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Content Engine Client files on Application Engine servers silently
The command-line method provides a way to silently install the Content Engine Client files. You can use the values in your installation worksheet to edit the silent input text file before you run the installation. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Important: Be sure that Content Engine is running before you start installing Content Engine Client files. To install the latest Content Engine Client files on Application Engine servers silently: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Client Installer in the Installation or Configuration Program column. 2. On the machine where Application Engine is installed, log on as any user who has the following permissions: v Read and write permission to a temporary directory, such as temp (Windows) or tmp (UNIX), on the machine where Application Engine is installed v Execute permission on the Content Engine Client install software 3. Copy the Content Engine Client installation software from the Content Engine installation software to the temporary directory. The version of the client installation software must match the version of Content Engine. 4. Expand the compressed Content Engine Client installation software file in the temporary directory. 5. Make a backup copy of the ceclient_silent_install.txt input file in the temporary directory. 6. Open the silent input file in a text editor. Follow the instructions in the silent input file to edit the file to reflect the appropriate responses for your update. Use the values from your worksheet. 7. Navigate to the temporary directory path containing the Content Engine Client installation program, and run the following command, where: path is the path that contains the installation program.

150

Installation Guide

Operating System Windows

Install Program 5.1.0-P8CE-CLIENT-WIN.EXE -f path\CEClient.Windows\ ceclient_silent_install.txt -i silent

8. When the installation completes, check the Content Engine Client log file for errors. The path to the log file depends on the type of operating system on the machine where you installed the Content Engine Client files:
Operating System Path to Log File C:\Program Files\IBM\FileNet\CEClient\ ceclient_install_log_5.1.0.txt

| |

Windows

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Process Engine Client files on Application Engine servers
The Process Engine Client software enables communication between the Application Engine and the Process Engine. Install the Process Engine Client files on all Application Engine servers. Installing the latest Process Engine Client files interactively The installation wizard provides an interactive way to install the Process Engine Client files. You can use the values you collected on your worksheet to fill in the required value for each field on the wizard screens. Installing the latest Process Engine Client files silently on page 152 You can install the Process Engine Client software on the Application Engine by using a silent input text file and running the installation program from the command line. Use the values in your installation worksheet to edit the silent input text file before you run the installation.

Installing the latest Process Engine Client files interactively

The installation wizard provides an interactive way to install the Process Engine Client files. You can use the values you collected on your worksheet to fill in the required value for each field on the wizard screens. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install the Process Engine Client files: 1. In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by PE Client Installer in the Installation or Configuration Program column. 2. On the machine where Application Engine is to be deployed, log on as the ae_install_user. 3. Copy the Process Engine Client install software from the Process Engine installation software to the temporary directory. The version of the install software must match the version of Process Engine.

Installing and configuring Application Engine

151

4. Expand the compressed Process Engine Client install software file within the temporary directory. The jre.tar file that is packaged with the Process Engine Client installer must be in the same directory as the Process Engine Client installer when the installer is run. The expanded install software contains the Process Engine Client install program specific to the operating system on the machine where Application Engine is deployed. 5. Start the installation program by running the following command:
Operating System Windows Install Program 5.0.0-P8PE-CLIENT--WIN.EXE

6. Complete the installation screens by using the values from your worksheet. 7. If the Process Engine is configured to use the IPv6 network protocol, locate and edit the taskman.properties file and add the following lines to that file:
-Djava.net.preferIPv6Addresses=true -Djava.net.preferIPv4Stack=false

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Installing the latest Process Engine Client files silently

You can install the Process Engine Client software on the Application Engine by using a silent input text file and running the installation program from the command line. Use the values in your installation worksheet to edit the silent input text file before you run the installation. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install the Process Engine Client files: 1. In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by PE Client Installer in the Installation or Configuration Program column. 2. On the machine where Application Engine is to be deployed, log on as the ae_install_user. 3. Copy the Process Engine Client install software from the Process Engine installation software to the temporary directory. The version of the install software must match the version of Process Engine. 4. Expand the compressed Process Engine Client install software file within the temporary directory. The jre.tar file that is packaged with the Process Engine Client installer must be in the same directory as the Process Engine Client installer when the installer is run. The expanded install software contains the Process Engine Client install program specific to the operating system on the machine where Application Engine is deployed. 5. Edit the peclient_silent_install.txt file using the values from your Installation and Upgrade Worksheet. 6. Start the installation program by running the following command:
Operating System Windows Install Program 5.0.0-P8PE-CLIENT-WIN.EXE -f peclient_silent_install.txt

152

Installation Guide

7. If the Process Engine is configured to use the IPv6 network protocol, locate and edit the taskman.properties file and add the following lines to that file:
-Djava.net.preferIPv6Addresses=true -Djava.net.preferIPv4Stack=false

Related concepts Installation and upgrade worksheet For more information about the installation and upgrade worksheet, see the worksheet topics in Plan and Prepare Your Environment for IBM FileNet P8.

Configuring Application Engine on the application server

After you complete the Application Engine installation, you must configure Application Engine files and your application sever to enable communication between Application Engine and Content Engine. You can choose the appropriate configuration tasks for your application server type and environment. (Farm of independent application server instances) Configure and deploy the Application Engine on each node. When installing in farm of independent application server instances, the steps shown for deploying Application Engine on the application server must be performed on every node. Important: Since there is no central administration server, every server acts as a separate server instance and must be configured as such. Configuring Application Engine on WebSphere Application Server After you install the Application Engine server, you must configure WebSphere Application Server to work with Application Engine. You can also configure changes for optional modes like SSO.

Configuring Application Engine on WebSphere Application Server

After you install the Application Engine server, you must configure WebSphere Application Server to work with Application Engine. You can also configure changes for optional modes like SSO. Remember: In farm and cluster environments, configure Application Engine on WebSphere Application Server on all nodes. Editing web.xml for container-managed authentication on page 154 You can choose to use WebSphere Application Server with container-managed authentication. To enable this optional authentication approach, edit the web.xml file on the WebSphere Application Server. Editing web.xml for SSO on page 156 You can use SSO with a proxy server in your Application Engine environment. To enable this optional approach, edit the web.xml file on the WebSphere Application Server. Configuring Java Virtual Machine settings for JAAS login and memory on page 159 Use the Java Virtual Machine settings in the WebSphere Application Server to set up JAAS login information for authentication and memory settings for resource usage. Configuring Lightweight Third Party Authentication (LTPA) on page 161 To set up LTPA security, configure settings to match on both the Content Engine application server and the Application Engine application server. If your

Installing and configuring Application Engine

153

Application Engine and Content Engine are on the same WebSphere Application Server, you are not required to configure LTPA. Configuring stand-alone Lightweight Directory Access Protocol (LDAP) on page 163 To enable LDAP communication between Application Engine and Content Engine, you must configure settings on the WebSphere Application Server. It is recommended that the LDAP configuration settings match those set on the application server where Content Engine is installed. Configuring Lightweight Directory Access Protocol (LDAP) for federated repositories on page 164 If you have a multiple domain environment, configure LDAP settings for federated repositories on the WebSphere Application Server to enable LDAP communication between Application Engine and Content Engine. It is recommended that the LDAP configuration settings match those set on the application server where Content Engine is installed.

Editing web.xml for container-managed authentication

You can choose to use WebSphere Application Server with container-managed authentication. To enable this optional authentication approach, edit the web.xml file on the WebSphere Application Server. 1. Make a backup copy of web.xml. AE_install_path/Workplace/WEB-INF/web.xml 2. Open web.xml for editing, search for the parameter challengeProxyEnabled, and set it to false.
<param-name>challengeProxyEnabled</param-name> <param-value> false </param-value>

3. Search for the first instance of <web-resource-collection>, and uncomment the <url-pattern> as noted in the file comments.
<web-resource-collection> <web-resource-name>action</web-resource-name> <description>Define thecontainer secured resource</description> <url-pattern>/containerSecured/*</url-pattern> <!-Uncomment this section if all resources that require credentials must be secured in order to obtain a secured Thread. If using WebSphere, this section must be uncommented. --> Move this commenting tag here from just before the </web-resource- collection> closing tag below. <url-pattern>/containerSecured/*</url-pattern> <url-pattern>/</url-pattern> <url-pattern>/author/*</url-pattern> <url-pattern>/Browse.jsp</url-pattern> <url-pattern>/eprocess/*</url-pattern> <url-pattern>/Favorites.jsp</url-pattern> <url-pattern>/GetPortalSitePreferences.jsp</url-pattern> <url-pattern>/GetTokenSignIn.jsp</url-pattern> <url-pattern>/GetUserInformation.jsp</url-pattern> <url-pattern>/GetUserToken.jsp</url-pattern> <url-pattern>/HomePage.jsp</url-pattern> <url-pattern>/IntegrationWebBasedHelp.jsp</url-pattern> <url-pattern>/is/*</url-pattern> <url-pattern>/operations/*</url-pattern> <url-pattern>/properties/*</url-pattern> <url-pattern>/redirect/*</url-pattern> <url-pattern>/regions/*</url-pattern> <url-pattern>/Search.jsp</url-pattern> <url-pattern>/select/*</url-pattern> <url-pattern>/SelectReturn.jsp</url-pattern> <url-pattern>/Tasks.jsp</url-pattern>

154

Installation Guide

<url-pattern>/UI-INF/*</url-pattern> <url-pattern>/utils/*</url-pattern> <url-pattern>/WcmAdmin.jsp</url-pattern> <url-pattern>/WcmAuthor.jsp</url-pattern> <url-pattern>/WcmBootstrap.jsp</url-pattern> <url-pattern>/WcmCloseWindow.jsp</url-pattern> <url-pattern>/WcmDefault.jsp</url-pattern> <url-pattern>/WcmError.jsp</url-pattern> <url-pattern>/WcmJavaViewer.jsp</url-pattern> <url-pattern>/WcmObjectBookmark.jsp</url-pattern> <url-pattern>/WcmQueueBookmark.jsp</url-pattern> <url-pattern>/WcmSignIn.jsp</url-pattern> <url-pattern>/WcmSitePreferences.jsp</url-pattern> <url-pattern>/WcmUserPreferences.jsp</url-pattern> <url-pattern>/WcmWorkflowsBookmark.jsp</url-pattern> <url-pattern>/wizards/*</url-pattern> <url-pattern>/Author/*</url-pattern> <url-pattern>/axis/*.jws</url-pattern> <url-pattern>/Browse/*</url-pattern> <url-pattern>/ceTunnel</url-pattern> <url-pattern>/CheckoutList/*</url-pattern> <url-pattern>/downloadMultiTransferElement/*</url-pattern> <url-pattern>/ExternalUrl/*</url-pattern> <url-pattern>/findRecordTarget</url-pattern> <url-pattern>/formCallback/*</url-pattern> <url-pattern>/getAnnotSecurity/*</url-pattern> <url-pattern>/getCEAnnotations/*</url-pattern> <url-pattern>/getContent/*</url-pattern> <url-pattern>/getForm/*</url-pattern> <url-pattern>/getISAnnotations/*</url-pattern> <url-pattern>/getISAnnotSecurity/*</url-pattern> <url-pattern>/getISContent/*</url-pattern> <url-pattern>/getMultiContent/*</url-pattern> <url-pattern>/getPreview</url-pattern> <url-pattern>/getProcessor/*</url-pattern> <url-pattern>/getRealms/*</url-pattern> <url-pattern>/getUsersGroups/*</url-pattern> <url-pattern>/Inbox/*</url-pattern> <url-pattern>/integrationCommandProxy</url-pattern> <url-pattern>/integrationResponse</url-pattern> <url-pattern>/integrationResponseProxy</url-pattern> <url-pattern>/integrationWebBasedCommand</url-pattern> <url-pattern>/keepAlive</url-pattern> <url-pattern>/launch/*</url-pattern> <url-pattern>/PublicQueue/*</url-pattern> <url-pattern>/putContent/*</url-pattern> <url-pattern>/QuickSearch/*</url-pattern> <url-pattern>/signingServlet/*</url-pattern> <url-pattern>/transport/*</url-pattern> <url-pattern>/upload/*</url-pattern> <url-pattern>/vwsimsoapservlet</url-pattern> <url-pattern>/vwsoaprouter</url-pattern> <url-pattern>/Workflows/*</url-pattern> Move the closing comment tag from here to the location indicated at the beginning of this example. </web-resource-collection>

4. Locate the section <auth-constraint>, comment the wildcard (*) <role-name> as noted in the file comments.
<auth-constraint> <!-- <role-name>*</role-name> --> <!-- For WebSphere 6, use the role-name line below instead of the wildcard role above. --> <role-name>All Authenticated</role-name> <!-- For WebSphere 6, add this
Installing and configuring Application Engine

155

security-role element below the login-config element (below). <security-role> <description>All Authenticated</description> <role-name>All Authenticated</role-name> </security-role> --> </auth-constraint>

5.

Locate the end of the </login-config> element, and add the All Authenticated users role-element after the closing tag.
<security-role> <description>All Authenticated</description> <role-name>All Authenticated</role-name> </security-role>

6. Search for the first instance of a <security-constraint> tag, and add the following <security-constraint> tag before that tag. Important: Enter the information below as single lines without line breaks.
<security-constraint> <web-resource-collection> <web-resource-name>action</web-resource-name> <description>Define the non-secured resource</description> <url-pattern>/P8BPMWSBroker/*</url-pattern> </web-resource-collection> </security-constraint>

7. Save your changes to web.xml and close the file.

Editing web.xml for SSO

You can use SSO with a proxy server in your Application Engine environment. To enable this optional approach, edit the web.xml file on the WebSphere Application Server. 1. Make a backup copy of web.xml. AE_install_path/Workplace/WEB-INF/web.xml 2. Open web.xml for editing, search for the parameter challengeProxyEnabled, and set it to false.
<param-name>challengeProxyEnabled</param-name> <param-value> false </param-value>

3. Search for the first instance of <web-resource-collection>, and uncomment the <url-pattern> as noted in the file comments.
<web-resource-collection> <web-resource-name>action</web-resource-name> <description>Define thecontainer secured resource</description> <url-pattern>/containerSecured/*</url-pattern> <!-Uncomment this section if all resources that require credentials must be secured in order to obtain a secured Thread. If using WebSphere, this section must be uncommented. --> Move this commenting tag here from just before the </web-resource- collection> closing tag below. <url-pattern>/containerSecured/*</url-pattern> <url-pattern>/</url-pattern> <url-pattern>/author/*</url-pattern> <url-pattern>/Browse.jsp</url-pattern> <url-pattern>/eprocess/*</url-pattern> <url-pattern>/Favorites.jsp</url-pattern> <url-pattern>/GetPortalSitePreferences.jsp</url-pattern> <url-pattern>/GetTokenSignIn.jsp</url-pattern> <url-pattern>/GetUserInformation.jsp</url-pattern> <url-pattern>/GetUserToken.jsp</url-pattern> <url-pattern>/HomePage.jsp</url-pattern>

156

Installation Guide

<url-pattern>/IntegrationWebBasedHelp.jsp</url-pattern> <url-pattern>/is/*</url-pattern> <url-pattern>/operations/*</url-pattern> <url-pattern>/properties/*</url-pattern> <url-pattern>/redirect/*</url-pattern> <url-pattern>/regions/*</url-pattern> <url-pattern>/Search.jsp</url-pattern> <url-pattern>/select/*</url-pattern> <url-pattern>/SelectReturn.jsp</url-pattern> <url-pattern>/Tasks.jsp</url-pattern> <url-pattern>/UI-INF/*</url-pattern> <url-pattern>/utils/*</url-pattern> <url-pattern>/WcmAdmin.jsp</url-pattern> <url-pattern>/WcmAuthor.jsp</url-pattern> <url-pattern>/WcmBootstrap.jsp</url-pattern> <url-pattern>/WcmCloseWindow.jsp</url-pattern> <url-pattern>/WcmDefault.jsp</url-pattern> <url-pattern>/WcmError.jsp</url-pattern> <url-pattern>/WcmJavaViewer.jsp</url-pattern> <url-pattern>/WcmObjectBookmark.jsp</url-pattern> <url-pattern>/WcmQueueBookmark.jsp</url-pattern> <url-pattern>/WcmSignIn.jsp</url-pattern> <url-pattern>/WcmSitePreferences.jsp</url-pattern> <url-pattern>/WcmUserPreferences.jsp</url-pattern> <url-pattern>/WcmWorkflowsBookmark.jsp</url-pattern> <url-pattern>/wizards/*</url-pattern> <url-pattern>/Author/*</url-pattern> <url-pattern>/axis/*.jws</url-pattern> <url-pattern>/Browse/*</url-pattern> <url-pattern>/ceTunnel</url-pattern> <url-pattern>/CheckoutList/*</url-pattern> <url-pattern>/downloadMultiTransferElement/*</url-pattern> <url-pattern>/ExternalUrl/*</url-pattern> <url-pattern>/findRecordTarget</url-pattern> <url-pattern>/formCallback/*</url-pattern> <url-pattern>/getAnnotSecurity/*</url-pattern> <url-pattern>/getCEAnnotations/*</url-pattern> <url-pattern>/getContent/*</url-pattern> <url-pattern>/getForm/*</url-pattern> <url-pattern>/getISAnnotations/*</url-pattern> <url-pattern>/getISAnnotSecurity/*</url-pattern> <url-pattern>/getISContent/*</url-pattern> <url-pattern>/getMultiContent/*</url-pattern> <url-pattern>/getPreview</url-pattern> <url-pattern>/getProcessor/*</url-pattern> <url-pattern>/getRealms/*</url-pattern> <url-pattern>/getUsersGroups/*</url-pattern> <url-pattern>/Inbox/*</url-pattern> <url-pattern>/integrationCommandProxy</url-pattern> <url-pattern>/integrationResponse</url-pattern> <url-pattern>/integrationResponseProxy</url-pattern> <url-pattern>/integrationWebBasedCommand</url-pattern> <url-pattern>/keepAlive</url-pattern> <url-pattern>/launch/*</url-pattern> <url-pattern>/PublicQueue/*</url-pattern> <url-pattern>/putContent/*</url-pattern> <url-pattern>/QuickSearch/*</url-pattern> <url-pattern>/signingServlet/*</url-pattern> <url-pattern>/transport/*</url-pattern> <url-pattern>/upload/*</url-pattern> <url-pattern>/vwsimsoapservlet</url-pattern> <url-pattern>/vwsoaprouter</url-pattern> <url-pattern>/Workflows/*</url-pattern> Move the closing comment tag from here to the location indicated at the beginning of this example. </web-resource-collection>

Installing and configuring Application Engine

157

4. Locate the section <auth-constraint>, comment the wildcard (*) <role-name> as noted in the file comments.
<auth-constraint> <!-- <role-name>*</role-name> --> <!-- For WebSphere 6, use the role-name line below instead of the wildcard role above. --> <role-name>All Authenticated</role-name> <!-- For WebSphere 6, add this security-role element below the login-config element (below). <security-role> <description>All Authenticated</description> <role-name>All Authenticated</role-name> </security-role> --> </auth-constraint>

5.

Locate the end of the </login-config> element, and add the All Authenticated users role-element after the closing tag.
<security-role> <description>All Authenticated</description> <role-name>All Authenticated</role-name> </security-role>

6. Search for the first instance of a <security-constraint> tag, and add the following <security-constraint> tag before that tag. Important: Enter the information below as single lines without line breaks.
<security-constraint> <web-resource-collection> <web-resource-name>action</web-resource-name> <description>Define the non-secured resource</description> <url-pattern>/P8BPMWSBroker/*</url-pattern> </web-resource-collection> </security-constraint>

7.

At the end of web.xml, comment out the <login-config> element.

<!-<login-config> <auth-method>FORM</auth-method> <realm-name>AE Workplace</realm-name> <form-login-config> <form-login-page>/ContainerLogin.jsp</form-login-page> <form-error-page>/ContainerError.jsp</form-error-page> </form-login-config> </login-config> -->

8. As needed, set the ssoProxyContextPath, ssoProxyHost, ssoProxyPort, and ssoProxySSLPort. These parameter values are used to modify one or more elements of the native URL that Workplace sees on a request. Wherever the value of an SSO proxy host element in the URL request is different from the equivalent information for the host where Workplace is deployed, you must set the corresponding SSO <proxy host element> parameter for that element in the URL to the value for the SSO proxy host.
<init-param> <param-name>ssoProxyContextPath</param-name> <param-value></param-value> </init-param> <init-param> <param-name>ssoProxyHost</param-name>

158

Installation Guide

<param-value></param-value> </init-param> <init-param> <param-name>ssoProxyPort</param-name> <param-value></param-value> </init-param> <init-param> <param-name>ssoProxySSLPort</param-name> <param-value></param-value> </init-param>

In general, the <init-param> parameters must be configured as follows: ssoProxyContextPath Set the value to the context path of the SSO proxy host URL. This is the path portion of the URL that appears after the server name, and which represents top-level access to the Workplace application. For example, if the Workplace deployment host URL is http://deploy_server:2809/Workplace and the SSO proxy host URL is http://sso_proxy_server.domain.com/fn/Workplace, then use the following setting:
<param-name>ssoProxyContextPath</param-name> <param-value>/Workplace</param-value>

ssoProxyHost Set the value to the SSO proxy host server name. Typically, this is a full domain-qualified host name. For example, if the host URL where Workplace is deployed is http://deploy_server/Workplace and the corresponding SSO proxy host URL is http://sso_proxy_server/Workplace, then use the following setting:
<param-name>ssoProxyHost</param-name> <param-value>sso_proxy_server</param-value>

ssoProxyPort Set the value to the http port on the SSO proxy host. For example:
<param-name>ssoProxyPort</param-name> <param-value>80</param-value>

ssoProxySSLPort Set the value to the https port on the SSO proxy host, if defined or used to access Workplace pages. For example:
<param-name>ssoProxySSLPort</param-name> <param-value>443</param-value>

9.

Save your changes to web.xml and close the file.

Configuring Java Virtual Machine settings for JAAS login and memory
Use the Java Virtual Machine settings in the WebSphere Application Server to set up JAAS login information for authentication and memory settings for resource usage. Remember: In high availability clustered server configurations, for steps that require Java Virtual Machine (JVM) settings to be made make sure to make these changes for every node in the application server configuration. 1. Log in to the WebSphere administrative console.
Installing and configuring Application Engine

159

2. Navigate to the Java Virtual Machine settings.

Option WebSphere Application Server 6.1 Description Servers > Application Servers > server_name > Java & Process Management > Process Definition > Java Virtual Machine Servers > Server Types > WebSphere application servers > server_name > Java & Process Management > Process Definition > Java Virtual Machine

WebSphere Application Server 7.0

3. In the Generic JVM arguments field, add the following entry:

-Djava.security.auth.login.config=AE_install_path \CE_API\config\jaas.conf.WebSphere

Replace AE_install_path in the entry above with your actual installation path, for example: UNIX:
-Djava.security.auth.login.config=opt/FileNet/AE /CE_API/config/jaas.conf.WebSphere

Windows:
-Djava.security.auth.login.config=C:\Progra~1\FileNet\AE \CE_API\config\jaas.conf.WebSphere

Windows 64-bit server with Application Engine installed in the Program Files (x86) directory:
-Djava.security.auth.login.config=C:\Progra~2\FileNet\AE \CE_API\config\jaas.conf.WebSphere

Your path might be slightly different based on the version of your client installations, or whether you have chosen a custom path for the installation. Verify the location of this file and specify the install path location before you enter the path. Important: Do not copy and paste the text from this guide into the field in the console because hidden formatting can cause problems with the entry. Use a paste special option in a text editor to remove formatting first, or type the entry into the field. Important: (Windows only) The path cannot contain a space. You must use 8.3-notation for the install path portion of the full JAAS login entry described above. If AE_install_path is: C:\Program Files\FileNet\AE use: C:\Progra~1\FileNet\AE 4. Set the Initial heap size and Maximum heap size, and save your changes. For example, you might set the Initial heap size to 512 and the Maximum heap size to 1024. However, these values vary significantly depending on your machine size. Refer to your application server vendor recommendation for Initial heap size and Maximum heap size values. For IBM specific recommendations, see the IBM FileNet P8 Performance Tuning Guide. 5. (For installations with Content Engine and Application Engine collocated on the WebSphere server, but in different WebSphere profiles) Create an additional JVM property for different WebSphere profiles.

160

Installation Guide

Perform the following steps on both the Content Engine profile and the Application Engine profile: a. In the Java Virtual Machine settings, create a Custom Property:
com.ibm.websphere.orb.uniqueServerName

b. Set the Value to true. c. Save your changes. d. Restart WebSphere Application Server. Related information Product documentation for IBM FileNet P8 Platform Download the IBM FileNet P8 Performance Tuning Guide, as well as PDFs of the rest of the IBM FileNet P8 Platform documentation.

Configuring Lightweight Third Party Authentication (LTPA)

To set up LTPA security, configure settings to match on both the Content Engine application server and the Application Engine application server. If your Application Engine and Content Engine are on the same WebSphere Application Server, you are not required to configure LTPA. Note: If your environment uses Workplace XT, follow the instructions for configuring Light weight Third Party Authentication (LTPA) in the IBM FileNet Workplace XT Installation and Upgrade Guide. Important: In a highly available WebSphere environment whereContent Engine and Application Engine are managed by different deployment managers, perform any LTPA configuration steps on the administrative server only. The scope of this action will affect the entire application server configuration. If you are already using LTPA with your Content Engine application server, you must export only the existing keys and copy the key file to the Application Engine server. Check with your Content Engine administrator. To configure LTPA: 1. On the Content Engine server, log in to the WebSphere administrative console. 2. Navigate to the LTPA settings page.
Option WebSphere Application Server 6.1 Description 1. Navigate to Security > Secure administration, applications, and infrastructure. 2. From the right side of the panel, select Authentication Mechanisms and expiration. WebSphere Application Server 7.0 1. Navigate to Security > Global security. 2. From the right side of the panel, select LTPA.

3. Enter a value for the LTPA timeout that is larger than the default. For example, if the timeout value is left at the default value of 120 minutes, the LTPA key expires after 2 hours. Users will not be able to log in to Workplace after being logged in for 2 hours. Important: In high availability environments, set the timeout value for forwarded credentials between servers:
Installing and configuring Application Engine

161

Option WebSphere Application Server 6.1 WebSphere Application Server 7.0

Description 35971 60000

4. Save your changes. 5. In the box for Cross-cell single sign-on, type a password to create the LTPA password. For password restrictions, see the WebSphere Application Server documentation. If you have already configured Content Engine for LTPA, use the existing password in the Application Engine configuration. 6. Enter the fully qualified path for the Key File Name. For example, /opt/LTPA/ltpa_key_name. 7. Click Export keys. Verify that a message like the following message is displayed: The keys were successfully exported to the file ltpa_key_name. 8. Click OK, then click Save changes directly to the master configuration. 9. Stop and restart the WebSphere Application Server instance. 10. Copy the key file from the Content Engine server location you specified to a directory on the Application Engine server. For example, /opt/LTPA/ ltpa_key_name 11. On the Application Engine server, log in to the WebSphere administrative console. 12. Navigate to the LTPA settings page.
Option WebSphere Application Server 6.1 Description 1. Navigate to Security > Secure administration, applications, and infrastructure. 2. From the right side of the panel, select Authentication Mechanisms and expiration. WebSphere Application Server 7.0 1. Navigate to Security > Global security. 2. From the right side of the panel, select LTPA.

13. Enter a value for the LTPA timeout that is larger than the default. For example, if the timeout value is left at the default value of 120 minutes, the LTPA key expires after 2 hours. Users will not be able to log in to Workplace after being logged in for 2 hours. Note: In high availability environments, set the timeout to 60,000. Save your changes. In the box for Cross-cell single sign-on, type and confirm the LTPA password you created for Content Engine. For password restrictions, see the WebSphere Application Server documentation. If you have already configured Content Engine for LTPA, use the existing password in the Application Engine configuration. Specify the path for the key file that you copied to the Application Engine server. For example, /opt/LTPA/ltpa_key_name. Click Import keys. Verify that a message like the following one is displayed: The keys were successfully imported from the file ltpa_key_name.

14. 15.

16. 17.

162

Installation Guide

18. Save your changes. In a highly available environment, synchronize the changes across all nodes after saving your configuration settings. Related tasks Starting or stopping an application server instance Related information Configuring LTPA for Workplace XT on WebSphere Application Server To set up LTPA security, you must configure settings to match on both the Content Engine Web application server and the Workplace XT Web application server. If your Workplace XT and Content Engine are on the same WebSphere Application Server, you do not need to configure LTPA.

Configuring stand-alone Lightweight Directory Access Protocol (LDAP)

To enable LDAP communication between Application Engine and Content Engine, you must configure settings on the WebSphere Application Server. It is recommended that the LDAP configuration settings match those set on the application server where Content Engine is installed. | | | | Important: If you are using WebSphere Application Server Network Deployment and Application Engine is to be deployed where Content Engine is deployed, you do not need to complete this task because you already configured LDAP as part of configuring Content Engine. To configure stand-alone Lightweight Directory Access Protocol (LDAP): 1. Open the WebSphere administrative console. 2. Navigate to the security settings page.
Option WebSphere Application Server 6.1 Description Navigate to Security > Secure administration, applications, and infrastructure. Navigate to Security > Global security.

WebSphere Application Server 7.0

3. Disable security by using the following Security settings: v Disable (clear) the Enable Administrative Security flag. v Disable (clear) the Enable application security flag. v Disable (clear) the Java 2 security flag. 4. From the bottom of the panel, in the dropdown list called Available realm definitions, select Standalone LDAP registry and click Configure. 5. Configure the LDAP provider to exactly match the corresponding settings on the Content Engine application server. Tip: Open the WebSphere administrative console for Content Engine to the same panels to see and copy all settings. v Primary administrative user name v Select Automatically generated server identity. v Type v Host v Port v Base distinguished name (DN)
Installing and configuring Application Engine

163

v Bind distinguished name (DN) v Bind password 6. Configure the LDAP user registry settings to exactly match the corresponding settings on the Content Engine application server. Tip: Open the WebSphere administrative console for Content Engine to the same panel to see and copy all settings. v User filter v Group filter v User ID map v Group member ID map v Certificate map mode v Certificate filter 7. Save these settings. 8. Next to Available realm definitions, ensure that Standalone LDAP registry is still selected, and click Set as current. 9. Set the following Security flags: v Enable (select) the Enable Administrative Security flag. v Enable (select) the Enable application security flag. v Disable (clear) the Java 2 security flag. The IBM FileNet P8 Platform utilizes LDAP-based security, and does not support Java 2 security. Enabling Java 2 security will cause unexpected behavior. 10. Save your changes to the master configuration. 11. Restart the WebSphere instance. 12. Test the connection on the Standalone LDAP registry page. If the test fails, correct the error before proceeding. If it passes, click OK to return to the previous page.

Configuring Lightweight Directory Access Protocol (LDAP) for federated repositories

If you have a multiple domain environment, configure LDAP settings for federated repositories on the WebSphere Application Server to enable LDAP communication between Application Engine and Content Engine. It is recommended that the LDAP configuration settings match those set on the application server where Content Engine is installed. Important: If you are using federated repositories, your WebSphere administrative console user cannot have the same username or ID as a user in the LDAP repository. Important: If you are using WebSphere Application Server Network Deployment and Application Engine is to be deployed where Content Engine is deployed, you do not need to complete this task. To configure Lightweight Directory Access Protocol (LDAP) for federated repositories: 1. Open the WebSphere administrative console. 2. Navigate to the security settings page.

164

Installation Guide

Option WebSphere Application Server 6.1

Description Navigate to Security > Secure administration, applications, and infrastructure. Navigate to Security > Global security.

WebSphere Application Server 7.0

3. Set the following Security flags: v Disable (clear) the Enable Administrative Security flag. v Disable (clear) the Enable application security flag. v Disable (clear) the Java 2 security flag. 4. From the bottom of the panel, in the dropdown list called Available realm definitions, select Federated Repositories and click Configure. 5. Configure the LDAP provider to exactly match the corresponding General Properties on the Content Engine application server. Tip: Open the WebSphere administrative console for Content Engine to the same panels to see and copy all settings. v Realm name v Primary administrative user name v Select Automatically generated server identity. v Ignore case for authorization v Repositories in the realm 6. Save these settings. 7. Next to Available realm definitions, ensure that Federated repositories is still selected, and click Set as current. 8. Set the following Security flags: v Enable (select) the Enable Administrative Security flag. v Enable (select) the Enable application security flag. v Disable (clear) the Java 2 security flag. The IBM FileNet P8 Platform utilizes LDAP-based security, and does not support Java 2 security. Enabling Java 2 security causes unexpected behavior. 9. Save your changes to the master configuration. 10. Restart the WebSphere instance. 11. Test the connection to the repository. a. In the WebSphere administrative console, navigate to Users and Groups > Manage Users. b. Click Search By User ID, and enter a known user. c. Click Search. This should return the user from the configured LDAP repository. Related tasks Starting or stopping an application server instance

Deploying Application Engine on the application server

After you install and configure Application Engine, you must deploy your client application, Workplace, on your application server. You might be required to re-create the WAR or WAR and EAR files before you deploy.

Installing and configuring Application Engine

165

Important: In a high availability environment, for steps that require Java Virtual Machine (JVM) settings to be made make sure to make these changes for every node in the application server configuration: v web.xml file If you need to edit the web.xml file as part of deployment, for example if you are using single sign-on (SSO), make these changes from the administrative server node only. In addition, to include these changes you must recreate the WAR or EAR file before deploying the application. Most application server cluster configurations deploy an application to managed servers by copying the application files from the administrative node to the managed server, and only changes made on the administrative node are deployed to the configuration.

Tip: An additional method for deploying applications to an application server cluster is to maintain a copy of the application on all servers as in a farm of independent servers instead of copying files. In this type of configuration, edits to files should be performed on all nodes in the application server cluster. v (WebSphere Application Server and WebLogic Server) When installing Application Engine through the administrative server make sure to deploy Application Engine to the cluster of server instances:
Table 21. Deployment actions Server WebSphere Application Server Action For WebSphere make sure you select the cluster and/or managed nodes that will be running the application when mapping modules to servers (the admin node is usually the default, so it is typical to change this). Click apply so that the application shows as deployed to the proper nodes instead of the default single node. UTF-8 encoding parameters should be set on every node. WebSphere 6.x: If you are using an IBM HTTP Server to proxy/load-balance application requests to WebSphere, make sure to select the Web server node when mapping modules to the application.

(Farm of independent application server instances) Configure and deploy the Application Engine on each node. When installing in farm of independent application server instances, the steps shown for deploying Application Engine on the application server must be performed on every node. Important: Since there is no central administration server every server acts as a separate server instance and must be configured as such. Deploying Application Engine on WebSphere Application Server on page 167 After you install and configure Application Engine, you must deploy your client application, Workplace, on your WebSphere Application Server. You might be required to re-create the WAR or WAR and EAR files before you deploy.

166

Installation Guide

Deploying Application Engine on WebSphere Application Server

After you install and configure Application Engine, you must deploy your client application, Workplace, on your WebSphere Application Server. You might be required to re-create the WAR or WAR and EAR files before you deploy. Remember: In farm and cluster environments, deploy Application Engine on WebSphere Application Server on all nodes. Re-creating the WAR or EAR file Any time that you change files in the /Workplace directory, such as changes to web.xml for container-managed authentication, SSO support, or any other edits, you must re-create the WAR or EAR file and redeploy your changes. Deploying the application (WebSphere Application Server 6.1) on page 168 Deploy Application Engine as an application in the WebSphere 6.1 administrative console. You can specify the context root for the application URL during the deployment. Deploying the application (WebSphere Application Server 7.0) on page 169 To use Workplace as a web application, you must deploy it as an application in the WebSphere 7.0 administrative console. You can specify the context root for the application URL during the deployment.

Re-creating the WAR or EAR file

Any time that you change files in the /Workplace directory, such as changes to web.xml for container-managed authentication, SSO support, or any other edits, you must re-create the WAR or EAR file and redeploy your changes. Remember: Before re-creating the EAR file, you must first re-create the WAR file. To re-create the WAR or EAR files: 1. Verify that all modified /Workplace directory files have been saved. 2. Re-create the app_engine.war file by running the script for your platform.
Option Windows Description AE_install_path\deploy\ create_app_engine_war.bat

3. (For WAR file deployment) Rename the newly re-created app_engine.war file to Workplace.war or custom_name.war to create the context root for your application. For example, the default app_engine.war generates the following context root: http://server_name:port#/app_engine. Renaming the WAR file Workplace.war generates the following context root: http://server_name:port#/ Workplace. Important: You must rename the WAR file every time you regenerate it. The create_app_engine_war script creates by default a file with the name app_engine.war. Important: Do not rename the WAR file if you are using the WAR file to re-create the EAR file for deployment. 4. (For EAR file deployments only) Re-create the app_engine.ear file by running the script for your platform.

Installing and configuring Application Engine

167

Option Windows

Description AE_install_path\deploy\ create_app_engine_ear.bat

Deploying the application (WebSphere Application Server 6.1)

Deploy Application Engine as an application in the WebSphere 6.1 administrative console. You can specify the context root for the application URL during the deployment. To deploy Application Engine: 1. Log on to the WebSphere administrative console. 2. Navigate to Applications > Enterprise Applications > Install 3. Select the file to deploy. v (If the administrative console is running locally) Select Local file system and enter or browse to the location of the app_engine.war or app_engine.ear file created by the installation program. For example, AE_install_path/deploy/ app_engine.war or AE_install_path/deploy/app_engine.ear. Do not enter the machine name. v (If the administrative console is remote) Select Remote file system and enter the fully qualified path name to the app_engine.war or app_engine.ear file. For example, AE_install_path/deploy/app_engine.war or AE_install_path/deploy/app_engine.ear. Do not enter the machine name. 4. If you are deploying a WAR file, enter the context root. Enter Workplace and click Next to proceed to deploying a new application. Tip: The context root is the name of the application that you log in to by using the web interface, such as: http://ApplicationEngineServerName:port#/ Context_Root. 5. Click Prompt only when additional information is required, and click Next. Complete the dialog boxes for installing a new application by using the following settings: For Application name, enter Workplace, or the name you chose to call the application. For WebServer, specify the server you are planning to use. Verify that your application name is selected and associated with the correct WebServer. For Map virtual hosts for Web modules, for virtual host, choose the default_host. (WAR file deployment only) For Context root, specify Workplace, or whatever you want to call the application. 6. Save your configuration. 7. Navigate to Applications > Enterprise Applications > Workplace > Class loading and update detection. 8. Set the polling interval for updated files with a number appropriate for your environment, for example, 3 seconds. 9. Change the Class loader order to Classes loaded with application class loader first. 10. Click Apply. 11. Click Workplace > Manage Modules. 12. Click Workplace.

168

Installation Guide

13. Change the Class loader order to Classes loaded with application class loader first. Important: Change this setting only for the specific web application. Do not change the similar settings for the entire application server. 14. If you are using container-managed authentication, navigate to Enterprise Applications > Workplace > Security role to user/group mapping. Verify that the All Authenticated column is checked for the "All Authenticated" role. 15. Save all your changes to the master configuration. 16. Stop and restart the WebSphere Application Server instance where the application is installed. To troubleshoot the deployment, check the following log: WAS_install_path/AppServer/profiles/profile_name/logs/server_name/ SystemOut.log 17. Start Application Engine (or whatever you named your application) from the administrative console. 18. In a high availability environment, by using the application server administration tool, verify that the Application Engine application is running. a. Open a Web browser and type in the URL for the Application Engine application. v If you are using a load-balancer or proxy server the URL has the form: Application Engine http://virtual_name:port_number/Workplace v If connecting to an individual cluster node the URL would have the form: Application Engine http://clustered_server_name:port_number/Workplace/ Sign-in by using the virtual name to properly set the base Application Engine URL. If it is not set correctly you must change it in Site Preferences. b. Verify that the sign-in page displays, and log in as a user. c. Fail one of the nodes. d. Verify that you can reload the sign-in page, and log in as the same user. Related tasks Starting or stopping an application server instance

Deploying the application (WebSphere Application Server 7.0)

To use Workplace as a web application, you must deploy it as an application in the WebSphere 7.0 administrative console. You can specify the context root for the application URL during the deployment. To deploy Application Engine (Workplace): 1. Log on to the WebSphere administrative console. 2. Navigate to Applications > WebSphere Enterprise Applications > New Enterprise Applications > Install 3. Select the file to deploy. v (If the administrative console is running locally) Select Local file system and enter or browse to the location of the app_engine.war or app_engine.ear file

Installing and configuring Application Engine

169

created by the installation program. For example, AE_install_path/deploy/ app_engine.war or AE_install_path/deploy/app_engine.ear. Do not enter the machine name. v (If the administrative console is remote) Select Remote file system and enter the fully qualified path name to the app_engine.war or app_engine.ear file. For example, AE_install_path/deploy/app_engine.war or AE_install_path/deploy/app_engine.ear. Do not enter the machine name. 4. If you are deploying a WAR file, enter the context root. Enter Workplace and click Next to proceed to deploying a new application. Tip: The context root is the name of the application you log in to using the web interface, such as: http://ApplicationEngineServerName:port#/ Context_Root. 5. Click Prompt only when additional information is required, and click Next. Complete the dialogs for installing a new application, using the following settings: For Application name, enter Workplace, or the name you chose to call the application. For WebServer, specify the server you are planning to use. Verify that your application name is selected and associated with the correct WebServer. For Map virtual hosts for Web modules, for virtual host, choose the default_host. (WAR file deployment only) For Context root, specify Workplace, or whatever you want to call the application. 6. Save your configuration. 7. Navigate to Applications > Enterprise Applications > Workplace > Class loading and update detection. 8. Set the polling interval for updated files with a number appropriate for your environment, for example, 3 seconds. 9. Change the Class loader order to Classes loaded with local class loader first (parent last). 10. Click Apply. 11. Click Workplace > Manage Modules. 12. In the Modules column, click Workplace. 13. Change the Class loader order to Classes loaded with local class loader first (parent last). Important: Change this setting only for the specific web application. Do not change the similar settings for the entire application server. 14. If you are using container-managed authentication, navigate to Enterprise Applications > Workplace > Security role to user/group mapping. a. Select the All Authenticated role and click Map Special Subjects. b. Map the All Authenticated role and to All Authenticated in Applications realm. 15. Save all your changes to the master configuration. 16. Stop and restart the WebSphere Application Server instance where the application is installed. To troubleshoot the deployment, check the following log: WAS_install_path/AppServer/profiles/profile_name/logs/server_name/ SystemOut.log

170

Installation Guide

17. Start Workplace (or whatever you named your application) from the administrative console. 18. In a high availability environment, by using the application server administration tool, verify that the Application Engine application is running. a. Open a Web browser and type in the URL for the Application Engine application. v If you are using a load-balancer or proxy server the URL has the form: Application Engine http://virtual_name:port_number/Workplace v If connecting to an individual cluster node the URL would have the form: Application Engine http://clustered_server_name:port_number/Workplace/ Sign-in by using the virtual name to properly set the base Application Engine URL. If it is not set correctly you must change it in Site Preferences. b. Verify that the sign-in page displays, and log in as a user. c. Fail one of the nodes. d. Verify that you can reload the sign-in page, and log in as the same user. Related tasks Starting or stopping an application server instance

Setting Application Engine bootstrap preferences

By successfully signing in to Workplace and saving the bootstrap preferences, you verify basic Application Engine functionality such as user authentication as well as communication and storing of data in Content Engine. Setting the bootstrap properties on first login Six bootstrap preference groups are available for configuring the first time you sign in to Workplace. Verifying that a single index has been added for Application Name on the site preferences object store on page 174 To properly index access roles and improve login performance on Application Engine, an index is created for Application Name on the object store that contains the Workplace site preferences. You can verify this index setting after you have successfully configured the bootstrap preferences. Enabling user access to the workflow subscription wizard on page 175 To allow users to create workflows subscriptions, you must configure the PWDesigner access role using the Workplace Site Preferences, and give the users appropriate access rights to the workflow subscriptions classes. Enhanced Timezone Detection on page 175 You can set the useEnhancedTimeZoneDetection parameter to accurately detect a time zone for a client browser. This setting cannot be modified through the Site Preferences page. To enable this feature you must manually modify the bootstrap.properties file.

Setting the bootstrap properties on first login

Six bootstrap preference groups are available for configuring the first time you sign in to Workplace.

Installing and configuring Application Engine

171

In addition to the preferences covered in this topic, more preferences can be set for the Workplace application using Workplace Site Preferences. For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents in Workplace > Site preferences. 1. Sign in to Workplace: a. On any computer, open a browser and type: http://ApplicationEngineServerName:port#/Workplace Important: ApplicationEngineServerName cannot be localhost or an IP address. b. Enter a user name and password, and then click Sign in. The Bootstrap Preferences page opens. The user who initially logs in and sets the bootstrap preferences is automatically added to the Application Engine Administrators role. For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Access Roles preferences. 2. Enter security info (required for SSL only). a. Enter the SSL Host and Port information for the SSL server. b. Enter the Java Server HTTP port. Use the Security info preference to redirect sign-ins through a Secure Socket Layer (SSL) server and to identify a remote Java server. This encrypts the user IDs and passwords when they travel over the network. See Setting up Application Engine SSL security on page 181 for instructions on setting up SSL security for one or more Application Engine installations. Important: After you have configured SSL, the Site Preferences application also runs under SSL to protect the guest account's user ID and password. This means that when you run Site Preferences on an unsecured server that redirects sign-ins to an SSL server, you will be editing the Bootstrap preferences of the SSL server (stored in the bootstrap.properties file). This does not affect the General, Object Store, and Shortcut preferences, which are retrieved from the preferences file saved in the object store. 3. Configure user token settings. User Tokens are used by IBM FileNet P8 applications to launch into each other without the need for an additional login. a. Select whether or not to create user tokens for your Application Engine (Default: Yes). b. Select whether or not the application will pick up generated tokens from other applications (Default: Yes). c. Specify a Token timeout interval (1 - 15 minutes). 4. (Required) Specify preference settings. Preference settings specify the name of the site preference file, its storage location (object store), and the documentation server URL (if installed). The site preferences file is checked into the object store the first time you log on to Workplace. The site preferences are stored as XML data in this file, Site Preferences for Preferences name.xml. Use Enterprise Manager to access this file, and navigate to Object Stores > Object Store location > Root Folder > Preferences. The bootstrap preferences are saved in the bootstrap.properties file, and not in the site preferences file. The default location for this file is AE_install_path/FileNet/Config/AE.

172

Installation Guide

a. Select an object store from the Object store location choice list. The preferences file will be saved in this object store. Workplace users must have access to this object store. b. Enter a preference file name in the Preferences name field. c. Enter the documentation server URL in the Documentation server field. The format of the URL depends on the documentation package you use:
Table 22. Documentation URLs FileNet P8 documentation package Online information center at www.ibm.com Installed P8 information center URL http://publib.boulder.ibm.com/infocenter/p8docs/ v5r1m0/topic/com.ibm.p8.doc http://server_name:port#/application_name/topic/ com.ibm.p8.doc where: v server_name is the name of the server where the FileNet P8 Platform documentation information center is installed. v port# is the port number. v application_name is the name of the deployed FileNet P8 Platform application. If you have installed a local information center, the application name is typically p8docs

If no documentation URL is specified, the Workplace Help link will default to http://localhost. d. Enter the ISRA Interface Servlet URL. For more information, see Enabling Application Engine to use ISRA on page 202. 5. Set Banner Image. The banner image is the graphic that appears at the upper left-hand side of the Workplace application pages. If you have a banner image that you would like to use in place of the default, follow this procedure. a. Copy the new graphic file to the location of your choice on Application Engine in the /FileNet/AE/Workplace folder. b. In the Path field, type the path (relative to the /Workplace folder) to the new banner graphic file. c. In the Image Width field, type the width of the image (in pixels). d. In the Image Height field, type the height of the image (in pixels). 6. Configure Application Integration. This preference setting only affects Outlook integration. Select No (default) if you do not want users to be prompted to add an e-mail to an object store each time the e-mail is sent. Select Yes if you want users prompted to add an e-mail to an object store when the e-mail is sent. 7. Add Application Engine Administrators (ae_admin_user). Add the users and groups that will perform Application Engine administration tasks to the Application Engine Administrators role. The user who initially signs in and sets the bootstrap preferences is automatically added to the Application Engine Administrators role. For more

Installing and configuring Application Engine

173

information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Access Roles preferences. To modify the access roles after the initial bootstrap configuration, users with the Application Engine Administrators role can use the access roles section of the Workplace Site Preferences. Launch Workplace and navigate to Admin > Site Preferences > Access Roles. When you access the bootstrap preference page via the Site Preferences application, an additional preference, Guest info (to allow guest sign ins), is also available. 8. Click Apply to save your bootstrap settings. After the initial bootstrap configuration, users with the Application Engine Administrators (ae_admin_user) role can change any of these preferences by signing into Workplace and navigating to Admin > Site Preferences > Bootstrap. In a web farm/clustered environment, all Application Engine installations share site preferences by using the same bootstrap.properties file.

Verifying that a single index has been added for Application Name on the site preferences object store
To properly index access roles and improve login performance on Application Engine, an index is created for Application Name on the object store that contains the Workplace site preferences. You can verify this index setting after you have successfully configured the bootstrap preferences. To verify the index setting: 1. On Content Engine, launch the Enterprise Manager. 2. In the left pane, expand the Object Stores folder. 3. Expand the object store node where your site preferences are stored. 4. Expand Other Classes and then Custom Object. 5. 6. 7. 8. Right click Access Role and select Properties. Select the Property Definitions tab. Select Application Name and click Edit. On the General tab of the Application Name Properties, verify that the Indexed field shows Single Indexed. v If the Indexed field shows Single Indexed, click OK. The verification is complete. Skip the remaining steps in this procedure.

v If the Indexed field shows Not indexed, continue with the following steps to change the setting. 9. Click Set/Remove. 10. Select Set and then Single Indexed. 11. Click OK to set the index. 12. Click OK to apply the change and close the Application Name Properties window. 13. Click OK to close the Access Role Class Properties window.

174

Installation Guide

Enabling user access to the workflow subscription wizard

To allow users to create workflows subscriptions, you must configure the PWDesigner access role using the Workplace Site Preferences, and give the users appropriate access rights to the workflow subscriptions classes. 1. Assign users as members of the PWDesigner access role. See the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Access roles preferences . 2. Run the security script wizard with the workplacescript.xml file to add accounts to the Workflow Designer role. In Enterprise Manager, right-click the domain root node or the object store node and select All tasks > Run Security Script Wizard. For more information about how to use the Security Script wizard to assign the Workflow Designer role to user or group accounts, see the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Content Engine Wizards > Security script. For more information about the workplacescript.xml file and how roles are defined in the Enterprise Manager, see the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Managing Security > Security Script Wizard.

Enhanced Timezone Detection

You can set the useEnhancedTimeZoneDetection parameter to accurately detect a time zone for a client browser. This setting cannot be modified through the Site Preferences page. To enable this feature you must manually modify the bootstrap.properties file. For more information, see the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Application Engine.

Updating Application Engine settings in a load balanced environment

You can update Application Engine settings in a load balanced Application Engine environment consisting of a load balancer or proxy device, several HTTP servers and several application server instances. When several application server instances host the Application Engine application the goal is to provide to end-users the same work environment from every server instance. Application Engine utilizes a number of preference settings and configuration information to customize the Application Engine application for user needs. In order to provide a seamless work experience in an environment with multiple application server instances residing behind a load-balancer or proxy device it is important that each instance access the same configuration data. The installer allows you to select the location of a shared configuration directory during the installation process. This shared configuration directory is used to store the files that contain preference settings and configuration information for the Application Engine application. A shared configuration directory allows you to have a single Application Engine instance with the same configuration information and preferences across multiple server instances. The process for managing settings by using a shared configuration directory is documented later in this section. The shared configuration directory should ideally be placed on a highly available share or NFS exported directory that is accessible by all systems in the application server configuration.
Installing and configuring Application Engine

175

Important: To be able to perform these tasks you must be a user assigned the Application Engine Administrator access role, and have copy/overwrite permissions on the directories shown later in this section on all nodes. If you need to update your Application Engine Site Preferences you must refresh the configuration files on each node server. To update Application Engine settings in a load balanced environment: 1. Make your Application Engine configuration changes. a. Sign into Application Engine as a user who is assigned the Application Engine Administrator access role. Application Engine: http://virtual_name:port_number/Workplace b. Click Admin. c. Click Site Preferences. d. Update your settings. e. Click Exit. 2. Reload the Application Engine configuration files on each node. After changes are made you must reload the Application Engine configuration files on each node server. To load identical settings on all the nodes you must perform the following steps on each individual node server by logging in to the Application Engine instance running on the server. Restriction: Do not log in by using the load balancer URL. a. Sign into Application Engine as a user who is assigned the Application Engine Administrator access role. b. Use the following URL to sign in: Application Engine: c. d. e. f. g. http://node_server_name:port#/Workplace Click Admin. Click Site Preferences. Click Refresh. From the Refresh page, click Reload configuration files. Click Exit.

For more information and a list of all configuration files that can be reloaded, go to the on-line help and navigate to: Application Engine: Developer Help > Workplace Development > Workplace Customization Guide > Appendixes > Reloading Workplace Configuration Files

176

Installation Guide

Configuration and startup tasks

After you install the IBM FileNet P8 components, there are some additional steps to configure the IBM FileNet P8 system. After you configure the IBM FileNet P8 components, familiarize yourself with IBM FileNet P8 system startup and shutdown procedures. See the Administering IBM FileNet P8 > Starting and stopping IBM FileNet P8 components help topic. Configuring the Process Engine connection point for Application Engine Before users can access Process Engine tasks and work items from Workplace, you must configure the connection point on the Application Engine. Enabling SSL between the Process Engine and the Process Engine client on page 178 Modify the configuration to enable SSL between the Process Engine and the Process Engine client. The default configuration does not have SSL enabled. Setting up Content Engine and client transport SSL security on page 179 Configuring SSL enables secure communications between the Content Engine and the directory service, as well as between Content Engine clients and the Content Engine server. In addition, setting up Content Engine SSL provides secure authentication for Process Engine. Setting up Application Engine SSL security on page 181 You can configure an Application Engine to direct sign-ins through a Secure Socket Layer (SSL) https connection. This configuration takes place after you have installed and configured Application Engine. Performing additional configuration tasks on page 184 Once you have completed the installation tasks, your core IBM FileNet P8 system is operational. You can do the recommended additional configuration tasks to prepare the system for general use.

Configuring the Process Engine connection point for Application Engine

Before users can access Process Engine tasks and work items from Workplace, you must configure the connection point on the Application Engine. Make sure that you have already created a Process Engine isolated region and a Process Engine connection point and that the Process Engine software is running. To configure the connection point: 1. Sign in to Workplace as an Application Engine Administrator: a. On any computer, open a browser and navigate to: http://ApplicationEngineServerName:port#/Workplace b. Sign in with the same account that you used to set the bootstrap preferences. 2. Click Admin. 3. Click Site Preferences. 4. Under General Settings > Tasks, select a Process Engine Connection Point from the list. 5. Click Apply. 6. Click Exit.
Copyright IBM Corp. 2001, 2011

177

Important: Initializing the isolated region, as described in the next step, in an existing environment will destroy all data in the existing region. 7. (For new installations only) Initialize the isolated region. If you initialized the isolated region earlier, do not initialize it again. a. Click Admin. b. Click Process Configuration Console. If your computer does not have the appropriate Java Runtime Environment (JRE) installed, you will be prompted to download the JRE at this point; follow the prompts to complete the download. During the installation process, click the Browser tab and clear the Internet Explorer option. c. Right-click the icon or name of the isolated region you want to initialize, and select Connect. d. Click Action. e. Click Initialize Isolated Region. f. Click Yes at the prompt asking if you want to continue. g. Close the Process Configuration Console. 8. In Workplace, click Tasks to confirm that Application Engine is communicating with Process Engine. 9. Sign out of Workplace. Related tasks Defining and initializing a Process Engine isolated region silently on page 136 Define and initialize a Process Engine isolated region and, if the configuration is for IBM Case Manager, configure the link between the region and a Content Engine object store silently by using the peinit command-line tool.

Enabling SSL between the Process Engine and the Process Engine client
Modify the configuration to enable SSL between the Process Engine and the Process Engine client. The default configuration does not have SSL enabled. Modify the configuration to enable SSL between the Process Engine and the Process Engine client. The Process Engine client could be Workplace or Workplace XT. In a farmed configuration, complete these steps on every node. To enable SSL between the Process Engine and Process Engine client: 1. Sign in to Process Engine server as the pe_install_user. 2. Change the current directory to pe_install_path where pe_install_path is the location of the program files that was specified during the Process Engine installation. 3. Edit the following file:
Operating system UNIX Windows Filename startpesvr.bat startpesvr.sh

4. Set the following values:

-Djpeserver.httptunnel.ssl=true -Djpeserver.useHTTPTunneling=true

5. Save the changes to the file and restart the Process Engine server.

178

Installation Guide

Setting up Content Engine and client transport SSL security

Configuring SSL enables secure communications between the Content Engine and the directory service, as well as between Content Engine clients and the Content Engine server. In addition, setting up Content Engine SSL provides secure authentication for Process Engine. Important: It is a best practice to enable SSL for the Content Engine and Process Engine web services. Authentication over these two web services is usually performed by providing username and password credentials. If these web services are not configured to run over an SSL connection, clear text passwords will be sent across the network. (However, this is not true when Kerberos-based authentication is used. In the IBM FileNet P8 5.1.0 release, Kerberos authentication is available only for the Content Engine web service.) The option not to use SSL over these two web services is provided primarily for development systems or other non-production systems where the security provided by SSL might not be required. For access to the Content Engine through the EJB transport (IIOP or T3 protocol), an SSL connection is necessary to provide privacy for data sent across the network. However, user passwords would not be compromised if SSL were not used. While it is preferable to use SSL with the EJB transport (IIOP or T3 protocol), it is not a requirement. v The Content Engine web service is used: By all clients of the Content Engine version 5.1.0 .NET API By all clients of the Content Engine version 5.1.0 COM Compatibility API (CCL) By Enterprise Manager tool and FileNet Deployment Manager tools By the Content Engine Upgrade tool By Process Engine, when making calls to Content Engine to retrieve user and group information By the Component Manager, running on the Application Engine, which is an integral component for BPM Process Orchestration framework By customer and 3rd party tools written against the Content Engine version 3.5 web service API, including Altien Document Manager and the Sharepoint integration done by Vorsite. v Certain Java applications (written against the Content Engine version 3.5 Java API or the Content Engine 5.1.0 zJava API) might use the Content Engine web service transport, but typically they would use EJB transport (IIOP or T3 protocol). v The Application Engine server uses only the EJB transport to communicate with the Content Engine in the 5.1.0 release. v The Process Engine web service is used by customer and independent software vendor applications to write runtime applications (typically step processor applications) against the Process Engine. The Process Engine Java API does not make use of the Process Engine web service. Enabling SSL for Content Engine on page 180 When you enable SSL, a server certificate is added to the Directory Services server (for authentication). In addition, the CA certificate is added in two different locations on the Content Engine server (the JDK path location is for authorization). Take care to ensure that the proper certificate is added to each of the three locations.

Configuration and startup tasks

179

Enabling SSL between Enterprise Manager and the directory service on page 181 Use the Enterprise Manager interface to enable SSL between Enterprise Manager and the directory service.

Enabling SSL for Content Engine

When you enable SSL, a server certificate is added to the Directory Services server (for authentication). In addition, the CA certificate is added in two different locations on the Content Engine server (the JDK path location is for authorization). Take care to ensure that the proper certificate is added to each of the three locations. To enable SSL for Content Engine: 1. Obtain and install a server certificate and a CA certificate on the directory service. These certificates are available from independent certificate authorities, such as VeriSign, or you can generate your own certificates if you have the necessary certificate management software installed. 2. Enable SSL on the directory service and set the SSL port number. The default SSL port number is 636; however, if you have more than one directory service that is using SSL on the server, you might need to use a non-default port number. See your directory server documentation for instructions. 3. On the Content Engine server, add the CA certificate to the application server keystore, if it does not already contain it. 4. On the Content Engine server, add the CA certificate to the JDK (Java) keystore, if it does not already contain it. You can use the default key store, or create your own key store in a custom location. v To use the JDK default Java key store, do the following: a. Determine the Java version your application server uses and the JAVA_HOME location. b. Use the keytool to import the CA certificate to the Java keystore at %JAVA_HOME%\jre\lib\security\cacerts. c. To improve security, change the default password. v To use your own key store (rather than the JDK default key store), do the following: a. Add the following system parameters to the Java command line in your application server startup script:
-Djavax.net.ssl.trustStore= path_to_your_keystore_file -Djavax.net.ssl.trustStorePassword= password_of_your_keystore

5.

6. 7. 8.

b. Use the Java keytool to import the CA certificate to your own keystore. Use Enterprise Manager to set the port number to match the SSL port number on the directory server: a. Select the domain icon in the left panel and choose Action > Properties. b. In the Properties dialog box, click Directory Configuration, and then click Modify. c. In the General tab, set the port number, and then click OK. Obtain another server and CA certificate for the Content Engine. Create a custom identity keystore on the Content Engine server, and add the server certificate to the custom keystore. Using the application server administration tool, enable SSL and point to the custom identity keystore. Directions vary by application server type; see your application server documentation for detailed procedures.

180

Installation Guide

Option WebSphere Application Server

Description Configure an SSL repertoire. In the left pane of the WebSphere administrative console, navigate to Security > SSL. In the right pane, select your Java Secure Socket Extension (JSSE) repertoire and specify key and trust file names and passwords.

9. Configure clients to use a particular URL for connecting to Content Engine based on the application server type and the client transport (protocol) type. The following table provides the default ports and sample URLs:
Protocol HTTP HTTPS IIOP IIOP SSL no yes no yes Default Port 9080 9443 2809 2809 App Server WebSphere Application Server WebSphere Application Server WebSphere Application Server WebSphere Application Server Sample URL http://mycorp.com:9080/wsi/ FNCEWS40MTOM/ https://mycorp.com:9443/wsi/ FNCEWS40MTOM/ iiop://mycorp.com:2809/ FileNetEngine iiop://mycorp.com:2809/ FileNetEngine (defautl) While the default port for IIOP with SSL is port 9403, use port 2809. The web application server resolves the SSL port number correctly.

The port values in the table are default values. If you change the port that your application server listens on, you might need to change the port number used by the Content Engine client.

Enabling SSL between Enterprise Manager and the directory service

Use the Enterprise Manager interface to enable SSL between Enterprise Manager and the directory service. To enable SSL between Enterprise Manager and the directory service: 1. Start Enterprise Manager and log in as a GCD administrator. 2. In the tree view, right-click the root node and choose Properties. 3. In the Enterprise Manager Properties dialog box, click the Directory Config. tab, select a directory service, and click Modify. 4. In the General tab of the Modify Directory Configuration dialog box, set the Is SSL Enabled parameter to True and modify the port number appropriately. 5. Click OK in each open dialog box.

Setting up Application Engine SSL security

You can configure an Application Engine to direct sign-ins through a Secure Socket Layer (SSL) https connection. This configuration takes place after you have installed and configured Application Engine.

Configuration and startup tasks

181

Application Engine supports the following methods of configuring an SSL environment: v Full SSL support - A single Application Engine server, where all of the software is running under SSL. v One server SSL redirect - One Application Engine server set up to redirect logon attempts on the non-SSL port to the SSL port. v Two server SSL redirect - Two Application Engine servers, where one is SSL-enabled, and the other redirects users to the SSL-enabled Application Engine server to log on. Setting up full SSL support on a single Application Engine To set up full SSL support, enable SSL on the preferred application server. Setting up SSL redirect on a single Application Engine server To set up SSL redirect, enable SSL on the preferred application server, set your bootstrap preferences, update the base URL, and sign out. Setting up SSL redirect on two Application Engine servers on page 183 You can set up two-server SSL redirect for Application Engine. In this configuration, one Application Engine server is SSL-enabled, and the other Application Engine redirects users to the SSL-enabled Application Engine server to log on. Using Java Applets in an SSL Environment on page 184 If you are using a Java applet in an SSL environment, you might experience an SSLHandshakeException because the appropriate certificate does not exist on your computer. Follow the instructions in the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Tools > Use Java applets to resolve this issue.

Setting up full SSL support on a single Application Engine

To set up full SSL support, enable SSL on the preferred application server. To set up full SSL support on a single Application Engine: 1. Enable SSL on the application server that runs Application Engine (see your SSL documentation). 2. Test the SSL connection by signing into Workplace using the following URL: https://Application_Engine_server_name:SSL port/Workplace The entire sign-in process will be handled by the SSL-enabled host. Related concepts SSL port numbers For more information about SSl port numbers, see Plan and Prepare Your Environment for IBM FileNet P8.

Setting up SSL redirect on a single Application Engine server

To set up SSL redirect, enable SSL on the preferred application server, set your bootstrap preferences, update the base URL, and sign out. To set up SSL redirect on a single Application Engine server: 1. Enable SSL on the application server that runs Application Engine (see your SSL documentation). 2. Sign in to Workplace: a. On any computer, open a browser and type the following URL address: http://Application_Engine_server_name:port#/Workplace

182

Installation Guide

b. Sign in as a user with Application Engine Administrator access role privileges. For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Access Roles preferences. 3. Set bootstrap preferences: a. Navigate to Admin Site Preferences > Bootstrap. b. Set the Security info Site Preference SSL Host:Port to identify the alias host name and port number. Use the IP address of the Application Engine server for the SSL Host entry. c. Click Apply to save your bootstrap settings. 4. Update the base URL: a. Navigate to Admin > Site Preferences > Refresh. b. Enter the Workplace Base URL value in the provided field. The URL must contain a valid host name, and not contain "localhost" or an IP number. For example, http://myserver:7001/Workplace For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Refresh preferences . c. Click Refresh to update the base URL. d. Click Exit to close Site Preferences. 5. Sign out of Workplace, and close your browser. 6. Test the SSL connection by signing in to Workplace using the following URL: http://Application_Engine_server_name:non-SSL port/Workplace You will be redirected to the SSL-enabled port for sign in, then back to the non-SSL enabled port after sign-in is complete. Before sign-in, you should receive a warning that you are accessing pages over a secure connection (unless you turned this dialog box off), and then Workplace will open.

Setting up SSL redirect on two Application Engine servers

You can set up two-server SSL redirect for Application Engine. In this configuration, one Application Engine server is SSL-enabled, and the other Application Engine redirects users to the SSL-enabled Application Engine server to log on. 1. Install Application Engine on both computers so that both Application Engine installations use the same bootstrap.properties file and site preferences file (the setup program will prompt you for a shared location). During setup of the first Application Engine, create a share on the folder where the bootstrap.properties file is installed (the \WEB-INF folder). Then during setup of the second Application Engine, specify the shared location from the first installation. The bootstrap.properties file must already exist when specifying a shared location. Important: The system clocks on the two Application Engine servers must be synchronized to within the Token time-out interval. For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Bootstrap Preferences > User token settings. 2. Copy the UTCryptokeyFile.properties file. For SSL redirect to work, each Application Engine must use the same User Token cryptographic key file.
Configuration and startup tasks

183

After installing the second Application Engine, copy the UTCryptoKeyFile.properties file from the first Application Engine server to the same location on the second Application Engine server. Copy the file over a secure link. 3. Enable SSL on the application server that you are using for the SSL-enabled Application Engine (see your SSL documentation). 4. Sign in to Workplace on the non-SSL enabled Application Engine. a. On any computer, open a browser and type: http://ApplicationEngineServerName:port#/Workplace b. Sign in as a user with Application Engine Administrator access role privileges. For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Access Roles preferences. 5. Set bootstrap preferences: a. Navigate to Admin > Site Preferences > Bootstrap. b. Set the Security info Site Preference SSL Host:Port to identify the alias host name and port number. c. Click Apply to save your bootstrap settings. 6. Update the base URL: a. Navigate to Admin > Site Preferences > Refresh. b. Enter the Workplace Base URL value in the provided field. The URL must contain a valid host name, and not contain localhost or an IP number. For example, http://myserver:7001/Workplace For more information, see the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Site preferences > Refresh preferences . c. Click Refresh to update the base URL. d. Click Exit to close Site Preferences. 7. Sign out of Workplace, and close your browser. 8. Test the SSL connection by signing into Workplace using the following URL: http://Application_Engine_server_name:non-SSL port#/Workplace You will be redirected to the SSL-enabled server for sign in, then back to the non-SSL enabled server after sign-in is complete. Before sign-in, you should receive a warning that you are accessing pages over a secure connection (unless you turned this dialog box off), and then Workplace will open.

Using Java Applets in an SSL Environment

If you are using a Java applet in an SSL environment, you might experience an SSLHandshakeException because the appropriate certificate does not exist on your computer. Follow the instructions in the IBM FileNet P8 help topic Working with documents > Working with documents with Workplace > Tools > Use Java applets to resolve this issue.

Performing additional configuration tasks

Once you have completed the installation tasks, your core IBM FileNet P8 system is operational. You can do the recommended additional configuration tasks to prepare the system for general use.

184

Installation Guide

Except where noted, the topics in the following list are located in the IBM FileNet P8 help. The documentation URL varies depending on the documentation package you use.
Table 23. Documentation URLs FileNet P8 Documentation package Online information center at www.ibm.com Installed local information center URL http://publib.boulder.ibm.com/infocenter/ p8docs/v5r1m0/topic/com.ibm.p8.doc/ http://yourdocserver:port#/application_name/ topic/com.ibm.p8.doc/ where v yourdocserver is the name of the server where the information center is installed locally. v port# is the port number of the server. v application_name is the name of your documentation application, typically p8docs.

v Configure Content Federation Services for Image Services Guidelines. See the IBM FileNet Content Federation Services for Image Services Planning and Configuration Guide. v Configure Application Engine to set the file types you want to open in a browser window rather than opening the Image Viewer. See Administering IBM FileNet P8 > Administering Application Engine > Application Engine Administration > Manage configuration files > Content redirection properties. v Set site preferences for the Workplace application. See Working with documents > Working with documents with Workplace > Tools > Publishing Designer > Security > Specify publication document security. v Design searches and/or search templates for Workplace users. See Working with documents > Working with documents with Workplace > Tools > Search Designer. v Design publishing templates for Workplace users. See Working with documents > Working with documents with Workplace > Tools > Publishing Designer. v Configure security for publishing. See Working with documents > Working with documents with Workplace > Tools > Publishing Designer > Security > Specify publication document security > . v Configure automatic workflow launch. See Administering IBM FileNet P8 > Administering Content Engine > Events and subscriptions . v Create and configure the object stores that will contain business objects, folders, documents, workflow definitions, searches, and other objects. See Administering IBM FileNet P8 > Administering Content Engine > Object Stores > Creating an object store. v Define document classes and folders and set security for each class. See Administering IBM FileNet P8 > Administering Content Engine > Classes > Concepts. v Review and, if necessary, edit the security of the network shared folders containing any file stores created for the object store. See Administering IBM FileNet P8 > Administering Content Engine > Content storage > Storage areas > File storage areas .

Configuration and startup tasks

185

v Configure Process Engine for automatic startup. See Administering IBM FileNet P8 > Process Task Manager > Process Engine > Configure automatic startup of Process Engine Manager (UNIX). v Configure e-mail notification. See Administering IBM FileNet P8 > Administering Process Engine > Workflow administration tasks > Coordinate workflow design > Enable email notification. v Set Process Engine runtime options. See Integrating workflow into document management > Process Configuration Console > Manage VWService > View or modify VWService properties > Set runtime options > . v Set the default date/time mask for the Process Service. See Administering IBM FileNet P8 > Process Task Manager > Process Service > Configuring Process Service > General properties. v Create content cache area. See Administering IBM FileNet P8 > Administering Content Engine > Content storage > Content cache areas > How to... > Create content cache. v Create additional authentication realms. See Security > IBM FileNet P8 security > How to... > Configure multiple realms. v Define additional isolated regions. See Integrating workflow into document management > Process Configuration Console > About isolated regions > . v For each isolated region: Define workflows. See Integrating workflow into document management > Process Designer. Configure event logging options. See Integrating workflow into document management > Process Configuration Console > About isolated regions > View or modify isolated region properties > Configure event logging options. Configure step processors. See Integrating workflow into document management > Process Configuration Console > About isolated regions > View or modify isolated region properties > Configure custom step processors. Define and configure work queues. See Integrating workflow into document management > Process Configuration Console > About queues > Manage work queues. Define and configure component queues. See Integrating workflow into document management > Process Configuration Console > About queues > Manage component queues. Define and configure workflow rosters. See Integrating workflow into document management > Process Configuration Console > Configure workflow rosters. Related information Product documentation for IBM FileNet P8 Platform Download the IBM FileNet P8 Non-English Support Guide, as well as PDFs of the rest of the IBM FileNet P8 Platform documentation.

186

Installation Guide

Optional installation tasks

You can install the additional or optional IBM FileNet P8 components in any order. Installing and configuring IBM FileNet P8 publishing components on page 188 For publishing capabilities, install the IBM FileNet Rendition Engine. Enabling the Process Engine Component Integrator on page 188 By using the Component Integrator functionality included in the IBM FileNet P8 Platform, a step in a workflow can access properties of documents, folders, and other objects in an object store. Using this functionality requires configuration on both Application Engine and Process Engine servers. Installing an additional instance of Enterprise Manager on page 191 You can install an instance of Enterprise Manager in addition to the one that you already installed. Creating additional file storage areas on page 193 Perform this task to create additional file storage areas for existing object stores. To create additional fixed storage areas, navigate instead to the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Content storage > Storage areas > Fixed storage areas. Installing IBM FileNet Deployment Manager on page 194 IBM FileNet Deployment Manager works with Enterprise Manager to deploy test systems into full production. You can install the IBM FileNet Deployment Manager interactively or silently on a Windows machine. Installing Application Integration on page 195 You can install Application Integration if you want to integrate IBM FileNet Workplace with your Microsoft Office applications and Outlook. You must complete the installation procedure on each machine that will use Workplace Application Integration. Installing Workplace File Tracker on page 198 If you want to use the file tracking feature without installing Application Integration, you can install Workplace File Tracker. Complete the installation on each machine that will use Workplace File Tracker. Deploying multiple Application Engine instances on page 200 You can deploy multiple instances of Workplace on a single application server. Each deployment of Workplace must use the same Content Engine, Process Engine, and connection point. Enabling Application Engine to use ISRA on page 202 Image Services Resource Adaptor (ISRA) is a J2EE connector to the IBM FileNet Image Services libraries. Using ISRA, Workplace users can view FileNet Image Services documents and their associated annotations in the FileNet Image Viewer and, if they have the appropriate permissions, update the annotations. Installing and configuring IBM System Dashboard for Enterprise Content Management on page 206 Content Engine, Application Engine, and Process Engine install, by default, the necessary software required for the System Manager performance component. To use System Manager, enable associated components and install IBM System Dashboard for Enterprise Content Management to perform related configuration procedures to enable System Manager. Modifying an Autonomy K2 server configuration on page 206 You can add Autonomy K2 servers or move existing servers to new hardware.
Copyright IBM Corp. 2001, 2011

187

Installing the COM compatibility layer (CCL) on page 212 The option to install the COM compatibility layer is available as part of the IBM FileNet P8 Content Engine installer. | | | | | |

Installing and configuring IBM FileNet P8 publishing components

For publishing capabilities, install the IBM FileNet Rendition Engine. Install the IBM FileNet Rendition Engine to establish publishing capabilities. For instructions, see the IBM FileNet Rendition Engine Installation and Upgrade Guide at FileNet P8 Documentation > FileNet P8 System Installation > Rendition Engine Installation and Upgrade.

Enabling the Process Engine Component Integrator

By using the Component Integrator functionality included in the IBM FileNet P8 Platform, a step in a workflow can access properties of documents, folders, and other objects in an object store. Using this functionality requires configuration on both Application Engine and Process Engine servers. As a post-installation task, you must define workflows that incorporate Content Engine operations in order to use the out-of-the-box Component Integrator functionality. For further details on defining such workflows, see the IBM FileNet P8 help topic Integrating workflow into document management > Process applications concepts > Designing and running workflows > Using Content Extended Operations in a workflow definition. After the software is installed, users can extend the out-of-the-box Component Integrator functionality so that a workflow step can interact with an external entity such as a CE operations Java object or Java Messaging Service (JMS) messaging system. For further information, see the IBM FileNet P8 help topic Developing IBM FileNet applications > Process Engine Development > Process Jave Developer's Guide > Developing Process Applications > Developing Work Performers > Developing Component Integrator-Based Work Performers. To update the credentials for the CE Operations Java adaptor (on an Application Engine server): 1. Sign in to Workplace. If you defined the Process Engine Configuration Group on the Security tab of Process Task Manager (when completing Configuring a Process Engine virtual server and database interactively on page 127), you must sign in as a member of either that group or the Process Engine Administrators Group, which was also defined on the Security tab, in order to complete the following steps. 2. In Workplace, click Admin and then click Process Configuration Console. If your computer does not have the appropriate Java Runtime Environment (JRE) installed, you will be prompted to download the JRE at this point; follow the prompts to complete the download. During the installation process, click the Browser tab and clear the Internet Explorer option. For further information about the JRE download, click Help in Process Configuration Console, click Process Reference on the help page toolbar, and see the IBM FileNet P8 help topic Concepts > Java Runtime Environment (JRE).

188

Installation Guide

3. Select the Isolated Region icon that corresponds to the isolated region that you initialized. For more information, see Defining a Process Engine isolated region on the Content Engine on page 134. 4. Right-click the CE_Operations component queue and select Properties . 5. On the Adaptor tab of the displayed dialog box, enter a user name and password that will be used for identification and permissions for both Process Engine and potentially any external systems that will be accessed. By default, the user name and password are set to Administrator and <no password>, respectively. If you choose to use another user name and password, they must already exist in the directory service. For additional information about the fields on the Adaptor tab, click the Help button. To use the out-of-the-box functionality, it is necessary to modify only the user name and password fields. 6. Click OK and commit the changes. Configuring and starting the Component Manager (on an Application Engine server) Configure the Component Manager and start it on an Application Engine. Specifying connection between Process Engine and Component Manager (on a Process Engine server) on page 190 Configure the connection between the Process Engine and the Component Manager using Process Task Manager on the Process Engine.

Configuring and starting the Component Manager (on an Application Engine server)
Configure the Component Manager and start it on an Application Engine. 1. Start Process Task Manager on the Application Engine server by running one of the following command files from the AE_install_path/FileNet/AE/Router directory, depending on your operating system:.
Option Windows Description routercmd.bat

If the Registry Port assigned to Component Manager conflicts with the port number required by another application or service running on the Application Engine server, Process Task Manager will not start up as expected and the necessary vwtaskman.xml will not be automatically created. If this happens, make a copy of the sample vwtaskman.xml.sample file located on the Application Engine. v On Application Engine, the file is located in: Drive:\Program Files\FileNet\AE\Router on Windows Open vwtaskman.xml.sample with a text editor, change the port element value to an available port number, and save the file to vwtaskman.xml in the same directory. 2. In Process Task Manager, select the server name in the left pane. 3. Find the Registry Port for the server in the right pane and verify that it is correct. 4. Select Component Managers in the left pane . 5. Enter the Content URI , service username, and service password Content URI to authenticate to the Content Engine server. The Content URI defaults and you can use the default or change the value. 6. Right-click and select New to select a connection point from the drop down list.
Optional installation tasks

189

7. Enter or modify the component properties as appropriate. For details, see the Administering IBM FileNet P8 > Process Task Manager > Component Manager > Configure Component Manager > Component Manager general properties. In an environment configured for single sign-on (SSO), do not use the SSO server name in the URL, even if Process Task Manager displays it by default. 8. (F5 using 3DNS for load balancing by DNS routing in a high availability environment) Configure the IOR cache time-to-live for applications accessing a farmed Process Engine. In a farmed Process Engine environment where you use F5 for load balancing by using DNS routing and the 3DNS method, you must configure the client machine IOR (Interoperable Object Reference) cache time-to-live to a value smaller than the default 3600 seconds, matching the DNS TTL set for the 3DNS. Having a cache time-to-live that is longer than the 3DNS TTL will cause the calls to be routed to only one Process Engine server instead of the preferred Process Engine server as intended by the 3DNS routing. The cache time-to-live is set by using the system property filenet.pe.ior.cache.ttl.in.seconds. a. Create the p8bpmsystems.properties configuration file in the JRE/LIB directory of the application server, or in the JRE/LIB directory of the Component Manager. For example, on Windows, create:
C:\Program Files\IBM\AE\Router\ java\jre\lib\p8bpmsystems.properties

b. Add this line to the file:

filenet.pe.ior.cache.ttl.in.seconds=TTL

Where TTL is the IOR cache time-to-live in seconds. For example, to set the IOR cache time-to-live to 30 seconds:
filenet.pe.ior.cache.ttl.in.seconds=30

9. Click Start on the toolbar. 10. In a farmed or cluster configuration, make the same changes on every node and restart the Component Integrator. Related concepts IBM FileNet P8 ports For details on how to resolve port number conflicts, see Plan and Prepare Your Environment for IBM FileNet P8.

Specifying connection between Process Engine and Component Manager (on a Process Engine server)
Configure the connection between the Process Engine and the Component Manager using Process Task Manager on the Process Engine. Configuring this connection is not recommended in a high availability configuration. 1. On the Process Engine server, start Process Task Manager as follows, depending on your operating system:
Option Windows Description Select Start > Programs > IBM FileNet P8 Platform > Process Engine > Process Task Manager.

2. Select Process Engine in the left pane (also referred to as the feature pane).

190

Installation Guide

3. In the Component Manager connection section, select the Server Connections tab. 4. In the Host field, enter the host name of the Application Engine server where Component Manager is running. Important: In a high availability environment, leave the Host field blank. If you configure Process Engine to talk to a specific Application Engine node, it would only attempt to communicate with the component integrator on that node, and will not be able to switch to another node in case of an Application Engine failover. 5. In the Event Port field, enter the port that the Component Manager listens to for incoming events. The default is 32773. The port number you enter must match the number you entered when you configured the Component Manager previously.

Installing an additional instance of Enterprise Manager

You can install an instance of Enterprise Manager in addition to the one that you already installed. Important: Do not install Enterprise Manager version 5.0.0 or the COM Compatibility Clients API on any machine that is running the 3.5 version, at least until the Content Engine 5.0.0 upgrade is complete. Otherwise, you will no longer be able to run Enterprise Manager 3.5 against any remaining 3.5 object stores. You might be required to use Enterprise Manager to prepare for upgrading the 3.5 object stores. Remember: You can install Enterprise Manager only on a Windows machine by using the Windows version of the Content Engine installation media. To install an additional instance of Enterprise Manager: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Installer in the Installation or Configuration Program column. 2. On the machine where you install Enterprise Manager, log on as a member of the Local Administrators group or the Power Users group. 3. If you have not already done so, install the required Windows components.

Optional installation tasks

191

Option Content Engine version 5.1.0 with Microsoft Windows Vista, Microsoft Windows Server 2008, or Microsoft Windows 7

Description Microsoft .NET Framework 3.0 and Windows Communication Foundation (WCF) To run FileNet Enterprise Manager without SSL configured on the same computer, you must have Microsoft Web Services Enhancements (WSE) 3.0 installed there. See the Microsoft support website for details about the impending end of general support for .NET Framework 2.0 and, by extension, WSE 3.0. If the support for WSE 3.0 ends, you must configure SSL on the Enterprise Manager computers to ensure a fully supported FileNet Content Manager environment To run FileNet Enterprise Manager with SSL configured on the same computer, you must have Microsoft Windows Communication Foundation (WCF), which is the successor to WSE, installed there.

4. 5.

Access the Content Engine software package. Start the Enterprise Manager installation.
Description 1. Run the following command in the software package: 5.1.0-P8CE-WIN.exe. 2. Complete the installation program wizard.

Option To install interactively

To install silently

1. Open the ce_silent_install.txt file in the software package for editing. 2. Set the parameter values in the ce_silent_install.txt file for your site. Be sure to set the CHOSEN_INSTALL_FEATURE_LIST parameter value to: DotNetClients,AdminTools 3. Save your edits. 4. Run the following command in the software package on a single line: 5.1.0-P8CE-WIN.EXE -f ce_silent_install.txt

6. Install any service packs, fix packs, or interim fixes.

192

Installation Guide

Creating additional file storage areas

Perform this task to create additional file storage areas for existing object stores. To create additional fixed storage areas, navigate instead to the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Content storage > Storage areas > Fixed storage areas. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. Complete the following procedure for each file storage area you want to create. 1. Prepare a location for the file storage area, as shown in "Prepare storage areas for object stores" in Plan and Prepare Your Environment for IBM FileNet P8. 2. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Enterprise Manager values for this task, filter by EM: Create a Storage Area in the Installation or Configuration Program column. Start Enterprise Manager. Select a FileNet P8 domain and log on as an administrator of the object store in which you will create a file storage area. 5. Right-click the Storage Areas node and then choose New Storage Area. 3. 4. 6. When the Create a Storage Area wizard opens, complete the wizard screens by using the values in your worksheet. Verifying the file storage area To verify the file storage area, log onto the machine that Content Engine Server is installed and verify that fsa1 contains an XML file named fn_stakefile.

Verifying the file storage area

To verify the file storage area, log onto the machine that Content Engine Server is installed and verify that fsa1 contains an XML file named fn_stakefile. 1. Log on to the machine where the Content Engine Server is installed. 2. List the contents of the fsa1 directory you created or designated when you configured your file server. 3. Verify that fsa1 contains an XML file, named fn_stakefile, and two subdirectories, content and inbound. 4. 5. Verify that fsa1 has the ownership and access permissions you specified. Assign the new storage area into a storage policy. Assign that storage policy as the default storage location for one of your document classes. See the IBM FileNet P8 help topic Administering IBM FileNet P8 > Administering Content Engine > Content storage > Storage policies for more information.

Optional installation tasks

193

Related information Configuring a UNIX-based file server For more information about the fsa1 directory, see the "Configuring a UNIX-based file server" in Plan and Prepare Your Environment for IBM FileNet P8. Configuring a Windows-based file server for a Windows client For more information about the fsa1 directory, see Plan and Prepare Your Environment for IBM FileNet P8. Configuring a Windows-based file server for a UNIX client For more information about the fsa1 directory, see Plan and Prepare Your Environment for IBM FileNet P8.

Installing IBM FileNet Deployment Manager

IBM FileNet Deployment Manager works with Enterprise Manager to deploy test systems into full production. You can install the IBM FileNet Deployment Manager interactively or silently on a Windows machine. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. FileNet Deployment Manager runs only on Windows. To install IBM FileNet Deployment Manager: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by CE Installer in the Installation or Configuration Program column. 2. On the machine where you will install FileNet Deployment Manager, log on as a member of the Local Administrators group or the Power Users group. 3. Access the Content Engine installation software. 4. Start the Tools installation. FileNet Deployment Manager is installed with the Content Engine tools.
Option Interactive installation Description 1. Run the following command in the software package: 5.1.0-P8CE-WIN.EXE 2. Complete the program installation wizard by using the values from your worksheet.

194

Installation Guide

Option Silent installation

Description 1. Open the CE_silent_install.txt file in the software package for editing. 2. Set the parameter values in the CE_silent_install.txt file for your site. Be sure to set the CHOSEN_INSTALL_FEATURE_LIST parameter value to Tools If you want to also install FileNet Enterprise Manager on this machine, select .NET Clients as well:DotNetClients,Tools 3. 4. 5. Set the LAUNCH_CM value to 0. Save your edits. Run the following command in the software package on a single line: 5.1.0-P8CE-WIN.EXE -f CE_silent_install.txt

| |

To start FileNet Deployment Manager, choose Start > All Programs > FileNet P8 Platform > P8 Deployment Manager.

Installing Application Integration

You can install Application Integration if you want to integrate IBM FileNet Workplace with your Microsoft Office applications and Outlook. You must complete the installation procedure on each machine that will use Workplace Application Integration. Installing Application Integration interactively You can access the Application Integration installation program from within the Workplace application. Complete the wizard screens to provide the appropriate values for your Application Integration installation. Installing Application Integration silently on page 196 To install the Application Integration software silently, save the ApplicationIntegration.exe file locally and then run it at the command line using the /s switch. Verifying your Workplace Application Integration installation on page 197 After you install Application Integration, you can verify your installation by trying the functions from within an integrated Microsoft application.

Installing Application Integration interactively

You can access the Application Integration installation program from within the Workplace application. Complete the wizard screens to provide the appropriate values for your Application Integration installation. To install the Application Integration software interactively: 1. Log onto the client machine with an account that has Administrator privileges. 2. Sign in to Workplace. 3. Click Author, and then click General Tools. 4. Scroll down and click Download Application Integration for Microsoft Office, and then do one of the following:
Optional installation tasks

195

v Click Open to run the program from its current location. v Click Save. In the Save As dialog box, find a location on your machine in which to download and save the ApplicationIntegration.exe file locally, and then click Save. After the file is saved to your hard drive, double-click the file to run the installer. The Welcome Wizard dialog box for Application Integration appears. Another Welcome dialog box appears. 5. Click Next. 6. Read the license agreement, and then select I accept the terms to the license agreement, and then click Next. If you do not accept the license agreement, you cannot continue with the install. 7. Do the following: v Select the applications you want to integrate, and then click Next. Remember: The Application Integration Toolkit Components option is required to use Application Integration. v Under Install to, the default installation path is displayed. Click Change to specify a different location on the Change Current Destination Folder dialog box, and then click OK. Click Next. You might see two default installation paths - one for Microsoft Office and Outlook, and another for the Toolkit Components. The Toolkit Components path only appears when the system on which you are installing Application Integration has the Toolkit Components currently installed. You cannot modify the Toolkit Components installation path. 8. Enter the server name, port number and application name that defines the Workplace address. The server name is the name of the web server running Workplace, port number is the web server assigned port, application is the directory where you installed the Workplace application files. Check Server uses secure connection (SSL) if you are running full SSL to encrypt all communication with Workplace. You can also leave these fields blank and enter the information when you log on to Workplace Application Integration. 9. Click Next. 10. Click Install. 11. After the install is complete, click Finish to complete the setup process.

Installing Application Integration silently

To install the Application Integration software silently, save the ApplicationIntegration.exe file locally and then run it at the command line using the /s switch. 1. Log in to the client machine using an account that has Administrator privileges. 2. Sign in to Workplace. 3. Click Author , and then click General Tools. 4. Scroll down and click Download Application Integration for Microsoft Office, and then click Save. In the Save As dialog box, find a location on your machine in which to download and save the ApplicationIntegration.exe file locally, and then click Save. 5. Open a DOS command window and change the current directory to the one where ApplicationIntegration.exe resides. 6. Type the following at the command line:

196

Installation Guide

ApplicationIntegration.exe /s/v"/qn <additional msi arguments included in string> LICENSE_ACCEPTED=true"

Use the /s switch to launch the execution silently and include the /qn switch in the msi string to make msi run silently. See the following optional command line values you can also use. Append the values within the string containing the msi arguments. For example:
ApplicationIntegration.exe /s/v"/qn /L*v C:\temp\AppIntSetup.txt LICENSE_ACCEPTED=true" Command Line Values ADDLOCAL=ALL ADDLOCAL=ALL REMOVE=OutlookIntegrationFeature ADDLOCAL=ALL REMOVE=OfficeIntegrationFeature Installs All Features Office Only Outlook Only

ADDLOCAL=ALL Core Only REMOVE=OutlookIntegrationFeature,OfficeIntegrationFeature

Command Line Values HOST=<host name> PORT=<port number> APPLICATION=<application name>

Settings Enter the name of the web server running Workplace. Enter the web server's assigned port number. Enter the directory in which you installed the Workplace application files. Set Application Integration to use an https connection Set Application Integration to use http connection. This is the default if this parameter is not passed. Set Application Integration to not use single sign-on (SSO). Set Application Integration to use single sign-on (SSO). Verbose installation log and specify log location.

SERVER_CONNECTION=1 SERVER_CONNECTION=0

SINGLE_SIGNON=0

SINGLE_SIGNON=1 /L*v C:\temp\AppIntSetup.txt

Verifying your Workplace Application Integration installation

After you install Application Integration, you can verify your installation by trying the functions from within an integrated Microsoft application. 1. Start Microsoft Word. 2. From the File menu, click FileNet P8, click Open Document, and then click Select Item. The Logon dialog box opens. 3. Log on with any valid domain account. The available object stores in your environment are displayed. If you did not enter the Workplace Address information during the installation, you can enter the server name, port number, and application name that define the Workplace address. The server name is the name of the web server running
Optional installation tasks

197

Workplace, the port number is the assigned port of the web server, and the application is the directory where you installed the IBM FileNet P8 Workplace application files. Check Server uses secure connection (SSL) if you use a full SSL to encrypt all communication with Workplace. Do not select this option if you use a SSL redirect during logon. 4. Close all dialog boxes and close Microsoft Word.

Installing Workplace File Tracker

If you want to use the file tracking feature without installing Application Integration, you can install Workplace File Tracker. Complete the installation on each machine that will use Workplace File Tracker. If you have already installed or upgraded to Application Integration 3.5.1-002 or higher, then the File Tracker feature has already been installed. Do not perform this procedure if you already installed a version of Application Integration that includes File Tracker, including Application Integration 4.0. If you have already installed Application Integration 3.5.1-001 or earlier, upgrade it to 4.0 plus the latest fix pack, and this will include the File Tracker installation. Installing the File Tracker software interactively You can download File Tracker from Workplace. To run the File Tracker software installation, you must have Administrator privileges and use the General Author tools in Workplace. Installing the File Tracker software silently on page 199 To install the File Tracker software silently, save the FileTracker.exe file locally and run it at the command line using the /s switch. You can include optional command line values when your run the installation program.

Installing the File Tracker software interactively

You can download File Tracker from Workplace. To run the File Tracker software installation, you must have Administrator privileges and use the General Author tools in Workplace. To install File Tracker interactively: 1. Log on to the client machine using an account that has Administrator privileges. 2. Sign in to Workplace. 3. Click Author, and then click General Tools. 4. Scroll down and click Download File Tracker and do one of the following: v Click Open to run the program from its current location. v Click Save. In the Save As dialog box, find a location on your machine in which to download and save the FileTracker.exe file locally, and then click Save. After the file is saved to your hard drive, double-click the file to run the installer. The Welcome Wizard dialog box for File Tracker appears. Another Welcome dialog box appears. 5. Click Next. 6. Read the license agreement, and then select I accept the terms to the license agreement, and then click Next. If you do not accept the license agreement, you cannot continue with the install.

198

Installation Guide

Do one of the following: Click Change if you want to install File Tracker to a different location. Specify the location to which you want to install File Tracker, and then click OK. Click Next. v Click Next to accept the default location. 8. Click Install. 9. After the install is complete, click Finish to complete the setup process. 10. (On Vista using Internet Explorer 7.0 only) Add the Workplace URL to the browser security tab. a. In the Internet Explorer 7.0 browser, click Tools > Internet Options. Click the Security tab. b. Select Trusted Sites, and click the Sites button. c. Add the Workplace URL and click Add. d. Click OK, and OK again to save changes. 7. v If you want file tracking to be available to all users who have downloaded the File Tracker application, set the Enable file tracking preference in the site preferences. For more information, see Working with documents > Working with documents with Workplace > Site preferences > General preferences > File tracking.

Installing the File Tracker software silently

To install the File Tracker software silently, save the FileTracker.exe file locally and run it at the command line using the /s switch. You can include optional command line values when your run the installation program. To install File Tracker software silently: 1. Log in to the client machine using an account that has Administrator privileges and sign in to Workplace. 2. 3. Click Author, and then click General Tools. Scroll down and click Download File Tracker and click Save. In the Save As dialog box, find a location on your machine in which to download and save the FileTracker.exe file locally, and then click Save . 4. Open a DOS command window and change the current directory to the one that contains FileTracker.exe. 5. Type the following at the command line:
FileTracker.exe /s /v"/qn <additional msi arguments included in string> LICENSE_ACCEPTED=true"

Use the /s switch to launch the execution silently and include the /qn switch in the msi string to make msi run silently. In addition, be aware of spaces specified between switches in the above example. Using the correct spacing ensures a successful silent install. Refer to the following optional command line values you can also use. Append the values within the string containing the msi arguments. For example:
FileTracker.exe /s /v"/qn /L*v C:\temp\FileTrackerSetup.txt LICENSE_ACCEPTED=true"

Optional installation tasks

199

Command Line Values /L*v C:\temp\FileTrackerSetup.txt

Settings Verbose installation log and specific log location. If you intend to specify a log location, create the directory before running the silent install. If the directory is not created ahead of time, the install will fail.

6. (On Vista using Internet Explorer 7.0 only) Add the Workplace URL to the browser security tab as follows: a. In the Internet Explorer 7.0 browser, click Tools > Internet Options. Click the Security tab. b. Select Trusted Sites, and click the Sites button. c. Add the Workplace URL and click Add. d. Click OK, and OK again to save changes. If you want file tracking to be available to all users who have downloaded the File Tracker application, set the Enable file tracking preference in the site preferences. For more information, see Working with documents > Working with documents with Workplace > Site preferences > General preferences > File tracking.

Deploying multiple Application Engine instances

You can deploy multiple instances of Workplace on a single application server. Each deployment of Workplace must use the same Content Engine, Process Engine, and connection point. Each deployment of Workplace might use different Site Preference settings and might provide access to different object stores. v The following procedure assumes that you have already installed Application Engine and performed the configuration tasks according to your application server type. v When deploying multiple instances of Workplace, make copies of all the Workplace configuration and working files. Each instance of Workplace will use separate configuration, deploy, download, upload, and Workplace files. Leave the default installed files unmodified. v For more information on how to deploy and manage multiple identical applications, see your application server documentation. To deploy a second instance of the Workplace application: Deploying a second instance of Workplace Each deployment of Workplace might use different Site Preference settings and might provide access to different object stores. Deploying each additional Workplace instance as an EAR file on page 201 You can choose to deploy your additional application instance as an EAR file. You must perform the additional configuration for each custom Workplace instance you plan to deploy.

Deploying a second instance of Workplace

Each deployment of Workplace might use different Site Preference settings and might provide access to different object stores. To deploy a second instance of the Workplace application:

200

Installation Guide

1. Make a copy of the /FileNet/Config/AE directory, including all of its contents, for each instance you plan to deploy. For example, if you are deploying two instances, you would create: install_path/FileNet/Config/AE1 install_path/FileNet/Config/AE2 2. Make copies of the upload and download directories in the install_path/FileNet/AE directory. For example, you would create: install_path/FileNet/AE/Download1 install_path/FileNet/AE/Upload1 install_path/FileNet/AE/Download2 install_path/FileNet/AE/Upload2 3. Make a copy of the deploy directory and all of its contents for each Workplace instance. For example, you would create: install_path/FileNet/AE/deploy1 install_path/FileNet/AE/deploy2 4. Make a copy the Workplace directory and all of its contents for each Workplace instance. For example, you would create: install_path/FileNet/AE/Workplace1 install_path/FileNet/AE/Workplace2 5. Navigate to each custom copied Workplace web.xml instance and update the path for the configuration directory, upload directory, and download directory locations. For example, in the install_path/FileNet/AE/Workplace1/WEB-INF/web.xml, you would make the following changes:
<context-param> <param-name>configurationDirectory</param-name> <param-value>/opt/FileNet/Config/AE1</param-value> </context-param> <context-param> <param-name>uploadDir</param-name> <param-value>/opt/FileNet/AE/Upload1</param-value> </context-param> <context-param> <param-name>downloadDir</param-name> <param-value>/opt/FileNet/AE/Download1</param-value> </context-param>

Deploying each additional Workplace instance as an EAR file

You can choose to deploy your additional application instance as an EAR file. You must perform the additional configuration for each custom Workplace instance you plan to deploy. 1. Modify the application.xml file located in the copied deploy directories, as follows: a. Open each instance of the application.xml file, for example, install_path/FileNet/AE/deploy1/META-INF/application.xml. b. Change the <display-name> and the <context-root> elements to your custom name, for example, Workplace1.
<display-name>Workplace1</display-name> <description>FileNet Application Engine</description> <module> <web>
Optional installation tasks

201

<web-uri>app_engine.war</web-uri> <context-root>Workplace1</context-root> </web> </module>

2. In the create_app_engine_war file, set the install home and deploy directory to match your custom names. For example, you would make the following changes:
install_home="/opt/FileNet/AE/Workplace1" "${install_home}/../_AEjvm/bin/jar" -cf "${install_home}/../ deploy1/app_engine.war"*

3. In the create_app_engine_ear file, set the install home, deploy directory, and EAR file to match your custom names. For example, you would make the following changes:
install_home="/opt/FileNet/AE/Workplace1" cd "${install_home}/../deploy1" "${install_home}/../_AEjvm/bin/jar" -cvf "${install_home}/../ deploy1/app_engine1.ear" META-INF *.war

4. Delete the existing app_engine.war and app_engine.ear files. 5. Create your custom WAR and EAR files by running the create_app_engine_war and then the create_app_engine_ear files. 6. Deploy the EAR file for each custom Workplace instance according to the procedures for your application server type. 7. Install any service packs, fix packs, or interim fixes required. To determine whether such additional software updates are needed, access the IBM FileNet P8 Platform support site.

Enabling Application Engine to use ISRA

Image Services Resource Adaptor (ISRA) is a J2EE connector to the IBM FileNet Image Services libraries. Using ISRA, Workplace users can view FileNet Image Services documents and their associated annotations in the FileNet Image Viewer and, if they have the appropriate permissions, update the annotations. To enable Workplace users to view documents by using ISRA: v Install Application Engine. v Install FileNet Image Services Resource Adaptor. For information on installing, configuring and deploying FileNet ISRA, See the Image Services Resource Adapter documentation in the FileNet ISRA installation package. Tip: Use the Sample Application shipped with FileNet ISRA to confirm that the ISRA installation was successful. Important: In an ISRA upgrade situation, take care to use the same library name (JNDI connection factory name) that has been previously set in the ISRA installation. Changing this variable can cause conflicts when accessing documents. v Install the Application Engine ISRA Servlet and take the following into account: Install and deploy ISRA before installing and deploying the ISRA Servlet. Deploy the ISRA Servlet on the same application server as FileNet ISRA. It is not necessary to install the ISRA Servlet on the Application Engine server. See ISRA SSL support on page 203 for details that might affect your collocation plans.

202

Installation Guide

Configure Workplace Site Preferences. ISRA SSL support The following table details supported SSL configurations for ISRA. Installing and deploying the Application Engine ISRA servlet To install and deploy the ISRA Servlet on the operating systems supported by Application Engine, run the associated ISRA setup program found in the Application Engine software package. Configuring Workplace site preferences for ISRA on page 205 Before using the ISRA servlet, you must enable the FileNet Image Services external service and set the ISRA Interface Servlet URL in Workplace Site Preferences. Logging in to FileNet Image Services by using an LDAP account on page 206 In order to log in to FileNet Image Services by using your LDAP account, you must configure ISRA for LDAP authentication. Accessing FileNet Image Services library documents on page 206 For information about accessing FileNet Image Services library documents, see Working with documents > Working with documents with Workplace > Documents > Add a document.

ISRA SSL support

The following table details supported SSL configurations for ISRA.
SSL Configuration ISRA Servlet and Application Engine collocated. Application Engine configured for SSL logon redirect to a non-local host. ISRA Servlet and Application Engine collocated. Application Engine configured for SSL logon redirect to a local host. ISRA Servlet and Application Engine collocated. Application Engine and ISRA Servlet running under SSL. ISRA Servlet remote from Application Engine. Application Engine configured for SSL logon redirect to a non-local host. ISRA Servlet remote from Application Engine. Application Engine configured for SSL logon redirect to a local host. ISRA Servlet remote from Application Engine. Application Engine running under SSL, ISRA Servlet not running under SSL. SSL Support Supported

Supported

Not Supported

Supported

Supported

Supported

ISRA Servlet remote from Application Not Supported Engine. Application Engine and ISRA Servlet running under SSL.

Installing and deploying the Application Engine ISRA servlet

To install and deploy the ISRA Servlet on the operating systems supported by Application Engine, run the associated ISRA setup program found in the Application Engine software package. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities.
Optional installation tasks

203

The Application Engine installation software contains the ISRA servlet installation programs for the supported Application Engine operating systems. To install and deploy the Application Engine ISRA servlet: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Engine values, filter by ISRA Installer in the Installation or Configuration Program column. 2. Log on to the application server by using the following account, depending on your operating system:
Option Windows Description A member of the local Administrators group or as a user account with equivalent permissions.

3. Stop the application server instance if it is running. 4. Access the ISRA installation package, and start the following Application Engine ISRA Servlet setup program, depending on your operating system:
Option Windows Description AE-ISRA-Servlet-4.0.2.0-WIN.exe

5. Complete the installation program screens by using the values from your worksheet. 6. Check the file AE_ISRA_Servlet_install_log-4_0_2_0.txt, located in the AE_israservlet_install_path\FileNet directory, to see if any errors occurred during the installation. 7. Install unlimited strength JAR files. Perform this step only if the following are true: v You selected the option to create Strong keys in the Application Engine User Token Security step of the Application Engine installation. v Application Engine ISRA Servlet is deployed on a different application server than Application Engine. Important: If these conditions are true, failure to perform this step causes an EncryptionException when you log on to the IS server. 8. (WebSphere Application Server and WebLogic Server only) Start the application server instance. 9. Deploy AE_israservlet_install_path/FileNet/ ApplicationEngineISRAServlet/ae_isra.war in the same way you deployed the app_engine.war file for Workplace. 10. Verify the Application Engine ISRA Servlet is installed and deployed correctly, as follows. This step launches a diagnostic tool that does the verification. a. Open your web browser. b. Enter the URL for the Application Engine ISRA Servlet, for example: http://ApplicationEngineISRAServlet_servername:port/ ApplicationEngineISRAServlet/ISRA

| |

204

Installation Guide

ApplicationEngineISRAServlet is the default context root. If you specified a different name for the context root when deploying the Application Engine ISRA Servlet, change the URL to match your configuration. If the ISRA Servlet is set up correctly, a congratulations message displays, for example:
Congratulations! ISRA Interface Servlet is configured at this URL. WcmApiConfigFile = D:\ISRAInterface\jsp\WEB-INF\WcmApiConfig.properties WcmApiConfig file exists CryptoKeyFile/UserToken = C:\Program Files\FileNet\Authentication\UTCryptoKeyFile.properties CryptoKeyFile/UserToken exists FileNet ISRA classes are in the classpath com.filenet.is.ra.cci.FN_IS_CciConnectionSpec

Related tasks Starting or stopping an application server instance

Configuring Workplace site preferences for ISRA

Before using the ISRA servlet, you must enable the FileNet Image Services external service and set the ISRA Interface Servlet URL in Workplace Site Preferences. The Application Engine installation program installs the pre-configured Image Services external service, which includes the parameterized values necessary to access FileNet IS libraries from Workplace. To configure Workplace Site Preferences for ISRA Servlet support: 1. Sign in to Workplace as a user having the Application Engine Administrators access role. 2. Launch Site Preferences as follows: a. Select Admin. b. Select Site Preferences. 3. Enable the pre-configured Image Services external service, as follows: a. Select External Services from the left options list. b. Select Modify for the Image Service, located under External Reference Services. The External Reference Service Settings site preference page displays. c. Under General Information, locate Show on Select File page and change the value to Show. d. Accept the setting. 4. Set the ISRA Interface Servlet URL as follows: a. Select Bootstrap. b. Under Preferences Settings, set the value of ISRA Interface Servlet URL. For example: http://servername:port/ApplicationEngineISRAServlet/ISRA ApplicationEngineISRAServlet is the default context root. If you specified a different name for the context root when deploying the Application Engine ISRA Servlet, change the URL to match your configuration.
Optional installation tasks

205

c. Accept the setting. d. Exit Site Preferences.

Logging in to FileNet Image Services by using an LDAP account

In order to log in to FileNet Image Services by using your LDAP account, you must configure ISRA for LDAP authentication. To log in to the FileNet Image Services library by using your LDAP account: 1. Configure ISRA for LDAP authentication. For information on configuring LDAP authentication for ISRA, See the ISRA Installation and Deployment Guide. For information on configuring LDAP authentication for FileNet Image Services, See the Image Services System Tools Reference Manual. 2. Configure FileNet Image Services for LDAP authentication. If the LDAP account with which you accessed Workplace is not valid for the FileNet Image Services library, or if LDAP authentication is not configured, you will be prompted to log in to the FileNet Image Services library.

Accessing FileNet Image Services library documents

For information about accessing FileNet Image Services library documents, see Working with documents > Working with documents with Workplace > Documents > Add a document.

Installing and configuring IBM System Dashboard for Enterprise Content Management
Content Engine, Application Engine, and Process Engine install, by default, the necessary software required for the System Manager performance component. To use System Manager, enable associated components and install IBM System Dashboard for Enterprise Content Management to perform related configuration procedures to enable System Manager. Installing Dashboard is not necessary if you currently have IBM FileNet System Monitor installed. See the following IBM FileNet P8 help topic Developing IBM FileNet P8 applications > FileNet System Manager Development for instructions on how to enable the associated System Manager components. See the documentation provided with IBM System Dashboard for Enterprise Content Management for instructions on how to use Dashboard. Related information Product documentation for installing IBM System Dashboard Download the product documentation for IBM System Dashboard from the IBM FileNet P8 Platform documentation download page.

Modifying an Autonomy K2 server configuration

You can add Autonomy K2 servers or move existing servers to new hardware.

206

Installation Guide

Adding additional K2 administration servers You must install additional Autonomy K2 Administration Servers to handle the indexing load. The Master Administration Server is the main hub for configuring all the servers you install. The additional servers are managed through the K2 Dashboard that is installed with the Master Administration Server. Moving Autonomy K2 servers to new hardware on page 209 To move an existing installation of the Autonomy K2 Master Administration server configuration, the installation must be imaged and then restored on the new hardware. If any details of the new configuration do not match the previous configuration, the configuration will not work. Dedicating a Verity domain to one object store on page 211 In general, a FileNet P8 domain has multiple object stores, and all the indexed objects are stored in a single Verity domain. You can improve scalability and performance by dedicating a Verity domain to one object store. By configuring a new Verity domain for each object store and reusing the existing Verity index collections, you can avoid the need to re-index all of the content of an object store.

Adding additional K2 administration servers

You must install additional Autonomy K2 Administration Servers to handle the indexing load. The Master Administration Server is the main hub for configuring all the servers you install. The additional servers are managed through the K2 Dashboard that is installed with the Master Administration Server. Important: A K2 Master Administration Server must be installed before you add additional K2 Administration Servers. Installing additional Autonomy K2 administration servers (Windows) You can install additional Autonomy K2 servers as part of a IBM Legacy Content Search Engine configuration. Configuring additional K2 administration servers on page 209 If you want to add and use additional K2 Index Servers or Search Servers in an existing configuration, you must enable them through Enterprise Manager.

Installing additional Autonomy K2 administration servers (Windows)

You can install additional Autonomy K2 servers as part of a IBM Legacy Content Search Engine configuration. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To install additional Autonomy K2 administration servers interactively: 1. Open your completed Installation and Upgrade Worksheet file. Tip: In the worksheet file, verify that the Data > Filter > AutoFilter command is enabled. To view only Content Search Engine values, filter by CSE Installer in the Installation or Configuration Program column. 2. Log on to the host machine as k2_os_user. 3. Install IBM Legacy Content Search Engine interactively or silently: Installing additional Autonomy K2 administration servers interactively (Windows) on page 208 To install additional Autonomy K2 administration servers interactively, you run the IBM Legacy Content Search Engine installation program interactively.
Optional installation tasks

207

Installing additional Autonomy K2 administration servers silently (Windows) To install additional Autonomy K2 administration servers interactively, you run the IBM Legacy Content Search Engine installation program silently. Installing additional Autonomy K2 administration servers interactively (Windows): To install additional Autonomy K2 administration servers interactively, you run the IBM Legacy Content Search Engine installation program interactively. To install additional Autonomy K2 administration servers interactively: 1. Access the IBM FileNet P8 Content Search Engine installation package and run the 5.0.0-P8CSE-WIN.EXE file. 2. Complete the installation program screens by using the values in your worksheet. 3. Review the following IBM Legacy Content Search Engine log files for installation errors. The files are located in the verity directory of the installation path: v verity_install_path\cse_install_log_5.0.0.log v verity_install_path\vconfig.log It is a best practice to review log files even if the IBM Legacy Content Search Engine installation program does not indicate any errors. Some errors noted in the log files are benign. If an error is not benign (that is, you cannot subsequently index or search for documents), refer to the log file for help in determining the cause. 4. Verify that the following two Windows services are installed on your machine after the installation finishes: v Verity K2 6.2.1 Administration Server service v Verity K2 Administration Web Server service (Tomcat server) Installing additional Autonomy K2 administration servers silently (Windows): To install additional Autonomy K2 administration servers interactively, you run the IBM Legacy Content Search Engine installation program silently. To install additional Autonomy K2 administration servers interactively: 1. Edit the cse_silent_install.txt file to reflect the appropriate responses for your installation by using the values from your worksheet. 2. Run the IBM FileNet P8 Content Search Engine installation program by executing the following command:
5.0.0-P8CSE-WIN.EXE -f CSE_silent_install.txt -i silent

3. Review the following IBM Legacy Content Search Engine log files for installation errors. The files are located in the verity directory of the installation path: v verity_install_path\cse_install_log_5.0.0.log v verity_install_path\vconfig.log It is a best practice to review log files even if the IBM Legacy Content Search Engine installation program does not indicate any errors. Some errors noted in the log files are benign. If an error is not benign (that is, you cannot subsequently index or search for documents), refer to the log file for help in determining the cause.

208

Installation Guide

4. Verify that the following two Windows services are installed on your machine after the installation finishes: v Verity K2 6.2.1 Administration Server service v Verity K2 Administration Web Server service (Tomcat server)

Configuring additional K2 administration servers

If you want to add and use additional K2 Index Servers or Search Servers in an existing configuration, you must enable them through Enterprise Manager. 1. Log on to Enterprise Manager as the GCD Administrator and expand the Enterprise Manager tree. 2. Open the Index Area folder. 3. Right-click the index area that you want to add the new services to and select Properties. 4. Enable the new Search Servers as follows: a. Click Edit Search Servers. b. In the Search Servers Available pane, highlight any servers you want to enable for this index area and click Add to add the server to the Search Servers Selected list. c. Click OK to save the settings and enable the new servers. 5. Enable the new Index Servers as follows: a. Click Edit Index Servers. b. In the Index Servers Available pane, highlight any servers you want to enable for this index area and click Add to add the server to the Index Servers Selected list. c. Click OK to save the settings and enable the new servers.

Moving Autonomy K2 servers to new hardware

To move an existing installation of the Autonomy K2 Master Administration server configuration, the installation must be imaged and then restored on the new hardware. If any details of the new configuration do not match the previous configuration, the configuration will not work. To move K2 Master Administration Server software to new hardware: 1. Back up your Autonomy K2 Master Administration Server configuration. 2. Configure the new machine. 3. Restore your Autonomy K2 Master Administration Server installation. Moving K2 administration server software to new hardware on page 210 Follow this procedure to maintain your existing configuration on new hardware. Alternatively, you can remove the server from your configuration (see procedure below) and then create a new configuration after installing the K2 Administration Server software. Removing K2 administration servers from your Content Search Engine configuration on page 210 To remove K2 administration servers from your Content Search Engine configuration, remove the appropriate K2 Administration server from the dashboard configuration.

Optional installation tasks

209

Moving K2 administration server software to new hardware

Follow this procedure to maintain your existing configuration on new hardware. Alternatively, you can remove the server from your configuration (see procedure below) and then create a new configuration after installing the K2 Administration Server software. To move your existing configuration to new hardware, your new hardware must be configured the same as the previous machine. All drives and shares must be named the same and each server must have the same host name and IP addresses. To move K2 administration server software to new hardware: 1. Take careful note of all aspects of your current Content Search Engine configuration. Record all share names, host names, server ports, and IP addresses. Record the server names and ports of all configured server services in the K2 Dashboard, and their locations. 2. If collections are stored on this machine, make a backup copy. 3. Set up your new hardware and ensure the machine host name and IP address match your previous configuration. 4. Follow the Add Additional K2 Administration Servers procedure above to install the K2 Administration Server software on the new machine. 5. Create the services for this machine in the K2 Master Administration Server dashboard and ensure all server services are named the same as your previous configuration and ensure all servers created in the Autonomy K2 Dashboard are named the same and configured for the same ports. You can change the ports; but if you do so, must reboot the Content Engine servers. The names of the search servers, index servers and brokers might not be changed for any items referenced by an index area on the Content Engine servers. 6. Restore the collections to the same Root Dir Path (as specified in the index area properties) as before. If the collections are no longer available, mark those collections as unavailable, and then run a reindexing job on those collections. Otherwise copy/restore those collections via whatever tool you used to save them. 7. Modify the appropriate directory path entries in the Verity.cfg file.

Removing K2 administration servers from your Content Search Engine configuration

To remove K2 administration servers from your Content Search Engine configuration, remove the appropriate K2 Administration server from the dashboard configuration. 1. If collections were stored on the machine you want to remove: a. Determine which K2 Server will hold the collections. On that machine, create a new collections directory and temp directory and assign the appropriate permissions. For details, see Creating a IBM Legacy Content Search Engine collections directory on page 115. Important: See the index area properties (Root Dir Path) for the collections location for the appropriate index area. b. Modify the appropriate directory path entries in the verity.cfg file. c. Move the collections to the new location. 2. Modify the index area to use the index servers and search servers of the machine to which the collections were moved.

210

Installation Guide

3. Access the K2 Dashboard and remove the appropriate K2 Administration server from the dashboard configuration.

Dedicating a Verity domain to one object store

In general, a FileNet P8 domain has multiple object stores, and all the indexed objects are stored in a single Verity domain. You can improve scalability and performance by dedicating a Verity domain to one object store. By configuring a new Verity domain for each object store and reusing the existing Verity index collections, you can avoid the need to re-index all of the content of an object store. Important: If you intend to change the language on the object store, do not reuse preexisting collections. Instead, you must re-index the content. To dedicate a Verity domain to one object store: 1. Install and configure IBM Legacy Content Search Engine (Autonomy K2) on a machine. Note that to take an Autonomy K2 machine out of one Verity domain and put it in another Verity domain, you have to uninstall and then reinstall Autonomy K2. 2. Define a new VerityDomainConfiguration object using IBM FileNet Enterprise Manager: a. Log on to IBM FileNet Enterprise Manager. b. Navigate to the properties page of the FileNet P8 domain and click the Verity Domains tab. c. Click Create Configuration and establish a new Verity domain object. Note that all existing Verity domains are displayed in the Verity Domains tab. d. Enable Content Engine CBR tracing. e. Disable the CBR Dispatcher on each P8 Server within the same Site as the object store whose collections you are moving. By default, the CBR Dispatcher is enabled or disabled at the P8 Domain level. If you have multiple virtual P8 sites, you might have overridden this setting at the P8 Site level. If you upgraded FileNet P8 from version 4.0.1, you might have overridden the setting at the Server level. You can find your setting on the Verity Server tab on the FileNet P8 Domain, Site, Virtual Servers, or Server properties page. 3. Check the Content Engine CBR trace by looking for the last line that indicates the number of active or running CBR executors for the object store. The following lines are typical trace lines:
Active CBR Executor count is 0 for Object Store TestOS1 Running CBR Executor count is 0 for Object Store TestOS1

If the active count or the running count is greater than 0, then wait until the trace log specifies a 0 value: 4. Open the Properties page of the object store and click the CBR tab. 5. Select the VerityDomainConfiguration object in the drop-down list that contains all the available Verity domains. 6. Copy the Verity collections for the object store from the original Verity domain location to the new one: a. Navigate to the path identified in the index area as the Root Dir Path. b. Copy the directories that have the name of the object store to a new Root Dir Path that the new Verity domain can access.

Optional installation tasks

211

Important: Do not put the Autonomy K2 collections from multiple domains into the same directory. 7. In the Autonomy K2 dashboard for the Verity domain whose collections you copied, remove the collections that have the name of the object store. 8. Open the properties page for each index area associated with the object store and verify that the following values are correct: v Root Dir Path v Temp Dir Path v Verity Search Servers v Verity Index Servers 9. Enable the CBR Dispatcher for each Content Engine server in the FileNet P8 site. 10. Repeat the preceding steps if you have another object store that needs a dedicated Verity domain.

Installing the COM compatibility layer (CCL)

The option to install the COM compatibility layer is available as part of the IBM FileNet P8 Content Engine installer. To install the COM Compatibility Layer (CCL) from the IBM FileNet Content Engine installer: 1. In the Choose Components dialog, select .NET Client, then click Next. 2. In the .NET API COM Compatibility Layer (CCL) Server URL dialog, enter a valid URL for the CCL (for example, http://localhost:9080/wsi/ FNCEWS40MTOM/ ). Note that if you do not enter a valid URL, the CCL will not be installed. If you do not install the CCL during the initial installation, you have the option of installing later by running the Content Engine installer again. You can also install the CCL anytime by using the Configuration Manager tool.

212

Installation Guide

Part 3. Removing software

Removing IBM FileNet P8 software can involve deleting one or more core components, expansion products, and the FileNet P8 documentation. For instructions on removing the Rendition Engine software, see the IBM FileNet P8 guide FileNet P8 Documentation > FileNet P8 System Installation > Rendition Engine Installation and Upgrade. Removing the IBM FileNet P8 documentation on page 215 To remove the IBM FileNet P8 documentation, you must remove the locally deployed Web application that contains the IBM FileNet P8 information center. Removing Content Engine on page 217 You can uninstall an entire Content Engine installation or selected Content Engine components. Removing IBM FileNet Content Search Engine on page 219 You can remove either of the IBM FileNet Content Search Engine options, IBM Content Search Services or IBM Legacy Content Search Engine, from Windows and UNIX platforms on your system. Removing Process Engine (Windows) on page 223 You can remove Process Engine from Windows platforms interactively or silently. Removing Application Engine (WebSphere) on page 225 Removal of the Application Engine for WebSphere on UNIX and Windows platforms requires that you log on to the application server and run the uninstall program. Removing the Application Engine ISRA servlet on page 227 Removal of the Application Engine ISRA Servlet for Windows and UNIX environments requires that you logon to the application server, undeploy the servlet, and run the uninstall program. Removing Workplace Application Integration on page 229 You can remove Application Integration by using the Microsoft Windows Control Panel, or you can remove the program files silently from the command line. Removing Workplace File Tracker on page 231 You can remove File Tracker by using the Microsoft Windows Control Panel, or you can remove the program files silently from the command line.

Copyright IBM Corp. 2001, 2011

213

214

Installation Guide

Removing the IBM FileNet P8 documentation

To remove the IBM FileNet P8 documentation, you must remove the locally deployed Web application that contains the IBM FileNet P8 information center. The procedure can be slightly different for each application server type and version. Use the documented procedures only for reference. Your specific installation directories and application names might vary. In some Windows installations where NTFS is used for the file system, rather than FAT or FAT32, there is a known issue with deleting files and directories that are longer than 256 characters. For example, if you use a default WebSphere Application Server installation location, you might encounter an error where the IBM FileNet P8 documentation files cannot be properly deleted due to the number of characters in the file or directory names. See the Microsoft Knowledge Base for possible articles that contain additional information about deleting files and directories in this environment. Removing the FileNet P8 documentation from a WebSphere Application Server To remove the FileNet P8 documentation from an application server, you must delete all the directories and files associated with the FileNet P8 information center. You must also delete the p8docs.war file that was installed by the FileNet P8 documentation installation program.

Removing the FileNet P8 documentation from a WebSphere Application Server

To remove the FileNet P8 documentation from an application server, you must delete all the directories and files associated with the FileNet P8 information center. You must also delete the p8docs.war file that was installed by the FileNet P8 documentation installation program. To remove the FileNet P8 documentation: 1. Log on to the WebSphere Application Server computer that contains the FileNet P8 documentation.
Option Windows Description Log on with a user account that has local Administrative (or Account Operators and Server Operators) rights.

2. Verify that the WebSphere Application Server is running. 3. From the WebSphere administrative console (for example, http:// localhost:9060/ibm/console), choose Uninstall to remove the FileNet P8 documentation website, p8docs. 4. Delete the entire FileNet P8 documentation directory structure p8docs.war, from the installation location. 5. Delete any temp directories or log files for the FileNet P8 documentation. Attention: Be careful not to accidentally remove any other FileNet P8 application files that are installed on the application server, for example, Workplace application files.
Copyright IBM Corp. 2001, 2011

215

6. Run the following program file to remove the p8docs.war file that was installed by the FileNet P8 documentation installation program.
Option Windows Description Choose Control Panel > Add/Remove Programs and then select IBM FileNet P8 Information Center.

216

Installation Guide

Removing Content Engine

You can uninstall an entire Content Engine installation or selected Content Engine components. Uninstalling Content Engine does not undeploy it. You must use the application server console or commands to remove the Content Engine EAR file from the application server. Use one of the following procedures to uninstall part or all of Content Engine. Removing part or all of a Content Engine installation interactively by using the Windows control panel You can remove part or all of a Content Engine installation. Removing Content Engine silently In silent mode, the uninstaller removes all Content Engine components. Removing data associated with Content Engine on page 218 After uninstalling Content Engine, you can remove its associated data.

Removing part or all of a Content Engine installation interactively by using the Windows control panel
You can remove part or all of a Content Engine installation. To remove Content Engine: 1. Choose Control Panel > Add/Remove Programs. 2. Highlight P8 Content Engine in the list of currently installed programs and click Change/Remove to launch the Uninstall P8 Content Engine program. 3. In the Uninstall Options screen, choose to uninstall some or all Content Engine components. 4. In the Choose Components screen, choose which components to remove. 5. In the Uninstall Complete screen, note the directories and files that cannot be removed by the uninstall program and choose whether to have the program restart the machine, or restart it manually. 6. Remove the remaining directories and files, as noted in the Uninstall Complete screen. 7. If you want to completely remove all traces of the Content Engine installation, delete the C:\Program Files\IBM\FileNet directory.

Removing Content Engine silently

In silent mode, the uninstaller removes all Content Engine components. To uninstall Content Engine silently, run one of the following commands:
Option Windows Description ce_uninstaller.exe -i silent

Copyright IBM Corp. 2001, 2011

217

Removing data associated with Content Engine

After uninstalling Content Engine, you can remove its associated data. 1. Use the application server console or command lines to undeploy Content Engine. 2. Use the application server console or command lines to remove any database JDNI data sources associated with Content Engine object stores. 3. Use your database tools to drop any databases or table spaces for the object stores and the GCD. 4. Use your LDAP tools to delete users and groups you created in Plan and Prepare Your Environment for IBM FileNet P8. 5. Use your operating system commands to delete any directories, users, and groups that were used for installing and administering Content Engine. 6. Use your operating system commands to delete any file-storage-area directories that contain content, such as documents. 7. User your operating system commands to delete any index-area directories (K2 collections).

218

Installation Guide

Removing IBM FileNet Content Search Engine

You can remove either of the IBM FileNet Content Search Engine options, IBM Content Search Services or IBM Legacy Content Search Engine, from Windows and UNIX platforms on your system. Removing IBM Content Search Services software Removing IBM Legacy Content Search Engine on page 220 To completely remove IBM Legacy Content Search Engine (Autonomy K2) and collections from your IBM FileNet P8 Platform installation, you must disable full-text indexing. You must also remove the Autonomy K2 installations from all servers associated with Content Engine.

Removing IBM Content Search Services software

You can remove IBM Content Search Services software from your Process Simulator server computer interactively or silently. Perform the appropriate tasks on your IBM Content Search Services server computer for the type of software removal you want to perform. Removing IBM Content Search Services interactively You must remove all of the existing IBM Content Search Services servers before you can completely remove IBM Content Search Services from your IBM FileNet P8 Platform. Removing IBM Content Search Services silently on page 220 You can remove IBM Content Search Services silently by setting the uninstallation value in an input response file and running the uninstallation program from a command line.

Removing IBM Content Search Services interactively

You must remove all of the existing IBM Content Search Services servers before you can completely remove IBM Content Search Services from your IBM FileNet P8 Platform. The IBM Content Search Services interactive uninstallation program removes the existing servers individually from your IBM FileNet P8 Platform. You can use the IBM Content Search Services silent uninstallation program to remove IBM Content Search Services in its entirety. To remove IBM Content Search Services interactively: 1. Log in as css_install_user. 2. Access the IBM Content Search Services uninstallation package and run the css_install_path/_cssuninst/css_uninstaller (AIX, Linux, Solaris) or css_uninstaller.exe (Windows) file. 3. Select the IBM Content Search Services Server that you want to remove and click OK to uninstall the server. 4. (Optional) Repeat step 3 For each of the remaining servers you want to remove. Attention: You must remove all of the servers before you can complete the IBM Content Search Services uninstallation. 5. Click Uninstall to remove the IBM Content Search Services product. 6. At the Uninstallation Complete window, click OK.
Copyright IBM Corp. 2001, 2011

219

7. Remove the original server directories and the css-servers.xml file. 8. Review the css_install_path/css_uninstall_5.0.0.log file to verify that the uninstallation is complete.

Removing IBM Content Search Services silently

You can remove IBM Content Search Services silently by setting the uninstallation value in an input response file and running the uninstallation program from a command line. The IBM Content Search Services interactive uninstallation program removes IBM Content Search Services servers from the system individually. Running the silent uninstallation program removes IBM Content Search Services in its entirety. To 1. 2. 3. 4. remove IBM Content Search Services silently: Log on to the host computer as css_install_user. Open the css_install_path/_cssuninst/installvariables.properties file. Go to the SILENT_UNINSTALL_ALL line and set the value to TRUE. Save the edited response file to your temporary directory.

5. Go to the temporary directory on your local disk. 6. Run the IBM Content Search Services uninstallation program by running the appropriate command:
Table 24. Silent uninstallation commands Platform Windows Command css_uninstaller.exe -i silent -f installvariables.properties

7. Remove the original server directories and the css-servers.xml file. 8. Review the css_install_path/css_uninstall_5.0.0.log file to verify that the uninstallation is complete.

Removing IBM Legacy Content Search Engine

To completely remove IBM Legacy Content Search Engine (Autonomy K2) and collections from your IBM FileNet P8 Platform installation, you must disable full-text indexing. You must also remove the Autonomy K2 installations from all servers associated with Content Engine. Important: v If you remove or disable Autonomy K2 before you disable CBR and full-text indexing in Enterprise Manager, your system is rendered unusable and require considerable reconstruction. v This procedure presumes you have a running installation of version 5.0.0 of IBM Legacy Content Search Engine and that you have existing collections. v If you intend to remove Content Engine, skip to 4 on page 221. To remove IBM Legacy Content Search Engine: 1. Launch Enterprise Manager. 2. Disable CBR for any classes that have been enabled for CBR. a. Right-click the class you want to configure and click Properties. b. Click the General tab. c. Clear the CBR Enabled check box and click OK.

220

Installation Guide

d. A dialog asks if you want to propagate this change to the subclasses of this class. Click Yes. e. Repeat this procedure to disable CBR for all classes. 3. Run an index job and reindex any of these objects that were previously enabled: v Document v Annotation v Custom Object v Folder The index job disables all full-text indexing and content-based retrieval settings and deletes any associated collections. After the index job is complete, continue with the next step. 4. As k2_os_user, log on to the Master Administration Server machine in your IBM Legacy Content Search Engine configuration. 5. Complete the steps in the table to remove the Autonomy K2 software on the machine.
Option Windows Description 1. Access the Add or Remove Programs control panel and select IBM Legacy Content Search Engine. 2. Click Change/Remove.

6. Delete verity_install_path on the machine. 7. Repeat 5 and 6 for each remaining machine in your IBM Legacy Content Search Engine configuration. Removing additional IBM Legacy Content Search Engine locales (Windows) You can remove the additional IBM Legacy Content Search Engine locales that you installed on Windows machines when they are no longer needed.

Removing additional IBM Legacy Content Search Engine locales (Windows)

You can remove the additional IBM Legacy Content Search Engine locales that you installed on Windows machines when they are no longer needed. To remove locales: 1. Click Start > Add or Remove Programs. 2. To remove all single-language locales, select Verity Locales 6.1. Then right-click, and select Uninstall. 3. To remove all European locales, select Verity Single-Language European Locales 6.1. Then right-click and select Uninstall.

Removing IBM FileNet Content Search Engine

221

222

Installation Guide

Removing Process Engine (Windows)

You can remove Process Engine from Windows platforms interactively or silently. Removing Process Engine interactively (Windows) To remove Process Engine interactively from a Windows platform, you use the Add or Remove Programs tool. Removing Process Engine silently (Windows) on page 224 You can remove Process Engine silently from Windows platforms by running one command.

Removing Process Engine interactively (Windows)

To remove Process Engine interactively from a Windows platform, you use the Add or Remove Programs tool. To remove the Process Engine software interactively: 1. If the user pe_install_user who installed Process Engine is not a member of the local Administrators group: a. Log on as a member of the local Administrator group. b. Stop all the following components that are running:
Component Process Simulator Case Analyzer Component Manager Application Engine Content Engine Process Service Process Task Manager Server Process Simulator Case Analyzer Application Engine Application Engine Content Engine Process Engine Process Engine or Application Engine

c. Run the following commands to stop all process services and remove the Process Engine Manager service.
cd pe_program_files_install_path\ProcessEngine\installer\ RemoveVWServicesPE.bat

d. Log on as user pe_install_user. e. Uninstall Process Engine by running the following command:
cd pe_program_files_install_path\_uninstaller pe_uninstall.exe

f. Reboot if prompted. 2. If the user pe_install_user who installed Process Engine is a member of the local Administrators group: a. Log on as user pe_install_user. b. Uninstall Process Engine by either of the following two methods: v Run the Add or Remove Programs tool and choose Process Engine to be removed. v Run the following commands:

Copyright IBM Corp. 2001, 2011

223

cd pe_program_files_install_path\_uninstaller pe_uninstall.exe

c. In the uninstallation program, stop the BPM software components. d. Reboot if prompted. 3. If errors occur during the uninstallation, check the following files in the Temp directory (as identified by the TEMP or TMP environment variable): v pe500_uninstall_stderr.txt v pe500_uninstall_stdout.txt

Removing Process Engine silently (Windows)

You can remove Process Engine silently from Windows platforms by running one command. To remove the Process Engine software silently: 1. If the user pe_install_user who installed Process Engine is not a member of the local Administrators group. a. Log on as a member of the local Administrator group. b. Stop all the following components that are running:
Component Process Simulator Case Analyzer Component Manager Application Engine Content Engine Process Service Process Task Manager Server Process Simulator Case Analyzer Application Engine Application Engine Content Engine Process Engine Process Engine or Application Engine

c. Run the following command to stop all process services and remove the Process Engine Manager service.
cd pe_program_files_install_path\ProcessEngine\installer RemoveVWServicesPE.bat

d. Log on as user pe_install_user. e. Run the following program to uninstall Process Engine:
cd pe_program_files_install_path\ProcessEngine\_uninstaller pe_uninstall -i silent

2. If the user pe_install_user who installed Process Engine is a member of the local Administrators group: a. Log on as user pe_install_user. b. Run the following program to uninstall Process Engine:
cd pe_program_files_install_path\ProcessEngine\_uninstaller pe_uninstall -i silent

224

Installation Guide

Removing Application Engine (WebSphere)

Removal of the Application Engine for WebSphere on UNIX and Windows platforms requires that you log on to the application server and run the uninstall program. To remove the Application Engine software: 1. Log on to the application server.
Option Windows Description Log on as a member of the local Administrators group or a user with equivalent permissions.

2. Log in to the WebSphere administrative console. 3. Uninstall the Workplace application. a. Stop the Workplace process in the admin console. b. Uninstall the Workplace application from Enterprise Applications. 4. Navigate to the /_uninst folder under the Application Engine installation location. 5. Run the uninstall program:
Option Windows Description uninstaller.exe

Tip: For Windows, you can also use Add/Remove Programs from the Control Panel to remove the FileNet Application Engine. On Windows, when you click Next on the Application Engine Uninstaller Welcome screen, the second screen asks you to wait while Windows Task Manager service shuts down before continuing the uninstall. This can take a few moments. Wait for the shutdown to complete, then complete the uninstall wizard from the next screen. 6. Delete the Workplace folder: WAS_HOME/temp/node_name/ application_server_name/Workplace 7. Delete the AE_install_path directory. 8. (If Application Engine is the only IBM FileNet P8 application installed on the server) Search for the vpd.properties file. If it exists, delete it. Important: In the following step, do not remove the system environment variable if any other IBM FileNet P8 application is installed on the server.

Copyright IBM Corp. 2001, 2011

225

226

Installation Guide

Removing the Application Engine ISRA servlet

Removal of the Application Engine ISRA Servlet for Windows and UNIX environments requires that you logon to the application server, undeploy the servlet, and run the uninstall program. Since the installed names for the ISRA Servlet are configurable on the supported application servers, the following information might not be the same as your environment. Make the appropriate name changes as required for your environment. To remove the Application Engine Servlet software: 1. Log on to the application server.
Option Windows Description Log on as a user with Administrative rights.

2. Undeploy the ApplicationEngineISRAServlet application. This step is similar to that required to undeploy the Workplace application.
Option IBM WebSphere Application Server Description 1. Stop the ApplicationEngineISRAServlet process in the Admin console. 2. Uninstall the ApplicationEngineISRAServlet application from Enterprise Applications.

3. Navigate to the /_uninstISRA directory under the ISRA Servlet installation location. 4. Run the uninstall program:
Option Windows Description uninstall.exe

Tip: For Windows, you can also use Add/Remove Programs from the Control Panel to remove the FileNet Application Engine ISRA Servlet. 5. Navigate to the /FileNet directory. If there is no other FileNet software installed under this directory, delete the /FileNet directory. If there is some other FileNet software installed under this directory, delete only the /ApplicationEngineISRAServlet subdirectory. 6. (WebSphere Application Server only) Delete the following temporary working folders for the Application Engine ISRA Servlet: WAS_Home\WebSphere\ AppServer\profiles\default\installedApps\servername\ ApplicationEngineISRAServlet.ear\

Copyright IBM Corp. 2001, 2011

227

228

Installation Guide

Removing Workplace Application Integration

You can remove Application Integration by using the Microsoft Windows Control Panel, or you can remove the program files silently from the command line. Removing or modifying Workplace Application Integration interactively You can use Microsoft Windows Control Panel to remove, repair, or modify Workplace Application Integration. Removing Workplace Application Integration silently To silently uninstall Workplace Application Integration run msiexec.exe /X{35907B7D-02E2-490C-8F3B-54C4E3729D90} /qn at the command line.

Removing or modifying Workplace Application Integration interactively

You can use Microsoft Windows Control Panel to remove, repair, or modify Workplace Application Integration. To remove Application Integration: 1. Select Start > Settings > Control Panel > Add/Remove Programs > FileNet Workplace Application Integration 4.0. 2. Select the operation to perform: v Click Remove, and then click Yes to confirm you want to uninstall Workplace Application Integration. v Click Change to access maintenance tasks, and then click Next. You can modify, repair, or remove Application Integration using the maintenance tasks. Select the task to perform: Select Modify to add or remove integration with Microsoft applications from your previous install. For example, if you have both Microsoft Office and Outlook installed, you can remove one of the applications by using this option. The Custom Setup dialog box opens, where you select the option you want to add or remove. Click Next , and then click Install. Click Finish to complete the process. Select Repair to re-install Workplace Application Integration to repair installation errors, and then click Next. Click Install to start the repair process. Click Finish to complete the process. Select Remove to remove Workplace Application Integration from your system, and then click Next. Click Remove. After the application is removed from your system, click Finish to complete the process.

Removing Workplace Application Integration silently

To silently uninstall Workplace Application Integration run msiexec.exe /X{35907B7D-02E2-490C-8F3B-54C4E3729D90} /qn at the command line. 1. Open a command prompt. 2. Enter the following command to uninstall Workplace Application Integration:
msiexec.exe /X{35907B7D-02E2-490C-8F3B-54C4E3729D90} /qn

Copyright IBM Corp. 2001, 2011

229

230

Installation Guide

Removing Workplace File Tracker

You can remove File Tracker by using the Microsoft Windows Control Panel, or you can remove the program files silently from the command line. Removing Workplace File Tracker interactively You can use the Microsoft Windows Control Panel to uninstall Workplace File Tracker. Removing Workplace File Tracker silently You can use a command line option to silently uninstall Workplace File Tracker.

Removing Workplace File Tracker interactively

You can use the Microsoft Windows Control Panel to uninstall Workplace File Tracker. 1. From the Start menu, click Settings, and then click Control Panel. 2. Click Add/Remove Programs, and then click FileNet Workplace File Tracker. 3. Click Remove, and then click Yes to confirm you want to uninstall Workplace File Tracker.

Removing Workplace File Tracker silently

You can use a command line option to silently uninstall Workplace File Tracker. 1. Open a command prompt. 2. Enter the following command to uninstall Workplace File Tracker:
msiexec.exe /X{4291FBBC-C585-43ED-9416-5F22D8C6FEE9} /qn

Copyright IBM Corp. 2001, 2011

231

232

Installation Guide

Part 4. Appendixes

Copyright IBM Corp. 2001, 2011

233

234

Installation Guide

Appendix A. Configuration Manager reference

Configuration Manager is a tool for configuring and deploying new or upgraded instances of the Content Engine application on an application server. You use Configuration Manager to define the following information for the Content Engine instance: v Application server properties v Java Database Connectivity (JDBC) data source properties for the Global Configuration Data (GCD) database v Java Database Connectivity (JDBC) data source properties for each object store database v Directory service (LDAP) provider properties v Content Engine application login modules v Content Engine bootstrap properties Overview of Configuration Manager on page 236 You can use Configuration Manager to generate one or more unique Content Engine configuration profiles. A profile is a collection of information required to configure and deploy new or upgraded Content Engine instances. Handling passwords in Configuration Manager on page 239 To provide the highest possible security, Configuration Manager's default settings do not save passwords from the GUI application. The password save setting is a preference setting in the Configuration Manager graphical interface. While the default setting provides greater password security, it does require you to reenter all necessary passwords each time you start the GUI. When you close a profile in Configuration Manager, the passwords are removed from memory. When you open Configuration Manager or the profile again to run a saved task, you must reenter passwords to run the tasks. Accessing the Configuration Manager log files on page 239 Configuration Manager generates task execution messages, log files for each task, and a log file for diagnosing Configuration Manager errors. Correcting a dotnetclient configuration profile error on page 240 If you specified an incorrect value in the dotnetclient configuration profile .NET API COM Compatibility Layer (CCL) server URL during the installation of Content Engine, you need to edit the configmgr.properties file to correct the error. Adding an SSL signer to the Configuration Manager keystore (WebSphere) on page 241 If you are using SSL for communication between Configuration Manager and WebSphere Application Server you might receive an SSL signer error when you test the connection to the application server or when you run the Deploy Application task. To resolve the issue, make sure that you have an entry for the SSL signer in the truststore that Configuration Manager uses. Correcting an SSL Signer Exchange Prompt error (WebSphere) on page 242 If you are using SSL for communication between Content Engine and WebSphere Application Server, you might receive the SSL signer error SSL SIGNER EXCHANGE PROMPT when you run the task for configuring the JDBC data sources for the Global Configuration Data (GCD) or for an object store. Configuration Manager user interface reference on page 242 The Configuration Manager graphical user interface (GUI) lets you create, view,
Copyright IBM Corp. 2001, 2011

235

and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task. Configuration Manager command-line reference on page 260 Configuration Manager can be run from a command line. This section covers the syntax for the command-line version of Configuration Manager.

Overview of Configuration Manager

You can use Configuration Manager to generate one or more unique Content Engine configuration profiles. A profile is a collection of information required to configure and deploy new or upgraded Content Engine instances. Configuration profile concepts The information for a profile is collected in XML files in the form of properties and values that describe the associated configuration and deployment tasks. You must provide values for the profile properties that are specific to each configuration at your site, such as the application server name. Using the graphical and command-line user interfaces on page 238 Both the graphical user interface (GUI) and the command-line interface (CLI) create the configuration XML files with the property values specific to your site, run tasks to apply your settings, display task status results, and deploy the Content Engine application. Gathering Configuration Manager values by using the installation and upgrade worksheet on page 238 You can use the installation and upgrade worksheet to record the values that you must enter in Configuration Manager.

Configuration profile concepts

The information for a profile is collected in XML files in the form of properties and values that describe the associated configuration and deployment tasks. You must provide values for the profile properties that are specific to each configuration at your site, such as the application server name. The XML files are stored in a directory that is unique to a given profile. Because the profile name is used for both the directory name and the configuration file name, you must provide a profile name that is a valid directory name for your operating system. By default, the profiles are stored in the ce_install_path/tools/ configure/profiles directory, where ce_install_path is the location where Content Engine is installed. If needed, you can create multiple profiles, each of which supports a unique Content Engine instance. These instances can be located on the same server or on different servers, depending on your deployment preferences, the managed or non-managed nature of your application servers, and your clustering or high-availability requirements. Use Configuration Manager to perform the following tasks that are associated with a Content Engine configuration profile: v Set the application server properties. Content Engine will be deployed as an application on the application server. You must specify the application server type, the software version number, the server name, the administrative user name and password, and other settings. The application server type determines some of the properties and their default values. All profiles include the application server properties. By default, the application server properties are

236

Installation Guide

stored in the ce_install_path/tools/configure/profiles/myprofile/ applicationserver.xml file, where myprofile is the name of your profile. You provide the application server properties when you create a profile by using the Create New Installation Profile wizard, and you can edit the application server properties at any time as needed. See Creating a profile for a new installation on page 251 or Editing the application server properties on page 252 for detailed procedures. v Configure the Java Database Connectivity (JDBC) data sources. The JDBC data source information is used by Content Engine to connect to Global Configuration Data (GCD) and object store databases. The application server uses the JDBC data source information to connect Content Engine to the database. You must specify the JDBC provider type, the database name, the database user name and password, and other settings. The JDBC provider type determines some of the properties and their default values. By default, the JDBC properties are stored in the ce_install_path/tools/configure/profiles/ myprofile/configurejdbcgcd.xml file or the the ce_install_path/tools/ configure/profiles/myprofile/configurejdbcos.xml file, where myprofile is the name of your profile. See Editing the configure JDBC data source task on page 253 for the procedure to set the JDBC data source properties after you have created a profile. v Configure the application login modules. The login modules provide authentication information for the Content Engine application. Run this task to create the login modules on the application server. See Editing the configure LDAP task on page 254 for the procedure to create the login modules after you have created a profile. v Configure the directory service (LDAP) provider. Content Engine connects to the directory service provider to authenticate users. Because the application server uses the directory service information to connect the Content Engine to the directory service provider, you cannot skip this task even if you have already configured your application server prior to installing Content Engine. You need to specify the directory service provider type, the user and group naming conventions for your provider, the directory service user name for the Content Engine to use for authentication, and other settings. The LDAP provider type that you select determines some of the properties and their default values. By default, the LDAP properties are stored in the ce_install_path/tools/ configure/profiles/myprofile/configureldap.xml file, where myprofile is the name of your profile. See Editing the configure LDAP task on page 254 for the procedure to set the LDAP properties after you have created a profile. v Configure the Content Engine bootstrap settings. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. By default, the bootstrap properties are stored in the ce_install_path/tools/configure/profiles/myprofile/configurebootstrap.xml file, where myprofile is the name of your profile. See Editing the configure bootstrap properties settings on page 254 for the procedure to set the bootstrap properties after you have created a profile. v Deploy the Content Engine application. This action deploys the Content Engine EAR file with the JDBC, LDAP, and bootstrap settings on the application server. Any time that you update the properties for an existing deployed Content Engine instance or update the Process Engine Client files on the Content Engine, you must redeploy for the changes to take effect. By default, the deployment

Appendix A. Configuration Manager reference

237

properties are stored in the ce_install_path/tools/configure/profiles/ myprofile/deployapplication.xml file, where myprofile is the name of your profile. Tip: After you deploy the Content Engine application, you use Enterprise Manager to customize Content Engine for your site's requirements. See Editing the deploy application task on page 254 for the procedure to edit the deployment properties after you have created a profile. v Check the status of a particular configuration task. Status messages are displayed when you run a task. You can also explicitly display the task status any time after you run the task. See Checking the task status on page 258. v Configure a profile for upgrading an existing Content Engine from 4. An upgrade profile includes the Upgrade Bootstrap task and the Deploy Application task. By default, the upgrade bootstrap properties are stored in the ce_install_path/tools/configure/profiles/myprofile/upgradebootstrap.xml file, and the deployment properties are stored in the ce_install_path/tools/ configure/profiles/myprofile/deployapplication.xml file, where myprofile is the name of your profile. See Creating a profile for a new installation on page 251 for a detailed procedure.

Using the graphical and command-line user interfaces

Both the graphical user interface (GUI) and the command-line interface (CLI) create the configuration XML files with the property values specific to your site, run tasks to apply your settings, display task status results, and deploy the Content Engine application. Configuration Manager has a GUI and a CLI. The GUI version of the tool displays the properties and default values that you must set. When you save your changes in the GUI tool, the configuration XML files are updated for you. If you use the CLI version of the tool, you must first generate the configuration XML files with the tool, and then manually edit the default values in the files using a text editor. After you edit the files, you use Configuration Manager to run the tasks to apply the saved settings. After you have set the required values, you use either version of Configuration Manager to deploy the Content Engine application. The configuration XML files that you create with either version of the Configuration Manager tool can be used with the other version. For example, you can create the files with the CLI version, and then use the GUI version to open the profile, edit the values, and run the configuration tasks.

Gathering Configuration Manager values by using the installation and upgrade worksheet
You can use the installation and upgrade worksheet to record the values that you must enter in Configuration Manager. Be sure that you have available the Installation and Upgrade Worksheet that was completed during your planning activities. To see only the properties you must specify for Configuration Manager: 1. Open your completed Installation and Upgrade Worksheet file. 2. Verify that the Data > Filter > AutoFilter command is enabled.

238

Installation Guide

3. Filter by one of the following Configuration Manager options in the Installation or Configuration Program column: v CM: config_mgr_user v CM: Create New Installation Profile v CM: Configure GCD JDBC Data Sources v CM: Configure Object Store JDBC Data Sources (object store 1) v CM: Configure LDAP v CM: Configure Bootstrap Properties v CM: Deploy Application v CM: Upgrade bootstrap v CM: Upgrade Configuration Profile

Handling passwords in Configuration Manager

To provide the highest possible security, Configuration Manager's default settings do not save passwords from the GUI application. The password save setting is a preference setting in the Configuration Manager graphical interface. While the default setting provides greater password security, it does require you to reenter all necessary passwords each time you start the GUI. When you close a profile in Configuration Manager, the passwords are removed from memory. When you open Configuration Manager or the profile again to run a saved task, you must reenter passwords to run the tasks. The following passwords are used to run the tasks: v The application server administrator password. Select File > Edit Application Server Properties to enter the password. v The database administrator password. Edit the Configure GCD JDBC Data Sources task or the Configure Object Store JDBC Data Sources task. v The directory service bind user password. Edit the Configure LDAP task. v The bootstrap user password. Edit the Configure Bootstrap task. The Configuration Manager command line passes the passwords from an XML configuration file to the required application when you run a task. You can use the storepasswords command to add encrypted passwords to the XML files, or you can enter plain text passwords when you edit the files. However, saving the passwords to the XML files might not be FIPS 140-2 compliant. If you later use the Configuration Manager GUI to open a profile with an XML configuration file that you manually edited, the GUI version reads the passwords in the XML file, and will overwrite the existing passwords when you save the file. If the GUI is not configured to save passwords (default setting), the passwords in the XML file will be overwritten with a blank entry. If the GUI is configured to save passwords, the original values or any changed values are encrypted and saved to the XML file.

Accessing the Configuration Manager log files

Configuration Manager generates task execution messages, log files for each task, and a log file for diagnosing Configuration Manager errors.

Appendix A. Configuration Manager reference

239

v When you run a task in the Configuration Manager graphical user interface, the task execution messages are displayed in the console pane. When you run the task in the command-line interface, the messages are written in the command window. v In the Content Engine Task View of the graphical user interface, you can view additional status in the console by right-clicking the task and then selecting Task Status. See Checking the task status on page 258 for details. In the command-line interface, use the checkstatus command within configmgr_cl to determine the status of each task. For example, to determine the deployment status, run this command:
configmgr_cl checkstatus -profile profile_name -task deployapplication

v The log file for each Configuration Manager task that you execute is located in the temporary directory that you specified for the task. For example, the configureldap task puts two files into the ce_install_path/tools/configure/tmp directory:
Log file configureldap.tcl configureldap.log Description The running version of the script The details log file

v The .log file contains additional information for diagnosing Configuration Manager errors. The path to the file depends on the platform:
Platform Windows Path user_home_directory\configmgr_workspace\ .metadata\.log

For example, on Windows the path might be C:\Documents and Settings\Administrator\configmgr_workspace\.metadata\.log.

Correcting a dotnetclient configuration profile error

If you specified an incorrect value in the dotnetclient configuration profile .NET API COM Compatibility Layer (CCL) server URL during the installation of Content Engine, you need to edit the configmgr.properties file to correct the error. To correct a dotnetclient configuration profile error: 1. Open the configmgr.properties file for editing This file is located at ce_install_path/tools/configure/configuration/. 2. Find the line in the file that starts with CCL_URL:
CCL_URL=http\://localhost\:port_number/wsi/FNCEWS40MTOM/

3. Use the graphical user interface or the command-line interface of Configuration Manager to reexecute the dotnetclient profile. If you use the command-line interface, run this command to reexecute the profile:
configmgr_cl execute -task configureDotNetAPI -profile dotnetclient

240

Installation Guide

Adding an SSL signer to the Configuration Manager keystore (WebSphere)

If you are using SSL for communication between Configuration Manager and WebSphere Application Server you might receive an SSL signer error when you test the connection to the application server or when you run the Deploy Application task. To resolve the issue, make sure that you have an entry for the SSL signer in the truststore that Configuration Manager uses. 1. Identify the serial number for the SSL certificate on the web application server. a. From the server where Configuration Manager is installed, browse to the WebSphere administrative console address. b. In the Security Alert dialog box, click View Certificate. c. Click the Details tab. d. Record the value for Serial number for the certificate. e. Click OK to dismiss the Certificate dialog box. f. Click Yes in the Security Alert dialog box to proceed. 2. Identify the truststore location and filename. a. b. c. d. e. Log in to the WebSphere administrative console. Select Security > SSL certificate and key management. Select SSL configurations. Click the default SSL setting, NodeDefaultSSLSettings. Under the Related items link, click Key stores and certificates.

f. Record the filename, such as trust.p12, in the Path column of the resource to be updated:
Table 25. Resources to be updated Application server type IBM WebSphere Application Server Clusters built on IBM WebSphere Application Server Network Deployment Name of resource to be updated NodeDefaultTrustStore CellDefaultSSLSettings

3. Start IBM Key Management by entering one of the following commands at a command prompt:
Option Windows Description WAS-Home\AppServer\bin\ikeyman.bat

4. Select Keybase File > Open. a. For the Key database type, select PKCS12. b. Click Browse to locate the filename you recorded in step 2. For example, the File Name filed contains the filename, such as trust.p12. The Location field contains the absolute path to the truststore, such as C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\etc\ for Windows. c. Click OK. d. Enter the password and click OK. The default password is WebAS. 5. Locate the signer certificate with the serial number that matches the serial number that you recorded in step 1. a. Double-click a certificate name other than default_signer to view the serial number for the certificate.
Appendix A. Configuration Manager reference

241

b. Click OK to close the dialog box. c. Repeat until you have located the correct signer certificate. 6. Extract the certificate. a. Select the signer certificate with the correct serial number, and click Extract. b. Provide a name and location, and then click OK. 7. Add the certificate that you extracted to the trust file for Content Engine. a. Open the DummyClientTrustFile.jks key database file located in the WebSphere profile for Content Engine, such as C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\etc\ for Windows. b. Add the certificate that you extracted in step 6. 8. Close IBM Key Management.

Correcting an SSL Signer Exchange Prompt error (WebSphere)

If you are using SSL for communication between Content Engine and WebSphere Application Server, you might receive the SSL signer error SSL SIGNER EXCHANGE PROMPT when you run the task for configuring the JDBC data sources for the Global Configuration Data (GCD) or for an object store. Use this procedure if you receive the following error when you run a task for configuring the JDBC data sources, such as Configure GCD JDBC Data Sources:
Error while executing Configure GCD JDBC Data Sources Execution failed with the following message: The data source configuration failed. *** SSL SIGNER EXCHANGE PROMPT *** SSL signer from target host null is not found in trust store

1. From a command prompt, navigate to the WAS_HOME/AppServer/profiles/ app_server_name/bin directory. 2. Run the following command:
wsadmin.bat -conntype SOAP -port portnumber -username username -password userpassword

Where: portnumber is the same value that you entered for the Application server SOAP field in the configure JDBC task properties. The WebSphere default is 8880. username is the same value that you entered for the Application server administrator user name field in the configure JDBC task properties. userpassword is the same value that you entered for the Application server administrator password field in the configure JDBC task properties. 3. At the prompt to add the signer to the trust store, enter Yes. 4. Close the command prompt. 5. Use Configuration Manager to run the configure JDBC task again, from the graphical user interface or from the command line.

Configuration Manager user interface reference

The Configuration Manager graphical user interface (GUI) lets you create, view, and edit your Content Engine configuration profile. You can also make a copy of an existing profile, run configuration tasks, view the session logs, and check the status of a particular task.

242

Installation Guide

Restriction: If you need an accessible version of Configuration Manager, use the command line interface instead of the GUI. See Configuration Manager command-line reference on page 260. Starting Configuration Manager You can start the graphical interface version of Configuration Manager to configure a Content Engine application instance on a web application server. Configuration Manager window on page 244 The default Configuration Manager window consists of the Content Engine Task View pane on the left side, the Task Editor pane on the upper right side, and the Console pane on the lower right side. You can drag, resize, and rearrange the panes to change the location if needed. Configuration Manager menus and commands on page 247 You can access the Configuration Manager commands through the menu or by right-clicking an item. The following tables describe the available commands. Working with Configuration Manager on page 249 You can use the Configuration Manager commands, icons, and panes to work with your profiles and configuration tasks. configmgr.ini parameters on page 259 When you install Configuration Manager, the path to the directory that contains the Java binary to be used to launch the graphical user interface is added to the ce_install_path/tools/configure/configmgr.ini file.

Starting Configuration Manager

You can start the graphical interface version of Configuration Manager to configure a Content Engine application instance on a web application server. See the appendix Configuration Manager user interface reference on page 242 for complete information about using the graphical user interface. If you need an accessible version of Configuration Manager, use the command-line interface instead of the graphical user interface. To start Configuration Manager: 1. Start Configuration Manager by running one of the following commands, depending on the operating system that runs on the machine where you installed Content Engine:
Option Windows Description Perform one of the following actions: v Double-click the FileNet Configuration Manager desktop shortcut. v Click Start > All Programs > IBM FileNet P8 Platform > FileNet Configuration Manager. v Run the following command: ce_install_path\tools\configure\configmgr.exe

The first time that you start Configuration Manager, the Welcome is displayed. 2. Select one of the links in the Welcome to learn more or to start working in a wizard, or close the Welcome by clicking the X in the tab at the upper left. You can reopen the Welcome later, as needed, from the Help menu.

Appendix A. Configuration Manager reference

243

Configuration Manager window

The default Configuration Manager window consists of the Content Engine Task View pane on the left side, the Task Editor pane on the upper right side, and the Console pane on the lower right side. You can drag, resize, and rearrange the panes to change the location if needed. The following table describes each pane:
Pane Content Engine Task View Description Displays a profile and the tasks for that profile. Only one profile can be open at a time. Displays the properties and values for a selected task. The Task Editor pane is empty until a specific task is selected from the Content Engine Task View pane. Each open task is displayed in a separate tab in the Task Editor pane. More than one task tab can be displayed at a time. Displays task execution messages, results from the Check Status command, or the session log.

Task Editor

Console

To move from one open task tab in the Task Editor pane to another open task tab, press Ctrl-F6. To move from one pane to the next, press Ctrl-F7. To restore a closed pane, select Window > Show View. Main toolbar The Configuration Manager main toolbar is located just below the menu bar. The main toolbar contains multiple icons for working with your profiles. Profile toolbar on page 245 The Configuration Manager profile toolbar is located at the upper right of the Content Engine Task View pane. The profile toolbar contains multiple icons for working with a selected profile. Task toolbar on page 245 The Configuration Manager task toolbar is located at the upper right of the Task Editor pane when a Task tab is open. Console toolbar on page 246 The Console toolbar is located at the upper right of the Console pane. The Console toolbar contains the multiple icons for working with the Console pane.

Main toolbar
The Configuration Manager main toolbar is located just below the menu bar. The main toolbar contains multiple icons for working with your profiles.

244

Installation Guide

Icon

Command name and Description New Installation Profile Click this icon to create a profile for a new installation. The current configuration profile will be closed, and the New Configuration Profile Wizard starts. If the existing open profile has been changed, you will be prompted to save your changes. New Upgrade Profile Click this icon to create a profile for upgrading an existing Content Engine server. The current configuration profile will be closed, and if there have been changes, you will be prompted to save your changes. The New Configuration Profile Wizard starts. Open Profile Click this icon to open an existing profile. The current configuration profile will be closed, and if there have been changes, you will be prompted to save your changes. Save Click this icon to save the current configuration profile settings. View Configuration Manager Log File Click this icon to view the Configuration Manager session log. The session log is cleared when you open Configuration Manager or when you close a profile.

Profile toolbar
The Configuration Manager profile toolbar is located at the upper right of the Content Engine Task View pane. The profile toolbar contains multiple icons for working with a selected profile.
Icon Command name and Description Edit Application Server Properties Click this icon to view or edit the application server properties for the current profile. Run All Tasks Click this icon to run all the enabled tasks for the current profile.

Task toolbar
The Configuration Manager task toolbar is located at the upper right of the Task Editor pane when a Task tab is open. The task toolbar contains the following icons for working with the current task:

Appendix A. Configuration Manager reference

245

Icon or Button

Command Name and Description Enable the Selected Task Click this icon to enable a task. The Run All Tasks command only runs tasks that are enabled. Disable the Selected Task Click this icon to disable a task. The Run All Tasks command only runs tasks that are enabled. Save Click this icon to save the current task.

Test Database Connection

Test Database Connection Configure GCD JDBC Data Sources task or Configure Object Store JDBC Data Sources task tab only. Click this button to test the connection to the database by using the values provided.

Test LDAP Connection

Test LDAP Connection Configure LDAP task tab only. Click this button to test the connection to the directory service provider by using the values provided.

Console toolbar
The Console toolbar is located at the upper right of the Console pane. The Console toolbar contains the multiple icons for working with the Console pane.
Icon Command name and Description Clear Console Click this icon to clear the display for the currently active tab in the Console pane. Clearing the display does not affect any log contents. Scroll Lock Click this icon to enable or disable the scroll bars for the currently active tab in the Console pane. When the scroll bars are locked, information in the console might scroll out of view. Pin Console Click this icon to lock or unlock the current console location. When pinned (or locked), you cannot move the Console pane to a new location or resize the Console pane.

246

Installation Guide

Icon

Command name and Description Display Selected Console Click this icon to select the console tab to display. Select the desired tab from the list of recently viewed consoles. Open Console Click this icon to new tab with the current Console view. For example, you can open a second tab for execution messages for the Deploy Application task.

Configuration Manager menus and commands

You can access the Configuration Manager commands through the menu or by right-clicking an item. The following tables describe the available commands.

Main menu
The following table lists the menus and commands that are available in Configuration Manager.
Table 26. Main Menu Commands Menu name File New Installation Profile New Upgrade Profile Open Profile Command name Description Provides commands for creating, saving, or opening a configuration profile. Creates a profile for a new installation. See Creating a profile for a new installation on page 251 for detailed procedures to create a profile. Creates a profile for upgrading Content Engine. See Creating a profile for a new installation on page 251 for detailed procedures to create a profile. Opens an existing profile for viewing or editing. Keyboard shortcut: Ctrl+O Close Profile Save Closes the current profile. Saves your changes to the active task. Keyboard shortcut: Ctrl+S Save All Saves your changes to all open tasks. Keyboard shortcut: Ctrl+Shift+S Save Copy of Profile As Edit Application Server Properties Saves the current profile with a new name or path. Opens the Edit Application Server Properties wizard for editing the application server values for the profile. Keyboard shortcut: Ctrl+U Run All Runs all of the tasks in the profile to apply your settings. If a particular task is disabled, that task is skipped when you select Run All Tasks. Keyboard shortcut: Ctrl+R
Appendix A. Configuration Manager reference

247

Table 26. Main Menu Commands (continued) Menu name Command name Exit Window Description Closes Configuration Manager. Provides commands for viewing a log file, changing the view in a Configuration Manager pane, and setting preferences View Log File Show View Provides commands that give you access to logs and various views of information. Displays the session log in the Console pane. The session log lists results from tasks that you have run since you opened the current profile. Provides choices for determining the behavior of Configuration Manager, such as the password save preference and the warning message preference. Displays help pages about Configuration Manager. Welcome Help Contents About Configuration Manager Provides a quick introduction to the use of Configuration Manager. Provides reference information for Configuration Manager. Displays the copyright and related information about Configuration Manager.

Preferences

Help

Pop-Up menus
The pop-up menus are displayed when you right-click an item in Configuration Manager.
Table 27. Profile Icon Pop-Up Menu Commands Command Edit Application Server Properties Add New Task > Configure JDBC Data Sources Add New Task > Configure LDAP Add New Task > Configure Bootstrap Run All Close Configuration Profile Description Opens the Edit Application Server Properties wizard for the profile. Adds a New_Configure JDBC Data Sources task to the profile. Adds a New_Configure LDAP task to the profile. Adds a Configure Bootstrap task to the profile. Displays a sub-menu of the tasks associated with the profile. Click the task name that you want to run. Closes the configuration profile.

Table 28. Task Icon Pop-Up Menu Commands Command Edit Selected Task Description Opens the task in the task pane for editing.

248

Installation Guide

Table 28. Task Icon Pop-Up Menu Commands (continued) Command Enable Selected Task Disable Selected Task Description Toggles the state of the task between enabled and disabled. Any task that is disabled will not run with either the Run Selected Task command or the Run All Tasks command. If the task is currently enabled, selecting the Disable Selected Task command prevents the task from running, changes the font for the task icon to italic, and appends "(disabled)" to the icon label. If the task is currently disabled, selecting the Enable Selected Task command allows the task to run, restores the original font, and removes "(disabled)" from the icon label. Copy the Selected Task Creates a copy of the selected task. This command is available only for the Configure JDBC Data Sources and the Configure LDAP tasks. Adds a Configure JDBC Data Sources task to the profile. You can have multiple Configure JDBC Data Sources tasks in a profile. Adds a Configure Login Modules task to the profile. You can only have one Configure Login Modules task in a profile. Adds a Configure LDAP task to the profile. You can have multiple Configure LDAP tasks in a profile. Adds a Configure Bootstrap Properties task to the profile. You can have multiple Configure Bootstrap Properties tasks in a profile. Adds a Deploy Application task to the profile. You can only one Deploy Application task in a profile. Resets the status of the task to indicate that it has not yet been run. Displays the current status of the task. Opens an edit window in which you can change the name of the label associated with the task. Deletes the task from the profile. You cannot delete a task if it is open for editing in the task pane. Moves the selected task up in the list of tasks. Moves the selected task down in the list of tasks.

Add New Task > Configure JDBC Data Sources Add New Task > Configure Login Modules Add New Task > Configure LDAP Add New Task > Configure Bootstrap Properties Add New Task > Deploy Application Reset Selected Task Status Check Task Status Rename Task Delete the Selected Task Move Selected Task Up Move Selected Task Down

Working with Configuration Manager

You can use the Configuration Manager commands, icons, and panes to work with your profiles and configuration tasks. Configuring a Content Engine instance on page 250 You can use the Configuration Manager graphical user interface to configure a Content Engine instance. Setting the password save preference on page 251 By default, the Configuration Manager password save preference is set to not save passwords to a file. If your site security requirements permit you to save passwords to a file, you can change the password save preference setting.

Appendix A. Configuration Manager reference

249

Creating a profile for a new installation on page 251 You must create a new configuration profile for each Content Engine application that you deploy. Opening and closing an existing profile or task on page 252 You can save a profile, and open it later to edit the saved settings or to run tasks. Editing the application server properties on page 252 You initially provide the application server properties when you create a new profile. You can open the application server properties for editing at any time, but you cannot change the application server type for an existing profile. The application server properties must be set before you run any tasks. Editing the properties for a specific task on page 253 You must provide the required property values for each task in your profile before you run the task. Applying the property settings by running a specific task on page 255 You must run a task to apply the values that you provided. Adding an additional task to your profile on page 257 A profile can contain an unlimited number of tasks. You can configure more than one Configure Object Store JDBC Data Sources task, more than one Configure LDAP task, or more than one Configure Bootstrap Properties task. You can add a new task for a task type that you do not already have in the profile. Deleting a task from a profile on page 257 You can delete any unneeded tasks from your profile. Running all tasks at the same time on page 258 You can run all the tasks in a profile at the same time. Disabled tasks will not run. Running a single task on page 258 You can run each configuration task individually. Disabled tasks will not run. Checking the task status on page 258 Task execution messages are displayed in the console pane when you run a task, and you can view the status of a specific task at any time. Viewing the session log on page 259 The session log contains information about the tasks that were run in the current session of Configuration Manager. As you run additional tasks for the same or a different profile, new messages are added to the log. When you exit Configuration Manager, the session log is cleared. Saving your changes to a task or profile on page 259 You can save your profile and task settings at any time.

Configuring a Content Engine instance

You can use the Configuration Manager graphical user interface to configure a Content Engine instance. To configure a Content Engine instance: 1. Create a configuration profile. See Creating a profile for a new installation on page 251. 2. Edit the configuration tasks included in the profile. See one or more of the following topics: v Editing the configure JDBC data source task on page 253 v Editing the configure LDAP task on page 254 v Configuring the login modules on page 255

250

Installation Guide

v Editing the configure bootstrap properties settings on page 254 3. Apply the configuration settings by running the tasks. See Running all tasks at the same time on page 258. 4. Deploy the application by running the Deploy Application task. Because deployment can take a long time, it is a best practice to run the Deploy Application task after you have completed all other configuration tasks. See Editing the deploy application task on page 254.

Setting the password save preference

By default, the Configuration Manager password save preference is set to not save passwords to a file. If your site security requirements permit you to save passwords to a file, you can change the password save preference setting. When you close the profile, the passwords are erased from memory. Each time that you start Configuration Manager or open a saved profile, the passwords are reset to blank (unless you previously changed the preferences setting). Before you can run a task, you must specify the passwords required by the task and the application server properties; otherwise, the task will not run successfully. If your site security requirements permit you to save passwords to a file, you can change the password save preference setting. To change the password save preference: 1. Click Window > Preferences. 2. Complete one of the following actions:
Option To save passwords to file To prevent writing passwords to file Description Select the Save all passwords to file when saving a task or profile check box. Clear the Save all passwords to file when saving a task or profile check box.

3. Click OK.

Creating a profile for a new installation

You must create a new configuration profile for each Content Engine application that you deploy. To create a new configuration profile: 1. Start the Create New Installation Profile wizard. v v 2. Click the New Installation Profile icon in the toolbar. Select File > New Installation Profile.

If a profile is already open, the Action Required message box opens. Respond to the messages as follows: a. Click Yes to continue creating a new profile, or click No to cancel. If you selected Yes and your current profile has any unsaved changes, the Save Resource message box opens. b. Click Yes to save your changes, or click No to continue without saving your changes.

The Create New Configuration Profile Wizard opens. 3. Complete the wizard screens. For details on the fields in the wizard screens, hover your mouse over the field name to view the property description.

Appendix A. Configuration Manager reference

251

The new profile is displayed as an icon in the left-hand panewith icons for the tasks for the tasks that you selected. The default profile contains the following tasks: v v v v v v Configure GCD JDBC Data Sources Configure Object Store JDBC Data Sources Configure Login Modules Configure LDAP Configure Bootstrap Properties Deploy Application (Disabled)

Opening and closing an existing profile or task

You can save a profile, and open it later to edit the saved settings or to run tasks. 1. Open a profile: v Click Open an Existing Profile in the toolbar. v Select File > Open Profile. a. If a profile is already open, the Action Required message box opens. Respond to the messages as follows: 1) Click Yes to continue creating a new profile, or click No to cancel.

2) If you selected Yes and your profile has any unsaved changes, the Save Resource message box opens. Click Yes to save your changes, click No to continue without saving your changes, or click Cancel. b. Either type in the fully qualified path to the myprofile.cfgp profile file, or click Browse to locate the file. c. Click OK. 2. Open a task: More than one task tab can be open at a time in the Task Editor pane. a. If the profile is collapsed in the Content Engine Task View pane, click + next to the profile name to expand it. b. Use one of the following methods to open the desired task: v Click the task name in the Content Engine Task View pane, and then click Edit Selected Task in the Profile toolbar. v Double-click the task name in the Content Engine Task View pane. 3. Switch between open tasks in the Task Editor pane by clicking the tab name in the Task Editor pane for the desired task. 4. Close a task: a. If the task is not the actively selected task, click the tab name in the Task Editor pane for the desired task. Click Close in the tab for the task. You will be prompted to save any changes to the task. 5. Close the profile by selecting File > Close Profile. b. You will be prompted to save any changes when you close a profile. Passwords are removed from memory when you close a profile.

Editing the application server properties

You initially provide the application server properties when you create a new profile. You can open the application server properties for editing at any time, but you cannot change the application server type for an existing profile. The application server properties must be set before you run any tasks.

252

Installation Guide

1. Start the Edit Application Server Properties wizard by using one of theses methods: v Click Edit Application Server Properties in the main toolbar. v Select File > Edit Application Server properties. 2. Provide values for the application server properties. For details on the fields, hover your mouse over the field name to view the property description. 3. Optional: WebSphere Application Server and Oracle WebLogic Server only. In the Set Properties for Application Server window, click Test Connection to test the connection between Configuration Manager and the application server by using the information that you have provided. The test is optional, and you can proceed in the wizard even if the test fails. If the test fails, make sure that the application server is running and that the application server property values that you entered match the values that are defined in your application server. 4. Click Finish.

Editing the properties for a specific task

You must provide the required property values for each task in your profile before you run the task. Editing the configure JDBC data source task The JDBC data source information is used by Content Engine to connect to Global Configuration Data and object store databases. Configuration Manager provides two tasks for configuring the JDBC data sources: Configure GCD JDBC Data Sources and Configure Object Store JDBC Data Sources. Editing the configure LDAP task on page 254 The LDAP information is used to connect Content Engine to the directory service provider to authenticate users. Editing the configure bootstrap properties settings on page 254 The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Editing the deploy application task on page 254 You can edit the deployment property values without applying the settings. When you apply the settings, the Content Engine is deployed as an application on the application server. Because deploying an application can take time, we recommend that you do not deploy the application until after you have installed any dependent files, such as Process Engine client files, Content Search Engine, or customized applications for Content Engine. Editing the configure JDBC data source task: The JDBC data source information is used by Content Engine to connect to Global Configuration Data and object store databases. Configuration Manager provides two tasks for configuring the JDBC data sources: Configure GCD JDBC Data Sources and Configure Object Store JDBC Data Sources. The procedure for editing the Configure GCD JDBC Data Sources task and the Configure Object Store JDBC Data Sources task is the same. To complete the Content Engine configuration, you must configure the GCD data sources and the data sources for each object store. 1. Open either the GCD data source task or the object store data source task for editing. v Double-click Configure GCD JDBC Data Sources. v Double-click Configure Object Store JDBC Data Sources.

Appendix A. Configuration Manager reference

253

2. Provide the property values for your database. Place your mouse on a field name to view the property description. 3. Optional: WebSphere Application Server and Oracle WebLogic Server only. Click Test Database Connection to test the connection to the database by using the database user name, database server name, database name, port number, and password that you provided. The test does not create the data sources. 4. Select File > Save to save your changes. Saving your changes to disk does not apply the settings to the application server. Editing the configure LDAP task: The LDAP information is used to connect Content Engine to the directory service provider to authenticate users. 1. Double-click Configure LDAP in the Content Engine Task View pane to open the task for editing. 2. Provide the property values for your LDAP provider. For details on the fields, hover your mouse over the field name to view the property description. 3. Optional: WebSphere Application Server and Oracle WebLogic Server only. Click Test LDAP Connection to test the connection to the directory service provider by using the directory service bind user name, host name, port number, and password that you provided. 4. Select File > Save to save your changes. Editing the configure bootstrap properties settings: The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. 1. Double-click Configure Bootstrap Properties in the Content Engine Task View pane to open the task for editing. 2. Select a value for the Bootstrap operation field:
Option Description

To provide bootstrap information for a new Select Create New. installation profile To modify an existing deployed EAR file To upgrade an existing deployed EAR file Select Modify Existing. Select Upgrade.

3. Provide the bootstrap property values. For details on the fields, hover your mouse over the field name to view the property description. 4. Optional: If you selected Modify Existing or Upgrade, then click Verify Bootstrap Information to display the bootstrap information from the modified EAR file. You can verify the information in the modified EAR file for a new installation after you run the task. 5. Select File > Save to save your changes. Editing the deploy application task: You can edit the deployment property values without applying the settings. When you apply the settings, the Content Engine is deployed as an application on the application server. Because deploying an application can take time, we recommend that you do not deploy the application until after you have installed any dependent files, such as Process Engine client files, Content Search Engine, or customized applications for Content Engine.

254

Installation Guide

To edit the Deploy Application task: 1. Right-click the Deploy Application task in the profile pane (left pane), and select Edit Selected Task. 2. Provide the property values for your deployment. For details on the fields, hover your mouse over the field name to view the property description.. 3. Select File > Save. Related tasks Configuring Content Engine on page 35 You can configure and deploy all of your Content Engine instances with Configuration Manager. Configuration Manager prepares the Content Engine application for deployment on the application server. A single Content Engine application instance equates to one deployed application on your application server.

Applying the property settings by running a specific task

You must run a task to apply the values that you provided. Applying the JDBC data source settings Your JDBC data source settings are stored when you save the task, but the settings are not applied to the application server until you run the task. Configuring the login modules The login modules provide authentication information for the Content Engine application. Applying the LDAP settings on page 256 Your LDAP settings are stored when you save the task, but the settings are not applied to the application server until you run the task. Applying the bootstrap properties settings on page 256 The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Your bootstrap settings are stored when you save the task, but the settings are not applied to the application server until you run the task. Deploying the application on page 256 Your Deploy Application task settings are stored when you save the task, but the Content Engine EAR file is not deployed to the application server until you run the task. Applying the JDBC data source settings: Your JDBC data source settings are stored when you save the task, but the settings are not applied to the application server until you run the task. 1. Select the configure data sources task that you want to run. v Right-click Configure GCD JDBC Data Sources in the Content Engine Task View pane, and select Run Task. v Right-click Configure Object Store JDBC Data Sources in the Content Engine Task View pane, and select Run Task. Running the configuration task can take a few minutes. 2. Close the Configure JDBC Data Sources task pane. The task execution status messages are displayed in the Console pane below the JDBC data source properties. Configuring the login modules:

Appendix A. Configuration Manager reference

255

The login modules provide authentication information for the Content Engine application. You do not need to provide any information to create the login modules. If needed, you can change the default values for the script file to run and for the temporary directory location. To configure the login modules: 1. Make sure that the task is enabled. When the task is disabled, the task name includes the text (Disabled). To enable the task, select Configure GCD JDBC Data Sources (Disabled) in the profile pane, and then either right-click and choose Enable Selected Task from the context menu, or click the Enable the Selected Task icon in the task toolbar. 2. Create the login modules by right-clicking Configure Login Modules in the profile pane, and selecting Run Task. Running the configuration task can take a few minutes. The task execution status messages are displayed in the console pane below the bootstrap properties. Tip: You can check the completion status of the task by right-clicking Configure Login Modules in the profile pane, and selecting Check Task Status. 3. Close the Configure Login Modules task pane.

Applying the LDAP settings: Your LDAP settings are stored when you save the task, but the settings are not applied to the application server until you run the task. 1. Right-click Configure LDAP in the Content Engine Task View pane, and then select Run Task. Running the configuration task can take a few minutes. 2. Close the Configure LDAP task pane. The task execution status messages are displayed in the Console pane below the LDAP properties. Applying the bootstrap properties settings: The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Your bootstrap settings are stored when you save the task, but the settings are not applied to the application server until you run the task. 1. Right-click Configure Bootstrap Properties in the Content Engine Task View pane, and then select Run Task. Running the configuration task can take a few minutes. 2. Optional: If you selected Create New, then click Verify Bootstrap Information to display the bootstrap information from the modified EAR file. 3. Close the Configure Bootstrap properties task pane. The task execution status messages are displayed in the Console pane below the bootstrap properties. Deploying the application:

256

Installation Guide

Your Deploy Application task settings are stored when you save the task, but the Content Engine EAR file is not deployed to the application server until you run the task. 1. Right-click the Deploy Application task in the left pane, and then select Run Task. Running the deployment task will take a few minutes. 2. Close the Deploy Application properties task pane. The task execution status messages are displayed in the Console pane below the Deploy Application task properties.

Adding an additional task to your profile

A profile can contain an unlimited number of tasks. You can configure more than one Configure Object Store JDBC Data Sources task, more than one Configure LDAP task, or more than one Configure Bootstrap Properties task. You can add a new task for a task type that you do not already have in the profile. The default configuration profile contains the following tasks: v Configure GCD JDBC Data Sources v v v v Configure Object Store JDBC Data Sources Configure LDAP Configure Bootstrap Properties Deploy Application

You can add a new task whenever the following conditions apply: v You do not already have an existing task of that type in the profile. You can have only one Configure GCD JDBC Data Sources task or one Deploy Application task. v You have more than one object store in your site. v You have multiple LDAP realms in your site. v You must modify or upgrade you bootstrap properties. To add a new task to your profile: 1. If your configuration profile is not open in Configuration Manager, open the profile. 2. Right-click any task name in the profile pane, and select Add New Task. 3. In the pop-up menu, select the task name that you want to create. The new task is added to the profile. If a task of the same type exists, the new task name begins with "New_." 4. Optional: Rename the task to provide a more useful name. a. Right-click the new task name, and select Rename Task. b. Enter a useful name for the task, such as Configure Object Store 2 JDBC Data Sources or Configure Bootstrap Properties for Upgrade. c. Click OK.

Deleting a task from a profile

You can delete any unneeded tasks from your profile. The default configuration profile contains the following tasks: v Configure GCD JDBC Data Sources v Configure Object Store JDBC Data Sources v Configure LDAP
Appendix A. Configuration Manager reference

257

v Configure Bootstrap Properties v Deploy Application When you delete a task, all the property values are removed. If you later need the task, you will have to add a new task and re-enter all your values. To delete a task from your profile: 1. If your configuration profile is not open in Configuration Manager, open the profile. 2. Right-click the task name that you want to remove, and select Delete Selected Task. 3. In the confirmation message box, click OK.

Running all tasks at the same time

You can run all the tasks in a profile at the same time. Disabled tasks will not run. To run all tasks in a profile: 1. If the profile is collapsed in the Content Engine Task View pane, click + next to the profile name to expand it. 2. Use one of the following methods to run the Run All Tasks command: v Click Run All Tasks in the Content Engine Task View pane toolbar. v Select File > Run All. Important: Tasks will not complete if you have not entered passwords correctly during the current Configuration Manager session. See Handling passwords in Configuration Manager on page 239. The Console pane displays the task execution messages.

Running a single task

You can run each configuration task individually. Disabled tasks will not run. To run a selected task: 1. If the profile is collapsed in the Content Engine Task View pane, click + next to the profile name to expand it. 2. Use one of the following methods to run the Run a Task command: v Click the down arrow just to the right of the Run All Tasks icon in the Main toolbar, and then select the task that you want to run. v Click the task name in the Content Engine Task View pane to select the task. Click Run a Task in the Profile toolbar. v Right-click the task name in the Content Engine Task View pane, and select Run Task from the context menu. Important: Tasks will not complete if you have not entered passwords correctly during the current Configuration Manager session. See Handling passwords in Configuration Manager on page 239. The Console pane displays the task execution messages.

Checking the task status

Task execution messages are displayed in the console pane when you run a task, and you can view the status of a specific task at any time.

258

Installation Guide

1. If the profile is collapsed in the Content Engine Task View pane, click + next to the profile name to expand it. 2. Use one of the following methods to run the Check Status command: v Click the task name in the Content Engine Task View pane, and then click Check Status in the Content Engine Task View pane toolbar. v Right-click the task name in the Content Engine Task View pane, and select Check Task Status from the context menu. The console pane opens with the status listed for the selected task. The following table lists the status results and their descriptions.
Status Result COMPLETED INCOMPLETE NO STATUS AVAILABLE FAILED Description The task ran successfully. The task is incomplete. The task has not been run. The task failed to complete. Additional information about the failure is displayed.

Viewing the session log

The session log contains information about the tasks that were run in the current session of Configuration Manager. As you run additional tasks for the same or a different profile, new messages are added to the log. When you exit Configuration Manager, the session log is cleared. 1. Run at least one task. 2. Use one of the following methods to run the View Log command: v Click View Configuration Manager Log File in the Main toolbar. v Select Window > View Log File in Console. The current session log is displayed in the Console pane. Subsequently running a task will replace the displayed session log with the current task status. To redisplay the session log, repeat this procedure as needed.

Saving your changes to a task or profile

You can save your profile and task settings at any time. Use one of these methods to save changes to the currently open task: v Click Save in the toolbar. v Select File > Save.

configmgr.ini parameters
When you install Configuration Manager, the path to the directory that contains the Java binary to be used to launch the graphical user interface is added to the ce_install_path/tools/configure/configmgr.ini file.

Windows example
-vm C:\Program Files\IBM\FileNet\ContentEngine\_cejvm\jre\bin

Appendix A. Configuration Manager reference

259

Configuration Manager command-line reference

Configuration Manager can be run from a command line. This section covers the syntax for the command-line version of Configuration Manager. Running Configuration Manager commands From the command line, you can generate the configuration XML files, run a configuration task to apply the settings in the configuration XML file, and check the status of a task. Use the following syntax to enter the Configuration Manager commands.

Running Configuration Manager commands

From the command line, you can generate the configuration XML files, run a configuration task to apply the settings in the configuration XML file, and check the status of a task. Use the following syntax to enter the Configuration Manager commands. Use one of these commands to run the Configuration Manager command line:
Operating System Windows File Name ce_install_path\tools\configure\ configmgr_cl.exe

How to read the syntax diagrams on page 261 Syntax diagrams describe how you must enter commands and what options are available. checkstatus command on page 261 The checkstatus command checks the status of the specified configuration task. The command name is not case sensitive. execute command on page 265 The execute command applies the settings from a configuration XML file for the specified configuration task. The command name is not case sensitive. generateconfig command on page 268 The generateconfig command generates the configuration XML file for the specified configuration task. The command name is not case sensitive. gui command on page 274 The gui command opens the Configuration Manager graphical user interface. The command is not case sensitive. listtasks command on page 274 The listtasks command displays a list of the tasks and the task files in the configuration profile. The command name is not case sensitive. movetask command on page 277 The movetask command moves a task to a different position in the list of tasks. The task position determines the order that the tasks are run when you run all the tasks at the same time. You use the listtask command to display the task order. The command names are not case sensitive. removetask command on page 280 The removetask command removes the specified task from the configuration profile. When you remove the task, the configuration XML file is deleted from the profile directory. The command name is not case sensitive. storepasswords command on page 282 The storepasswords command prompts for passwords that are blank in a profile and stores the encrypted passwords in the file. Storing encrypted

260

Installation Guide

passwords might not be FIPS 140-2 compliant. You can run the command for a single task or for all tasks in the profile. The command name is not case sensitive.

How to read the syntax diagrams

Syntax diagrams describe how you must enter commands and what options are available. The syntax topics uses several conventions to indicate variable, parameters, required items, and optional items. Enter all commands on a single line, even if the command or syntax examples wrap to the next line.
command_name -option_1 variable_1 [-option_2 variable_2] [-option_3 variable_3 | -option_4]

Where: command_name The command_name is required. -option_1 The -option_1 parameter is a required parameter. variable_1 The variable_1 value is a required variable for the -option_1 parameter. [-option_2 variable_2] Square braces [] indicate optional items. The -option_2 parameter with its value is optional. -option_3 variable_3 | -option_4 A vertical bar indicates a choice of parameters. Use the -option_3 parameter with its value, or use the -option_4 parameter. In this example, both items are optional, and you can use only one or the other.

checkstatus command
The checkstatus command checks the status of the specified configuration task. The command name is not case sensitive.

checkstatus command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.
configmgr_cl checkstatus [-task task_type | -taskfile task_file_name] -profile myprofile [-help]

checkstatus command parameters

-task task_type The -task task_type parameter specifies which task to use for the status check. You can omit the -task task_type parameter if you want to check all of the tasks or if you specify the -taskfile task_file_name parameter. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.

Appendix A. Configuration Manager reference

261

Table 29. task_type values Option omitted Configuration file configurebootstrap.xml configurejdbcgcd.xml configurejdbcos.xml configurejdbcos.n.xml configureldap.xml configureldap.n.xml configureloginmodules.xml deployapplication.xml Where n is an integer starting with 2 configurebootstrap configurebootstrap.xml Checks status for applying the settings for the Content Engine bootstrap on the application server. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Checks the status for configuring the JDBC connections to the Global Configuration Data (GCD) database used by Content Engine. Description If you omit the -task task_type parameter and the -taskfile task_file_name parameter, then the status for all the configuration files in the profile is displayed.

configurejdbcgcd

configurejdbcgcd.xml

262

Installation Guide

Table 29. task_type values (continued) Option configurejdbcos Configuration file configurejdbcos.xml Description

Checks the status for configuring JDBC connections configurejdbcos.n.xml, to a single object store where n is an integer starting database used by Content with 2 Engine. You need to generate, edit, and apply the configurejdbcos task settings for each object store in your database. When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task. If your profile contains more than one configurejdbcos task, then you must specify the -taskfile task_file_name parameter to identify the task to check.

configureLDAP

configureldap.xml

Checks status for configuring the connection to the configureldap.n.xml, where directory server for n is an integer starting with 2 authenticating Content Engine users. (WebSphere Application Server or Oracle WebLogic Server only.) If you generate a second LDAP configuration file, then it is named configureldap.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task. If your profile contains more than one ConfigureLDAP task, then you must specify the -taskfile task_file_name parameter to identify the task to check.

Appendix A. Configuration Manager reference

263

Table 29. task_type values (continued) Option configureloginmodules Configuration file configureloginmodules.xml Description (WebSphere Application Server or JBoss Application Server only.) Checks status for creating the login modules for the Content Engine application. Checks status for deploying the Content Engine application on the application server.

deployapplication

deployapplication.xml

-taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". -help The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

| |

| |

checkstatus command examples

The following examples include line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks. Check the status of a profile with only one file for the configurejdbcos task. The following command checks the status of the configurejdbcos task in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:
configmgr_cl checkstatus -task configurejbcos -profile wstdb2jdbc

264

Installation Guide

Check the status of a profile with several files for the configurejdbcos task. The following command checks the status of the configurejdbcos.2.xml task file in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:
configmgr_cl checkstatus -taskfile configurejdbcos.2.xml -profile wstdb2jdbc

Check the status for creating the login modules. The following command checks the status of the configureloginmodules task in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:
configmgr_cl checkstatus -task configureloginmodules -profile wstdb2jdbc

Display the help for the checkstatus command. The following command displays the help for the checkstatus command:
configmgr_cl checkstatus -help

execute command
The execute command applies the settings from a configuration XML file for the specified configuration task. The command name is not case sensitive.

execute command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.
configmgr_cl execute [-task task_type | -taskfile task_file_name] -profile myprofile [-silent] [-force] [-help]

execute command parameters

-task task_type The -task task_type parameter is indicates which task to run. You can omit the -task task_type parameter if you want to run all of the tasks or if you specify the -taskfile task_file_name parameter. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 30. task_name values Option omitted Configuration file to execute Description configurebootstrap.xml configurejdbcgcd.xml configurejdbcos.xml configurejdbcos.n.xml configureldap.xml configureldap.n.xml configureloginmodules.xml deployapplication.xml where n is an integer starting with 2 If you omit the -task task_type parameter and the -taskfile task_file_name parameter, then all the configuration files in the path are run. Any configuration XML file that has the enabled attribute value in the <configuration> tag set to false is skipped.

Appendix A. Configuration Manager reference

265

Table 30. task_name values (continued) Option configurebootstrap Configuration file to execute Description configurebootstrap.xml Applies the settings for the Content Engine bootstrap on the application server. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Applies the settings for configuring the JDBC connections to the Global Configuration Data (GCD) database used by Content Engine.

configurejdbcgcd

configurejdbcgcd.xml

configurejdbcos

configurejdbcos.xml

Applies the settings for configuring JDBC connections configurejdbcos.n.xml, to a single object store where n is an integer starting database used by Content with 2 Engine. You need to generate, edit, and apply the configurejdbcos task settings for each object store in your database. When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate. You can edit the file name as needed. If your profile contains more than one configurejdbcos task, then you must specify the -taskfile task_file_name parameter to identify the task to run.

266

Installation Guide

Table 30. task_name values (continued) Option configureldap Configuration file to execute Description Configures the connection to the directory server for configureldap.n.xml, where authenticating Content n is an integer starting with 2 Engine users. configureldap.xml WebSphere Application Server or Oracle WebLogic Server only.) If you generate a second LDAP configuration file, then it is named configureldap.2.xml. The filename increments for each new file you generate. You can rename the file as needed. If your profile contains more than one configureldap task, then you must specify the -taskfile task_file_name parameter to identify the task to run. configureloginmodules configureloginmodules.xml (WebSphere Application Server or JBoss Application Server only.) Creates the login modules for the Content Engine application. Deploys the Content Engine application on the application server. Windows only. Registers or unregistersEnterprise Manager from the Windows Registry.

deployapplication

deployapplication.xml

registerem

registerem.xml

-taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2.
Appendix A. Configuration Manager reference

| |

267

| |

v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". -silent The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter. -force The -force parameter is optional and only applies when the -silent parameter is used. When -force is specified, then the task is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers. -help The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

execute command examples

The following examples include line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks. Run all the tasks in a profile. The following command runs all the tasks in the wstdb2jdbc profile, which is located in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory. If you include the -silent parameter in the command, you must also include the -force parameter.
configmgr_cl execute -profile wstdb2jdbc

Run the configurejdbcos task in a profile with one configurejdbcos task. The following command runs the configurejdbc task in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:
configmgr_cl execute -task configurejdbcos -profile wstdb2jdbc

Run a single configurejdbcos task in a profile with multiple configurejdbcos tasks: The following command runs the configurejdbcos.2.xml task file in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:
configmgr_cl execute -taskfile configurejdbc.2.xml -profile wstdb2jdbc

Display the help for the execute command. The following command displays the help for the execute command:
configmgr_cl execute -help

generateconfig command
The generateconfig command generates the configuration XML file for the specified configuration task. The command name is not case sensitive.

268

Installation Guide

generateconfig command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.
configmgr_cl generateconfig -appserver app_server_type -repositorytype ldap_repository_type -db database_type -ldap ldap_type -bootstrap bootstrap_operation -deploy deploy_type -task task_type -taskname display_name -profile myprofile [-silent] [-force] [-help]

generateconfig command parameters

-appserver appserver_name The -appserver appserver_type specifies the type of application server and must be WebSphere, WebLogic, or JBoss. -repositorytype ldap_repository_type WebSphere Application Server only. The -repositorytype ldap_repository_type parameter is required only when you are generating the XML files. This parameter specifies the type of LDAP repository to use and must be standalone or federated. -db database_type The -db database_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurejdbcgcd or configurejdbcos option. This parameter specifies the type of database to be used by Content Engine and must be mssql, oracle, oracle_rac, db2, or db2zos. -ldap ldap_type The -ldap ldap_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configureldap option. This parameter specifies the type of directory service repository that Content Engine uses for authenticating users and must be activedirectory, adam, ca, edirectory, oid, oracledirectoryse, or tivoli. The adam option applies to both Microsoft ADAM and AD LDS. -bootstrap bootstrap_operation The -bootstrap bootstrap_operation parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurebootstrap option. This parameter specifies the bootstrap operation for the profile and must be new, modify, or upgrade. -deploy deploy_type The -deploy deploy_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the deployapplication option. This parameter specifies the type of Content Engine deployment. The value must be standard, cluster, or netdeploy (network deployment). Specify standard if you are deploying Content Engine to a stand-alone (that is, a server that is not managed or clustered) WebSphere Application Server, Oracle WebLogic Server, or JBoss Application Server. Specify cluster if you are deploying Content Engine to a WebSphere Application Server, Oracle WebLogic Server, or JBoss Application Server cluster. | | | Specify netdeploy if you are deploying Content Engine to a managed WebSphere Application Server instance. That is, you are using Network Deployment to manage individual servers that are not in a cluster.
Appendix A. Configuration Manager reference

269

-task task_type The -task task_type parameter indicates which task to generate. You can omit the -task task_type parameter if you want to generate all the tasks. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 31. task_type values Option omitted Configuration file to generate applicationserver.xml configurebootstrap.xml configurejdbcgcd.xml configurejdbcos.xml configureldap.xml configureloginmodules.xml deployapplication.xml configurebootstrap applicationserver.xml configurebootstrap.xml Generates the file for the application server properties and the file with the settings for the Content Engine bootstrap on the application server. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Generates the file for the application server properties and the file with the settings for configuring the JDBC connections to the Global Configuration Data (CGD) database used by Content Engine. If the profile already contains an applicationserver.xml file, the existing file is retained. Description If you omit the -task task_type parameter, then all the default configuration files for a profile are created.

configurejdbcgcd

applicationserver.xml configurejdbcgcd.xml

270

Installation Guide

Table 31. task_type values (continued) Option configurejdbcos Configuration file to generate applicationserver.xml Description

Generates the file for the application server properties configurejdbcos.xml and the file with the settings for configuring JDBC configurejdbcos.n.xml, connections to a single object where n is an integer starting store database used by with 2 Content Engine. You need to generate, edit, and apply the configurejdbcos task settings for each object store in your database. When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task. If the profile already contains an applicationserver.xml file, the existing file is retained.

configureldap

applicationserver.xml

Generates the file for the application server properties configureldap.xml and the file for configuring the connection to the configureldap.n.xml, where directory server for n is an integer starting with 2 authenticating Content Engine users. (WebSphere Application Server or Oracle WebLogic Server only.) When you generate a second LDAP configuration file, it is named configureldap.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task. If the profile already contains an applicationserver.xml file, the existing file is retained.

Appendix A. Configuration Manager reference

271

Table 31. task_type values (continued) Option configureloginmodules Configuration file to generate applicationserver.xml configureloginmodules.xml Description (WebSphere Application Server or JBoss Application Server only.) Generates the file for the application server properties and the files for the login modules for the Content Engine application. If the profile already contains an applicationserver.xml file, the existing file is retained. deployapplication applicationserver.xml deployapplication.xml Generates the file for the application server properties and the file with settings for deploying the Content Engine application on the application server. If the profile already contains an applicationserver.xml file, the existing file is retained. registerem registerem.xml Generates the file for registering or unregisteringEnterprise Manager from the Windows Registry.

-taskname display_name The -taskname display_name parameter is optional and is valid only for generating the files. This parameter specifies the value for the displayName attribute in the configuration XML file. If the display name includes spaces, put the entire name inside quotation marks. The display name is used in the graphical user interface to identify the task. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg.

| |

| |

272

Installation Guide

Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". -silent The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter. -force The -force parameter is optional and only applies when the -silent parameter is used. When -force is specified, then the task is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers. -help The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

generateconfig command examples

The following examples include line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks. Generate all configuration files at the same time. The following command generates all the configuration XML files for a new installation profile for a standard deployment on WebSphere with IBM Tivoli Directory Server that uses a stand-alone LDAP repository and DB2 in the ce_install_path/tools/configure/profiles/wstdb2 directory:
configmgr_cl generateconfig -appserver websphere -repositorytype standalone -db db2 -ldap tivoli -bootstrap new -deploy standard -profile wstdb2

Generate only the configurejdbcos task file for an object store. The following command generates only the configurejdbcos.n.xml file for a new installation profile for deployment on WebSphere that uses a stand-alone LDAP repository in the ce_install_path/tools/configure/ profiles/wstdb2 directory:
configmgr_cl generateconfig -appserver websphere -repositorytype standalone -task configurejdbcos -profile wstdb2jdbc

Generate only the configurejdbcos task file for an object store and provide a display name for the task. The following command generates only the configurejdbcos.n.xml file for a new installation profile for deployment on WebSphere that uses a stand-alone LDAP repository in the ce_install_path/tools/configure/ profiles/wstdb2 directory and uses a display name of Configure Object Store OS23 Data Sources:
configmgr_cl generateconfig -appserver websphere -repositorytype standalone -task configurejdbcos -taskname "Configure Object Store OS23 Data Sources" -profile wstdb2jdbc

Display the help for the generateconfig command. The following command displays the help for the generateconfig command:
Appendix A. Configuration Manager reference

273

configmgr_cl generateconfig -help

gui command
The gui command opens the Configuration Manager graphical user interface. The command is not case sensitive.

gui command syntax

configmgr_cl gui

gui command Example

The following command starts the Configuration Manager graphical user interface:
configmgr_cl gui

listtasks command
The listtasks command displays a list of the tasks and the task files in the configuration profile. The command name is not case sensitive.

listtasks command syntax

configmgr_cl listtasks [-task task_type] [-help] -profile myprofile

listtasks command parameters

-task task_type The -task task_type parameter is optional and indicates which task type to list. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 32. task_type values Option omitted Configuration files configurebootstrap.xml configurejdbcgcd.xml configurejdbcos.xml configurejdbcos.n.xml configureldap.xml configureldap.n.xml configureloginmodules.xml deployapplication.xml Where n is an integer starting with 2 configurebootstrap configurebootstrap.xml Lists the task for configuring the settings for the Content Engine bootstrap on the application server. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Description If you omit the -task task_type parameter, then all the configuration tasks and the associated task files for the profile are listed.

274

Installation Guide

Table 32. task_type values (continued) Option configurejdbcgcd Configuration files configurejdbcgcd.xml Description Lists the task for configuring the settings for the JDBC connections to the Global Configuration Data (CGD) database used by Content Engine.

configurejdbcos

configurejdbcos.xml

Lists the task for configuring the settings for the JDBC configurejdbcos.n.xml, connections to a single object where n is an integer starting store database used by with 2 Content Engine. You must generate, edit, and apply the configurejdbcos task settings for each object store in your database. When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate.

configureldap

configureldap.xml

Lists the tasks for configuring the connection to the configureldap.n.xml, where directory server for n is an integer starting with 2 authenticating Content Engine users. (WebSphere Application Server or Oracle WebLogic Server only) When you generate a second LDAP configuration file, it is named configureldap.2.xml. The filename increments for each new file you generate. When you generate a second LDAP configuration file, it is named configureldap.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task.

configureloginmodules

configureloginmodules.xml

(WebSphere Application Server or JBoss Application Server only.) Lists the task for configuring the login modules for the Content Engine application. Lists the task for deploying the Content Engine application on the application server.

deployapplication

deployapplication.xml

Appendix A. Configuration Manager reference

275

-profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". -help The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

| |

| |

listtasks command examples

List all the configuration tasks in the profile. The following command lists all the configuration tasks and the associated configuration XML files in the wstdb2 profile located in the ce_install_path/tools/configure/profiles/wstdb2 directory:
configmgr_cl listtasks -profile wstdb2

A message like the following example is displayed:

All tasks in profile wstdb2. The tasks will be executed in the positions indicated when executing all tasks: Task 1: Name: Configure GCD JDBC Data Sources Type: configurejdbcgcd File: configurejdbcgcd.xml Task 2: Name: Configure Object Store JDBC Data Sources Type: configurejdbcos File: configurejdbcos.xml Task 3: Name: Configure Login Modules Type: configureloginmodules File: configureloginmodules.xml Task 4: Name: Configure LDAP Type: configureldap File: configureldap.xml Task 5: Name: Configure Bootstrap Properties Type: configurebootstrap File: configurebootstrap.xml Task 6: Name: Deploy Application Type: deployapplication File: deployapplication.xml

List all the configurejdbcos tasks in the profile.

276

Installation Guide

The following command lists all the configure JDBC settings for the object store tasks and the associated configuration XML files in the wstdb2 profile located in the ce_install_path/tools/configure/profiles/wstdb2 directory:
configmgr_cl listtasks -task configurejdbcos -profile wstdb2

A message like the following example is displayed:

Tasks in profile wstdb2 of the task type configurejdbcos: Task name: Configure Object Store JDBC Data Sources File: configurejdbcos.xml

Display the help for the listtasks command. The following command displays the help for the listtasks command:
configmgr_cl listtasks -help

movetask command
The movetask command moves a task to a different position in the list of tasks. The task position determines the order that the tasks are run when you run all the tasks at the same time. You use the listtask command to display the task order. The command names are not case sensitive.

movetask command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.
configmgr_cl movetask -task task_type | -taskfile task_file_name -position new_position -profile myprofile [-silent][-force][-help]

movetask command parameters

-task task_type The -task task_type parameter indicates which task to move. This parameter must be included if the -taskfile task_file_name parameter is omitted. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 33. task_type values Option configurebootstrap Configuration files configurebootstrap.xml Description Moves the task for configuring the settings for the Content Engine bootstrap on the application server. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine Moves the task for configuring the settings for the JDBC connections to the Global Configuration Data (CGD) database used by Content Engine.

configurejdbcgcd

configurejdbcgcd.xml

Appendix A. Configuration Manager reference

277

Table 33. task_type values (continued) Option configurejdbcos Configuration files configurejdbcos.xml Description

Moves the task for configuring the settings for configurejdbcos.n.xml, the JDBC connections to a where n is an integer starting single object store database with 2 used by Content Engine. When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate.

configureldap

configureldap.xml

Moves the task for configuring the connection to configureldap.n.xml, where the directory server for n is an integer starting with 2 authenticating Content Engine users. (WebSphere Application Server or Oracle WebLogic Server only) When you generate a second LDAP configuration file, it is named configureldap.2.xml. The filename increments for each new file you generate. When you generate a second LDAP configuration file, it is named configureldap.2.xml. The filename increments for each new file you generate.

configureloginmodules

configureloginmodules.xml

Moves the task for configuring the login modules for the Content Engine application. Moves the task for deploying the Content Engine application on the application server.

deployapplication

deployapplication.xml

-taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -positionnew_position The -positionnew_position parameter specifies the new position in the list for the item. You can run the listtasks to view the list of tasks in the profile and their position before you run the movetask command.

278

Installation Guide

-profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". -silent The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter. -force The -force parameter is optional and only applies when the -silent parameter is used. When -force is specified, then the task is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers. -help The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

| |

| |

movetask command examples

Move the task for the configurejdbcos.3.xml file in a profile with more than one configurejdbcos task. The following command moves the task for the configurejdbcos.3.xml file for the wstdb2 profile located in the ce_install_path/tools/configure/ profiles/wstdb2 directory to position 1:
configmgr_cl movetask -taskfile configurejdbcos.3.xml -position 1 -profile wstdb2

Move the configureloginmodules task. The following command moves the configureloginmodules task from the default position of task 3 to task 5 in the wstdb2 profile located in the ce_install_path/tools/configure/profiles/wstdb2 directory:
configmgr_cl movetask -task configureoginmodules -position 5 -profile wstdb2

Display the help for the movetask command. The following command displays the help for the movetask command:
Appendix A. Configuration Manager reference

279

configmgr_cl movetask -help

removetask command
The removetask command removes the specified task from the configuration profile. When you remove the task, the configuration XML file is deleted from the profile directory. The command name is not case sensitive.

removetask command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.
configmgr_cl removetask -task task_type | -taskfile task_file_name -profile myprofile [-silent][-force][-help]

removetask command parameters

-task task_type The -task task_type parameter is optional and indicates which task to remove. You can omit the -task task_type parameter if you specify the -taskfile task_file_name parameter. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 34. task_type values Option configurebootstrap Configuration file to remove Description configurebootstrap.xml Settings for the Content Engine bootstrap on the application server. The bootstrap information is needed for creating the Global Configuration Data and for starting Content Engine. Settings for configuring the JDBC connections to the Global Configuration Data (CGD) database used by Content Engine.

configurejdbcgcd

configurejdbcgcd.xml

configurejdbcos

configurejdbcos.xml

Settings for configuring JDBC connections to a single object configurejdbcos.n.xml, store database used by where n is an integer starting Content Engine. You need to with 2 generate, edit, and apply the configurejdbcos task settings for each object store in your database. If you generate a second object store JDBC configuration file, then it is named configurejdbcos.2.xml. The filename increments for each new file you generate.

280

Installation Guide

Table 34. task_type values (continued) Option configureldap Configuration file to remove Description configureldap.xml Configures the connection to the directory server for configureldap.n.xml, where authenticating Content n is an integer starting with 2 Engine users. (WebSphere Application Server or Oracle WebLogic Server only) If you generate a second LDAP configuration file, then it is named configureldap.2.xml. The filename increments for each new file you generate. If your profile contains more than one configureldap task, then you must specify the -taskfile task_file_name parameter to identify the task to remove. configureloginmodules configureloginmodules.xml (WebSphere Application Server or JBoss Application Server only) Creates the login modules for the Content Engine application. Deploys the Content Engine application on the application server.

deployapplication

deployapplication.xml

-taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg.

| |

| |

Appendix A. Configuration Manager reference

281

Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg". -silent The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter. -force The -force parameter is optional and only applies when the -silent parameter is used. When -force is specified, then the task is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers. -help The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

removetask command examples

Remove the configurejdbcos task from a profile with only one configurejdbcos task. The following command removes the configurejdbcos task and the configurejdbcos.xml file from the profile named wstdb2jdbc_one.
configmgr_cl removetask -task configurejdbcos -profile wstdb2jdbc_one

Remove the configurejdbcos task from a profile with several configurejdbcos tasks. The following command removes the configurejdbcos task and the configurejdbcos.2.xml file from the profile named wstdb2jdbc_many.
configmgr_cl removetask -taskfile configurejdbcos.2.xml -profile wstdb2jdbc_many

Remove the configurejdbcos task from a profile with several configurejdbcos tasks by using an absolute path to the profile directory. The following command removes the configurejdbcos task and the configurejdbcos.2.xml file from the profile named wstdb2jdbc_many that is located in the c:\temp\myprofiles\wstdb2jdbc_many directory.
configmgr_cl removetask -taskfile configurejdbcos.2.xml -profile c:\temp\myprofiles\wstdb2jdbc_many

Display the help for the removetask command. The following command displays the help for the removetask command:
configmgr_cl removetask -help

storepasswords command
The storepasswords command prompts for passwords that are blank in a profile and stores the encrypted passwords in the file. Storing encrypted passwords might not be FIPS 140-2 compliant. You can run the command for a single task or for all tasks in the profile. The command name is not case sensitive.

storepasswords command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.

282

Installation Guide

Tip: If the storepasswords command prompts you to store passwords in configuration files on disk, you must respond with yes or no (instead of y or n).
configmgr_cl storepasswords [-task task_type | -taskfile task_file_name] -profile myprofile [-help]

storepasswords command parameters

-task task_type The -task task_type parameter specifies a specific task to encrypt passwords for. You can omit the -task task_type parameter if you want to store passwords for all the tasks or if you specify the -taskfile task_file_name parameter. The task_name value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Engine settings affected by the task.
Table 35. task_type values Option omitted Configuration file applicationserver.xml configurebootstrap.xml configurejdbcgcd.xml configurejdbcos.xml configurejdbcos.n.xml configureldap.xml configureldap.n.xml deployapplication.xml Where n is an integer starting with 2 configurebootstrap configurebootstrap.xml Encrypts the password for the BootstrapPassword property that is used to create the Global Configuration Data and to start Content Engine. Encrypts the password for the DatabasePassword property that Content Engine uses to access the GCD database. Description If you omit the -task task_type parameter and the -taskfile task_file_name parameter, then you are prompted to enter the passwords for each configuration XML file in the profile. Each password is encrypted before it is added to the XML file.

configurejdbcgcd

configurejdbcgcd.xml

configurejdbcos

configurejdbcos.xml

Encrypts the password for the DatabasePassword configurejdbcos.n.xml, property that Content Engine where n is an integer starting uses to access the object store with 2 database. If you have more than one configurejdbcos.n.xml file, run the command for each task file.

Appendix A. Configuration Manager reference

283

Table 35. task_type values (continued) Option configureldap Configuration file configureldap.xml Description

Encrypts the password for the LDAPBindPassword configureldap.n.xml, where property that Content Engine n is an integer starting with 2 uses to connect to the directory server for authenticating Content Engine users. (WebSphere Application Server or Oracle WebLogic Server only.) If you have more than one configureldap.n.xml file, run the command for each task file.

-taskfile task_file_name The -taskfile task_file_name parameter specifies the configuration XML file to use. If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional. If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter. -profile myprofile The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items: v The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Engine software is installed. v The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/ profiles/ce_was_tiv_db2. v The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/ tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg. Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ ce_was_tiv_db2.cfg".

| |

| |

storepasswords command examples

Encrypt and save all passwords for a profile. The following command encrypts and saves passwords for any blank entries in the profile named wstdb2jdbc_one.
configmgr_cl storepasswords -profile wstdb2jdbc_one

284

Installation Guide

Encrypt and save the passwords for a specific configurejdbcos task in a profile with several configurejdbcos tasks. The following command encrypts and saves passwords for any blank entries in the configurejdbcos.2.xml file from the profile named wstdb2jdbc_many.
configmgr_cl storepasswords -taskfile configurejdbcos.2.xml -profile wstdb2jdbc_many

Display the help for the storepasswords command. The following command displays the help for the storepasswords command:
configmgr_cl storepasswords -help

Appendix A. Configuration Manager reference

285

286

Installation Guide

Appendix B. Troubleshooting FileNet P8 Platform installation and upgrade

This section provides troubleshooting solutions for problems you might encounter when installing or upgrading IBM FileNet P8 software. AddOn installation can fail with resource unavailable exception An AddOn installation might fail if a prepared statement in the prepared server cache of an application server references the specified database table. Application server does not start after installation and shutdown on page 288 The WebSphere Application Server might not start after installation and shutdown because LDAP settings are not configured correctly or JVM startup arguments are not specified properly. Cannot save Process Task Manager security settings on page 289 Saving the initial Process Task Manager security settings could fail because the software or database is not running, the connection with Content Engine failed, or user credential information is not correct. Recovering from errors during Content Engine upgrade on page 292 As with all complex processes, errors can occur during the upgrade of Content Engine.

AddOn installation can fail with resource unavailable exception

An AddOn installation might fail if a prepared statement in the prepared server cache of an application server references the specified database table.

Symptoms
The installation of an AddOn into an object store that uses a DB2 for z/OS database fails. The installation returns an exception message that indicates the database table is currently referenced by a prepared statement and cannot be altered.

Causes
Installing an AddOn into an object store that uses DB2 for z/OS might fail when a prepared statement that is stored in the prepared statement cache of the application server references the affected database table. This reference maintains an active association to the referenced table and thus prevents any schema modifications from occurring. For example, a -904 resource exception message with the reason code of SQLERRMC=00E70081 indicates the table associated with the ALTER TABLE statement (DocVersion) is currently referenced by a prepared statement that is stored in the prepared statement cache and therefore, it cannot be altered.
2008-10-08T06:25:07.204Z 291E291E API FNRCE0230E - ERROR An error occurred accessing the database. ErrorCode: -904, Message: DB2 SQL Error: SQLCODE=-904, SQLSTATE=57011,SQLERRMC=00E70081;00000A00;A12BASE.DOCVERSION, DRIVER=3.51.118 SQL: vargraphic(1200) "\ncom.filenet.api.exception.EngineRuntimeException: DB_ERROR: An error occurred accessing the database. ErrorCode: -904, Message: DB2 SQL Error: SQLCODE=-904, SQLSTATE=57011,
Copyright IBM Corp. 2001, 2011

287

SQLERRMC=00E70081;00000A00;A12BASE.DOCVERSION, DRIVER=3.51.118 SQL: "ALTER TABLE DocVersion ADD COLUMN uee8_rmentitydescription vargraphic(1200)"

Resolving the problem

Disable the prepared statement cache for the XA data source of the affected object store. Additionally, ensure the DB2 for z/OS CACHEDYN subsystem parameter is set to YES. To disable the prepared statement cache for the XA data source of the object store: 1. Go to the prepared statement cache for the XA data source of the affected object store. 2. Make a note of this current statement size value to use when you reset it. 3. Disable the prepared statement cache for the XA data source of the affected object store by setting the statement size to 0. 4. Set the DB2 for z/OS CACHEDYN subsystem parameter to YES if needed. 5. Run the AddOn installation. 6. In the prepared statement cache for the XA data source of the affected object store, reset the statement size to its previous value.

Application server does not start after installation and shutdown

The WebSphere Application Server might not start after installation and shutdown because LDAP settings are not configured correctly or JVM startup arguments are not specified properly.

Symptoms
The WebSphere Application Server does not start after installation and shutdown.

Causes
This problem can occur because of several reasons: v After you enable Global Security, the WebSphere Application Server might not be able to start because LDAP repository settings are not configured correctly. This condition is more likely to happen if you use Standalone as your default LDAP repository. v You specified incorrect JVM startup arguments.

Resolving the problem

To resolve the LDAP problem, you must have valid LDAP users to enable Global Security. Important: The WebSphere Application Server User ID (referred to as the WebSphere Administrative Login during Content Engine installation) must reside within the LDAP Base Distinguished Name that you specified during Content Engine installation. To modify your LDAP settings: 1. Run \IBM\WebSphere\AppServer\profiles\profile\bin\wsadmin -conntype NONE. 2. At the wsadmin> prompt, enter securityoff.

288

Installation Guide

3. Enter exit. 4. Restart the application server. 5. Start the WebSphere Console and make the necessary changes to the LDAP security settings. 6. In the WebSphere Console, re-enable Global Security. To correct the JVM startup arguments, modify or remove the problematic argument values: 1. Open the /IBM/WebSphere/AppServer/profiles/<profile>/config/cells/ <cell_name>/nodes/<node_name>/servers/<server_name>/servers.xml file. 2. Search for "genericJvmArguments". 3. Modify or remove the incorrect argument values. 4. Save your changes.

Cannot save Process Task Manager security settings

Saving the initial Process Task Manager security settings could fail because the software or database is not running, the connection with Content Engine failed, or user credential information is not correct. To save Process Task Manager security settings, the following conditions must be true: v Process Engine software and the database must be running. v Process Engine must be able to connect to the Content Engine by using the URI configured in Process Task Manager. v All user names, groups, and passwords must match the names that are configured in the Content Engine LDAP configuration. After all connections are made and security information is verified, the configuration is written to the Process Engine database. If the security settings cannot be saved, start by checking the following log files.
Operating system Windows Log file location C:\Program Files\IBM\FileNet\ ProcessEngine\vwtaskman.log

After you review the log files, the following procedures provide information to assist with identifying the source of the problem. Verifying the Content Engine server is available to Process Engine on the network on page 290 To save Process Engine security settings from Process Task Manager, the server where Content Engine is installed must be available to Process Engine on the network. Verifying that the Process Engine can connect to a FileNet Engine Web page on Content Engine on page 290 Verify that Process Engine can connect to the FileNet Engine Web page on Content Engine. Failures could indicate an incorrect server name or problems with the designated port. Verifying that Process Engine can connect to Content Engine by using the Content Engine URI on page 291 Verify that Process Engine can connect to the Content Engine by using the

Appendix B. Troubleshooting FileNet P8 Platform installation and upgrade

289

Content Engine URI. Failures could indicate problems connecting to the Content Engine or problems with security settings.

Verifying the Content Engine server is available to Process Engine on the network
To save Process Engine security settings from Process Task Manager, the server where Content Engine is installed must be available to Process Engine on the network.

Symptoms
Process Task Manager security settings cannot be saved.

Resolving the problem

Verify with the application server administrator that the Content Engine server name is correct.

Ping the Content Engine server

To ping the server and to verify that the Process Engine server access the Content Engine server on the network: 1. Open a Web browser on the Process Engine server. 2. Ping the server by running the following command: ping ceserver You should see responses that are similar to these:
Pinging ceserver [1.2.3.4] Reply from 1.2.3.4: bytes =32 Reply from 1.2.3.4: bytes =32 Reply from 1.2.3.4: bytes =32 Reply from 1.2.3.4: bytes =32 time time time time < < < < 1ms 1ms 1ms 1ms TTL=127 TTL=127 TTL=127 TTL=127

The format varies, but the messages indicate there was a reply from the server and the IP address of this server is 1.2.3.4. If the ping returns a message indicating the host could not be found, verify that the server is running, the server name is correct, there is no DNS or firewall issue, and try again.

Verifying that the Process Engine can connect to a FileNet Engine Web page on Content Engine
Verify that Process Engine can connect to the FileNet Engine Web page on Content Engine. Failures could indicate an incorrect server name or problems with the designated port.

Symptoms
Process Task Manager security settings cannot be saved.

Resolving the problem

v If you are not able to retrieve the information, verify that the server can be reached by pinging the Content Engine server (ceserver). v If you can ping the server with the ceserver name, the problem could be with the port number that you are trying to use. Or the server that you can ping is not a Content Engine server, even though it responds on the network.

290

Installation Guide

Verify the connection to the Content Engine FileNet Engine Web page
To verify that the Process Engine server can access the FileNet Engine Web page on the Content Engine and verify that the software version on the Content Engine matches the version of Content Engine Client software installed on the Process Engine: 1. Open a Web browser on the Process Engine server. 2. Browse to the FileNet Engine Web page and enter: http://ceserver:port/ FileNet/Engine ceserver The host name of the machine where Content Engine is deployed. port The HTTP port that is used by the application server where Content Engine is deployed. The following table describes an example address for your application server.
Application server type IBM WebSphere Application Server Web page address http://myserver:9080/FileNet/Engine

3. Verify the value in the Startup Message key. The Content Engine build and version (for example, dap451.100), must match the build and version in the version.txt file in the TAR or ZIP file of the Content Engine Client installation software on Process Engine. If you are able to retrieve the FileNet Engine information, the Content Engine server is available and configured correctly. If you are able to retrieve the information but the Content Engine and Content Engine Client software versions are not the same, you must install the correct version of the Content Engine Client software.

Verifying that Process Engine can connect to Content Engine by using the Content Engine URI
Verify that Process Engine can connect to the Content Engine by using the Content Engine URI. Failures could indicate problems connecting to the Content Engine or problems with security settings.

Symptoms
Process Task Manager security settings cannot be saved.

Resolving the problem

v Verify with the application server administrator that the Content Engine server name, the protocol, and port number are correct. v Verify with the security administrator that the authentication information is correct.

Appendix B. Troubleshooting FileNet P8 Platform installation and upgrade

291

Verify the Content Engine connection using the Content Engine URI
To verify that the Process Engine server can connect to the Content Engine by using the Content Engine URI and the security information specified in Process Task Manager: 1. Open a Web browser on the Process Engine server. Enter the Content Engine URI that is configured in Process Task Manager. In these examples, the protocol is HTTP and the attachment protocol is MTOM. The attachment protocol can also be specified as FNCEWS40DIME.
Application server type IBM WebSphere Application Server Web page address http://CEserver:9080/wsi/FNCEWS40MTOM/

2. If you can connect to the Content Engine by using the URI, try to save the security settings by clicking Apply. If an error is returned, you verified the ability to connect to Content Engine, so security information might not be correct, including the user name, password, or group names. Check the following log files for specific information related to problems with the security settings.
Operating system UNIX Windows Log file location /opt/IBM/FileNet/ProcessEngine/ vwtaskman.log C:\Program Files\IBM\FileNet\ ProcessEngine\vwtaskman.log

The service user name must be a member of the group that is specified in the Process Engine Administrator Group (pe_admin_group). The user name must be entered as a short name. Duplicate short names are not supported.

Recovering from errors during Content Engine upgrade

As with all complex processes, errors can occur during the upgrade of Content Engine. Related troubleshooting information Recovering from errors during Global Configuration Data (GCD) upgrade The Content Engine upgrade can fail during the upgrade of the GCD. Recovering from errors during an object store upgrade on page 293 The upgrade of Content Engine can fail during the upgrade of an object store.

Recovering from errors during Global Configuration Data (GCD) upgrade

The Content Engine upgrade can fail during the upgrade of the GCD.

Symptoms
The upgrade of Content Engine fails prior to the upgrade of any object stores.

Causes
The FileNet P8 domain information provided to the upgrade tool is incorrect, and an error occurs prior to any object store upgrades.

292

Installation Guide

The FileNet P8 domain has already been upgraded or partially upgraded and you are seeing constraint violation errors. The FileNet P8 domain has preexisting version 5.1 GCD objects, such as marking sets or fixed content devices, with names that conflict with version 3.5.2 GCD objects. The user logging into Content Engine Web Upgrade Tool lacks sufficient privileges and permissions to update the GCD.

Resolving the problem

Diagnose the problem in the error log. If the 3.5.2 GCD needs modifications, restore the version 5.1.0 GCD database and correct the information in it with version 3.5.2 Enterprise Manager. Back up the 3.5.2 sysinit.dat file again, and start a new upgrade from the beginning with Content Engine Web Upgrade Tool. If the version 5.1.0 GCD needs modifications, restore the 5.1.0 GCD database and correct the information in it with the version 5.1.0 Enterprise Manager. Restart the in-progress upgrade by clicking Reset All Status in Content Engine Web Upgrade Tool. If you previously upgraded the version 5.1.0 GCD, either partially or fully, restore the version 5.1.0 GCD database. If the version 3.5.2 GCD has correct information, but the information entered in Content Engine Web Upgrade Tool for the GCD objects is incorrect, correct the information in the tool and restart the in-progress upgrade by clicking Reset All Status in the tool.

Recovering from errors during an object store upgrade

The upgrade of Content Engine can fail during the upgrade of an object store.

Symptoms
The upgrade of Content Engine from version 3.5.2 to 5.0.0 fails with error messages during the upgrade of an object store.

Causes
The object store information provided to Content Engine Web Upgrade Tool is incorrect, and an error occurs during an object store upgrade. The user who logged into the Content Engine Web Upgrade Tool to do the upgrade is not an object store administrator. There are missing classes or properties on system AddOns that are being upgraded. There is a transaction timeout when upgrading system AddOns. The file store specified in Content Engine Web Upgrade Tool cannot be accessed for reading or writing.
Appendix B. Troubleshooting FileNet P8 Platform installation and upgrade

293

Hitachi or IBM fixed file stores are specified to be upgraded.

Resolving the problem

Examine the error log. If you can correct the errors without using the version 3.5.2 tools to access the object store, do so and then and reenable and restart the in-progress upgrade. If you need to correct the error using the version 3.5.2 tools to access the object store, use the P8 5.0.0 IBM FileNet Enterprise Manager to remove the object store from the P8 5.0.0 domain. Correct the error in the version 3.5.2 IBM FileNet Enterprise Manager and start the upgrade from the beginning. If the database schema upgrade completed or was in progress when the error occurred, you will not be able to access the object store using the version 3.5.2 IBM FileNet Enterprise Manager. Depending on the error, you must correct the problem in the database or restore the database to its state before the upgrade began. You can then click Reset All Status in Content Engine Web Upgrade Tool to reenable the object store for upgrade and then start the upgrade again. If the error occurred during the upgrade of an addon or a file store, then you must resolve the problem with the addon or file store. You can then click Reset Status in Content Engine Web Upgrade Tool to reenable the upgrade of the addon or file store and start the upgrade again. If you have Hitachi or IBM fixed file stores, use the Move File Store Wizard of the version 3.5.2 Enterprise Manager to migrate the version 3.5.2 content to a file store that is supported for upgrades. Backup the object store database, and use Content Engine Web Upgrade Tool to run an entirely new upgrade with a new version 3.5.2 sysinit.dat file.

294

Installation Guide

Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

Copyright IBM Corp. 2001, 2011

295

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose, CA 95141-1003 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy,

296

Installation Guide

modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.

Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml (www.ibm.com/legal/ copytrade.shtml). Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others.

Notices

297

298

Installation Guide

Index A
additional file storage areas 193 AddOn installation problems troubleshooting 287 Application Engine access roles 172 administrator access roles 172 administrators 172 Application Name 174 configuring on all application servers 153 configuring on WebSphere 153 configuring SSL 182 container-managed authentication on WebSphere 154 deploying on all application servers 166 deploying on WebSphere 167 deploying on WebSphere 6.1 168 deploying on WebSphere 7.0 169 indexing 174 installing 144 installing and configuring 143 installing Content Engine Client 148 installing interactively 144 installing silently 146 installing software updates 148 multiple instances 200 removing ISRA servlet 227 removing on WebSphere 225 setting up full SSL support 182 Application Integration installing 195 installing interactively 195 installing silently 196 verify installation 197 application server enabling connections after database failover 62 authentication token IBM Content Search Services server 93 Autonomy K2 installing Content Search Engine 103 moving administration servers 210 Autonomy K2 administration server installing additional silently Windows 208 Autonomy K2 administration servers installing additional interactively Windows 208 Windows 207 Autonomy K2 server modifying configuration 207 Autonomy K2 servers moving 209

B
banner image changing 172 bootstrap 45 bootstrap preferences configuring 171 enhanced time zone 175 setting on first login 172 setting the SSL configuration for Application Engine 172 bootstrap properties 254 bootstrap.properties file sharing between Application Engines 183

C
CCL 212 certificates validating on IBM Content Search Services 102 checking the status of a task from the command line 59 checking the task status from the command line 60 checkstatus command 261 COM compatibility layer 212 Component Manager 189 Composite Platform Installation Tool interactive 5 configmgr.ini 259 configuration IBM Content Search Services 93 configuration and startup tasks 177 Configuration manager overview 235 Configuration Manager config_mgr_user permissions 37 adding an SSL signer to the keystore 241, 242 adding new tasks 257 applying configuration settings from the command line 56, 57 applying the Configure Bootstrap Properties settings 256 applying the Configure JDBC Data Sources settings 255 applying the values in a task 255 changing password preference for installation 40 checking the status of a task 259 checking the status of a task from the command line 59 checking the task status from the command line 60 checkstatus command 261 command line interface 47 command-line reference 260 Configure Bootstrap settings for upgrade 45

Configuration Manager (continued) configuring Content Engine using the graphical user interface 38 console toolbar 246 creating a new profile 251 deploying Content Engine 257 editing a configuration XML file for installation 52 editing a task 253 editing the application server properties 253 editing the Configure Bootstrap Properties task 254 editing the Configure JDBC Data Sources task 253 editing the Configure LDAP task 254 editing the Deploy Application task 255 execute command 265 generateconfig command 269 generating a configuration XML file for installation 50 generating all of the configuration XML files at the same time for installation 49 grant user permissions 37 graphical user interface and command-line interface differences 238 gui command 274 GUI reference 243 installation worksheet 238 listtasks command 274 logs 240 main toolbar 245 menus and commands 247 movetask command 277 new profile 41 opening an existing profile 252 overview 236 passwords 239 profile concepts 236 profile toolbar 245 reference 235 remove task 257 removetask command 280 running a selected task 258 running all configuration XML files at the same time 56 running all tasks at the same time 258 running commands 260 running configuration XML files for installation 56 running configuration XML files one at a time 57 saving changes to a task or profile 259 setting password save preference 251 starting 39 starting for installation 243

Copyright IBM Corp. 2001, 2011

299

Configuration Manager (continued) storepasswords command 282 task status 259 task toolbar 245 viewing the session log 259 window description 244 working in the Configuration Manager window 244 working with 249 configuration profile adding new tasks 257 creating a new profile 41 renaming tasks 257 configuration tasks adding 257 renaming 257 configuration XML files applying installation settings in Configuration Manager 56 configuration, silent peinit command 129, 136 Configure Bootstrap settings 45 Configure Global Configuration Data (GCD) data source 42 Configure LDAP 256 Configure LDAP task 44 Configure Login Modules task 43, 44 configure object store data source 81 configuring Content Engine 35, 38 configuring Content Engine using the Configuration Manager graphical user interface 38 configuring environment variables 72 configuring login modules for Content Engine 256 connection point configure for Application Engine 177 connection points creating for Process Engine 135 container-managed authentication Application Engine on WebSphere 154 content based retrieval enabling index objects for 96 Content Engine bootstrap settings 45 configuration IBM Content Search Services servers on Content Engine 94 configuring 35, 38 configuring an instance 250 configuring file stores 73 configuring for IBM Content Search Services 93 configuring IBM Content Search Services servers 94 connecting 88 correcting a dotnetclient configuration profile error 240 creating a profile by using the command line 48 deploying instances 63 deploying instances using the GUI 63 deploying on server clusters 88

Content Engine (continued) enabling application server connections after database failover 62 generating configuration XML files 48 highly available connection 87 installing 25 installing and configuring 23 installing interactively 26 installing Process Engine Client files 33 installing silently 26 installing software updates 29 login modules 43, 44, 256 post deployment steps 73 post-deployment steps WebSphere 73 removing 217 removing data 218 removing silently 217 SSL signer error 241, 242 storage device source files 69 using command line interface to configure 47 verify installation 89 verifying deployment 74 web service 179, 180 Content Engine Client installing interactively on Application Engine 149 installing on Application Engine 148 installing silently on Application Engine 150 Content Search Engine adding administration servers 207 CBREnabled flag 116 class properties 116 collections directory 115 configuring additional administration servers 209 installing additional locales Windows 113 installing Client files 32 interactively 32 silently 33 K2 Broker Server 116 removing servers 210 Content Search Engine Client installing 29 cpit_silent_install.txt 6 creating a new profile Configuration Manager 251

Deployment Manager 194 document check in (verify new object store) 89 check out (verify new object store) 89 create (verify new object store) 89 documentation configuring site preference settings for 172 installing as a local information center 17 installing information center interactively 18 removing from WebSphere Application Server 215 server URL 151 starting 20 verifying 20 domain users group 86 Verity (K2) 116 domain, FileNet P8 configure permissions 77 create 77 download directory 3

E
editing a configuration XML file 52 EJB transport 179, 180 EMC Centera SDK 72 EMC Centera SDK library files installing 71 installing for use with Content Engine 71 Enterprise Manager enable SSL 181 installing 27 installing additional instances 191 execute command 265

F
file storage verifying 193 file storage area specify 86 file stores configuring 73 File Tracker installing 198 installing interactively 198 installing silently 199 FileNet P8 backing up 21 disaster recovery 21 redeploying 21 removing documentation 215 removing documentation from WebSphere Application Server removing software 213 single-server installation 1 FileNet P8 documentation configure for Process Engine help 151 FileNet Styleset 108

D
data source 81 Global Configuration Data (GCD) data sources 79, 83 creating 79 deleting 37 deleting existing data sources 37 deploy application 255 deploy application task 68 deployapplication.xml file 65, 68 deploying Content Engine 65 deployment configuration files 67 42

215

300

Installation Guide

fsa1 directory

193

G
generateconfig command 269 generating a configuration XML file 50 generating all of the configuration XML files at the same time 49 generating configuration XML files 48 genseed 133 gui command 274

H
host names verifying on IBM Content Search Services 102 how to read syntax diagrams 261

I
IBM Content Search Services adding index areas 95 authentication token 93 configuring 91, 93 configuring Content Engine 93 configuring for Content Engine 93 configuring SSL for 98 deploying server certificates 100 enabling SSL 98 enabling SSL ports 98 installing 91, 92 installing and configuring 91 installing Client files interactively 30 silently 31 performing server authentication 99 removing 219 removing interactively 219 removing silently 220 self-signed certificates 100 third party certificates 100 uninstalling interactively 219 validating certificates 102 verifying host names 102 IBM Content Search Services Client installing 29 IBM Content Search Servicesverifying the installation 96 IBM FileNet Content Search Engine removing 219 IBM FileNet P8 System Health page 74 IBM Legacy Content Search Engine 207 CBR indexing 116 CBR locale 116 collections 108 collections directory 115 configuring CBR 108 configuring services 112 FileNet Styleset 108 installing additional locales 113 installing and configuring 91, 102 installing interactively on Windows 104, 106 installing on Windows 103 installing silently on Windows 105

IBM Legacy Content Search Engine (continued) installing with Autonomy K2 103 K2 Administrative Users 108 K2 Index Server 108 K2 Search Server 108 K2 Ticket Server 108 launching K2 Dashboard 108 removing 219, 220 removing locales on Windows 221 setting Autonomy K2 Administration Security 108 verifying installation 119 IIOP protocol 179, 180 Image Services library documents 206 index areas adding 95 index objects enabling for content based retrieval 96 information center backing up 21 installing 17 installing interactively 18 redeploying 21 Install Process Engine interactively on Windows 122 silently on Windows 123 installation distributed server system 15 IBM Content Search Services 91, 92 IBM Content Search Services Client 29 IBM Legacy Content Search Engine 91 optional tasks 187 P8 documentation silent 19 single-server 1 troubleshooting 287 installation Client Content Search Services 29 installing Content Engine 26 Installing Content Engine and related client software 24 installing Process Engine client Application Engine 151, 152 interactive installation IBM Content Search Services Client 30 interactive uninstallationIBM Content Search Services 219 IP address Application Engine SSL host 182 isolated region for Process Engine 134 ISRA installing the servlet 203 SSL configurations 203

K
K2 Administration Server setting logon user 107 K2 servers enabling 119 Kerberos 179, 180

L
LDAP federated repositories on WebSphere 164 Image Services login 206 stand-alone on WebSphere 163 listtasks command 274 locales removing on Windows 221 log files Configuration Manager 240 login modules for Content Engine 43, 44 LTPA configuring on Application Engine 161

M
Microsoft Office installing application integration for 195 movetask command 277 multi-server configuration Application Engine 200 Enterprise Manager 191

O
object store 81, 86 data sources 79, 83 enabling text search 95 verify new 89 object store data source 81

P
P8 documentation 17 installing, silently 19 password encryption Process Engine 133 password preference 251 passwords Configuration Manager 239 peinit command 129, 136 platform installation Administrator password 11 interactive 5 preparing 3 silent 6 verifying 9 Process Engine adding instances to a farm 139 Component Integrator 188 configuration 127 connection to Component Manager 190 creating connection points 135 Index

J
Java Virtual Machine settings on Application Engine Websphere 159 JDBC data source Global Configuration Data (GCD) 42

301

Process Engine (continued) installing 122 installing and configuring 121 installing Client files interactively 34 silently 35 installing Content Engine client files 124 installing Content Engine client files interactively 125 installing Content Engine client files silently 126 installing interactively 122 installing silently 123 installing software updates 124 isolated region configuration 134 removing on Windows 223, 224 server farm 141 silent configuration 129 silent configuration isolated region 136 Process Engine Client installing on Content Engine 33 Process Task Manager configuring 127, 138 configuring security 127 defining isolated regions 135 profile 236 publishing capabilities 188

R
realm configuring more than one 185 object store administrator 86 remove task 257 removetask command 280 Rendition Engine 188

S
saving passwords to file in Configuration Manager 40 secure ports enabling on IBM Content Search Services 98 security setting up SSL for Application Engine 182 SSL for Content Engine 180 SSL preference setting for Application Engine 172 SSL, set up for Content Engine 179 self-signed certificates deploying on IBM Content Search Services 100 server authentication performing 99 server certificates deploying on IBM Content Search Services 100 server farm configuring for a software load balancer 141 Process Engine 141

server farm (continued) configuring for a software load balancer 141 silent installation IBM Content Search Services Client 31 single-server interactive installation 5 passwords 11 silent installation 6 verifying installation 9 single-server installation downloading 3 Site preference settings documentation URL 172 name and location 172 site preferences ISRA 205 single index for Application Name 174 software load balancer configuring 141 SSL adding an SSL signer to the keystore 241 configuring for IBM Content Search Services 98 correcting SSL Signer Exchange Prompt errors 242 enable between Process Engine and Process Engine client 178 full support on Application Engine 182 Java applets 184 security info preference 172 set up for Content Engine 180 setting up for Application Engine 182 setting up for Content Engine 179 SSL communication 138 SSL ports enabling on IBM Content Search Services 98 SSO configuring for Application Engine on WebSphere 156 Statement Cache Size 77 storage device source files 69 storepasswords command 282 subfolder, create, (verify new object store) 89 syntax diagrams 261 System Manager 206

Tivoli Storage Manager (WebSphere Application Server) installing client and adding native API library paths 69 Tivoli Storage Manager API libraries copying to additional servers 70 Tivoli Storage Manager client installing 70 Tivoli Storage Manager native API library files creating a shared library definition 70 troubleshooting AddOn installation failure 287 application server does not start 288 application server problems troubleshooting 288 connecting to the FileNet Engine Web page on the Content Engine 290 Content Engine 292, 293 error during the upgrade of the Global Configuration Data (GCD)Content Engine 292 installation 287 ping the Content Engine server 290 Process Engine cannot save security settings 289 Process Task Manager 289 verify the Content Engine server responds on the network 290 Process Engine connect to Content Engine using the URI 291 recovering from errors during object store upgrades 293 recovering from upgrade errors 292 upgrade 287

U
upgrade troubleshooting 287 User Token configuring 172 UTCryptoKeyfile.properties

144

V
verification IBM Content Search Services installation 96 verify installation Process Engine 139 verifying Content Engine deployment 74 Verity domain dedicating to one object store 211 Verity Domain Config. tab (VDC) 116

T
T3 protocol 179 T3protocol 180 text search enabling on the object store 95 third party certificates deploying on IBM Content Search Services 100 Tivoli Storage Manager adding native API library paths WebSphere 69

W
WAR or EAR file re-creating on WebSphere 167 Web Service Transport Content Engine 88 web services Content Engine 179, 180

302

Installation Guide

web services (continued) Process Engine 179, 180 WebSphere configuring Application Engine 153 deploying Application Engine 167 WebSphere 6.1 enabling connections after database failover 62 WebSphere 7.x enabling connections after database failover 62 Windows cluster Process Engine Windows 138 workflow subscription wizard 175 Workplace Application Integration collocation issues 195 configuring SSL access to 182 defining workflow features for users 185 deploying a second instance 200 deploying additional instances as an EAR file 201 designing publishing templates for users 185 designing searches for users 185 enable access to tasks and work items 177 enable for access to IS documents 202 installing Application Integration 195 installing File Tracker 198 setting bootstrap properties 171 setting documentation server URL 172 specifying Application Engine administrators 172 updating settings load balanced environment 175 Workplace Application Integration removing 229 removing interactively 229 removing silently 229 Workplace File Tracker removing 231 removing interactively 231 removing silently 231

Index

303

304

Installation Guide

Product Number: 5724-R76 5724-R81

GC19-3071-04