FileNet P8 Platform Installation and Upgrade Guide

IBM FileNet P8 Platform
1
Version 4.0
Installation and Upgrade Guide
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
GC31-5488-05
2
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
IBM FileNet P8 Platform
3
Version 4.0
Installation and Upgrade Guide
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
GC31-5488-05
4
Note
Before using this information and the product it supports, read the information in “Notices” on page 713.
This edition applies to version 4.0.1 of IBM FileNet Content Manager (product number 5724-R81), version 4.0.2 of
IBM FileNet Business Process Manager (product number 5724-R76), and to all subsequent releases and
modifications until otherwise indicated in new editions.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
© Copyright International Business Machines Corporation 2001, 2008. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Typographical Conventions
This document uses the conventions in the following table to distinguish elements of text.
Convention
Usage
UPPERCASE
Environment variables, status codes, utility names.
Bold
Program names and selected terms such as command
parameters or environment variables that require emphasis.
Bold Gray
Clickable user-interface elements (such as buttons).
Bold Olive
Paths and file names.
Italic
User-supplied variables and new terms introduced in text,
names of additional documents (such as IBM FileNet® P8
Platform Installation and Upgrade Guide).
<italic>
User-supplied variables that replace everything between and
including the angle bracket delimiters (< and >).
Monospace
Code samples, examples, display text, and error messages.
NOTE Some path names in this document that are identical (except for the directory-separator character)
on both UNIX® and Windows® platforms are specified in UNIX syntax only (that is, with forward-slash
directory separators).
WARNING This document contains examples of text to be typed on a command line. Be sure to manually
type the command, rather than copying and pasting it from this document. Otherwise, your command line
may contain unrecognized characters and will not execute properly.
Revision Log
The following table identifies changes made to this document since the IBM FileNet P8 4.0.0
release.
Date
Revision
06/08
Added a new appendix, “Installing Process Engine on Solaris 10 Zones” on
page 697.
In “Remove Process Engine (UNIX)” on page 657, modified executable to remove
Process Engine software.
Clarified when Oracle password complexity must be disabled for Process
Engine. Changes reflected in:
•
“Install Process Engine (Windows)” on page 294
•
“Install Process Engine (AIX)” on page 325
•
“Install Process Engine (HP-UX)” on page 337
•
“Install Process Engine (Solaris)” on page 311
•
“Upgrade Process Engine (UNIX)” on page 550
•
“Upgrade Process Engine (Windows)” on page 556
Updates to reflect changes related to the Process Engine 4.0.3 release. Along
with changes to existing topics, some new topics have been added to
incorporate information that was previously covered in Service Pack readme
files.
Added additional database connection verification step immediately after
installing Process Engine in:
•
“Install Process Engine (Windows)” on page 294
•
“Install Process Engine (AIX)” on page 325
•
“Install Process Engine (HP-UX)” on page 337
•
“Install Process Engine (Solaris)” on page 311
Date
Revision
Added information related to configuring Process Engine region recovery in:
•
“Install Process Engine (Windows)” on page 294
•
“Install Process Engine (AIX)” on page 325
•
“Install Process Engine (HP-UX)” on page 337
•
“Install Process Engine (Solaris)” on page 311
•
“Verify that Microsoft SQL Server Is Installed for IBM FileNet P8” on page 101
•
“Verify that Oracle Server Is Installed for IBM FileNet P8” on page 106
•
“Verify that DB2 Server Is Installed for IBM FileNet P8” on page 114
•
“Configure Process Task Manager” on page 352
In “Process Engine SQL Scripts” on page 671:
•
Called out SQL scripts needed on upgrades versus installations.
•
Added procedures to edit SQL scripts to change default passwords for f_sw
and f_maint users.
•
Added steps to manually execute upgrade scripts.
•
Noted that there are no upgrade scripts for SQL Server databases.
In “Upgrade Process Engine (Windows)” on page 556, removed requirement to
change fnsw password to the default before an upgrade.
05/08
Corrected executable name to run Process Engine Setup on Windows in “Install
Process Engine (Windows)” on page 294.
03/08
In “Installation Planning Considerations” on page 26, added a statement in the
“Database Considerations” subtopic about the effect of a database upgrade on
the application server.
Corrected the caution note in step 2 of the “To specify the WebSphere
environment variables” procedure in “Configure an Application Server for Content
Engine (WebSphere)” on page 134.
Fixed errors in procedure for encrypting LDAP password in “Configure an
Application Server for Content Engine (JBoss)” on page 146.
Added a step to configure Autonomy K2 Dashboard to use SSL in “To configure
Autonomy K2 for Content-Based Retrieval” on page 180.
Date
Revision
In “Install and Deploy Content Engine” on page 187:
•
•
Revised descriptions of the following Content Engine Setup screens:
–
Choose Application Server
–
Review Installation Summary
–
Configure Java TM Database Connectivity (JDBC)
–
Specify Authentication Provider
–
Verify Installation
Clarified steps 2 and 3 in the “To enable the Log4j logging API (optional)”
procedure.
In “Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)”
on page 281, made the following revisions:
•
Fixed XML syntax errors.
•
Fixed errors in step 1 in the following procedures:
•
–
"To configure JBoss 4.0.x database connectivity (MS SQL Server)"
–
"To configure JBoss 4.0.x database connectivity (DB2)"
Clarified step 2 in the “To encrypt data source passwords” procedure.
In “Configure Application Engine (JBoss)” on page 396, added quotation marks to
the "%JAVA%" %JAVA_OPTS% command example for Windows to
accommodate the word spacing in the “Program Files” directory.
Corrected batch file names for creating EAR and WAR files in “Deploy Application
Engine (WebLogic)” on page 409.
Removed requirement that an Oracle upgrade can occur only after upgrading
IBM FileNet P8 components in “Upgrade Planning Considerations” on page 478.
In “Upgrade Planning Considerations” on page 478, added a statement in the
“Database Considerations” subtopic about the effect of a database upgrade on
the application server.
In “Upgrade Content Engine Data” on page 523, removed step 3 from the “To create
the XML upgrade status file" procedure, as it duplicates steps 2 through 5 of the
"To check Upgrader Tool prerequisites" procedure.
Clarified the Application Engine install-path location for an upgrade in “Upgrade
Application Engine” on page 577.
12/07
Clarified configuration requirements for supported Java TM 2 Enterprise Edition
(J2EE) application servers in “J2EE Application Server Considerations” on page 32.
11/07
Updated links to online documentation for the new IBM FileNet FTP site.
Date
Revision
09/07
Added notes and topics throughout the guide for new support of JBoss
application servers for Content Engine, Application Engine and FileNet P8
documentation servers. For example, added or updated the following topics:
•
“Install IBM FileNet P8 Platform Documentation (JBoss)” on page 169
•
“Upgrade IBM FileNet P8 Documentation” on page 496
•
“Configure an Application Server for Content Engine (JBoss)” on page 146
•
“Configure an Application Server for Application Engine (JBoss)” on page 154
•
“Configure Application Engine (JBoss)” on page 396
•
“Deploy Application Engine (JBoss)” on page 412
Added notes and topics throughout the guide for new support of Microsoft®
Active Directory Application Mode (ADAM) directory service.
Added notes throughout the guide for new support of Microsoft SQL Server 2005
databases.
Added notes throughout the guide for new support of Oracle 10g.
Added information in “Install Process Engine (HP-UX)” on page 337 and “Install
Process Engine (Solaris)” on page 311 to support DB2® databases.
Added notes throughout the guide for new support of IBM® WebSphere® 6.1
application servers for Content Engine and Application Engine.
Modified the topic “Create Additional File Storage Areas” on page 446, including its
title, to change the focus to the second and all subsequent file storage areas.
Modified the title and approach of the topic “Deploy Multiple Content Engine
Instances” on page 454. It now clarifies that each Content Engine instance needs
its own application server configuration.
Added new topic “Complete Post-Upgrade Content Engine Configuration” on
page 538 to cover final steps required for upgrading and recreating Content
Engine data, including content search collections.
Made numerous changes to instructions related to upgrading Content Search
Engine. For example, see the new “Complete Content Search Engine Upgrade
and Create Collections” procedure in the topic “Complete Post-Upgrade Content
Engine Configuration” on page 538.
Applied significant updates and improvements to the Application Engine
installation, configuration, and upgrade topics.
In the topic “Complete Post-Upgrade Process Engine Configuration” on page 563,
removed steps to clean up database views. Process Engine post-upgrade steps
generally simplified and the process made more user friendly.
Date
Revision
Removed the silent installation and upgrade sample response files from the
guide and renamed the associated appendix topic to be “Encrypt Passwords for
Silent Installations and Upgrades” on page 666. This was done because the actual
sample response files are included with the software distributions.
06/07
Replaced sections “Installation Roadmaps” and “Upgrade Roadmaps” with
multiple topics to clarify process for installation, upgrade, and software updates.
Added silent install and uninstall information to the topics “Install Application
Integration” on page 447 and “Install File Tracker” on page 451.
In the “Security Considerations” section of the topic “Upgrade Planning
Considerations” on page 478, added a section describing the upgrade of 3.5.x
authentication parameters.
In the “Security Considerations” section of the topic “Upgrade Planning
Considerations” on page 478, added information about reconciling the Process
Engine user security information.
Date
Revision
03/07
Numerous topics added or updated to cover new IBM DB2 database
certification:
•
“Installation Planning Considerations” on page 26
•
“Sample Configurations” on page 34
•
“Installation Checklists” on page 39
•
“Specify IBM FileNet P8 Accounts” on page 72
•
“Verify that DB2 Server Is Installed for IBM FileNet P8” on page 114
•
“Verify that DB2 Client Is Installed for IBM FileNet P8” on page 127
•
“Install Process Engine (Windows)” on page 294
•
“Install Process Engine (AIX)” on page 325
•
“Configure Process Task Manager” on page 352
•
“Upgrade Process Engine (UNIX)” on page 550
•
“Upgrade Process Engine (Windows)” on page 556
•
“Complete Post-Upgrade Process Engine Configuration” on page 563
•
“IBM FileNet P8 Database Character Sets” on page 681
•
“IBM FileNet P8 Port Numbers” on page 667
In “Specify IBM FileNet P8 Accounts” on page 72, added links to the topics where
specific users or groups are referenced, and added information about whether
the user or group is different from 3.5.x.
Added installation and upgrade planning topics “Installation Roadmaps” and
“Upgrade Roadmaps”.
In the topic “Verify that Microsoft SQL Server Is Installed for IBM FileNet P8” on
page 101, changed a reference to direct users to the FileNet P8 Hardware and
Software Requirements document for the JDBC version information, replacing a
link to a Microsoft website.
Date
Revision
The topic “Create an Object Store and Verify the Content Engine Installation”
has been split into the following topics:
•
“Configure Content Engine Application Server Database Connectivity (WebSphere
5.1.x)” on page 227
•
“Configure Content Engine Application Server Database Connectivity (WebSphere
6.0.x)” on page 240
•
“Configure Content Engine Application Server Database Connectivity (WebLogic
8.1.x)” on page 270
•
“Configure Content Engine Application Server Database Connectivity (WebLogic
9.2.x)” on page 275
•
“Create Object Stores” on page 286
•
“Verify the Content Engine Installation” on page 291
In the topic “Complete Post-Install Process Engine Configuration (Windows Only)” on
page 354, added a step to restart Process Engine after creating a new key in the
registry.
In the topics “Upgrade Process Engine (UNIX)” on page 550 and “Upgrade Process
Engine (Windows)” on page 556, added a note to install the 4.0.1 Service Pack
before proceeding to post-upgrade steps.
In the topic “Upgrade Process Engine (UNIX)” on page 550, added information on
editing the ims_start file if on HP with memory greater than 2GB.
In the topic “Complete Post-Upgrade Process Engine Configuration” on page 563,
added information on view cleanup, a step that is only necessary if stopping at
the FCS release. There is no need to drop and recreate database views if
proceeding straight to the GA release.
12/06
Initial release of the FileNet P8 Platform 4.0.0 Installation and Upgrade Guide.
Table of Contents
Table of Contents
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Revision Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
About this Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs. . . . . . . . . 23
Installation Planning and Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Plan the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Installation Planning Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Requirements for all IBM FileNet P8 Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
All platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
J2EE Application Server Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Baseline Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Baseline Configuration With Optional Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Developer Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Demo Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation Checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IT Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
P8 Platform Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Environment Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
26
26
27
29
29
29
30
31
32
34
35
36
37
38
39
39
39
39
39
40
40
40
40
41
42
42
44
46
46
47
48
48
48
13
Table of Contents
Prerequisite Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Task 1: Configure Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Task 2a: Configure UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configure UNIX for FileNet P8 Servers (All Components) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configure Content Engine Servers (All UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configure Autonomy K2 Master Administration Servers (HP-UX) . . . . . . . . . . . . . . . . . . . . . . . . 53
Configure Process Engine Servers (All UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Configure Process Engine Servers (AIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configure Process Engine Servers (HP-UX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Configure Process Engine Servers (Solaris) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Configure Application Engine Servers (Linux) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Task 2b: Configure Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Content Engine and Enterprise Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Content Engine authenticating with Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Process Engine on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Task 3a: Configure Windows Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Task 3b: Configure Active Directory Application Mode (ADAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Task 3c: Configure Sun Java System Directory Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Configure Sun Java System Directory Server (v 5.1 SP2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Configure Sun Java System Directory Server (v 5.2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Task 3d: Configure Novell eDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Task 3e: Configure IBM Tivoli Directory Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Task 4: Specify IBM FileNet P8 Accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Accounts for Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Accounts for Process Engine (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Accounts for Process Engine (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Accounts for Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Accounts for Content Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Task 5: Prepare Storage Areas for Object Stores. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Configure File Servers for File Storage Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Remote File Access Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Configure the Remote Access Protocol on the Client Machine . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Task 6a: Verify that Microsoft SQL Server Is Installed for IBM FileNet P8 . . . . . . . . . . . . . . . . . . . . 101
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8 . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Task 7a: Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8 . . . . . . . . . . . . . . . 121
Task 7b: Verify that Oracle Client Is Installed for IBM FileNet P8. . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Task 7c: Verify that DB2 Client Is Installed for IBM FileNet P8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Task 7d: Verify the Ability to Connect to the Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
To Verify the Process Engine Database Connection (Oracle) . . . . . . . . . . . . . . . . . . . . . . . . . . 131
To Verify the Process Engine Database Connection (DB2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
To Verify the Process Engine Database Connection (SQL Server) . . . . . . . . . . . . . . . . . . . . . . 133
Task 8a: Configure an Application Server for Content Engine (WebSphere) . . . . . . . . . . . . . . . . . . 134
Task 8b: Configure an Application Server for Content Engine (WebLogic) . . . . . . . . . . . . . . . . . . . 138
Configure WebLogic 8.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Configure WebLogic 9.2.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Install JDBC drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Adjust transaction timeout value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
14
Table of Contents
Task 8c: Configure an Application Server for Content Engine (JBoss). . . . . . . . . . . . . . . . . . . . . . .
Manually Configure JBoss Data Sources for the GCD (Optional) . . . . . . . . . . . . . . . . . . . . . . .
Encrypt LDAP Password (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Encrypt GCD Data Source Passwords (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 9a: Configure an Application Server for Application Engine (WebSphere) . . . . . . . . . . . . . . .
Task 9b: Configure an Application Server for Application Engine (WebLogic) . . . . . . . . . . . . . . . . .
Task 9c: Configure an Application Server for Application Engine (JBoss) . . . . . . . . . . . . . . . . . . . .
146
147
149
150
151
152
154
Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Task 10a: Install IBM FileNet P8 Platform Documentation (WebSphere). . . . . . . . . . . . . . . . . . . . . 158
Overview of Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Install IBM FileNet P8 Platform Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Install Expansion Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Update Documentation Search Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Complete and Verify the Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic) . . . . . . . . . . . . . . . . . . . . . . 163
Overview of Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Install the IBM FileNet P8 Platform Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Install Expansion Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Update the Documentation Search Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Complete and Verify the Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Task 10c: Install IBM FileNet P8 Platform Documentation (JBoss) . . . . . . . . . . . . . . . . . . . . . . . . . 169
Overview of procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Install the IBM FileNet P8 Platform documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Install functional expansion documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Update the documentation search index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Complete and verify the documentation installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Task 11: Install and Configure Content Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Task 12: Install and Deploy Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Task 13: Install Content Engine Software Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Task 14: Install the Latest Process Engine Client Files on Content Engine Servers . . . . . . . . . . . . 205
Task 15: Redeploy Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Task 16: Complete Post-Install Content Engine Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Install Centera Shared Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Verify the Data Sources and Connection Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Verify That Content Engine Has Deployed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Enable Log4J Logging API (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Task 17: Install Enterprise Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD). . . . . . . . . . . . . . 221
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x) . .
227
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x) . .
240
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x) . .
254
Task 19d: Configure Content Engine Application Server Database Connectivity (WebLogic 8.1.x). 270
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x). 275
Task 19f: Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x) . . . . 281
Task 20: Create Object Stores. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
15
Table of Contents
Task 21: Verify the Content Engine Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 22: Install Content Search Engine Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 23a: Install Process Engine (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To Complete Additional Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 23b: Install Process Engine (Solaris) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 23c: Install Process Engine (AIX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 23d: Install Process Engine (HP-UX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 24: Install Process Engine Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 25: Install the Latest Content Engine Client Files on Process Engine Servers . . . . . . . . . . . .
Task 26: Configure Process Task Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 27: Complete Post-Install Process Engine Configuration (Windows Only) . . . . . . . . . . . . . . .
Task 28: Install Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 29a: Configure Application Engine (WebSphere). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 29b: Configure Application Engine (WebLogic) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 29c: Configure Application Engine (JBoss) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 30: Install Application Engine Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 31: Install the Latest Content Engine Client Files on Application Engine Servers . . . . . . . . . .
Task 32: Install the Latest Process Engine Client Files on Application Engine Servers . . . . . . . . . .
Task 33a: Deploy Application Engine (WebSphere) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 33b: Deploy Application Engine (WebLogic) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 33c: Deploy Application Engine (JBoss) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
291
293
294
307
311
325
337
350
351
352
354
357
369
388
396
398
399
400
403
409
412
Configuration/Startup Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Task 34: Configure Content Engine for Content-Based Retrieval. . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 35: Set Application Engine Bootstrap Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Bootstrap Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enhanced Timezone Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 36: Create a Process Engine Isolated Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 37: Create a Process Engine Connection Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 38: Configure the Process Engine Connection Point for Application Engine . . . . . . . . . . . . . .
Task 39: Set Up Content Engine and Client Transport SSL Security . . . . . . . . . . . . . . . . . . . . . . . .
Task 40: Set Up Application Engine SSL Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional procedure for WebSphere 5.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Java Applets in an SSL Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 41: Perform Additional Configuration Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
415
421
421
421
426
427
428
430
434
437
437
438
Optional Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Task 42: Install and Configure IBM FileNet Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 43: Enable the Process Engine Component Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 44: Install an Additional Instance of Enterprise Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 45: Create Additional File Storage Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 46: Install Application Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 47: Install File Tracker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 48: Deploy Multiple Content Engine Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 49: Deploy Content Engine to Other Application Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deploy Content Engine Into a Non-Managed Server Environment . . . . . . . . . . . . . . . . . . . . . .
Deploy Content Engine Into a Managed Server Environment . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 50: Deploy Multiple Application Engine Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 51: Install Additional Content Search Engine Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
441
442
445
446
447
451
454
455
455
457
461
464
16
Table of Contents
Task 52: Enable Application Engine to Use ISRA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ISRA SSL support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To install and deploy the Application Engine ISRA Servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To configure the Workplace site preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To set the ISRA Interface Servlet URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To log on to Image Services via LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To access IS library documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 53: Install and Configure IBM FileNet System Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 54: Install Software Updates for Optional Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
468
468
469
471
471
472
472
473
474
Upgrade Planning and Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Plan the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Upgrade Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrade Planning Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Requirements for all IBM FileNet P8 Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Functional Expansion Product Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
eForms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Records Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Third-party Software Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fixed Content Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operating System Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Server Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrade Checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IT Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Before the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrade Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Before the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Environment Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
477
478
478
479
479
479
480
480
480
480
481
481
482
484
484
484
485
485
485
487
487
487
487
488
488
489
489
489
490
490
491
491
491
491
491
492
17
Table of Contents
Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Application Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Upgrade Core Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Task 1: Upgrade IBM FileNet P8 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Refresh IBM FileNet P8 4.0.0 Documentation Without Uninstalling . . . . . . . . . . . . . . . . . . . . . .
Update IBM FileNet P8 4.0.0 Documentation by Uninstalling and Reinstalling . . . . . . . . . . . . .
Update Help Search Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deploy and Verify IBM FileNet P8 Documentation Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 2: Verify Current Release Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 3: Upgrade Content Engine Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 4: Install Content Engine Software Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 5: Install the Latest Process Engine Client Files on Content Engine Servers . . . . . . . . . . . . .
Task 6: Redeploy Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 7: Upgrade Content Engine Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphical User Interface to Upgrader Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Prepare Items for Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Perform the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Line Interface to Upgrader Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 8: Install Content Search Engine Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 9: Complete Post-Upgrade Content Engine Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . .
Check Completion Status of Asynchronous Upgrade Events . . . . . . . . . . . . . . . . . . . . . . . . . .
Create CodeModules Folders for Upgraded Object Stores . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Clear the Read-Only Attribute for NTFS File Storage Areas . . . . . . . . . . . . . . . . . . . . . . . . . . .
Move File Storage Areas from Windows to UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstall Version 3.5.x of Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Complete Content Search Engine Upgrade and Create Collections . . . . . . . . . . . . . . . . . . . . .
Task 10: Complete Pre-Upgrade Process Engine Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . .
To execute pre-upgrade steps for upgrades from PE 3.5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To execute pre-upgrade steps for upgrades from PE 4.0.x . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 11a: Upgrade Process Engine (UNIX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 11b: Upgrade Process Engine (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 12: Install Process Engine Software Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 13: Install the Latest Content Engine Client Files on Process Engine Servers . . . . . . . . . . . .
Task 14: Complete Post-Upgrade Process Engine Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .
Complete the Upgrade from Process Engine 3.5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Complete the Upgrade from Process Engine 4.0.0 or 4.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Complete the Upgrade from Process Engine 4.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 15: Upgrade Application Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 16: Complete Post-Upgrade Application Engine Configuration . . . . . . . . . . . . . . . . . . . . . . . .
496
496
497
499
502
503
504
505
515
516
519
523
525
528
531
532
537
538
538
539
539
539
540
541
542
542
547
550
556
561
562
563
563
575
576
577
583
Upgrade Add-On Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Task 17: Upgrade Enterprise Manager (Standalone) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 18: Upgrade Application Integration and File Tracker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrade considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 19: Upgrade IBM FileNet Publishing Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 20: Upgrade Custom Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
586
587
587
589
590
18
Table of Contents
Content Engine COM API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
New Content Engine 4.0 Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
COM API Object Types Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
New Content Engine 4.0 Properties on Supported Object Types . . . . . . . . . . . . . . . . . . . . 591
COM API Properties Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Content Engine 4.0 Methods Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Validation of Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Default Method Short-Cutting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
VB Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Property Side-effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Managed Client Applications Using Catclient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Error Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
OLEDB/ADO Data Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Microsoft IIS (Internet Information Services) WebDAV Provider . . . . . . . . . . . . . . . . . . . . . 596
Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Events and Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Auditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Document Lifecycles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Document Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Content Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
VersionSeries Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Addons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Exception When Attempting to Modify Root Folder Properties . . . . . . . . . . . . . . . . . . . . . . 602
Exception When Attempting to Update the List of PropertyDefinition Objects for a ClassDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
GUID Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Reusing Dependent Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Retrieving an ObjectStore's ClassDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Retrieving Realm Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Operating on Deleted Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Type Property on Domain Class Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
GCD Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
PropertyDescription DateTime Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Content Engine Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Classes Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Properties Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Events and Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Retrieving an ObjectStore's ClassDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
ObjectStore DatabaseType property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Content Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Creating an Addon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
IsPersistent Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Document Lifecycles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
19
Table of Contents
Document Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GUID Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Type Property on Domain Class Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GCD Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Java API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Removed from the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deprecated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Events and Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document Lifecycle and Classification Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Feature AddOns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ServerEnvironment Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MimeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VersionSeries Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PropertyDescription DateTime Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Java SecurityManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exception When Attempting to Modify Root Folder Properties . . . . . . . . . . . . . . . . . . . . . .
Retrieving an ObjectStore's ClassDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GCD Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Java API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Directory Services and Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Engine API Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web Application Toolkit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading Custom Applications to Web Application Toolkit Version 4.0 . . . . . . . . . . . . . .
Upgrading Custom Applications to Web Application Toolkit Version 3.x and Later . . . . . .
Upgrading Custom Applications to Access Workflows on a P8 System 4.0 . . . . . . . . . . . .
Obsolete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Workplace Application Integration Toolkit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Obsolete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 21: Upgrade Server-Side Scripts and COM Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Document Handler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log Event Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Send eMail Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 22: Upgrade ISRA Servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ISRA SSL Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Task 23: Install Service Packs for Add-On Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
610
611
611
611
612
612
612
613
614
614
617
619
621
622
622
622
622
623
623
623
623
623
623
624
625
625
625
626
626
628
628
628
629
630
632
632
634
634
637
639
641
641
646
Remove Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Remove the IBM FileNet P8 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove Content Search Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove Content Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove Process Engine (Windows). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
648
650
652
655
20
Table of Contents
Remove Process Engine (UNIX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove Application Engine (WebSphere) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove Application Engine (WebLogic). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove Application Engine (JBoss). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remove the Application Engine ISRA Servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
657
658
660
661
663
Appendixes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Encrypt Passwords for Silent Installations and Upgrades . . . . . . . . . . . . . . . . . . . . . . 666
IBM FileNet P8 Port Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Process Engine SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
SQL Scripts for SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SQL Scripts for Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changes Made by pe_filenet_site.sql and pe_ora_users_defaults.sql . . . . . . . . . . . . . . . . . . .
Changes Made by pe_create_stored_procedures.sql and pe_grant_sp_permissions.sql . . . . .
Use Cases for Running Scripts and Setting Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
671
672
673
674
677
IBM FileNet P8 Database Character Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
IBM FileNet P8 Database components character sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Additional Oracle character set information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Additional DB2 character set information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
New Content Engine Classes and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Content Engine Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Content Engine Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Installing Process Engine on Solaris 10 Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Types of zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resource pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fair Share Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create a sparse root zone for Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Install Process Engine on the sparse root zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
697
698
698
698
703
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
21
About this Document
About this Document
Installation by an IBM FileNet Certified Professional (FCP) recommended. For more information
on the FCP program, contact your IBM service representative.
Every effort has been made to provide you with complete installation instructions. If information
becomes available after the documentation release from which you accessed this guide, we will
provide an updated version of the guide on the Product Documentation for FileNet P8 Platform
support page. As a general rule, you should refer to the web site to obtain the current version of
this guide. See “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
A new version of the guide will be distributed as of the release of any core IBM FileNet P8
Platform component (Content Engine, Process Engine, or Application Engine). Component fix
packs are often released independently of one another and can also require updates of the guide.
Check the edition number applied to this common guide to determine the product versions
covered.
Send your comments by e-mail to comments@us.ibm.com. Be sure to include the name of the
product, the version number of the product, and the name and part number of the book (if
applicable). If you are commenting on specific text, include the location of the text (for example, a
chapter and section title, a table number, a page number, or a help topic title).
NOTES
•
This guide provides instructions for installing and/or upgrading the core IBM FileNet P8
Platform components to their current released version. Be aware that each release of an IBM
FileNet P8 component or expansion product can have multiple software updates available in
the form of service packs, fix packs, and/or interim fixes, each with potentially different
dependencies and installation requirements. Therefore, before you attempt to install or
upgrade IBM FileNet P8 Platform, review the list of releases and their associated
dependencies in the IBM FileNet Compatability Matrix on the Fix Packs for FileNet P8 Platform
support page. See “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on
page 23.
•
If you do not intend to upgrade all IBM FileNet P8 components and expansion products to the
most current released version, review the dependencies for the version(s) you intend to install.
These dependencies will be contained in a document and location on the IBM Customer
Service and Support web site for FileNet customers (equivalent to those noted in the previous
bullet).
•
This guide assumes that to perform your installations you are using the 4.0.0b update of the
generally released Content Engine software, which among other things adds support for
JBoss as an application server.
•
This guide contains links to the IBM FileNet P8 Platform online help system, where you will
find important additional information that can help you make decisions about your installation.
The ideal way to use this guide is as an online PDF installed within the help system. To take
advantage of these links while using this guide, perform the documentation install tasks
(Task 10a on page 158, Task 10b on page 163, or Task 10c on page 169) before beginning your full
IBM FileNet P8 Platform installation.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
22
Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs
To access documentation for IBM FileNet products
Access IBM FileNet Documentation,
Compatibility Matrices, and Fix Packs
To access documentation for IBM FileNet products
1. Access the Product Documentation for FileNet P8 Platform support page
(http://www-1.ibm.com/support/docview.wss?rs=3247&uid=swg27010422).
2. Select the appropriate product link.
To access compatibility matrices and fix packs for IBM FileNet products
1. Access the Fix Packs for FileNet P8 Platform support page
(http://www-1.ibm.com/support/docview.wss?&uid=swg27010146)
2. From the Fix Pack page:
•
To access the compatibility matrix, under FileNet P8 Compatibility Matrices, click Matrix.
•
To access the fix pack you need, under a specific product name, click the release number.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
23
Installation Planning and Procedures
Installation Planning and Procedures
This installation section contains the following major topics:
•
“Plan the Installation” on page 25
•
“Prerequisite Tasks” on page 50
•
“Installation Tasks” on page 156
•
“Configuration/Startup Tasks” on page 414
•
“Optional Installation Tasks” on page 440
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
24
Plan the Installation
Plan the Installation
Before you begin to install the IBM FileNet P8 Platform, do the following:
NOTE Although many of the bullet items below apply to upgrade as well as new installations, also
see “Plan the Upgrade” on page 476 for specific upgrade details.
•
Retrieve updates to IBM FileNet P8 documentation and software from the IBM Information
Management support page on www.ibm.com.
•
Review the “Installation Planning Considerations” on page 26 for a list of auxiliary documentation
you should gather and a list of tasks you should perform before installing IBM FileNet P8
Platform software.
•
Review the “Sample Configurations” on page 34.
•
Use the items in “Installation Checklists” on page 39 to track installation tasks and to record
information that will be needed in later tasks.
•
Become familiar with the tasks you will perform when setting up your IBM FileNet P8 Platform
software by reading the following:
–
“General Requirements for all IBM FileNet P8 Systems” on page 26
–
“Installation Tasks” on page 156
–
“Configuration/Startup Tasks” on page 414
–
“Optional Installation Tasks” on page 440
CAUTION Follow the planning, installation, and configuration tasks in the order presented in these
topics. If you do otherwise, or you install IBM FileNet P8 components on machines containing
components for existing IBM FileNet P8 systems, you may encounter unforeseen problems or be
required to perform additional setup steps. See the IBM FileNet P8 Platform Troubleshooting
Guide for details. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
25
Installation Planning Considerations
General Requirements for all IBM FileNet P8 Systems
Installation Planning Considerations
This section lists details that will help you prepare your environment for the installation of an IBM
FileNet P8 system. In many cases, the items you see listed will be links to more detailed
information that will help you plan a system rollout. Review this section thoroughly before you
start to set up IBM FileNet P8 components or required third-party software.
When you have completed the considerations in this section, see the “Installation Checklists” on
page 39 for a convenient way to track your progress and collect necessary information throughout
the prerequisite and installation stages.
General Requirements for all IBM FileNet P8 Systems
•
Gather auxiliary documentation.
NOTE To download this and other IBM FileNet product documentation from the IBM web site,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
–
IBM FileNet P8 Hardware and Software Requirements. This document provides details for
all IBM FileNet P8 system components, as well as the minimum supported levels of thirdparty software components. The information throughout the IBM FileNet P8 Platform
Installation and Upgrade Guide assumes you have met all applicable requirements listed
in that document.
–
IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet
P8 Security > Users and groups. This help topic provides a complete list of the user and
group roles, accounts, and responsibilities required to install, configure, and maintain an
IBM FileNet P8 system.
–
IBM FileNet P8 Release Notes. This document provides details on new features, known
issues, and resolved problems.
–
IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration >
Shutdown and Startup. This help topic describes how to shut down and restart IBM FileNet
P8 Platform components and some expansion products. Manual, command line, and some
sample batch file procedures are provided.
–
IBM FileNet P8 Platform Installing Non-English Environments Technical Notice. This
document will help you set up the product if your environment is not English-language
based.
–
IBM FileNet P8 Platform High Availability Technical Notice. This document provides details
on how to set up your IBM FileNet P8 system using clusters, farms, and other highavailability software and hardware.
–
IBM FileNet P8 Platform Planning and Deployment Guide. This document provides details
on how to deploy an IBM FileNet P8 system from a staging environment into a full
production environment.
–
IBM FileNet P8 Platform Troubleshooting Guide. This document provides troubleshooting
information on all aspects of the product.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
26
Installation Planning Considerations
Security Considerations
–
IBM FileNet P8 Platform Performance Tuning Guide. This document provides performance
tuning information on all aspects of the product.
–
IBM FileNet Rendition Engine Installation and Upgrade Guide. This document provides
details on how to install and upgrade Rendition Engine.
–
For all optional components, see the IBM FileNet P8 4.0.0 version of the appropriate
documentation, including:
•
IBM FileNet P8 Content Federation Services for Image Services Guidelines
•
IBM FileNet P8 Process Analyzer Installation and Upgrade Guide
•
IBM FileNet P8 Process Simulator Installation and Upgrade Guide
•
Determine your IBM FileNet P8 user application requirements. Install Application Engine if
you will be using Workplace or creating a custom user application. Alternatively, you can
install and use Workplace XT. If you plan to use Workplace XT, installing Application Engine is
not required.
•
Consider the Java™ requirements for the IBM FileNet P8 Documentation server. To
enable the help Search functionality, you must install the IBM FileNet P8 Documentation onto
a Java-enabled application server (for example, any Java TM 2 Enterprise Edition (J2EE) web
application server supported by Content Engine or Application Engine).
•
Use the latest IBM FileNet P8 base installation media. When installing Content Engine, Process
Engine, and Application Engine, you must use the latest base installation media.
Security Considerations
The security information in this section is provided to assist in the security planning process but is
not a complete description of any security feature or level of support. For complete information
about IBM FileNet P8 security, consult the Security Guide, IBM FileNet P8 help topic FileNet P8
Administration > Enterprise-wide Administration > FileNet P8 Security. The Security Guide sections that
are especially applicable to installation are Authentication, Directory Service Providers, and Users
and Groups.
•
Understand that authentication and authorization are separate processes. As of the IBM
FileNet P8 Platform 4.0.0 release, authentication (logon security) is separate from
authorization (object and process security). Thus, you must configure your Java TM
Authentication and Authorization Service (JAAS) login on the Content Engine application
server so that any user or group that can successfully authenticate to access (log on to) IBM
FileNet P8 resources can also be authorized to work within IBM FileNet P8 interfaces, using
Content Engine’s directory service provider's connection.
The Content Engine Setup program can capture configuration information to create your
application server authentication provider; or you can use an authentication provider that
already exists on the application server. Immediately following Content Engine installation,
you will be required to use Enterprise Manager to configure a directory service provider
(creating what is called a Directory Configuration).
•
Understand that logins are done through JAAS. IBM FileNet P8 leverages Java Authentication
and Authorization Service (JAAS) for authentication only, which is a process that occurs
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
27
Installation Planning Considerations
Security Considerations
between a J2EE client application, a J2EE application server, and one or more JAAS login
modules. This process does not involve any FileNet code.
NOTE IBM FileNet P8 Platform uses JAAS for authentication only, not for authorization on
stored objects, etc. Also, it does not support Java TM Security Manager.
•
Determine your single sign-on (SSO) requirements. Content Engine's ability to leverage JAASbased authentication means that if a single sign-on (SSO) provider writes a JAAS
LoginModule for a supported application server, then clients of FileNet P8 applications hosted
in that application server can leverage that SSO solution.
•
Determine Kerberos applicability. You can use Kerberos for SSO authentication between
FileNet Enterprise Manager and Content Engine, provided you use Windows Active Directory
as the directory server. See the IBM FileNet P8 help topic FileNet P8 Administration >Enterprisewide Administration > FileNet P8 Security > Authentication > Kerberos for Content Engine.
This guide does not provide specific instructions for installing or configuring your SSO
provider. For detailed reference information, see the IBM FileNet P8 help topic FileNet P8
Administration > Enterprise-wide Administration > FileNet P8 Security > Authentication.
•
Determine how many authentication realms you require. At least one authentication realm is
required, which you establish via your directory service or authentication provider and specify
during the procedure for creating an object store. For an explanation of how to create and
configure multiple realms, for example, multiple Windows domains, see the IBM FileNet P8
help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security > How to
> Configure for multiple realms.
•
Ensure that you have a directory service provider in place. Authorization in IBM FileNet P8
Platform is provided by one of the following supported directory servers:
–
Microsoft Windows Active Directory
–
Microsoft Active Directory Application Mode (ADAM)
–
Novell eDirectory
–
Sun Java System Directory Server
–
IBM Tivoli® Directory Server
This guide provides instructions for configuring the connections between Content Engine and
the directory server. You can find additional detailed reference information in the IBM FileNet
P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security >
Directory Service Providers.
•
Note that any WebLogic authentication provider should be dedicated to IBM FileNet P8. For
performance reasons, no authentication provider used by WebLogic for deployed IBM FileNet
P8 components should be shared with applications used for other purposes.
•
Understand the users and groups required for IBM FileNet P8. All general administrative users
and groups needing access to IBM FileNet P8-based applications must reside in one of the
supported directory servers. This guide provides instructions for creating the administrative
accounts required for installation and initial configuration. You can find additional detailed
reference information for all users, groups, and administrative roles in the IBM FileNet P8 help
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
28
Installation Planning Considerations
Database Considerations
topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security > Users and
groups.
•
Note that Process Engine delegates authentication to Content Engine. As of the IBM FileNet
P8 Platform 4.0.0 release, Process Engine no longer has a direct connection to a directory
server for authentication purposes, as it did in earlier releases. Instead, it delegates
authentication tasks to Content Engine. Content Engine, in turn, runs under a J2EE
application server, and relies on that server's JAAS-based facilities to authenticate users and
groups against the chosen directory server.
Database Considerations
All platforms
•
Determine your local vs. remote database engine preference. The database engine is
local if it is installed on a server where you will also be installing Content Engine, Process
Engine and/or Rendition Engine software. The database is remote if it is on a separate server
from the component using that database. The choice is yours with the exception of DB2,
which must be remote from Process Engine. An Oracle database must be remote if it is
installed on a Linux server.
•
Determine what type(s) of database engine you want to use. See the IBM FileNet P8 Hardware
and Software Requirements for support information related to IBM FileNet P8 components and
database engines. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
Determine your NLS and character-set requirements. See “IBM FileNet P8 Database
Character Sets” on page 681 for information.
•
Determine whether you will use Process Engine region recovery. Using the Process Engine
region recovery feature will have an impact on how you configure your database and configure
isolated regions. If you know you want to use the feature, configure the system accordingly
during installation. It is possible to configure regions for recovery after the initial installation,
but once a region has been initialized, a conversion is required to make the change.
Microsoft SQL Server
•
Determine whether you want to use a dedicated or shared database. In this regard:
–
Content Engine, Process Engine, and Rendition Engine can share a database engine, or
they can each have a dedicated (unique) database engine. The Process Analyzer
expansion product must have its own database engine.
–
Content Engine, Process Engine, and Rendition Engine components can each have a
dedicated SQL Server database instance, or they can share a database instance with one
another or with non-IBM FileNet applications. You can use the default instance or a named
instance of your choosing.
–
Content Engine, Process Engine, and Rendition Engine must each have their own
databases, even if they share a database engine.
–
Each Process Engine isolated region configured for recovery must have dedicated
filegroups.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
29
Installation Planning Considerations
Database Considerations
•
Be aware of database client software requirements. For Process Engine, if the database is
remote, you might need to install database client software on the Process Engine server. See
“Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8” on page 121 for details.
•
SQL Server scripts must be executed for Process Engine. A number of SQL scripts must
be executed that create a number of stored procedures. These stored procedures will then be
used to create database users and other stored procedures required for PE production.
These scripts can be executed manually, before starting Process Engine installation, or
executed from Process Engine setup. See “Process Engine SQL Scripts” on page 671 for
information on execution modes and associated security requirements as well as details about
the scripts.
Process Engine Setup will complete only if all these scripts run successfully.
•
Determine the maximum size of the content elements your users store. This affects setting up
database storage areas or file storage areas. When you create an object store, a database
storage area is provided by default, allowing you to store content as database BLObs. You can
also create one or more file storage areas to store content on local or remote file systems. If
your users store large individual documents or other content elements, and you create the
associated object stores on Microsoft SQL Server or IBM DB2 databases, use only file storage
areas. Otherwise, users can encounter memory-related errors when retrieving or indexing the
large content.
NOTE Controlled tests with limited concurrency exhibited errors when run with files that were
300 MB or larger. Factors affecting this file-size limitation include driver and application server
memory demands, other activity such as concurrent retrieval or indexing of large content, and
Java TM Virtual Machine (JVM) memory allocations.
Oracle
General
•
Oracle 9i support. Oracle 9i is nearing end-of-life and is thus supported only for upgrades from
IBM FileNet P8 3.5.x. If you are planning a new Oracle-based installation of IBM FileNet P8
4.0.x, use Oracle 10g.
•
Determine whether you want to use a dedicated or shared database. In this regard:
–
Content Engine, Process Engine, and Rendition Engine can share a database engine, or
they can each have a dedicated (unique) database engine.
–
Content Engine, Process Engine, and Rendition Engine can each have a dedicated Oracle
database instance, or they can share a database instance with one another or with nonIBM FileNet applications.
–
Content Engine, Process Engine, and Rendition Engine must each have their own
tablespaces, even if they share a database engine.
–
Each Process Engine isolated region configured for recovery must have dedicated
tablespaces.
NOTE For detailed information regarding installation of Rendition Engine, see IBM FileNet P8
guide FileNet P8 System Installation > Rendition Engine Installation and Upgrade.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
30
Installation Planning Considerations
Database Considerations
•
Plan to use locally managed tablespaces. For performance reasons, IBM recommends that you
create locally managed, rather than dictionary managed, tablespaces for Process Engine and
Content Engine. (The tablespaces you create via Oracle Database assistant (dbca) are locally
managed by default.)
•
Be aware of database client software requirements. For Process Engine, if the database is
remote, you must install database client software on the Process Engine server.
Process Engine
•
Process Engine does not support Oracle Password Complexity Verification during the
installation process. During installation this Oracle feature must be turned off if the Process
Engine run-time user (f_sw or alias) or maintenance user (f_maint or alias) will use default
passwords. After installation is complete and the passwords are changed, Oracle's password
complexity verification can be turned back on.
•
Oracle SQL scripts must be executed. A number of SQL scripts must be executed that:
–
Create Oracle database accounts for IBM FileNet PE use.
–
Create a number of stored procedures.
–
Grant access levels to the default tablespaces specified in Process Engine Setup.
These scripts can be executed manually, before starting Process Engine installation, or
executed from Process Engine setup. See “Process Engine SQL Scripts” on page 671 for
information on execution modes and associated security requirements as well as details about
the scripts.
Process Engine Setup will complete only if all these scripts run successfully.
DB2
•
DB2 server for Process Engine must be remote. The DB2 database server must be remote from
Process Engine. See the IBM FileNet P8 Hardware and Software Requirements for specifics on
supported operating systems. To download this guide from the IBM support page, see “Access
IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
DB2 server instances must be 64-bit on Unix, 32-bit on Windows. Instances created on a remote
Unix database server must be 64-bit. On Windows database servers, instances must be 32-bit.
•
DB2 client instances must be 32-bit. Instances created on the Process Engine server must be 32bit.
•
Determine whether you want to use a dedicated or shared database. In this regard:
–
Content Engine and Process Engine can share a database engine, or they can each have a
dedicated (i.e., unique) database engine.
–
Content Engine and Process Engine can each have a dedicated DB2 instance, or they can share
an instance with one another or with non-IBM FileNet applications.
–
Each Content Engine and Process Engine must have their own databases and tablespaces.
–
The Content Engine global configuration data (GCD) and each object store must have its own
database.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
31
Installation Planning Considerations
J2EE Application Server Considerations
–
Each Process Engine isolated region configured for recovery must have dedicated
tablespaces.
•
Plan to use Database Managed User(DMS) for tablespaces. For performance reasons, IBM
recommends that you create database managed user and user temp tablespaces rather than system
managed tablespaces for Process Engine and Content Engine.
•
Be aware of database client software requirements. For Process Engine on UNIX, if the remote
database server software is version 9, the DB2 client software on the Process Engine server must be
version 8.
•
Use DB2 default collation. For both Content Engine and Process Engine, use the default collation
setting.
•
IBM recommends SERVER authentication. SERVER_ENCRYPT and CLIENT authentication are
also supported.
•
Be aware of recommended pagesizes. IBM recommends 8 KB minimum pagesizes for Process
Engine databases and requires 32 KB minimum pagesizes for Content Engine databases.
•
Determine the maximum size of the content elements your users store. This affects setting up
database storage areas or file storage areas. When you create an object store, a database
storage area is provided by default, allowing you to store content as database BLObs. You can
also create one or more file storage areas to store content on local or remote file systems. If
your users store large individual documents or other content elements, and you create the
associated object stores on Microsoft SQL Server or IBM DB2 databases, use only file storage
areas. Otherwise, users can encounter memory-related errors when retrieving or indexing the
large content.
NOTE Controlled tests with limited concurrency exhibited errors when run with files that were
300 MB or larger. Factors affecting this file-size limitation include driver and application server
memory demands, other activity such as concurrent retrieval or indexing of large content, and
JVM memory allocations.
J2EE Application Server Considerations
Requirement for J2EE application servers. Content Engine and Application Engine are J2EE
application server-based applications. (Process Engine is not.) You must install Content Engine and
Application Engine in a homogeneous J2EE environment in which all of your application servers (IBM
WebSphere, BEA WebLogic, or JBoss) and their version numbers are identical for both components. Also,
the applications must use Enterprise JavaTM Bean (EJB) transport.
See the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet
P8 Security > Authentication for reference information about support for EJB and Web Services
transports.
The Java Virtual Machine determines the maximum number of object stores. If the application
server where Content Engine will be deployed is running on a 32-bit JVM, it is a best practive to
create no more than 75 Content Engine object stores. On a 64-bit JVM, it is a best practive to
create no more than 150 Content Engine object stores.
Deploying Content Engine and other applications on the same machine. Content Engine 4.0.x is a
resource-intensive enterprise application. Running Content Engine and other J2EE applications
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
32
Installation Planning Considerations
J2EE Application Server Considerations
on the same machine is possible but not a best practice. Other J2EE applications will compete
with Content Engine for the same CPU, memory, and disk I/O resources, and increase the
complexity of the installation and the risk of the deployment, as configurations will not match what
has been qualified by IBM FileNet Engineering.
Although you might need to host Content Engine and other applications on the same machine, it is
preferable to host Content Engine on its own machine or logical partition. If an architecture
requires Content Engine and a non-P8 J2EE application to be on the same machine, be sure to
thoroughly test the configuration in your integration environment before deploying them into
production.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
33
Sample Configurations
Sample Configurations
This topic shows you some simple examples of how to distribute FileNet P8 Platform components
across a variety of machines. Each example represents a minimum recommended configuration.
The configurations include the major IBM FileNet P8 Platform components, both those that are
core required components and those that are expansion product add-ons.
This topic includes the following sample configurations:
•
“Baseline Configuration” on page 35
•
“Baseline Configuration With Optional Components” on page 36
•
“Developer Configuration” on page 37
•
“Demo Configuration” on page 38
In all the sample configurations, note that:
•
None of the samples shows a database engine, but at least one is required. You can collocate
either Microsoft SQL Server or Oracle database engines with IBM FileNet P8 Platform
components on any of the servers shown, or you can install them on separate database
servers. A DB2 database engine must be remote from Process Engines. Likewise, an Oracle
database engine running on a Linux machine must be remote from all IBM FileNet P8
components.
•
None of the samples shows the required directory service provider.
•
You can scale out the components, but the following graphics do not attempt to show this.
•
If you choose to run Content Engine on a UNIX server, as of release 4.0.0 you will also need a
Windows administrative client for your Enterprise Manager installation.
•
To administer Application Engine, you can run IBM FileNet P8 Workplace clients either from
the computers shown or from one or more browser clients.
•
You can also run Workplace (or Workplace XT) as a user client to create and access stored
content and processes. Optionally, you can configure these clients to integrate with Microsoft
Outlook and Office applications, or to work in conjunction with expansion products, for
example, IBM FileNet P8 eForms, IBM FileNet P8 Portlets, or IBM FileNet Records Manager,
as they come available on a given release. You can also use WebDAV clients.
•
If you want to apply business rules to Process Designer workflows, you can install a rules
engine of your choice, such as ILOG JRules, which is not shown in the samples.
•
Optional components not shown in the samples include: IBM FileNet P8 Portlets and Image
Services Resource Adapter (ISRA). Check with your service representative for availability of
other expansion products.
•
You must set up Content Engine, Application Engine, and the P8 Platform Documentation on
application servers. You can collocate the documentation with Content Engine or Application
Engine, or deploy it on a dedicated server, as shown.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
34
Sample Configurations
Baseline Configuration
Baseline Configuration
This configuration shows a typical setup where basic process and content capabilities are
required. It includes only the core components, and not the other add-on components that are
shipped with the IBM FileNet P8 Platform as expansion products.
Figure 1: Baseline Configuration
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
35
Sample Configurations
Baseline Configuration With Optional Components
Baseline Configuration With Optional Components
This configuration is useful for environments that plan to use not only the core IBM FileNet P8
Platform components but also optional expansion product components.
Figure 2: Baseline Configuration With Optional Components
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
36
Sample Configurations
Developer Configuration
Developer Configuration
This configuration illustrates how a development team might set up an environment for building an
application that leverages the IBM FileNet P8 Platform.
Figure 3: Developer Configuration
NOTES
•
It is useful to share all services, with the exception of Image Services, among the development
workstations.
•
You can use terminal services to run the Enterprise Manager from developer workstations, or
install it directly on any Windows workstation.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
37
Sample Configurations
Demo Configuration
•
This configuration represents a single IBM FileNet P8 domain.
•
Refer to the IBM FileNet P8 Developer Help topic IBM FileNet P8 Documentation > Developer
Help > Developer Roadmap > Introduction for information on setting up your development
environment and installing the IBM FileNet P8 API toolkits.
Demo Configuration
This configuration supports demos, proof-of-concepts, and development on a single Windows
server.
Figure 4: Demo Configuration
NOTE
•
Avoid collocating IBM FileNet P8 components. See the IBM FileNet P8 Hardware and
Software Requirements guide for details. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
38
Installation Checklists
IT Administrator
Installation Checklists
The following topics provide checklists of items that must be completed for a successful
installation or upgrade of the IBM FileNet P8 Platform. The lists are divided by user or role. Note
that your organization may have different administrator roles, and that some of the responsibilities
of listed roles may vary.
You can print these lists and record the information as you perform the prerequisite and
installation tasks. Where applicable, the list items indicate which role will need the information you
provide. Coordinate communication among the various roles to facilitate an easier installation
process.
IT Administrator
This role administers hardware and operating systems for your environment, as well as helping to
make decisions about machine usage and configurations such as clustering and farming. The
information confirmed and collected in this set of checklists should be provided to the Installation
Administrator for each component.
P8 Platform Environment
ˆ Consult with the application server, database, and P8 administrators to determine port
requirements for all the servers in your install environment. For details, see “IBM FileNet P8
Port Numbers” on page 667.
Content Engine
ˆ Provide the host name of the application server machine and the directory where Content
Engine is to be installed:
Host name:
Directory:
ˆ (Windows installations only) Verify the version of Microsoft .NET Framework (2.0) and Web
Services Enhancements (WSE) (3.0). If these are the versions you plan to use, and they are
not installed, install them prior to the Content Engine installation.
Process Engine
ˆ Decide whether to perform a standalone installation, a farmed installation, or a clustered
installation.
Standalone
Clustered
Farmed
ˆ Determine a location for the following files that will be added to the machine during
installation.
NOTE In a clustered environment, you must place configuration and data files on a shared
drive.
Common files:
Program files:
Configuration and data files:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
39
Installation Checklists
Security Administrator
ˆ (All UNIX platforms) Save the following files for the fnsw (or alias) and root users. The Process
Engine installer will make modifications to them and you will be instructed to restore your
custom changes after installing Process Engine software.
.Xdefaults
.Xresources
.dbxinit
.dtprofile
.env
.login
.mwmrc
.profile
.cshrc
.xinitrc
Application Engine
ˆ (WebLogic) Determine the recommended MaxPermSize value for MEM_ARGS:
MaxPermSize:
For information refer to your application server vendor's recommendation for Initial and
Maximum heap size values. For IBM FileNet specific recommendations, see the IBM FileNet
P8 Platform Performance Tuning Guide. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Security Administrator
This role administers authentication, users and groups, passwords, encryption, and general
network access considerations for the installation and eventual use of the P8 Platform software.
The information confirmed and collected in the following checklist items should be provided to the
Installation Administrator for each component, as well as to the P8 administrators (for example,
the GCD administrator).
User Accounts
ˆ Create necessary P8 Platform accounts.
The task “Specify IBM FileNet P8 Accounts” on page 72 provides details about the accounts that
are required to install and configure IBM FileNet P8 Platform, and directs you to the install or
upgrade tasks that require the accounts. The topic provides a worksheet format for recording
the accounts you create or specify so that you can have them to refer to throughout the install
or upgrade process.
Content Engine
ˆ Configure the directory service provider. See one of the following:
•
“Configure Windows Active Directory” on page 65
•
“Configure Active Directory Application Mode (ADAM)” on page 66
•
“Configure Sun Java System Directory Server” on page 67
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
40
Installation Checklists
Security Administrator
•
“Configure Novell eDirectory” on page 70
•
“Configure IBM Tivoli Directory Server” on page 71
ˆ Record the following information about the directory service (authentication) provider relative
to the application server.
For details on these parameters, see the IBM FileNet P8 help topic FileNet P8 Administration >
Enterprise-wide Administration > FileNet P8 Security > Directory Service Providers, and navigate to
the section about your directory service provider.
Host:
Port:
Distinguished name of user (DN)
that the app server will use to
connect to the authentication
provider:
User Base DN:
User Name Attribute:
User From Name Filter:
Group Base DN:
Group From Name Filter:
Static Group Name Attribute:
NOTE This information must also be available during the Application Engine install.
ˆ Designate a user account in the directory service to serve as WebSphere administrator:
WebSphere administrator:
ˆ (CE on WebSphere for Windows, using Windows Active Directory) Provide the name or IP
address of the domain controller:
Domain controller name or IP address:
Application Engine
ˆ Specify the users and groups to add to the Application Engine Administrators access role. For
details on this role, see “Specify IBM FileNet P8 Accounts” on page 72.
Users or groups
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
41
Installation Checklists
Database Administrator
ˆ Specify the users and groups who will be allowed to create subscriptions to add to the
PWDesigner access role.
NOTE These are not specifically required to complete an install, but required to create
subscriptions later in Workplace, and can also be added later:
Users or groups
ˆ For Single Sign On (SSO), specify the following:
SSO proxy host URL:
SSO proxy host server name:
HTTP port on the SSO proxy host:
HTTPS port on the SSO proxy host:
ˆ For SSL, specify the following:
SSL host name and port number:
Java Server HTTP port:
ˆ (WebLogic) If you are using container-managed authentication, configure a new password or
credential in the WebLogic interface. See “To configure Application Engine (WebLogic 8.1.x)” on
page 391 or “To configure Application Engine (WebLogic 9.2)” on page 393.
Database Administrator
This role oversees database creation and administration. The decisions, task confirmations, and
information gathered in the following checklist items should be provided to the Installation
Administrator for each component.
Content Engine
ˆ Set up the database servers for Content Engine. Refer to one of the following:
–
“Verify that Microsoft SQL Server Is Installed for IBM FileNet P8” on page 101
–
“Verify that Oracle Server Is Installed for IBM FileNet P8” on page 106
–
“Verify that DB2 Server Is Installed for IBM FileNet P8” on page 114
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
42
Installation Checklists
Database Administrator
ˆ For SQL, record the following information for the GCD and each object store:
JavaTM Database Connection (JDBC) connection pool
name (available from the application server
administrator):
Type of authentication (Windows or database engine):
Database name:
Database host name or IP address:
Database port:
Database user name:
Password:
(For details, see Task 4 on page 72.)
ˆ For Oracle, record the following information for the GCD and each object store:
JDBC connection pool name (available from the
application server administrator):
Net service name:
Database name:
Database host name or IP address:
Database port:
Tablespace user names for the GCD and each object store (See Task 4 on page 72.)
• Permanent tablespace:
• Temporary tablespace:
Password:
ˆ For DB2, record the following information for the GCD and each object store:
JDBC connection pool name (available from the
application server administrator):
Tablespace name:
Database host name or IP address:
Database port:
Database user name:
Password:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
(See Task 4 on page 72.)
43
Installation Checklists
Database Administrator
Process Engine
ˆ Set up the database server for Process Engine. Refer to one of the following:
•
“Verify that Microsoft SQL Server Is Installed for IBM FileNet P8” on page 101
•
“Verify that Oracle Server Is Installed for IBM FileNet P8” on page 106
•
“Verify that DB2 Server Is Installed for IBM FileNet P8” on page 114
ˆ If using a remote database, install the database client software for Process Engine. Refer to
one of the following:
•
“Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8” on page 121
•
“Verify that Oracle Client Is Installed for IBM FileNet P8” on page 124
•
“Verify that DB2 Client Is Installed for IBM FileNet P8” on page 127
ˆ Turn off Oracle password complexity before beginning the Process Engine install.
ˆ Is the database local or remote?
Local
Remote
ˆ (SQL) Specify the SQL sa password (needed to create the ODBC data source and to run SQL
scripts from PE Setup):
ˆ (SQL) For SQL, provide the following information
SQL ODBC data source name:
Database name:
Filegroup name:
SQL version:
ˆ Decide whether to run SQL scripts for a SQL Server or Oracle database before running the
Process Engine installer, from the installer and prompting the user for a password, or silently
using operating system authentication.
Before running
setup
Prompt for a password
from setup
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Silently, using
operating system
authentication
44
Installation Checklists
Database Administrator
ˆ If running SQL scripts manually for a SQL Server database before installing Process Engine,
collect the following information for inclusion in the scripts.
Parameter
Value
SQL Server database name for Process Engine
DSN (ODBC data source name)
runtime user
f_sw (default) or alias to be assigned in
Process setup
(See Task 4 on page 72.)
maintenance user
f_maint (default) or alias to be assigned
in Process setup
(See Task 4 on page 72.)
ˆ If running SQL scripts manually for an Oracle database before installing Process Engine,
collect the following information for inclusion in the scripts.
Parameter
Value
Oracle data tablespace name
Oracle index tablespace name
Oracle temporary tablespace name
runtime user
f_sw (default) or alias to be assigned in
Process setup
(See Task 4 on page 72.)
maintenance user
f_maint (default) or alias to be assigned in
Process setup
(See Task 4 on page 72.)
ˆ (Oracle Windows) For Oracle on Windows, provide the following information as applicable:
Oracle SYS password: (only if running
sql scripts from installer)
Oracle Home directory
• Remote:
• Local:
Global database name (remote):
Temporary tablespace name
• Remote:
• Local:
Data tablespace name
• Remote:
• Local:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
45
Installation Checklists
Installation Administrator
Index tablespace name (optional)
• Remote:
• Local:
Oracle SID (local):
Oracle version:
ˆ (Oracle UNIX) For Oracle on UNIX, provide the following information
Oracle SYS password: (only if running
sql scripts from installer)
Oracle Home directory
• Remote:
• Local:
Global database name (remote):
Temporary tablespace name
• Remote:
• Local:
Data tablespace name
• Remote:
• Local:
Index tablespace name (optional)
• Remote:
• Local:
Oracle SID (local):
Oracle user name
(See Task 4 on page 72.)
• Remote:
• Local:
Oracle DBA group
(See Task 4 on page 72.)
• Remote:
• Local:
Oracle version:
ˆ (DB2) For DB2, provide the following information
Database alias name:
Tablespace name:
Instance owner name (UNIX only):
f_sw (or alias) password:
f_maint (or alias) password
Installation Administrator
This role will actually perform installation tasks for your P8 Platform software. This role may also
perform initial configuration, setup, and startup tasks, and is typically filled by one or more
operating system administrators on the associated computers.
Environment Considerations
ˆ Install the IBM FileNet P8 documentation and record the URL, per:
–
Task 10a on page 158 (WebSphere)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
46
Installation Checklists
Installation Administrator
–
Task 10b on page 163 (WebLogic)
–
Task 10c on page 169 (JBoss)
Documentation Server URL:
Content Engine
ˆ Install WebLogic or WebSphere.
ˆ For WebSphere, record the following:
WebSphere installation:
WebSphere profile:
WebSphere cell:
Node (machine on which WebSphere is managed):
Server (name of WebSphere instance):
SOAP port:
HTTP port:
WebSphere administrator:
Password:
(See Task 4 on page 72.)
ˆ For WebLogic, record the following:
WebLogic domain:
WebLogic Root Directory:
WebLogic Configuration Tool Directory:
WebLogic Domains Directory:
Administration Server:
WebLogic Administrator:
Password:
(See Task 4 on page 72.)
ˆ Configure the application server for Content Engine. See “Configure an Application Server for
Content Engine (WebSphere)” on page 134 and “Configure an Application Server for Content Engine
(WebLogic)” on page 138.
ˆ Install and deploy the Content Engine software. See “Install and Deploy Content Engine” on
page 187. You will also create a P8 domain as part of that task.
ˆ Set up an object store and test the Content Engine installation. See “Create Object Stores” on
page 286 and “Verify the Content Engine Installation” on page 291.
ˆ After installation, record the Content Engine client software URL (Content Engine server name
and port number), which will be entered during Process Engine and Application Engine setup:
Content Engine Client software URL:
ˆ After installing Content Engine, record the Content Engine server's name and Web Services
(WSI) port, which you will enter as part of the URL for the Component Manager during
Application Engine setup and Process Engine Task Manager configuration:
Content Engine Component Manager URL:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
47
Installation Checklists
Installation Administrator
ˆ After installation, record the Content Engine URLs (Content Engine server name and port
number) for downloading and uploading document content, which will be entered during
Application Engine setup:
Content Engine download URL:
Content Engine upload URL:
Content Search Engine
ˆ Install the Autonomy K2 Master Administration Server. See “Install and Configure Content Search
Engine” on page 174.
ˆ (Optional) Install additional K2 Administration Servers. See “Install Additional Content Search
Engine Servers” on page 464.
ˆ Configure Content Engine for content-based retrieval. See “Configure Content Engine for
Content-Based Retrieval” on page 415.
Process Engine
ˆ Before the Process Engine installation, determine the J2EE application server type
(WebLogic, WebSphere, or JBoss) and version used for the Content Engine installation:
Content Engine application server type:
Content Engine application server version:
ˆ Install Process Engine per the procedure for your platform:
–
“Install Process Engine (Windows)” on page 294
–
“Install Process Engine (Solaris)” on page 311
–
“Install Process Engine (AIX)” on page 325
–
“Install Process Engine (HP-UX)” on page 337
ˆ Configure Process Task Manager per Task 26 on page 352.
ˆ Complete post-install Process Engine configuration per Task 27 on page 354.
Application Engine
ˆ Verify that at least one Content Engine object store has been created. See “Create Object
Stores” on page 286.
ˆ Configure the application server for Application Engine, per Task 9a on page 151 for
WebSphere, Task 9b on page 152 for WebLogic, or Task 9c on page 154 for JBoss. Provide the
application server type and version (this must match the type and version used for Content
Engine):
Application Engine application server type:
Application Engine application server version:
ˆ Decide on an application name; Workplace is the default (relevant for custom applications):
Application name:
ˆ Install Application Engine. See “Install Application Engine” on page 357.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
48
Installation Checklists
Installation Administrator
ˆ Set up Application Engine per the procedure for your platform:
–
“Configure Application Engine (WebSphere)” on page 369
–
“Configure Application Engine (WebLogic)” on page 388
–
“Configure Application Engine (JBoss)” on page 396
ˆ Gather information to provide to bootstrap preferences which will be required on first login to
Workplace, per “Bootstrap Preferences” on page 421.
SSL Host Server Name
SSL port
Java Server HTTP port
Generate User Tokens?
Y/N
Accept User Tokens?
Y/N
Token Timeout Interval (1-15 minutes)
Object Store Location for Site Preferences file:
Documentation server URL
ISRA Interface Servlet URL
Banner Image:
Path to file
Image width
Application Integration Settings - Prompt to add Y/N
email?
Users or groups to add to Application Engine
Administrators group?
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Image Height
49
Prerequisite Tasks
To configure the network and operating system
Prerequisite Tasks
Tasks in this section describe how to prepare your system for installing IBM FileNet P8. Do not
start installation tasks until you complete all relevant prerequisite tasks.
Tasks to be performed by the Network and Operating System Administrator
To configure the network and operating system
1. Configure the network. Do Task 1 on page 52.
2. Configure your operating system. Do one of the following:
•
Task 2a on page 53 (UNIX)
•
Task 2b on page 64 (Windows)
Tasks to be performed by the Security Administrator
To configure the security environment
1. Configure your directory server. Do one of the following:
•
Task 3a on page 65 (Active Directory)
•
Task 3b on page 66 (Active Directory Application Mode - ADAM)
•
Task 3c on page 67 (Sun Java System Directory Server)
•
Task 3d on page 70 (Novell eDirectory)
•
Task 3e on page 71 (Tivoli Directory Server)
2. Create IBM FileNet P8 Platform groups and users. Do Task 4 on page 72.
3. Prepare storage areas. Do Task 5 on page 95.
Tasks to be performed by the Database Administrator
To prepare the databases
1. Configure your database server.
a. For Content Engine, do one of the following:
•
Task 6a on page 101 (Microsoft SQL Server)
•
Task 6b on page 106 (Oracle)
•
Task 6c on page 114 (DB2)
b. For Process Engine, do one of the following:
•
Task 6a on page 101 (Microsoft SQL Server)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
50
Prerequisite Tasks
To configure the application servers
•
Task 6b on page 106 (Oracle)
•
Task 6c on page 114 (DB2)
2. Configure database client software on any computer that needs to access the Process Engine
database engine directly. Do one of the following:
•
Task 7a on page 121 (Microsoft SQL Server)
•
Task 7b on page 124 (Oracle)
•
Task 7c on page 127 (DB2)
3. Verify database client connection for Process Engine. Do Task 7d on page 131.
Tasks to be performed by the Application Server Administrator
To configure the application servers
1. Configure your application server for Content Engine. Do one of the following:
•
Task 8a on page 134 (WebSphere)
•
Task 8b on page 138 (WebLogic)
•
Task 8c on page 146 (JBoss)
2. Configure your application server for Application Engine. Do one of the following:
•
Task 9a on page 151 (WebSphere)
•
Task 9b on page 152 (WebLogic)
•
Task 9c on page 154 (JBoss)
Tasks to be performed by the Email Administrator
•
Create an email account that will be used to configure the Notification Tab of the Process Task
Manager so that Process Engine can send email notifications to end users. (Do this step only
if you use this feature.) Required information includes:
–
Email Account Name
–
Email Account Password
–
Name of the email server
–
Port for the email server (almost always 25).
For more information, refer to FileNet P8 Administration > Process Engine Administration >
Workflow administration tasks > Coordinating workflow design > Email notification.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
51
Task 1: Configure Network
To configure the network
Task 1: Configure Network
The requirements in this task apply to the network where you will install FileNet P8 servers.
To configure the network
You can perform the following in any order.
1. Assign all IBM FileNet P8 servers a static IP address.
2. Ensure TCP/IP settings. Verify TCP/IP configuration settings on all UNIX and Windows servers
and Enterprise Manager clients intended for FileNet P8 so that they can all communicate with
one another.
3. Ensure availability of required port numbers. Several port numbers are required by the various
IBM FileNet P8 components. See “IBM FileNet P8 Port Numbers” on page 667.
4. For information about proxy/firewall configuration requirements, see the IBM FileNet P8
Hardware and Software Requirements guide for support information related to IBM FileNet P8
components and database engines. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
To configure time and date
1. Synchronize the time and date on all servers. System users will experience a variety of
problems if one or more servers are not synchronized with the rest of the system.
The Process Engine database server (the machine that hosts the database used by Process
Engine) is considered the master time keeper; the UTC time of that machine is considered the
correct time. The server hosting the Process Engine API and the server hosting Content
Engine must have the UTC time set.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
52
Task 2a: Configure UNIX
Configure UNIX for FileNet P8 Servers (All Components)
Task 2a: Configure UNIX
The topics in this task describe how to configure UNIX on the servers where you will install the
FileNet P8 system.
Configure UNIX for FileNet P8 Servers (All Components)
To configure UNIX FileNet P8 servers
1. Ensure host file contents on each UNIX-based IBM FileNet P8 server that does not include
Domain Name Service (DNS) or Network Information Service (NIS). The /etc/hosts file must
contain the name and Internet Protocol (IP) address of all servers it will communicate with,
including the remote database server, if applicable.
Configure Content Engine Servers (All UNIX)
To configure UNIX FileNet Content Engine servers
1. On the UNIX-based application servers that will host Content Engine Server software, run the
umask UNIX utility program as shown below to set the the default file-creation permissions
mask for the JVM instance that will host Content Engine Server so that the owner (the user
running JVM) and the members of the owner's group have read/write/execute access
permissions, and all others have no access.
Also, run umask to set the same permissions for any other UNIX user who will be reading or
writing to files or directories created by the Content Engine server, including users who run
Content Engine Setup and users doing CBR indexing on the Verity server.
Specify the mask in the umask command using octal notation (for example, 007) or symbolic
notation, as shown in the command below, depending on your UNIX platform:
umask u=rwx,g=rwx,o=
This umask setting ensures that the access permissions on files and directories created by
Content Engine Server are identical to those you will need to specify when creating file
storage areas on UNIX file servers.
To make this umask setting the default for the users that require read/write access to the
Content Engine files and directories, it should be specified in the .profile or .cshrc file
(depending on the user's shell environment) in each user’s $HOME directory or in a systemwide file (such as /etc/profile) that is used as the default for all users on that UNIX server.
Configure Autonomy K2 Master Administration Servers (HP-UX)
To configure HP-UX for Content Search Engine
1. To install Content Search Engine on HP-UX, manually configure the kernel with following
parameters before you begin the Autonomy K2 Master Administration Server installation.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
53
Task 2a: Configure UNIX
Configure Process Engine Servers (All UNIX)
Value
Setting
maxdsiz
1.9 Gbytes (0x7B033000)
maxfiles
2048 Kbytes
maxfiles_lim
2048 Kbytes
maxssiz
160 Mbytes (0xA000000)
max_thread_proc
1024
maxswapchunks
8192
maxtsiz
1 Gbyte (0x40000000)
maxuprc
512
maxusers
128
nkthread
1024
nproc
517
Configure Process Engine Servers (All UNIX)
To configure UNIX FileNet PE servers
You can perform the following in any order.
1. Ensure minimum /tmp size. The /tmp directory must have 510 MB free.
2. Save the following files for the root user:
.cshrc
.Xdefaults
.Xresources
.dbxinit
.dtprofile
.env
.login
.mwmrc
.xinitrc
.profile
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
54
Task 2a: Configure UNIX
Configure Process Engine Servers (AIX)
3. Process Engine requires the presence of several partitions. Before installing Process Engine
verify that your Operating System is set up with a correctly configured volume manager. You can
use the volume manager provided with the operating systems or an equivalent Veritas volume
manager.
NOTE Solaris volume management software might use port 32776 by default. This is the
default for the Process Engine Communication Port (IOR port).
Volume Name
Mount Point
Minimum
Size
User
Group
Mode
fnsw
/fnsw
1200MB
fnsw
fnusr
775
250MB
fnsw
fnusr
775
64MB
fnsw
fnusr
664
64MB
fnsw
fnusr
664
file system
local
/fnsw/local
file system
fn_sec_db0 (raw)
n/a
logical volume
fn_sec_rl0 (raw)
n/a
logical volume
Configure Process Engine Servers (AIX)
To configure AIX-based FileNet PE servers
Perform the following in any order:
1. Set the Kernel to 64-bit mode.
2. Set the swap space to 1.5 - 2 times RAM.
3. Set the Maximum Number of Processes allowed per user to at least 400.
4. Set the Maximum Kbytes of real memory allowed for MBUFS to 0. Setting the MBUFS parameter
to 0 causes the system to use the default amount of available memory. This default amount is
approximately 1/8 to 1/4 the amount of real memory.
5. Set the Maximum Number of FIXED licenses (Num) to a minimum of 16.
6. Install and commit the following file sets:
–
bos.adt.libm
–
bos.adt.lib
–
bos.adt.base
–
bos.perf.perfstat
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
55
Task 2a: Configure UNIX
To modify /etc/rc.dt and /etc/tunables/nextboot for AIX 5.3 and 6.1.
–
bos.perf.libperfstat
–
bos.adt.debug
7. Review and change the time zone parameters if necessary. In SMIT, choose System
Environments > Change/Show Date and Time > Change Time Zone Using System Defined
Values. Choose the Daylight Savings Time option if applicable. At the CUT Time Zone menu,
choose the option associated with your site. For example, in California, the time zone needs to
be set to the Pacific time zone (PST8PDT) Pacific U.S.; Yukon (cut -8).
To modify /etc/rc.dt and /etc/tunables/nextboot for AIX 5.3 and 6.1.
1. As the root user, execute the following commands or set them by editing the /etc/tunables/
nextboot:
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
-p
-p
-p
-p
-p
-p
-p
-p
-o
-o
-o
-o
-o
-o
-o
-o
tcp_sendspace=16384
tcp_recvspace=16384
tcp_keepidle=80
tcp_keepintvl=20
tcp_ephemeral_high=65535
tcp_ephemeral_low=42767
udp_ephemeral_high=65535
udp_ephemeral_low=42767
2. Add the following statements at the beginning for /etc/rc.dt file:
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
/usr/sbin/no
-o
-o
-o
-o
-o
-o
-o
-o
tcp_sendspace=16384
tcp_recvspace=16384
tcp_keepidle=80
tcp_keepintvl=20
tcp_ephemeral_high=65535
tcp_ephemeral_low=42767
udp_ephemeral_high=65535
udp_ephemeral_low=42767
3. Restart the server (shutdown -Fr) for these settings to take effect. Executing the commands at
the command line is not sufficient. The changes must be generated via the "nextboot" to avoid
bind failures.
4. Check the values by executing the following commands:
no -a | grep ephemeral
and
no -a | grep tcp
To correct a required link in AIX 6.1
AIX 6.1 installs the file /usr/lib/libMrm.a in a directory that is different from the one required by the
IS 4.1.0 mini-installer. As a result, the Process Engine installation will fail when running lic_admin.
To prevent this failure, use the following workaround after you install AIX 6.1, but before you install
IS4.1.0:
1. Log in as a user with root privileges.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
56
Task 2a: Configure UNIX
To install a required Oracle patch for AIX 6.1
2. Remove any "filenet-*" entries in the \etc\services file.
3. Download and install either SP3 or APAR: IZ13179 on AIX 6.1.
4. Enter the following command:
ln -s /usr/lpp/x11/lib/R1/libMrm.a /usr/lib/libMrm.a
To install a required Oracle patch for AIX 6.1
AIX 6.1 requires the Oracle 10gR2 6613550 patch to fix a problem with rootpre.sh.
1. Download patch number 6613550 from the Oracle support web site.
2. As a user with root privileges, run the script.
3. As Oracle user, launch the Oracle Universal Installer (runInstaller).
Configure Process Engine Servers (HP-UX)
The following operating system prerequisites apply to HP-UX-based FileNet Process Engine
servers.
To configure HP-UX servers for Process Engine
Perform the following in any order:
1. On each HP-UX 11 or HP-UX 11i machine where you will install a JVM-based IBM FileNet P8
component (such as Content Engine), or where an associated third-party JVM-based
component (such as WebLogic or WebSphere) will run, increase the values of the kernel
parameters max_thread_proc (maximum number of threads per process) and nkthread
(maximum number of kernel threads in the system) beyond their default values, which are too
small for IBM FileNet P8 applications.
Refer to the HP web page "Programmer's guide for Java 2 HP-UX configuration for Java
support" for tools to determine values of these two kernel parameters that are sufficient for
IBM FileNet P8.
2. The physical memory must be at least 512 MB.
3. The Kernel must be set to 64-bit mode.
4. The swap space must be set as follows:
–
2 times RAM if RAM < 1GB
–
1.5 times RAM if RAM between 1GB and 2GB
–
Equal to RAM if between 2GB and 8GB
–
.75 times RAM if > 8GB
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
57
Task 2a: Configure UNIX
To perform symbolic links for X11 libraries
To perform symbolic links for X11 libraries
1. Log on as the root user.
2. At the prompt, execute the following:
cd
ln
ln
ln
ln
ln
ln
ln
ln
ln
/usr/lib
-s /usr/lib/libX11.3 libX11.sl
-s /usr/lib/libXIE.2 libXIE.sl
-s /usr/lib/libXext.3 libXext.sl
-s /usr/lib/libXhp11.3 libXhp11.sl
-s /usr/lib/libXi.3 libXi.sl
-s /usr/lib/libXm.4 libXm.sl
-s /usr/lib/libXp.2 libXp.sl
-s /usr/lib/libXt.3 libXt.sl
-s /usr/lib/libXtst.2 libXtst.sl
To configure kernel parameters
1. Ensure that the following parameters are set to at least the values shown unless otherwise
noted. The values are appropriate for both HP PA-RISC and Integrity operating systems unless
noted otherwise. These values are sufficient to install and initialize the software but system
tuning will be required, specifically for the nfiles and maxfiles parameters.
Kernel Parameter
Minimum Setting
Minimum Setting
PA-RISC
Integrity V2 and V3
unless noted
otherwise
maxdsiz
0x10000000 or
268435456 (256MB)
0x10000000 or
268435456 (256MB)
maxfiles
512
1024
nproc
1005
1005
maxuprc
400
400
nfile
1024
2048
ninode
1085
1085
semmns
2000
2000
semmni
2000
2000
shmmax
0x10000000 or
268435456 (256MB)
0x20000000 or
536870912 (512MB)
shmseg
120
120
semmnu
1000
1000
semume
500
500
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
58
Task 2a: Configure UNIX
To check and optionally modify the timezone settings
Kernel Parameter
Minimum Setting
Minimum Setting
PA-RISC
Integrity V2 and V3
unless noted
otherwise
msgmni
2048
2048
msgseg
16384
16384 (obsolete in HP
11i V3)
msgtql
6640
6640
msgmap
msgtql + 2
msgtql + 2 (obsolete in
HP 11i V3
dbc_max_pct
1 to 10 (the value can
not be greater than 30)
1 to 30 ( the value can
not be greater than
30) (obsolete in HP
11i V3)
dbc_min_pct
5
5 (obsolete in HP 11i
V3)
timezone
Set appropriately
Set appropriately
msgmnb (DB2
only)
65535
65535
msgmax (DB2
only)
65535
65535
NOTE If you will be installing the 8.2 version of DB2 Client software, pay particular attention to
the shmmax parameter. The minimum value documented for Process Engine might not be high
enough to allow successful installation of the DB2 software. See the appropriate vendor
documentation for the 8.2 release for recommended kernel parameter settings.
To check and optionally modify the timezone settings
HP-UX has two timezone settings: the kernel parameter timezone and the environment variable
TZ. The value of both timezone settings must match. Review and, if necessary, change these
settings on all servers.
1. As the root user, enter:
sam
2. Select the Kernel Configuration option.
3. Select the Configurable Parameters option, then check the Pending Value for the timezone
parameter. The default value is 420 minutes west of Greenwich Mean Time (GMT), which is the
U.S. Mountain timezone.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
59
Task 2a: Configure UNIX
To check and optionally modify the timezone settings
Determine the number of minutes east or west of GMT for your location by multiplying the
number of hours east or west of GMT by 60 minutes per hour. For example, the U.S. Pacific
timezone is 8 hours west of GMT. Multiply 8 x 60 to get 480 minutes. If your timezone location
is east of GMT, you should use a negative number. For example, Middle European Time is one
hour east of GMT. Multiply -1 x 60 to get -60 minutes for MET (Middle European Time).
4. If the Pending Value for the timezone parameter is correct, proceed to step 6. To change the
value, continue with Step 5.
5. To change the timezone kernel parameter value:
a. Select the timezone parameter by pressing the spacebar and then press Tab to go to Actions
menu.
b. Select the Modify Configurable Parameter option from the Actions menu and press Return.
c. In the popup window that displays, the Specify New Formula/Value option should already be
selected.
d. Tab to the Formula/Value field and type the new value.
e. Tab to OK and press Return. When the popup window disappears, the new value appears in
the Pending Value column.
f.
Rebuild the kernel to make your change take effect:
i.
Press the F4 key to access the menu bar.
ii.
From the Action menu, select the Create a New Kernel option using the Arrow keys and
press Return.
iii. Answer Yes when prompted about creating the kernel now.
iv. On the next screen, make sure the Move Kernel into Place and Shutdown/Reboot the
System Now option is selected, tab to OK and press the Return key to reboot the system
and make the new changes take affect.
6. As the root user, enter the following to check the current value of the TZ environment variable:
echo $TZ
7. If the current setting is not correct, enter the following to set the correct timezone:
/sbin/set_parms timezone
Choose the appropriate timezone from the menus displayed. Remember that the value must
match that of the timezone kernel parameter.
If you change the current setting, you will be prompted to reboot the server.
NOTE If the HP-UX set_parms command is not available on your server, the timezone might
be set via the SAM interface using the Kernel Parameters option in the same manner that
other parameters are set. The System Administrator should consult the HP-UX operating
system documentation to determine the appropriate way to set the TZ environment variable.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
60
Task 2a: Configure UNIX
Configure Process Engine Servers (Solaris)
Configure Process Engine Servers (Solaris)
The operating system prerequisites in this subsection pertain to Solaris-based FileNet PE
servers.
To enable ports
When Solaris starts up, it takes the first several ports, called anon ports, to use for its
communication daemons. By default, the maximum tcp_smallest_anon_port is 32768. IBM FileNet
uses several ports higher than 32768. See “IBM FileNet P8 Port Numbers” on page 667 for details on
which ports IBM FileNet uses.
To use these ports on Solaris-based systems, you must first enable the ports by setting the
smallest anon port to 32778. By doing so, the ports used by Solaris communication daemons will
be 32778 or greater, leaving 32777 available for IBM FileNet use.
The Solaris platform provides several different tools, such as the netstat command, which you can
run to determine if a port is in use, as follows:
1. To determine the current tcp_smallest_anon_port setting, enter the following at the command
prompt:
ndd -get /dev/tcp tcp_smallest_anon_port
If the port is less than 32778, you must enable port 32777.
2. To enable port 32777 on Solaris 9, use a text editor to edit the /etc/rc2.d/S69inet file.
Enter the following line:
ndd -set /dev/tcp tcp_smallest_anon_port 32778
3. To enable port 32777 on Solaris 10, use a text editor to edit the /lib/svc/method/net-init file.
Enter the following line:
ndd -set /dev/tcp tcp_smallest_anon_port 32778
NOTE Put this entry in the file before the exit 0 entry at the bottom of the file.
4. Reboot the Process Engine server to force the release of ports required by Process Engine that
might be in use by the OS. Failure to reboot after these changes are made can result in port
32776 being unavailable, generating OpenSocket errors.
To verify national language character set and time settings
1. Because the default mask varies on UNIX depending on the LANG and LC_TIME environment
settings, verify the current LC_TIME settings by running the following command:
locale -k t_fmt
The result will appear similar to the following example:
t_fmt=%r
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
61
Task 2a: Configure UNIX
To increase the operating system kernel limits
NOTE If the default mask is currently set to “%r” for use with NLT as shown the example above,
reset the LC_TIME environment to C, and then run the locale -k t_fmt command again to
verify your change.
2. Modify the default shelf environment to use the C time format.
3. Change the /etc/profile file for the entire system or change .profile files for each user that runs
sh or ksh to include the following lines:
LC_TIME=C
export LC_TIME
4. Verify the current LANG settings by entering locale at the shell prompt. This example shows the
U.S. character set, ISO 8859-1. Be sure it is consistent with the database character set unless
your database character set is AL32UTF8 (Unicode).
LANG=en_US.ISO8859-1
LC_CTYPE=en_US.ISO8859-1
LC_NUMERIC=en_US.ISO8859-1
LC_TIME=en_US.ISO8859-1
LC_COLLATE=en_US.ISO8859-1
LC_MONETARY=en_US.ISO8859-1
LC_MESSAGES=en_US.ISO8859-1
LC_ALL=
To increase the operating system kernel limits
1. Make a copy of the system file (with a new name). Log on as root, and enter a command similar
to the following:
cp /etc/system /etc/system.save
2. Edit the /etc/system file, using your preferred editor (for example, vi):
vi /etc/system
3. Ensure that the following parameters are listed and are set to at least the values shown,
depending on your operating system version:
Solaris 9
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
semsys:seminfo_semmap=50
semsys:seminfo_semmni=2000
semsys:seminfo_semmns=2000
semsys:seminfo_semmnu=500
semsys:seminfo_semmsl=512
semsys:seminfo_semopm=256
semsys:seminfo_semume=500
semsys:seminfo_semvmx=32767
semsys:seminfo_semaem=16384
shmsys:shminfo_shmmax=4294967295*
shmsys:shminfo_shmmin=0
shmsys:shminfo_shmmni=2000
shmsys:shminfo_shmseg=100
msgsys:msginfo_msgmni=2048
max_nprocs=1000
fnsod:sod_Debug=0
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
62
Task 2a: Configure UNIX
Configure Application Engine Servers (Linux)
set rlim_fd_max=1024
set rlim_fd_cur=256
noexec_user_stack=1
Solaris 10
set semsys:seminfo_semmni=2000
set semsys:seminfo_semmsl=512
set semsys:seminfo_semopm=256
set shmsys:shminfo_shmmax=4294967295*
set shmsys:shminfo_shmmni=2000
set msgsys:msginfo_msgmni=2048
set max_nprocs=1000
set fnsod:sod_Debug=0
set rlim_fd_max=1024
set rlim_fd_cur=256
noexec_user_stack=1
NOTE It is a best practice to set this value to 4 GB but not higher than physical memory. It is
recommended that this be set to less than 80% of physical memory.
4. Save your changes.
5. Reboot the server.
Configure Application Engine Servers (Linux)
To configure Linux-based Application Engine servers
1. Ensure that Linux® libraries are installed.
To install Application Engine on Linux, several legacy libraries are required. You must install
the compat-libstdc++ packages on your Red Hat system prior to beginning your install of
Application Engine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
63
Task 2b: Configure Windows
Content Engine and Enterprise Manager
Task 2b: Configure Windows
The topics in this task describe how to configure Windows on the servers where you will install the
P8 system.
Content Engine and Enterprise Manager
To configure Windows for Content Engine and Enterprise Manager
1. On any Windows machine where you are going to install Content Engine or Enterprise Manager
(Content Engine is a Java application that can optionally be installed on Windows; Enterprise
Manager must be installed on Windows), you must first install the following:
•
Microsoft .NET Framework
•
Web Services Enhancements (WSE)
Check the IBM FileNet P8 Hardware and Software Requirements for the latest version
requirements of these two components. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Enterprise Manager requires no other Content Engine services or files.
Content Engine authenticating with Active Directory
To configure Windows for Content Engine
If Windows Active Directory is your directory service, set the primary DNS server IP address on
your Content Engine machine to the IP address of the machine where DNS is installed.
Process Engine on Windows
To configure Windows for Process Engine
1. If Process Engine will be installed by a domain user rather than a local user on the associated
server, see “Specify IBM FileNet P8 Accounts” on page 72 for details on creating required users
and groups.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
64
Task 3a: Configure Windows Active Directory
To enable DNS forwarders (when they are required for your network configuration)
Task 3a: Configure Windows Active Directory
Use this task to configure Windows Active Directory on a Windows server.
For a complete list of IBM FileNet P8-supported Windows Active Directory features, refer to
FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security > Directory service
providers > Windows Active Directory.
To enable DNS forwarders (when they are required for your network configuration)
1. If you want to have access to the Internet or other external network resources from the network
in which you intend to run IBM FileNet P8 Platform software, then you must log on to a Windows
domain name server (DNS) and set a DNS forwarder to point to a DNS server with an IP having
access to the Internet. DNS forwarders provide the external domain name service (DNS)
functionality.
For example, under Windows 2003 you can set this functionality from the Windows DNS
administrative tool that is available from Start > All Programs > Administrative Tools > DNS,
where you can enable forwarders in the Properties page. See your Microsoft Windows
documentation for details.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
65
Task 3b: Configure Active Directory Application Mode (ADAM)
Task 3b: Configure Active Directory Application Mode
(ADAM)
For IBM FileNet P8, no special settings are required for Microsoft ADAM on a Windows server. For
a complete list of ADAM directory server features that IBM FileNet P8 supports, refer to the IBM
FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security >
Directory Service Providers > ADAM.
NOTES
•
You can use ADAM as a stand-alone directory service, or you can synchronize ADAM with
Active Directory, using Microsoft’s built-in tools. Synchronization is invisible to IBM FileNet P8
applications and authentication.
•
To provision some or all of your user accounts in Microsoft Active Directory you must use
ADAM’s userProxyFull class of objects (and not the userProxy object) to represent those user
accounts.
•
Consult your ADAM documentation for full information, including how to synchronize Active
Directory to ADAM. It is a best practice to establish the connection between Active Directory
and ADAM before installing IBM FileNet P8.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
66
Task 3c: Configure Sun Java System Directory Server
Task 3c: Configure Sun Java System Directory Server
Use this task to configure Sun Java System Directory Server on a Windows or UNIX server. For a
complete list of IBM FileNet P8-supported Sun Java System Directory Server features, refer to the
IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8
Security > Directory Service Providers > Sun Java System Directory Server.
NOTES
This step is performed on the Windows or supported UNIX computer that will be configured as the
IBM FileNet P8 Platform authentication server using a Sun Java System Directory Server (v 5.1
SP2 or 5.2).
•
When configuring the Sun Java System Directory Server software, you may find references in
the user interface to iPlanet or Sun ONE. These terms have been replaced by Sun Java
System Directory Server.
•
On Windows servers, Sun Java System Directory Server should be installed on an NTFS hard
drive partition.
•
If there are more than 2,000 users in the Directory Server, you must increase the resource
limits to correctly display users in IBM FileNet P8. IBM recommends setting this limit to -1
(unlimited). You can either set this limit for the entire LDAP server or for the individual IBM
FileNet P8 users. Instructions for either procedure appear below.
•
Access control settings in IBM FileNet P8 require that all users have Read access on the
directory server. If you do not want to set Read access at the individual user level, you can
establish this configuration by one of the following:
–
Setting up anonymous access privileges
–
Adding all users to an authenticated users group having Read access.
•
If you enable one-way SSL, use the fully qualified domain name of the Sun Java System
Directory Server when requesting the certificate.
•
If multiple users within a realm have the same UID value, these users cannot log on via IBM
FileNet P8 application sign-in screens using their short name (uid). Instead, they must
configure the application server to use the fully qualified distinguished name (FQDN).
For example, consider two separate users in two different organizational units (OUs):
uid=jdoe,ou=Sales,dc=filenet,dc=com
uid=jdoe,ou=Marketing,dc=filenet,dc=com
In this case neither user can log on with a short name (uid) of jdoe. Each user must use his
fully qualified name. For example, jdoe in Marketing must enter all of the information
necessary to create the fully qualified name uid=jdoe,ou=Marketing,dc=filenet,dc=com. (If you
use a custom logon application, some of this information can be defaulted or hidden from the
user.)
•
No user can have a blank password. Any user attempting to log on (for example, to Workplace
or Enterprise Manager) or to configure the Process Engine LDAP connection will receive an
error message.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
67
Task 3c: Configure Sun Java System Directory Server
Configure Sun Java System Directory Server (v 5.1 SP2)
Configure Sun Java System Directory Server (v 5.1 SP2)
To set the resource limits for the entire directory server
NOTE User resource limits take precedence over server resource limits. Existing users who have a
value specified for resource limits will not be affected by the changes made in the following steps.
1. From the server where Sun Java System Directory Server is installed, log on with an account
that has rights to modify the Sun Java System Directory Server environment.
2. Run the Sun Java System Directory Server console and login.
3. Expand the Domain > Server Group containers and select your Directory Server. Then rightclick and select Open.
4. Select the Directory tab and expand config > plugins > ldbm database.
5. Double-click the config folder.
6. From the Property Editor sheet for cn=config,cn=ldbm database,cn=plugins,cn=config, change
nsslapd-lookthroughlimit value to -1 and click OK.
7. Select the Configuration tab.
8. Select the Performance tab, change the Size limit to -1 and click Save.
9. Select the Tasks tab and click Restart to restart the Directory Server.
To set the resource limits for individual IBM FileNet P8 users
You will need to perform the steps below any time you add additional IBM FileNet P8 users.
1. From the Sun Java System Directory Server console, expand the Domain > Server Group
containers and select your Directory Server. Then click Open.
2. Select the Directory tab.
3. From the left pane, select the Object (OU, etc.) that contains the user(s) you want to change.
4. For each IBM FileNet P8 user whose limit you want to change, complete the following steps:
a. From the right pane, double-click on the user name.
b. Select Properties.
c. On the left pane of the Properties dialog box, select Account.
d. Enter -1 in the Look through limit and size limit fields.
e. Click OK.
5. Restart the Directory Server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
68
Task 3c: Configure Sun Java System Directory Server
Configure Sun Java System Directory Server (v 5.2)
Configure Sun Java System Directory Server (v 5.2)
To set the resource limits for the entire Directory Server
NOTE User resource limits take precedence over server resource limits. Existing users who have a
value specified for resource limits will not be affected by the changes made in the following steps.
1. From the server where Sun Java System Directory Server is installed, log on with an account
that has rights to modify the Sun Java System Directory Server environment.
2. Run the Sun Java System Directory Server console and login.
3. Expand the Domain > Server Group containers and select your Directory Server.
4. Right-click and select Open.
5. Select the Configuration tab.
6. Select the Performance container.
7. Select the Client Control tab.
8. For the LDAP group box, ensure that Size limit and Look-through limit are both set to Unlimited.
9. If changes were made, click Save.
10. Select the Tasks tab and Restart the Directory Server if changes were made.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
69
Task 3d: Configure Novell eDirectory
Task 3d: Configure Novell eDirectory
For a complete list of IBM FileNet P8-supported Novell eDirectory features, refer to the IBM
FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security >
Directory Service Providers > Novell eDirectory.
NOTES
•
The Windows server where Novell eDirectory Server is installed, must have an NTFS hard
drive partition.
•
The Novell eDirectory administrator may have to create an index if the sorting attribute is not
in the list of default attributes shipped by eDirectory.
•
Access control settings in IBM FileNet P8 require that all users have Browse access on the
directory server. If you do not want to set Browse access at the individual user level, it is a
best practice to establish a Public trustee for the realm.
•
IBM FileNet P8 supports cross-realm group memberships. This means that IBM FileNet P8
supports a configuration in which a group is in one realm while some or all of its users are in
another.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
70
Task 3e: Configure IBM Tivoli Directory Server
Task 3e: Configure IBM Tivoli Directory Server
No special IBM FileNet P8-specific settings are required for IBM Tivoli Directory Server. For a
complete list of IBM FileNet P8-supported IBM Tivoli Directory Server features, refer to the IBM
FileNet P8 Help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security >
Directory Service Providers > Tivoli Directory Server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
71
Task 4: Specify IBM FileNet P8 Accounts
Task 4: Specify IBM FileNet P8 Accounts
This task assumes that you have a directory server that is properly installed and configured.
The following procedures create or designate the accounts needed to install and configure IBM
FileNet P8. Some IBM FileNet P8 roles are not fully described here because the information is not
essential for completing the installation procedures.
NOTES
•
For a complete list of the user and group roles, accounts, and responsibilities required to
install, configure, and maintain an IBM FileNet P8 system, see the IBM FileNet P8 help topic
FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security > Users and groups.
•
In a multi-domain Microsoft Active Directory environment, a logon will fail for any account
whose user name and password in a parent/child domain match those in a child/parent
domain.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
72
Task 4: Specify IBM FileNet P8 Accounts
Accounts for Content Engine
Accounts for Content Engine
To create Content Engine accounts
1. Create new (or designate existing) directory server accounts for Content Engine, as shown in
the following table:
User/Group
Description
Required
by
Change
status from
3.5.x
<SQL_Server_
login>
SQL Server account for
creating databases and
unique database users for
object stores and the
GCD. The account must
have at least the following
server roles:
Install:
Task 12,
New
requirement
for access
to the
master
database.
NOTE This
account
applies only if
the Content
Engine
database is
SQL Server.
•
System Administrators
•
Security
Administrators
•
Disk Administrators
•
Database Creators
and at least the following
database access
permissions:
•
public
•
db_owner
Also add this account to
SQL Server’s master
database and grant the
SqlJDBCXAUser role and
the public role.
Task 19a
(Web
Sphere
5.1.x),
Task 19b
(Web
Sphere
6.0.x),
Task 19c
(Web
Sphere
6.1.x),
Task 19d
(Web
Logic
8.1.x),
Task 19e
(Web
Logic
9.2.x),
Task 20
Upgrade:
Task 3
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
73
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
<Oracle_alias>
The account you will use
to create tablespaces and
unique tablespace users
for object stores and the
GCD. Give this account at
least the following
permissions:
Install:
Task 12,
•
CREATE SESSION
•
CREATE TABLE
•
CREATE SEQUENCE
(object store
tablespaces only)
Task 19b
(Web
Sphere
6.0.x),
NOTE This
account
applies only if
the Content
Engine
database is
Oracle.
Task 19a
(Web
Sphere
5.1.x),
Task 19c
(Web
Sphere
6.1.x),
Task 19d
(Web
Logic
8.1.x),
Task 19e
(Web
Logic
9.2.x),
Task 20
Upgrade:
Task 3
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Change
status from
3.5.x
Name/Alias
74
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
<DB2 user>
An operating system user
on the database server
with the following DB2
database permissions. In
the case of a remote
database, no equivalent
users are needed on the
Content Engine server.
Install:
Task 6c,
No change
•
Connect to the
database
•
Create tables in the
tablespace
(CREATETAB)
Task 19b
(Web
Sphere
6.0.x),
NOTE This
account
applies only if
the Content
Engine
database is
DB2.
•
Use the tablespace
(USE OF) for User and
User Temp
tablespaces
Task 12,
Task 19a
(Web
Sphere
5.1.x),
Task 19c
(Web
Sphere
6.1.x),
Task 19d
(Web
Logic
8.1.x),
Task 19e
(Web
Logic
9.2.x),
Task 20
Upgrade:
Task 3
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
75
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
Accounts
required for
DB2 database
setup and
administration:
Operating system user
and group that must exist
on the database server.
Install:
Task 6c,
No change
•
Groups:
instance
owner
primary
group
•
Users:
instance
owner
Task 20
Upgrade:
Task 3
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
76
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
Application
server
administrator
You will use this account
to:
Install:
Task 8a
(Web
Sphere),
New for
4.0.0
NOTE JBoss
does not
require an
administrative
account.
•
•
•
•
Create and configure
the application server
domain/profile for IBM
FileNet P8
Start the application
server before
launching Content
Engine Setup
Specify the username
and password to
Content Engine Setup
to log on to the
application server
Deploy the EAR file
during initial Content
Engine installation and
when deploying
Content Engine to
other servers
Content Engine Setup will
use this account to
configure JDBC data
sources and connection
pools for the GCD.
Task 8b
(Web
Logic),
Task 12,
Task 19a
(Web
Sphere
5.1.x),
Task 19b
(Web
Sphere
6.0.x),
Task 19c
(Web
Sphere
6.1.x),
Task 19d
(Web
Logic
8.1.x),
Task 19e
(Web
Logic
9.2.x)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
77
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
Content
Engine Setup
account
The account you will use
to log on to a machine to
launch Content Engine
Setup. The account must:
Install:
Task 12
No longer
needs to be
member of
Domain
Users.
Install:
Task 12
New for
4.0.0
(Windows)
•
Belong to the Local
Administrators group
•
(Under WebLogic)
Have write permission
to directory
<WebLogic_Install_Dir
ectory>/user_projects/
domains/FNCEDomain
which you will create
when you prepare
WebLogic for Content
Engine installation.
See “Configure
WebLogic 9.2.x” on
page 140.
Content
Engine Setup
account
The account you will use
to log on to a machine to
launch Content Engine.
(AIX)
Must be root user.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
78
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
Content
Engine Setup
account
The account you will use
to log on to a machine to
launch Content Engine
Setup. This account must:
Install:
Task 12
New for
4.0.0
HP-UX 11
HPUX 11i
Linux
Solaris
•
Belong to the adm
group.
•
Have read/write/
execute permission to
the device and path
where:
–
Content Engine is
to be installed.
–
The application
server has been
installed.
•
Have write permission
to the directories
where you will create
file storage areas,
index areas, and
content caches.
•
Have write permission
to the /tmp directory.
•
Be the user (or a
member of the group)
that launched the
application server
instance where you
will deploy Content
Engine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
79
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
Content
Engine system
user
An application server
administrative account that
is stored in the
CEMPBoot.properties file.
This account is used first
to create the GCD, and
thereafter is the account
that Content Engine runs
as. It is the account
Content Engine will use to
establish a connection with
the application server,
access the application
server's Java TM Naming
and Directory Interface
(JNDI) tree, and look up
the data sources for
accessing the GCD.
Install:
Task 12
New for
4.0.0
CAUTION If you are
deploying Content Engine
on WebSphere 6.1.x with
federated repositories and
with multiple realms in
your IBM FileNet P8
domain, be sure that no
two realms contain the
same short name for this
account; otherwise, this
account will not be able to
create the GCD.
Content
Engine
operating
system user
Account used to create
and configure the shared
root directory of a file
storage area or content
cache area.
Install:
Task 5
Upgrade:
Task 3
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
80
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
User/Group
Description
Required
by
Change
status from
3.5.x
GCD
administrators
The accounts that serve in
the role of GCD
administrator. Use one of
these accounts to:
Install:
Task 12,
No change
Object store
administrators
•
Create the GCD.
•
Launch the Configure
New Domain
Permissions wizard
the first time you start
Enterprise Manager to
establish the IBM
FileNet P8 domain
(see “To configure
permissions for a FileNet
P8 domain” on
page 225).
Each account will
administer an object store
and will have Full Control
access to it. You will need
to specify these accounts
when you run the Create
an Object Store wizard in
Enterprise Manager (see
“To create an object store”
on page 287).
Task 20
Install:
Task 20
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
No change
Name/Alias
81
Task 4: Specify IBM FileNet P8 Accounts
To create Content Engine accounts
2. Create a new (or designate an existing) directory server account, which Content Engine Setup
will prompt you for, to use when connecting to and searching within the directory server. This
account must have at least the following permissions:
User/Group
Description
Required
by
Change
status from
3.5.x
Directory
service user
(Content
Engine/Active
Directory)
Used by Content Engine to
connect to Active Directory.
Requires at least the
following permissions:
Install:
Task 3a,
New for
4.0.0
Directory
service user
(Content
Engine/
ADAM)
Used by Content Engine to
connect to a single Microsoft
ADAM partition. Requires at
least the following
permissions:
Task 20
Member of the Pre-Windows
2000 Compatible Access
Group in each desired
domain in the Active
Directory forest.
Install:
Task 3b,
Task 20
New for
Content
Engine
4.0.1
Ability to see the other users
in the partition. (For a
procedure, see the entry for
the ADAM directory service
user in FileNet P8
Administration > Enterprisewide Administration > FileNet
P8 Security > Users and
groups.)
Directory
service user
(Content
Engine/Sun)
Used by Content Engine to
connect to the Sun Java
System directory server.
Requires at least the
following permissions:
Install:
Task 3c,
Task 20
Read, Search, Compare
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
No change
Name/Alias
82
Task 4: Specify IBM FileNet P8 Accounts
Accounts for Process Engine (Windows)
User/Group
Description
Required
by
Change
status from
3.5.x
Directory
service user
(Content
Engine/Novell
eDirectory)
Used by Content Engine to
connect to Novell eDirectory.
Requires at least the
following permissions:
Install:
Task 3d,
No change
Directory
service user
(Content
Engine/IBM
Tivoli)
Used by Content Engine to
connect to IBM Tivoli
Directory Server. Requires at
least the following
permissions:
Name/Alias
Task 20
Read, Compare
Install:
Task 3e,
New for
4.0.0
Task 20
Read, Search, Compare
Accounts for Process Engine (Windows)
To create Process Engine accounts (Windows)
Depending on your response to its prompt, Process Engine Setup creates default user and group
accounts or creates the accounts with your specified alias names.
There are two options:
•
Allow Process Engine Setup to create the Process Engine accounts or aliases.
•
Pre-create the default accounts or aliases before running Process Engine Setup.
Process Engine Setup will ask if you want to configure aliases:
•
A no answer indicates that Process Engine Setup should create the default accounts and
groups.
•
A yes answer brings up a second screen allowing you to define aliases for each of the default
accounts and groups.
If the accounts and groups do not already exist, Process Engine Setup will create them. If the
accounts and groups already exist, Process Engine Setup will use them during the install. If you
are pre-defining the users and groups, be sure to assign the fnsw user alias to the aliased fnadmin,
fnusr, and fnop groups before running Process Engine Setup, otherwise Process Engine Setup can
encounter errors.
If you choose to create an alias for one Process Engine account, you must create aliases for all
accounts, even if you set the alias to the default value of a Process Engine account.
If the database is DB2, the f_sw and f_maint accounts, or their aliases, must be predefined as
operating system (OS) users. See “Verify that DB2 Server Is Installed for IBM FileNet P8” on page 114
for additional information.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
83
Task 4: Specify IBM FileNet P8 Accounts
To create Process Engine accounts (Windows)
1. Optionally assign aliases to the following users and groups:
User/
Group
Description
Required
by
Change
status
from 3.5.x
fnadmin
(group
account)
Operating system group
whose members have all
privileges on Process
Engine files and
databases.
Install:
Task 23a,
No
change
fnusr
(group
account)
Operating system group
whose members have nonadministrator privileges to
Process Engine files and
databases.
Install:
Task 23a
No
change
fnop
(group
account)
Operating system group
whose members have
operator non-administrator
privileges to Image
Services utilities used by
Process Engine.
Install:
Task 23a
No
change
fnsw
(user
account)
Operating system user
account that executes
Process Engine software.
Install:
Task 7b,
No
change
Task 26
Task 23a,
Task 26
Upgrade:
Task 11b,
Task 14
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
84
Task 4: Specify IBM FileNet P8 Accounts
To create Process Engine accounts (Windows)
User/
Group
Description
Required
by
Change
status
from 3.5.x
f_sw
(user
account)
Database runtime user
(OS user for DB2)
Install:
Task 6c,
No
change
Name/Alias
Task 7c,
Task 23a
Appendix:
“Process
Engine SQL
Scripts”
f_maint
(user
account)
Database maintenance
user (OS user for DB2)
Install:
Task 6c,
No
change
Task 7c,
Task 23a
Appendix:
“Process
Engine SQL
Scripts”
NOTE The f_sw and f_maint database users will be created if the SQL scripts for SQL Server
and Oracle databases are manually executed before Process Engine Setup. These scripts
create users, passwords and stored procedures. There are no comparable scripts for DB2
databases. See “Process Engine SQL Scripts” on page 671 for details on the SQL scripts.
2. If you are going to run Process Engine Setup while logged on as a Windows domain user, do the
following:
a. Create the following security group accounts, with Windows domain local scope, on the
Windows domain controller:
Default Name
Description
fnadmin or alias
Members have all privileges to IBM FileNet files and
databases
fnusr or alias
Members have normal privileges to IBM FileNet files and
databases
fnop or alias
Members have operator non-administrator privileges to
Image Services utilities used by Process Engine
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
85
Task 4: Specify IBM FileNet P8 Accounts
Accounts for Process Engine (UNIX)
b. Create the following user accounts on the Windows domain controller:
Default Name
Description
<peinstaller>
User who will run Process Engine Setup
fnsw or alias
Primary IBM FileNet software user
NOTE Set the password to BPMtemp1pzwd. This password is
case-sensitive. You can change the password after installing
Process Engine.
c. Add the <peinstaller> and fnsw users to the fnadmin, fnusr, and fnop groups.
d. Log on to the machine where you will install Process Engine as a member of the Domain
Admins group.
e. Add the <peinstaller> and fnsw users to the local Administrators group.
Accounts for Process Engine (UNIX)
To create Process Engine accounts (UNIX)
The required Process Engine users and groups for UNIX are detailed in the following tables. After
you create or modify an account, log out and log back in to pick up the changes.
NOTE (AIX only) Because AIX does not allow users to create a group with an empty member list,
you must create these groups and users in the following order:
1. Create the fnusr or alias group with root and Oracle User as its members.
2. Create the fnsw or alias user with fnusr as its primary group.
3. Create the fnadmin group with fnsw and root as its members
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
86
Task 4: Specify IBM FileNet P8 Accounts
To create Process Engine accounts (UNIX)
User/Group
Description
Required
by
Change
status from
3.5.x
Name/Alias
root
Make the following
modifications:
Install:
Task 23b
(Solaris),
No change
n/a
Default shell: Ksh
Secondary group: fnusr,
fnadmin
Task 23c
(AIX),
Task 23d
(HP-UX)
fnadmin, or
an alias
(group
account)
Create an operating system
group account whose
members have all privileges
to Process Engine files and
databases.
Members: fnsw, root
fnusr, or an
alias (group
account)
Create an operating system
group account whose
members have nonadministrative privileges to
Process Engine files and
databases.
Members: fnsw, root, Oracle
User; default = oracle
fnop, or an
alias (group
account)
Install:
Task 23b
(Solaris),
No change
Task 23c
(AIX),
Task 23d
(HP-UX)
Install:
Task 23b
(Solaris),
No change
Task 23c
(AIX),
Task 23d
(HP-UX)
Create an operating system
group account whose
members have operator nonadministrator privileges to
Image Services utilities used
by Process Engine.
Install:
Task 23b
(Solaris),
Members: fnsw
Task 23d
(HP-UX)
Task 23c
(AIX),
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
No change
87
Task 4: Specify IBM FileNet P8 Accounts
To create Process Engine accounts (UNIX)
User/Group
Description
Required
by
Change
status from
3.5.x
fnsw, or an
alias (user
account)
Create an operating system
user account who executes
Process Engine software.
Install:
Task 7b,
No change
Default shell: Ksh
Primary Group: fnusr
Secondary Group: Oracle
Database Administrators
Group; default = dba,
fnadmin, fnop
Task 23b
(Solaris),
Task 23c
(AIX),
Task 23d
(HP-UX),
Task 26
Upgrade:
Task 11a,
Task 14
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
88
Task 4: Specify IBM FileNet P8 Accounts
To create Process Engine accounts (UNIX)
User/Group
Description
Required
by
Change
status from
3.5.x
f_sw, or an
alias (user
account)
Create a database runtime
user.
Install:
Task 23b
(Solaris),
No change
For DB2: Create f_sw (or its
alias) as an OS user. See
“Verify that DB2 Server Is
Installed for IBM FileNet P8” on
page 114 for additional
information.
f_sw and f_maint will be
created if the SQL scripts for
SQL Server and Oracle
databases are manually
executed before Process
Engine Setup. These scripts
create users, passwords and
stored procedures. There are
no comparable scripts for
DB2 databases. See “Process
Engine SQL Scripts” on
page 671 for details on the
SQL scripts.
f_maint, or
an alias (user
account)
Create a database
maintenance user.
For DB2: create f_maint (or
its alias) as an OS user. See
“Verify that DB2 Server Is
Installed for IBM FileNet P8” on
page 114 for additional
information.
Task 23c
(AIX),
Task 23d
(HP-UX)
Upgrade:
Task 14
Install:
Task 23b
(Solaris),
Task 23c
(AIX),
Task 23d
(HP-UX)
f_sw and f_maint will be
created if the SQL scripts for
SQL Server and Oracle
databases are manually
executed before Process
Engine Setup. These scripts
create users, passwords and
stored procedures. There are
no comparable scripts for
DB2 databases. See “Process
Engine SQL Scripts” on
page 671 for details on the
SQL scripts.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
No change
Name/Alias
89
Task 4: Specify IBM FileNet P8 Accounts
To create Oracle accounts for Process Engine (UNIX)
To create Oracle accounts for Process Engine (UNIX)
If the Oracle database is local to Process Engine, the following operating system user and group
accounts should already exist as a result of installing the Oracle software. Process Engine Setup
will prompt for the values. If the database is remote, the user and group might need to be defined
on the server where Process Engine will be installed. When the Oracle user and group have been
created, modify the account information as described.
Process Engine Setup prompts for the user and group account names but does not allow
assignment of aliases for them.
User/Group
Description
Required
by
Change
status
from
3.5.x
Oracle User;
default =
oracle
Action: Modify, if the database is
local. Create, if the database is
remote.
Install:
Task 23b
(Solaris),
No
change
User Type: Database
Task 23c
(AIX),
Primary Group: Oracle Database
Administrators Group; default =
dba
Task 23d
(HP-UX)
Secondary Group: fnusr
Oracle
Database
Administrators
Group; default
= dba
Members act as database
administrators
Action: Modify, if the database is
local. Create, if the database is
remote.
Members: fnsw, Oracle user;
default = oracle
Install:
Task 23b
(Solaris),
Task 23c
(AIX),
Task 23d
(HP-UX)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
No
change
Name/Alias
90
Task 4: Specify IBM FileNet P8 Accounts
To create other Process Engine accounts
To create other Process Engine accounts
1. Create new (or designate existing) directory server accounts for Process Engine, as shown in
the following table:
User/Group
Description
Required
by
Change
status from
3.5.x
Process
Engine
service user
Create an account that
Process Engine will use
when connecting to the
Content Engine server.
This user must belong to
the Process Engine
administrators group.
Install:
Task 26
No longer
used to
communicate
directly to
the
directory
server.
Process
Engine
administrators
group
Create a group whose
members will
automatically have
administrative privileges
for Process Engine.
Install:
Task 26
No change
Process
Engine
configuration
group
(Optional) A valid group
name. Members of this
group automatically have
configuration privileges
for the Process Engine
workflow database.
Install:
Task 26
No change
If this group is used to
configure security on
Process Task Manager,
members of this group or
of the Process Engine
administrator group can
make configuration
changes to the workflow
database. If the Process
Engine configuration
group is not used during
this configuration,
anyone can make these
changes.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
91
Task 4: Specify IBM FileNet P8 Accounts
Accounts for Application Engine
Accounts for Application Engine
To create Application Engine accounts
1. Create new (or designate existing) directory server accounts for Application Engine, as shown in
the following table:
User/Group
Description
Required
by
Change
status from
3.5.x
Application
Engine setup
account
(Windows)
The account you will use
to log on to a Windows
machine and launch
Application Engine
Setup. This account must
have read/ write/execute
access to the directory
where you will install
Application Engine.
Install:
Task 28
No change
Application
Engine setup
account
(UNIX)
The account you will use
to log on to a UNIX
machine and launch
Application Engine Setup.
This account must have
read/write access to the
/bin directory and read/
write/execute access to
the directory where you
will install Application
Engine.
Install:
Task 28
No change
Application
server
account
This account will have
permissions to deploy an
application. The account
may be the same as the
Application Engine setup
account.
Install:
Task 29a,
No change
Application
Engine
Administrators
These accounts will serve
in the role of Application
Engine administrator. You
will specify these
accounts as members of
the AE administrator role
in “Set Application Engine
Bootstrap Preferences” on
page 421. These accounts
must have passwords.
Install:
Task 35,
Task 29b
Task 40,
Task 52
Upgrade:
Task 22
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
No change
Name/Alias
92
Task 4: Specify IBM FileNet P8 Accounts
Accounts for Content Search Engine
In addition to the requirements above, the Application Engine setup account and Application
server account need the read/write permissions to these directories:
WebSphere
<WAS_HOME>/profiles/default/installedApps/node_name/app_engine_war.ear/app_engine.war
<WAS_HOME>/profiles/default/config/cells/machine_name/Node01cell/nodes/machine_name/
Node01/serverindex.xml
WebLogic
<WL_HOME>/bea/user_projects/domains/base_domain/bin/startWebLogic.sh or
startWebLogic.cmd
<WL_HOME>/bea/weblogic92/server/bin/startWLS.sh or startWLS.cmd
WebLogic (8.x only)
<WL_HOME>/bea/user_projects/domains/domain_name/config.xml
WebLogic (9.x only)
<WL_HOME>/bea/user_projects/domains/domain_name/config/config.xml
JBoss
<JBOSS_HOME>/jboss-4.0.5.GA/binrun.sh or run.bat
JBOSS_home/server/default/conf/login-config.xml (both on the Content Engine and the
Application Engine)
NOTE All IBM FileNet Workplace accounts, as well as accounts for other client applications
and expansion products that use Content Engine or Application Engine, must have passwords.
Accounts for Content Search Engine
To create Content Search Engine accounts
1. If you are installing Content Search Engine, create new (or designate existing) Autonomy K2
security accounts as shown in the following table:
User/
Group
Description
Required by
Change
status from
3.5.x
K2
Security
Group
Autonomy K2 security group
used to secure K2
collections. You will specify
this group in the User Group
field in the Verity Domain
Configuration when you
configure Content-Based
Retrieval (CBR) in
Enterprise Manager.
Install:
Task 11
New for
4.0.0
Install:
Task 34
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Name/Alias
93
Task 4: Specify IBM FileNet P8 Accounts
To create Content Search Engine accounts
User/
Group
Description
Required by
Change
status from
3.5.x
K2
Security
User
Autonomy K2 security user
account, used when logging
on to perform CBR. You will
specify this account in the
Verity Username field in the
Verity Domain Configuration
when you configure CBR in
Enterprise Manager. This
user must be a member of
the K2 Security Group and
must be defined as an
authorized K2 administrator
in the K2 dashboard.
Install:
Task 11
New for
4.0.0
K2
Operating
System
User
Autonomy K2 services will
run as this user. This user
must be an operating
system administrator on the
machine where the
Autonomy K2 Master
Administration server is
installed. Additionally, this
user must have access to
the file system that contains
the file storage areas and
the full text index
collections, because the
Autonomy K2 software
needs to read the file
storage areas and write to
the full text index collections
as part of the full text
indexing operation.
Install:
Task 11
Name/Alias
Install:
Task 34
New for
4.0.0
Install:
Task 34
Install:
Task 45
Install:
Task 51
NOTE Both K2 Security User and K2 Operating System User can be the same user. All
permissions listed above must be assigned.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
94
Task 5: Prepare Storage Areas for Object Stores
Task 5: Prepare Storage Areas for Object Stores
This task has two purposes:
•
To prepare locations of initial storage areas for the object stores you will be creating, via the
Create Object Store wizard (see “Create Object Stores” on page 286).
•
To prepare locations of additional file storage areas (see “Create Additional File Storage Areas”
on page 446) for object stores you already created.
An object store can have up to three types of storage areas for the content of documents and
business objects:
•
A file storage area stores content in a network-accessible directory. The path name to this
directory specifies the location of the file storage area.
For information about file storage areas, see the IBM FileNet P8 help topic FileNet P8
Administration > Content Engine Administration > Content storage > File storage areas.
•
A fixed storage area is a file storage area on a large-capacity, (possibly) write-once, fixed
content device.
For information about fixed storage areas, see the IBM FileNet P8 help topic FileNet P8
Administration > Content Engine Administration > Content storage > Fixed storage areas.
•
A database storage area stores content as binary large objects (BLOBs) in a database.
NOTES
•
In this document, file storage area refers only to a network-accessible directory that is not on
a fixed content device.
•
The names of file storage areas and database storage areas must be unique within an object
store.
•
File storage areas on encrypted NTFS devices are not supported.
By default, the Create Object Store wizard creates a database storage area. If your object stores
will use database storage areas only, you can skip the rest of this task, provided that one of the
following conditions is met:
•
Your database type is non-DB2.
•
Your database type is DB2 and either of the following conditions is met:
–
Your database storage areas will not contain large content elements (larger than 300 MB,
for example).
–
You intend to set the value of the DB2 custom property fullyMaterializeLobData to false for
the data sources that will be associated with the database.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
95
Task 5: Prepare Storage Areas for Object Stores
Configure File Servers for File Storage Areas
Besides creating a database storage area, the Create Object Store wizard allows you to create an
initial file storage area or initial fixed storage area. But the wizard requires that you first do at least
one of the following, depending on the type of storage areas you want for your object stores:
•
For fixed storage areas, create at least one fixed content device (typically via Enterprise
Manager). Multiple fixed storage areas can share the same fixed content device, or a fixed
storage area can have its own fixed content device.
If the content of all your object stores will be in fixed storage areas only, create your fixed
content devices now, skip the rest of this topic.
To create a fixed content device, refer to the procedures in IBM FileNet P8 help topic FileNet
P8 Administration > Content Engine Administration > Content storage > Fixed storage areas.
•
For file storage areas, prepare locations on one or more file servers (which usually are not a
machine where you installed Content Engine), as shown in the remainder of this task.
Configure File Servers for File Storage Areas
In this section you will configure file servers for the initial file storage areas of the object stores to
be created, and for additional file storage areas of existing object stores.
Refer to the IBM FileNet P8 Hardware and Software Requirements for currently supported
operating systems for file servers. To download this guide from the IBM support page, see “Access
IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Configuring a file server for file storage areas involves the following general steps, which are
described in more detail in the procedures later in this task:
1. Create or designate an existing top-level directory on the file server where file storage areas will
reside.
2. Secure the directory so only Content Engine Server and Content Search Engine can access it.
3. Expose the directory via the remote file access protocol that applies to the operating system of
the file server.
4. (Recommended) Under the top-level directory, create a subdirectory for each file storage area
you intend to create.
If you decide to put a file storage area directly within a top-level directory, rather than in a
subdirectory, and you later decide to create an additional file storage area on this file server,
you will have to create another top-level directory for it, as you will not be able to use the
previously created top-level directory.
Remote File Access Protocols
The supported remote file access protocols between Content Engine and a file server are as
follows:
•
Common Internet File System (CIFS)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
96
Task 5: Prepare Storage Areas for Object Stores
Configure File Servers for File Storage Areas
•
Network File System (NFS)
•
Distributed File System (DFS)
NOTE DFS is supported if you are using it to manage a file storage area; however, the
replication feature of DFS is not supported. For details on setting up a link to DFS, see IBM
FileNet P8 help topic FileNet P8 Administration > Content Engine Administration > Content storage >
File storage areas > How to...Create DFS link.
The communication method between the Content Engine machine and the file server depends on
the operating systems running on the two machines, as shown in the following table:
Content Engine Operating System
File Server Operating System
File Access Protocol
Windows 2003
Windows 2003
CIFS
UNIX
UNIX
NFS
UNIX
Windows 2003
NFS
NOTE Install a UPS power supply backup system on each file server to enable graceful shutdown.
Loss or corruption of data will result if a file server does not shut down gracefully.
Users and Groups
The following table shows the operating system users and groups involved in securing file storage
areas. These users and groups must be defined in the directory service that the operating system
uses to authenticate users, which is not necessarily the same directory service that Content
Engine Server uses.
NOTE The user and group names in this table are placeholders for the actual names of the names
that you designate.
Users and Groups
Role
Content Engine operating system user
The user under which Content Engine Server
executes (typically, the user that starts Content
Engine Server).
K2 operating system user
The user under which Content Search Engine
executes (typically, the user that starts Content
Search Engine).
Content Engine operating system group
The group in which the Content Engine operating
system user and the K2 operating system user are
members.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
97
Task 5: Prepare Storage Areas for Object Stores
To configure a UNIX-based file server
The following procedures, which use the abbreviations in the following table, show how to
configure UNIX-based and Windows-based file servers. Do the procedures that apply to your
environment.
Abbreviation
Meaning
<CE_OS_User>
Content Engine operating system user
<CE_OS_Group>
Content Engine operating system group
<fsa1>
Directory where content will be stored
For details on file storage area security, see the IBM FileNet P8 help topic FileNet P8 Administration >
Enterprise-wide Administration > FileNet P8 Security > Authorization > Storage Area Security.
To configure a UNIX-based file server
1. Log on to the UNIX file server as a user with read/write access to the device where you want to
create a storage area.
2. Create or designate a directory <fsa1> where content will be stored. For example:
$ mkdir /opt/filenet/file_stores/<fsa1>
3. Set the Content Engine operating system user as the owner of <fsa1> and give group access
permission to the Content Engine operating system group. For example:
chown <CE_OS_User>:<CE_OS_Group> <fsa1>
NOTE The UID (user ID) for <CE_OS_User> and the GID (group ID) for <CE_OS_Group> on
the file server must match the UID and GID for the same user and group on the machine
where Content Engine Server and Content Search Engine are running. This will normally be
true if all machines use the same directory service, but they may be different.
4. Change the permissions on <fsa1> so that <CE_OS_User> and <CE_OS_Group> both have
read/write/execute privileges and all other users have no privileges:
chmod 0770 <fsa1>
5. Via NFS, export <fsa1>. Alternatively, if the file server will host more than one file storage area,
export the parent directory.
In the latter case, for example, export /opt/filenet/file_stores, rather than /opt/filenet/
file_stores/<fsa1>, and then create a separate subdirectory to serve as the root of each file
storage area.
NOTE IBM recommends that trusted hosts be restricted to just those on which an instance of
Content Engine Server or Content Search Engine is executing. Root access should also be
restricted. Refer to the UNIX administrator manual for details on exporting files in NFS.
To configure a Windows-based file server for a Windows client using CIFS
1. Log on to the Windows file server as <CE_OS_User>.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
98
Task 5: Prepare Storage Areas for Object Stores
To configure a Windows-based file server for a UNIX client using NFS
2. Create (or designate) a directory <fsa1> where content will be stored. For example:
C:\> md c:\filenet\file_stores\<fsa1>
3. Navigate in Windows Explorer to <fsa1>, right-click the file icon, and choose Properties.
4. In the Security tab, click Advanced.
5. In the Advanced Security Settings dialog box,
a. Grant Full Control to <CE_OS_User> and <CE_OS_Group>, and select This Folder,
subfolders, and files from the Apply onto drop-down list.
b. Remove all other users and groups in the Permission entries table.
c. Click OK.
6. In the Sharing tab, do the following:
a. Click Share this folder and click Permissions.
b. Grant Full control to <CE_OS_User> and <CE_OS_Group>.
c. Remove all other users and groups in the Permission entries table.
d. Click OK.
To configure a Windows-based file server for a UNIX client using NFS
1. Do all the steps in “To configure a Windows-based file server for a Windows client using CIFS” on
page 98.
2. Use the procedures in Microsoft documentation to configure Windows Services for NFS to
expose <fsa1>.
NOTES
•
Windows Services for NFS is an optional Windows component bundled with Windows Server 2003
R2.
•
As part of configuring Windows Services for NFS, you must set up a mapping of Windows
users and groups to UNIX users and groups. When setting up the mapping for
<CE_OS_User> and <CE_OS_Group>, you must specify the same UID (UNIX user ID)
and GID (UNIX group ID) that these accounts have on the machine where Content Engine
Server is installed.
Configure the Remote Access Protocol on the Client Machine
When configuring the remote file access protocol (NFS or CIFS), the “client machine” is the one
where Content Engine Server and/or Content Search Engine are running.
Configuring the remote access protocol (NFS or CIFS) means designating a directory (where
content is be stored) so that it appears to be on the a local file system of the client machine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
99
Task 5: Prepare Storage Areas for Object Stores
To configure UNIX-based Content Engine Server to talk to a UNIX or Windows file server via NFS
To configure UNIX-based Content Engine Server to talk to a UNIX or Windows file server via NFS
1. On the application server where you are going to deploy Content Engine, log on as the user who
launched the application server.
2. Mount the exported NFS file system (from Step 5 of “To configure a UNIX-based file server” on
page 98) onto a local directory on the Content Engine machine. The mount point must be in the
same location on all machines where Content Engine Server and Content Search Server are
going to be installed in the local file system. For example,
mount -t nfs filesrv:/opt/filenet/file_stores /home/filenet/file_stores
where filesrv is the host name of Content Engine machine.
In this example, all Content Engine Server machines (including machines that are part of the
same server farm or cluster) must mount the remote file system at /home/filenet/file_stores.
To configure Windows-based Content Engine Server to talk to a Windows file server via CIFS
If both Content Engine Server and the file server are in the same Windows domain, no action is
required. If they are in different domains, establish access to the file server machine from the
machine where you will install Content Engine Server before creating the file storage areas.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
100
Task 6a: Verify that Microsoft SQL Server Is Installed for IBM FileNet P8
Task 6a: Verify that Microsoft SQL Server Is Installed
for IBM FileNet P8
The procedures in this task describe how to install and configure a SQL Server database that is
dedicated or shared by one or more of the following IBM FileNet P8 components:
•
dedicated to Content Engine
•
dedicated to Process Engine
•
shared by two or more of Content Engine, Process Engine, and Rendition Engine
For a SQL Server database dedicated to Rendition Engine, see the IBM FileNet P8 guide FileNet
P8 System Installation > Rendition Engine Installation and Upgrade.
In a shared configuration, the IBM FileNet P8 components use the same database instance. You
can also share the database with other (non-IBM FileNet) applications. In a dedicated
configuration, Content Engine, Process Engine, and Rendition Engine use separate database
instances.
If you plan to use the region recovery feature of Process Engine, each region configured for
recovery must use a dedicated data filegroup, separate from the default filegroup.
A database is local if it is on a server where you will also be installing Content Engine, Process
Engine, or Rendition Engine. A database is remote if it is on a separate server from the
component using that database.
If you are installing a new 4.0.x IBM FileNet P8 system (that is, not upgrading from version 3.5.x),
do all the procedures in this task. If you are upgrading Content Engine 3.5.x to version 4.0.x, do
only the following procedures in this task:
•
“To create a Microsoft SQL database for the GCD” on page 103
•
“To enable XA Transactions” on page 104
•
“To configure the JDBC Distributed Transaction Components” on page 105
•
“To configure user-defined roles” on page 105
NOTES
•
Process Engine requires an ODBC data source for connection to the SQL Server database.
See “Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8” on page 121 for details
on configuring the data source.
•
If your Microsoft SQL Server database will be remote, then after completing the procedures in
this topic you might also need to install SQL Server Client software on the machine where you
will install Process Engine. See “Verify that Microsoft SQL Server Client Is Installed for IBM FileNet
P8” on page 121 for details.
•
The following components can optionally share a SQL Server instance:
–
Content Engine (object store databases and GCD database)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
101
Task 6a: Verify that Microsoft SQL Server Is Installed for IBM FileNet P8
To install and configure Microsoft SQL Server
–
Process Engine
–
Rendition Engine
•
A database should not be shared by multiple Content Engine object stores.
•
Process Engine and the optional Process Analyzer component cannot share an instance. For
information on SQL Server requirements for Process Analyzer, see the Process Analyzer
Installation and Upgrade Guide.
•
Record the values for the following settings as you work through the database installation.
This information must be entered during subsequent installations of IBM FileNet P8
components. Be aware that Process Engine Setup allows only alphanumeric and underscore
characters.
–
Server name
–
Instance name (for example, P8_inst)
–
Dedicated database name (for example, VWdb)
–
Default file group (for example, vwdata_fg)
–
TCP/IP port number assigned
To install and configure Microsoft SQL Server
CAUTION Do this procedure only if you are installing a new version 4.0 IBM FileNet P8 system. If
you are upgrading from version 3.5.x, skip to “To create a Microsoft SQL database for the GCD” on
page 103.
•
Create a database instance for use by IBM FileNet P8 software, or verify that such an instance
already exists.
•
If creating a new instance, indicate an appropriate name based on whether Content Engine
(object store), GCD, Process Engine, or Rendition Engine will use the instance. Be aware of
the following rules for instance names:
–
The name cannot exceed 16 characters.
–
The first character cannot be numeric or '$.
–
The name cannot contain special characters, except underscores or periods.
–
The name cannot contain spaces.
–
The name cannot be Default or SQLServer.
•
Verify the authentication mode you specify is for Mixed Mode.
•
Select the database collation settings. Specify one of the following:
•
Dictionary order, case-insensitive, for use with 1252 Character Set (or any case-insensitive
SQL Server collation). Case-insensitive collation is the Microsoft default and the setting most used
in IBM FileNet P8 environments (because it offers search results without regard to character
case).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
102
Task 6a: Verify that Microsoft SQL Server Is Installed for IBM FileNet P8
To create a Microsoft SQL database for the GCD
•
Dictionary order, case-sensitive, for use with 1252 Character Set (or any case-sensitive SQL
Server collation). Select case-sensitive SQL Server collation only if you are sure your site actually
requires (and will continue to require) searches that must differentiate uppercase from lowercase
characters (in property choice lists, folder names, etc.).
CAUTION Select your SQL Server collation setting carefully. Switching collation settings after
installation can be difficult and time-consuming, especially if you want to switch from casesensitive to case-insensitive collation after significant user activity. Also, be aware that if you
have a case-sensitive database, and you want to perform a case-insensitive search
(programmatically or otherwise), you will likely encounter serious performance degradation on
SQL Server because the database cannot use column (that is, property) indexes in these
cases.
•
(SQL Server 2000 only)Assign a TCP/IP port number for the instance. If your instance is the
only instance on the server, you can accept port 1433 (the default value). If you are creating a
named instance you must assign a static port number.
•
(SQL Server 2005 only)The TCP/IP port number cannot be assigned during installation of
SQL Server 2005. You must assign the port number after installation is complete by using the
SQL Server Configuration Manager application to modify the network configuration.
•
Refer to the IBM FileNet P8 Hardware and Software Requirements for required operatingsystem and database patch sets, and service packs. Verify that the required service pack has
been installed before proceeding. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
If you want to disable the Named Pipes protocol for the database instance to be used by
Process Engine, wait until after Process Engine installation and configuration is complete.
Disabling this protocol too early might cause Process Engine initialization to fail.
WARNING The default on a SQL Server 2005 installation is to disable Named Pipes. Use the
SQL Server Configuration Manager application to modify this network configuration parameter
after SQL Server 2005 is installed and the instance has been created.
To create a Microsoft SQL database for the GCD
Create a SQL Server database for GCD database, which is required for Content Engine
installation. Create the database with an initial size of 100 MB, minimum. Make note of the
database name as it will be required later when installing Content Engine software.
To create a Microsoft SQL database for Content Engine object store(s)
CAUTION Do this procedure only if you are installing a new version 4.0 IBM FileNet P8 system. If
you are upgrading from version 3.5.x, skip to “To enable XA Transactions” on page 104.
Create a SQL Server database for a Content Engine object store. Each object store you create
will require its own, empty database. Create the database with an initial size of 200 MB,
minimum.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
103
Task 6a: Verify that Microsoft SQL Server Is Installed for IBM FileNet P8
To create the Process Engine database
To create the Process Engine database
Create a SQL Server database for Process Engine. The default name assigned by the Process
Engine Setup program is VWdb. Create the database with an initial size of 200 MB minimum.
Assign a new file name for the database (for example, vw_data). Specify a filegroup (for example,
vwdata_fg.) IBM recommends that the Primary filegroup is not used. If you will be using the
region recovery feature, create an additional filegroup for every region configured for recovery.
NOTE You will need the default database and filegroup names for the Process Engine installation.
To modify the tempdb database for Process Engine
Verify that the space allocated for the tempdb is at least 80 MB.
To execute Process Engine pre-installation scripts manually
If you intend to run Process Engine pre-installation scripts manually, do so now. See“Process
Engine SQL Scripts” on page 671 for detailed information on scripts and modes of execution.
NOTE Setting up Process Engine requires that several pre-installation SQL scripts be run to
create Process Engine users, passwords, and stored procedures. These scripts for SQL Server
databases can be executed in one of the following three ways:
•
Execute them manually on the database server, before running the Process Engine Setup
program. If the scripts are run manually, both the default run-time and maintenance users and
their passwords can be modified in the scripts before execution.
•
Execute them automatically from the Process Engine Setup program, allowing setup to prompt
for the sa password for SQL Server.
•
Execute them automatically from the Process Engine Setup program, running silently using
operating system authentication. Use operating system authentication only in a trusted
environment or when configured with a local database.
To enable XA Transactions
Perform the following procedure on every SQL Server machine that will contain a Content Engine
database.
1. From Control Panel, open Administrative Tools, and then open Component Services.
2. Expand Component Services, right-click My Computer, and then select Properties.
3. Click the MSDTC tab, and then click Security Configuration.
4. Select the Enable XA Transactions check box, and then click OK. This will restart the MS DTC
service.
5. Click OK again to close the Properties dialog box, and then close Component Services.
6. Stop and then restart the SQL Server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
104
Task 6a: Verify that Microsoft SQL Server Is Installed for IBM FileNet P8
To configure the JDBC Distributed Transaction Components
To configure the JDBC Distributed Transaction Components
Perform the following procedure on every SQL Server machine that will contain a Content Engine
database.
1. Download the Microsoft SQL Server 2005 JDBC Driver that is referenced in the IBM FileNet P8
Hardware and Software Requirements. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
2. Copy the sqljdbc_xa.dll from the JDBC installation directory to the Program Files\Microsoft SQL
Server\80\Tools\Binn directory if there is only a default instance or the Program Files\Microsoft
SQL Server\MSSQL$<instance name>Binn if you are using a named instance. If you are on a
32-bit processor, use the sqljdbc_xa.dll file in the x86 folder. If you are on a 64-bit processor,
use the sqljdbc_xa.dll file in the x64 folder.
3. Log on as a database administrator and execute the database script xa_install.sql on every SQL
Server instance that will participate in distributed transactions. This script installs sqljdbc_xa.dll
as an extended stored procedure and creates the SqlJDBCXAUser role in the Master database.
CAUTION Use SQL Server database credentials, not Windows credentials, to log on.
Windows Integrated Logon to SQL Server is not supported with IBM FileNet P8.
To configure user-defined roles
Perform the following procedure on every SQL Server machine that will contain a Content Engine
database.
NOTE If the SQL Server login account you are using for Content Engine is the default sa user, you
can skip this procedure and proceed to one of the topics noted below the steps.
1. Add the SQL Server login account you are using for Content Engine to the SqlJDBCXAUser role.
This action grants permissions to the account to participate in distributed transactions with the
JDBC driver.
2. Ensure this same user account is assigned to the master database.
Refer to “Specify IBM FileNet P8 Accounts” on page 72 for more information on the Content Engine
SQL Server user requirements.
If you are upgrading from version 3.5.x of IBM FileNet P8, continue at “To install and configure an
application server for Content Engine Server” on page 508 in “Upgrade Content Engine Software” on
page 505.
If you are installing a new 4.0 IBM FileNet P8 system and intend to use SQL Server for Process
Engine, proceed to “Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8” on page 121
to configure the ODBC data source and optionally install SQL Server Client software.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
105
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
Task 6b: Verify that Oracle Server Is Installed for IBM
FileNet P8
The procedures in this task describe how to install and configure an Oracle database that is
dedicated or shared by one or more of the following IBM FileNet P8 components:
•
dedicated to Content Engine
•
dedicated to Process Engine
•
dedicated to Rendition Engine
•
shared by two or more of Content Engine, Process Engine, and Rendition Engine
In the shared configuration, the IBM FileNet P8 components use the same database, but different
tablespaces.
If you plan to use the region recovery feature of Process Engine, each region configured for
recovery must reside in a dedicated data and index tablespace, separate from the default
tablespaces.
You can also share the database with other (non-IBM FileNet) applications. In the dedicated
configuration, Content Engine, Process Engine, and Rendition Engine use separate databases.
A database is local if it is on a machine where you will also be installing Content Engine, Process
Engine, or Rendition Engine. A database is remote if it is on a separate server from the
component using that database.
If you are installing a new 4.0.x IBM FileNet P8 system (that is, not upgrading from version 3.5.x),
do all the procedures in this task. If you are upgrading Content Engine 3.5.x to version 4.0.x, do
only the procedure “To create tablespaces for the GCD” on page 109.
For information regarding installation of Oracle Server and Rendition Engine, see the IBM FileNet
P8 guide FileNet P8 System Installation > Rendition Engine Installation and Upgrade.
NOTES
•
If your Oracle database will be remote, then after completing the procedures in this topic you
must also complete the procedures in “Verify that Oracle Client Is Installed for IBM FileNet P8” on
page 124 on each machine where you will install Process Engine.
•
Make sure the machine that will host the database satisfies all pre-installation requirements
specified in the Oracle9i or Oracle 10g installation documentation.
•
For Content Engine and Process Engine, IBM FileNet P8 supports the Oracle Advanced
Security functionality of secure data transfer across network protocol boundaries.
•
If you will be installing Process Engine on a UNIX machine hosting the Oracle database, be
sure that the value of the Oracle environment variable ORACLE_HOME (the path name for the
Oracle Server software) is a string of at most 53 characters. If the string has more than 53
characters, the Process Engine installer will not find the Oracle software, causing the
installation to fail.
•
Refer to the IBM FileNet P8 Hardware and Software Requirements for required operatingsystem and database patch sets, and service packs. To download this guide from the IBM
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
106
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To install an Oracle database engine
support page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on
page 23. The Oracle patches are available at the Oracle Web site. The Oracle patchinstallation procedure may be less complicated if done before you create any databases.
•
Transaction Processing is the required configuration type for the database that supports
Content Engine. Choose this configuration type if your database will be dedicated to Content
Engine or shared with Process Engine.
•
Record the values for the following settings as you work through the database installation.
This information must be entered during subsequent installations. Be aware that Process
Engine Setup allows only alphanumeric and underscore characters. Tablespace names used
by Process Engine can contain only alphanumeric and underscore characters. Names must
start with an alphabetic character and must be at most 18 characters long.
–
Oracle Home
–
Global Database Name
–
Oracle temporary tablespace name
–
Oracle data tablespace name
–
Oracle index tablespace name (optional)
–
Oracle SID
To install an Oracle database engine
CAUTION Do this procedure only if you are installing a new version 4.0 IBM FileNet P8 system. If
you are upgrading from version 3.5.x, skip to “To create tablespaces for the GCD” on page 109.
The following procedure shows the minimal choices (specific to the needs of Content Engine and
Process Engine) for installing a database engine. Consult the Oracle9i or Oracle 10g installation
documentation for complete preinstallation requirements and instructions.
•
For Oracle 9i, choose the following from the list of available product components.
–
Oracle9i Server
–
Oracle Net Services
•
–
Oracle9i Development Kit
•
–
•
Oracle Call Interface (OCI)
(Windows) Oracle Windows Interfaces
•
–
Oracle Net Listener
Oracle Services for Microsoft Transaction Server
Oracle9i Documentation (recommended)
For Oracle 10g, choose the following from the list of available product components.
–
Oracle10g Server
–
Oracle Net Services
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
107
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To create an Oracle database
•
–
Oracle Call Interface (OCI)
–
(Windows) Oracle Windows Interfaces
•
–
•
Oracle Net Listener
Oracle Services for Microsoft Transaction Server
Oracle10g Documentation (recommended)
If you are going to install Process Engine on this machine, verify/add/edit/uncomment the
following lines in the file sqlnet.ora (create the file if it doesn’t exist) while the Oracle services/
processes are stopped:
NAMES.DIRECTORY_PATH=(TNSNAMES)
SQLNET.AUTHENTICATION_SERVICES=(NTS)
NOTE If Oracle is configured to use LDAP, TNSNAMES must appear in the
names_directory_path ahead of LDAPNAMES.
The sqlnet.ora file is typically located in the following directory:
(UNIX) $ORACLE_HOME/network/admin
(Windows) ORACLE_HOME\network\admin
1. Install the latest Oracle patch sets, as specified in the IBM FileNet P8 Hardware and Software
Requirements. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23.
2. Start the listener and the Oracle database service/processes if they haven't started
automatically.
To create an Oracle database
Oracle documentation describes several ways to create a database. It is a best practice to use the
Database Configuration Assistant (DBCA).
IBM FileNet requires the following settings:
•
Database configuration type
If this database is dedicated to Content Engine, or if it will be shared by Content Engine and
Process Engine, then Transaction Processing (also known as OLTP) is the required database
configuration type.
•
Server process type
Dedicated server mode
•
Database character set
Choose a database character set as specified in “IBM FileNet P8 Database Character Sets” on
page 681.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
108
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To create tablespaces for the GCD
To create tablespaces for the GCD
Using Oracle Enterprise Manager or SQL*Plus, create a user, password, and default tablespace in
the Oracle database for each object store that Content Engine will access. Grant CREATE
SESSION and CREATE TABLE to the user.
NOTE In the past, CONNECT and RESOURCE roles were granted to the user. These roles have
been deprecated in Oracle release 10g. Although these roles are still available and behave
correctly, they have the side affect of granting other, unnecessary, privileges and it is best practice
to grant only minimum privileges.
Because these two roles include other privileges as well, it is best practice that you design your
own roles if you prefer to grant only the minimal privileges required by Content Engine.
WARNING The Oracle user you create for the permanent and temporary tablespaces of the GCD
must be unique. That is, the Oracle user for the GCD must not be the same as that of the user for
any object store. Otherwise, the objects you intend to add only to the GCD will show up in all
object stores that share the same Oracle user.
Tablespace names must contain only alphanumeric and underscore characters. Names must start
with an alphabetic character and must be at most 18 characters long.
For performance reasons, IBM recommends that you specify locally managed, instead of
dictionary managed, tablespaces. (The tablespaces you create via Oracle Enterprise Manager are
locally managed by default.)
The following table shows the recommended minimum sizes of the permanent and temporary
tablespaces for each object store that Content Engine will access.
Tablespace Name
Tablespace Type
Minimum Size (MB)
Description
<gcd>
Permanent
100
Permanent
tablespace for the
GCD
<tempgcd>
Temporary
200
Temporary
tablespace for the
GCD
If you are upgrading from version 3.5.x of FileNet P8, continue at “To install and configure an
application server for Content Engine Server” on page 508 in “Upgrade Content Engine Software” on
page 505.
To create Oracle tablespaces for Content Engine object stores
Using Oracle Enterprise Manager or SQL*Plus, create a user, password, and default tablespace in
the Oracle database for each object store that Content Engine will access. Grant CREATE
SESSION, CREATE TABLE, and CREATE SEQUENCE to the user.
NOTE In the past, CONNECT and RESOURCE roles were granted to the user. These roles have
been deprecated in Oracle release 10g. Although these roles are still available and behave
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
109
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To create tablespaces for Process Engine
correctly, they have the side affect of granting other, unnecessary, privileges and it is best practice
to grant only minimum privileges.
WARNING The Oracle user you create for the permanent and temporary tablespaces of an object
store must be unique. That is, multiple object stores and the GCD must not share the same Oracle
user. Otherwise, the objects you intend to add only to one object store will show up in all object
stores (and the GCD) that share the same Oracle user.
Tablespace names used by Content Engine must contain only alphanumeric and underscore
characters. Names must start with an alphabetic character and must be at most 18 characters
long.
For performance reasons, it is a best practice to specify locally managed, instead of dictionary
managed, tablespaces. (The tablespaces you create via Oracle Enterprise Manager are locally
managed by default.)
The following table shows the recommended minimum sizes of the permanent and temporary
tablespaces for each object store that Content Engine will access.
Tablespace Name
Tablespace Type
Minimum Size (MB)
Description
<objectstore1>
Permanent
200
Permanent
tablespace for
object store
<tempobjectstore1>
Temporary
400
Temporary
tablespace for
object store
To create tablespaces for Process Engine
Using Oracle Enterprise Manager or SQL*PLus, create the tablespaces shown in the following
table for the Process Engine. Note that the indexing tablespace (vwindex_ts) is optional.
If you will use the region recovery feature in Process Engine, you must create the default
tablespaces and an additional data and index tablespace for each region to be configured for
recovery. The same run-time and maintenance users will be used for all Process Engine
tablespaces.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
110
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To create tablespaces for Process Engine
The following table shows the recommended tablespace names, types, and minimum sizes:
Tablespace Name
Tablespace Type
Minimum Size (MB)
Description
vwdata_ts
Permanent
200
Default name of the
dedicated IBM
FileNet data
tablespace. This is
the only data
tablespace
configured in
Process Engine
Setup.
vwtemp_ts
Temporary
400
Default name of the
dedicated IBM
FileNet temporary
tablespace. This is
the only temp
tablespace
configured in
Process Engine
Setup.
vwindex_ts (optional)
Permanent
200
Default name of the
optional default
index tablespace.
This is the only
index tablespace
configured in
Process Engine
Setup.
<region X data>
Permanent
200
Data tablespace to
be used by an
individual region
configured for
recovery. Cannot
be shared by any
other region.
<region X index>
Permanent
200
Index tablespace to
be used by an
individual region
configured for
recovery. Cannot
be shared by any
other region.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
111
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To set environment variables for the Oracle and root users on UNIX database server
NOTES
•
If you don't create vwindex_ts, vwdata_ts will be used for indexes.
•
Only the default tablespace names need to be entered during Process Engine Setup.
To set environment variables for the Oracle and root users on UNIX database server
If your Oracle database runs on a UNIX machine, set the following environment variables in the
.profile, .cshrc, or .login file before using the Oracle database. (On Windows, the Oracle Universal
Installer sets these variables.)
•
For the oracle user, set the following:
–
ORACLE_SID
–
ORACLE_HOME
–
Set PATH to:
$ORACLE_HOME/bin (HP-UX and 32-bit Solaris only)
–
Set LD_LIBRARY_PATH to:
$ORACLE_HOME/lib (HP-UX and 32-bit Solaris only)
–
Set LD_LIBRARY_PATH to:
$ORACLE_HOME/lib32 (64-bit Solaris only)
–
Set LIBPATH to:
$ORACLE_HOME/lib32:$ORACLE_HOME/lib (AIX only)
–
Set SHLIB_PATH to:
$ORACLE_HOME/lib32 (HP-UX only)
•
For the root user, set ORACLE_HOME.
To configure automatic transaction recovery
In a distributed database environment, Oracle MTS Recovery Service (automatically installed with
Oracle Services for Microsoft Transaction Server) can resolve in-doubt transactions on the
computer that started the failed transaction.
To enable automatic transaction recovery, perform the tasks shown in the section "Scheduling
Automatic Microsoft Transaction Server Recovery" in Oracle Services for Microsoft Transaction
Server Developer's Guide (Oracle Part Number A95496-01).
In addition, if you are using an Oracle Fail Safe configuration, perform the procedure shown in
“Modifying Registry Values for Oracle Fail Safe Configurations” in Oracle Services for Microsoft
Transaction Server Developer's Guide (Oracle Part Number A95496-01).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
112
Task 6b: Verify that Oracle Server Is Installed for IBM FileNet P8
To verify the listener
To verify the listener
Use Oracle utilities to configure the Oracle listener (which creates the listener.ora file) and verify
that it is running.
To execute Process Engine pre-installation scripts manually
If you intend to run Process Engine pre-installation scripts manually, do so now. See “Process
Engine SQL Scripts” on page 671 for detailed information on scripts and modes of execution.
NOTE Setting up Process Engine requires that several pre-installation SQL scripts be run to
create Process Engine users, passwords, and stored procedures. These scripts for SQL Server
databases can be executed in one of the following three ways:
•
Execute them manually on the database server, before running the Process Engine Setup
program. If the scripts are run manually, both the default run-time and maintenance users and
their passwords can be modified in the scripts before execution.
•
Execute them automatically from the Process Engine Setup program, allowing setup to prompt
for the sys password for Oracle.
•
Execute them automatically from the Process Engine Setup program, running silently using
operating system authentication. Use operating system authentication only in a trusted
environment or when configured with a local database.
To turn off Oracle Password Complexity Verification
Process Engine does not support Oracle Password Complexity Verification during the installation
process. If you are using the default passwords for the run-time (f_sw or alias) or maintenance
(f_maint or alias) users, turn off this Oracle feature and do not re-enable it until you have installed
and configured Process Engine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
113
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
Task 6c: Verify that DB2 Server Is Installed for IBM
FileNet P8
The procedures in this task describe how to install and configure a DB2 instance that is dedicated
or shared by one or more of the following IBM FileNet P8 components. In a shared configuration,
the IBM FileNet P8 components use the same instance, but different databases. You can also
share the instance with other (non-IBM FileNet) applications.
•
dedicated to Content Engine
•
dedicated to Process Engine
•
shared by two or more of Content Engine and Process Engines
If you plan to use the region recovery feature of Process Engine, each region configured for
recovery must reside in a dedicated data, blob, and index tablespace, separate from the default
data tablespace.
A database is local if it is on a machine where you will also be installing Content Engine or
Process Engine. A database is remote if it is on a separate server from the component using that
database.
If you are installing IBM FileNet P8 as a new application (that is, not upgrading from version
3.5.x), do all the procedures in this task. If you are upgrading Content Engine 3.5.x to version
4.0.x, do only the procedure to create a GCD database as documented in “To create the DB2
tablespaces” on page 117.
NOTES
•
Process Engine supports DB2 only on remote database servers. After completing the
procedures in this topic, you must also complete the procedures in “Verify that DB2 Client Is
Installed for IBM FileNet P8” on page 127.
•
It is assumed that all DB2 software is installed by the root user.
•
Content Engine and Process Engine should not share a tablespace but can share a database.
For maintenance and support reasons, it is a best practice to use separate databases.
•
The Content Engine GCD and every object store must have dedicated databases.
•
Content Engine and Process Engine have different requirements for DB2 users and groups, ,
which is explained later in this task topic.
•
See “IBM FileNet P8 Database Character Sets” on page 681 for information on character set
requirements.
IBM recommends using Database Managed Space (DMS) for user and user temp tablespaces for
both Content Engine and Process Engine.
Record the values for the following settings as you work through the database installation. This
information must be entered during subsequent installations of Process Engine and Content
Engine. Be aware that Process Engine Setup allows only alphanumeric and underscore
characters.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
114
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
To create DB2 users and groups
•
DB2 server name
•
DB2 server database instance name(s) (e.g. P8_inst)
•
Content Engine and Process Engine dedicated database names (e.g. VWdb)
•
Dedicated tablespace names (e.g. vwdata)
•
DB2 instance port numbers
•
Process Engine run-time database user (f_sw or alias) password
•
Process Engine maintenance database user (f_maint or alias) password
•
User ID and password for Content Engine DB2 user
To create DB2 users and groups
1. Create the following operating system users and groups. You may specify any user and group
names, as long as they adhere to system and DB2 naming rules.
•
Instance Owner - A user required for each database instance. Only one is required per instance,
even if the instance is shared by Content Engine and Process Engine. The instance owner is
assigned during the process of creating the instance. Each instance has its own home file system,
and each instance owner must have a unique home directory. The instance owner home directory
is where the DB2 instance will be created. All of the files necessary to run the instance are created
in the home directory of the instance owner’s user ID/username.
NOTE You must log on as the instance owner to act as the DBA. The root user cannot act as a
DBA.
•
Instance Owner primary group - The instance owner's primary group. Only one such group is
required per instance, even if the instance is shared by Content Engine and Process Engine. This
primary group automatically becomes the system administration group for the instance and gains
SYSADM authority as a database administrator (DBA) over the instance. Other user IDs or user
names that are members of this primary group also gain this level of authority.
•
Fenced User - (Process Engine only) A user who runs user-defined functions (UDFs) and stored
procedures outside the address space used by the DB2 database.
•
Fenced User primary group - (Process Engine only) The fenced users primary group.
2. (Process Engine only) If the database authentication type is set to SERVER or
SERVER_ENCRYPT, create two additional operating system users for Process Engine on the
DB2 database server, as instructed in ““To create additional OS users and groups (Process Engine
SERVER or SERVER_ENCRYPT authentication only)” on page 119.
3. (Content Engine only) Designate a separate user account for every tablespace required. This
account's user ID and password will be required later when creating connection pools and object
stores. For this account, you can create a new operating system user, or identify an existing
operating system user, to whom you will grant the following DB2 permissions:
•
Permission to connect
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
115
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
To install DB2 Enterprise Server Edition
•
Permission to create tables in the tablespace (CREATETAB)
•
Permission to use the tablespace (USE OF) for User and User Temp tablespaces
When the database authentication type is set to SERVER or SERVER_ENCRYPT, two additional
operating system users must be created for Process Engine on the database server where the
DB2 database resides. See “To create additional OS users and groups (Process Engine SERVER or
SERVER_ENCRYPT authentication only)” on page 119.
To install DB2 Enterprise Server Edition
1. As root user, create a temporary file system with 2.0 GB of free space to contain the tar.Z and
the uncompressed installation file.
2. Install the DB2 software. Content Engine and Process Engine both need 64-bit instances on a
Unix servers, 32-bit instances on Windows servers, and a single instance can be shared.
3. When the installation is finished, view the status report or go to /tmp to view all DB2 install logs
to ensure there are no errors.
4. Make note of the TCP/IP port number assigned to the instance or instances, as the port number
will be needed during the DB2 client configuration steps. The port number assigned can be
found in the /etc/services file, associated with the DB2 instance(s) just created.
After a successful installation, the DB2 instance should be up and running. Continue with the next
procedure.
To create DB2 instance(s)
Create the appropriate DB2 instances, if they do not already exist, for Content Engine and
Process Engine. Content Engine and Process Engine can share an instance, or each engine can
have its own instance. Both Content Engine and Process Engine require 64-bit instances on UNIX
servers and 32-bit instances on Windows servers.
To set TCP/IP as the default protocol
1. Log on to the database as the instance owner.
2. Set DB2COMM by executing:
db2set DB2COMM=tcpip
To determine page size and user fields
Before you create any DB2 tablespace for use by IBM FileNet P8, do the following:
1. Determine the total row length of all the fields to be used in the tablespace (system and user).
2. From the length total in step a [cross-ref], determine your choice of tablespace page size.
Page size options include 4 KB, 8 KB, 16 KB, and 32 KB. The page size you choose affects the
number and size of the user-defined index fields the tablespace can support, and it also affects
the maximum row length of the tables within that tablespace.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
116
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
To create and update the DB2 databases for Content Engine and Process Engine
NOTE The important thing to remember is that the total row length of all the fields (including
system and user) cannot be larger than the page size. The DB2 page size you select when you
create the database must be large enough to hold at least one complete record. DB2 cannot
retrieve a partial record or spread a single record onto two pages.
To create and update the DB2 databases for Content Engine and Process Engine
1. Log on as the database instance owner as defined earlier.
2. Create at least three databases, one for each of the following:
•
Process Engine
•
Content Engine GCD
•
Content Engine object store
Every object store requires a separate DB2 database. The database name needs to be unique
and from 1 to 8 characters long. For example, VWdb is the default database name in Process
Engine Setup.
3. For any database to be used by Content Engine object store, update the following configuration
parameter (setting the value, minimally, to what is indicated here):
APPLHEAPSZ 2560
To create the DB2 tablespaces
1. Determine whether you will use the Process Engine region recovery feature.
2. Do one of the following:
•
If you will use region recovery, create the default data tablespace and an additional data, blob, and
index tablespace for each region to be configured for recovery.
•
If you will not use region recovery, create only a single data tablespace for Process Engine.
Only the default data tablespace name will be required input to Process Engine Setup. Separate
Index and blob tablespaces are not supported for this default configuration.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
117
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
To create the DB2 tablespaces
IBM FileNet
Tablespaces
Actual
Assigned
Name
Minimum
Size (MB)
Actual
Created Size
Minimum
Page Size (KB)
user temporary
(for PE)
40
must match pagesize
of PE data tablespace
system
temporary (for
PE)
40
must match pagesize
of PE data tablespace
vwdata_ts
(for PE)
200
8 (recommended)
<region X data>
(Data
tablespace to
be used by an
individual PE
region
configured for
recovery.
Cannot be
shared by any
other region.)
200
8 (recommended)
<region X index>
(Index
tablespace to
be used by an
individual PE
region
configured for
recovery.
Cannot be
shared by any
other region)
200
8 (recommended)
NOTE This is
the only
tablespace
name entered
for Process
Engine Setup
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
118
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
To create additional OS users and groups (Process Engine SERVER or SERVER_ENCRYPT authentication
IBM FileNet
Tablespaces
Actual
Assigned
Name
Minimum
Size (MB)
Actual
Created Size
Minimum
Page Size (KB)
<region X blob>
(Blob
tablespace to
be used by an
individual PE
region
configured for
recovery.
Cannot be
shared by any
other region)
200
8 (recommended)
GCD_ts
(for the GCD
database)
256
32 (required)
cedata_ts
(for a single CE
object store)
512
32 (required)
user temporary
ts
(for CE)
40
32 (required)
system
temporary ts
(for CE)
40
32 (required)
To create additional OS users and groups (Process Engine SERVER or SERVER_ENCRYPT
authentication only)
1. Create the following two additional operating system users with SYSADM authority to access
the DB2 database used by Process Engine.
•
•
Process Engine runtime database user (f_sw or alias)
–
Primary runtime Process Engine database user.
–
Used only by the Process Engine software to access the DB2 database.
–
Must be a member of the operating system group having SYSADM authority over the
DB2 instance that will be used by the Process Engine software.
Process Engine maintenance database user (f_maint or alias)
–
Process Engine Database maintenance user.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
119
Task 6c: Verify that DB2 Server Is Installed for IBM FileNet P8
To grant database permissions for f_sw and f_maint (Process Engine CLIENT authentication only)
–
Mainly used by the customer for database maintenance.
–
It is best practice to be a member of the operating system group having SYSADM
authority over the DB2 instance that will be used by the Process Engine software.
Unlike the instance owner account, these users do not need separate file systems for their
home directories. They must belong to the primary group of the instance owner.
2. After creating the new users and setting their group memberships, log off as root user, log on as
each of the new users, and change the password of each to avoid connection problems the first
time they’re used.
The user names and passwords will be required input to Process Engine Setup.
To grant database permissions for f_sw and f_maint (Process Engine CLIENT authentication only)
If you will be using DB2 CLIENT authentication, create the following Process Engine run-time and
maintenance database users on the Process Engine. These users do not exist on the database
server, but you must grant them the following permissions in the DB2 database for Process
Engine.
•
•
Process Engine runtime database user
–
Primary runtime Process Engine database user
–
Used only by the Process Engine software to access the DB2 database
–
Must be granted the following permissions in the DB2 database:
•
Connect
•
Createtab
•
Bindadd
•
db2set DB2_SNAPSHOT_NOAUTH=on
Process Engine maintenance database user
–
Process Engine Database maintenance user
–
Mainly used by the customer for database maintenance
–
Must be granted the following permissions in the DB2 database:
•
dbadm
•
db2set DB2_SNAPSHOT_NOAUTH=on
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
120
Task 7a: Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8
To create the Process Engine ODBC data source and test the connection(SQL Server only)
Task 7a: Verify that Microsoft SQL Server Client Is
Installed for IBM FileNet P8
Use the procedures in this topic to create the ODBC data source required by Process Engine.
This topic also describes requirements for SQL Server Client software for Process Engine.
Content Engine does not require installation of SQL Server client software in the 4.0.x version of
IBM FileNet P8 software
Only Process Engine has a possible requirement for SQL Server Client software installation. A
number of SQL scripts must be executed for the SQL Server database to create stored
procedures. Those scripts can either be executed manually on the SQL Server database before
running Process Engine Setup, or they can be executed from Process Engine Setup. If the scripts
are executed from Process Engine Setup, SQL Server Client software must be installed on the
Process Engine server. If the scripts are executed manually on the remote database server
before you install Process Engine, you need not install SQL Server Client. If SQL Server Client
software is installed on the Process Engine Server, that software can be removed after successful
installation and configuration of Process Engine software.
See “Process Engine SQL Scripts” on page 671 for details on execution of the SQL Scripts.
NOTES
•
SQL Server connections for Process Engine at run time are handled through an ODBC data
source.
•
You have the option of installing Microsoft SQL Server and Process Engine servers in different
Active Directory forests. In this case, however, you must use SQL Authentication rather than
Windows Authentication.
To create the Process Engine ODBC data source and test the connection(SQL Server only)
The 32-bit ODBC data source is required for both local and remote databases and must be
created on the Process Engine server. The following steps apply on a 32-bit version of the
operating system.
NOTE On a 64-bit operating system locate and manually execute the 32-bit version, typically
located in: C:\WINDOWS\SysWOW64\odbcad32.exe.
1. Start Program > Administrator Tools > Data Source (ODBC).
2. Click Add on the System DSN tab.
3. Select SQL Server as the driver to use for the new data source and click Finish.
4. Enter a name and description for the data source. The name will be required input for the
Process Engine Setup program when configuring for a SQL Server database.
5. Choose the SQL Server to connect to from the dropdown list of servers and click Next.
NOTE If only a server name appears in the list, the connection will be with the default instance.
If there are named instances in the database, the name will appear as <server>/<instance
name>.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
121
Task 7a: Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8
To install MS SQL Server Client software for remote database access (optional for Process Engine)
6. Do the following, and then click Next:
a. Choose SQL Server authentication.
b. Select the option to get default settings for additional configuration options by connecting to
the SQL Server.
c. Indicate the Login ID and Password to connect to the database.
NOTE This database login ID information needd not be for an administrator and it is only used to
connect to the database to get the default values for the remaining settings required to configure
the data source.
7. Change the default database to be the Process Engine database created earlier in “Verify that
Microsoft SQL Server Is Installed for IBM FileNet P8” on page 101.
8. Turn on Use ANSI null, paddings, and warning and turn on Use ANSI quoted identifiers.
9. Turn on Perform translation for character data and click Finish.
10. Verify the settings for the data source configuration and click Test Data Source. If the test is
successful click OK. Otherwise resolve the problem before continuing.
11. Double-click SQL Server on the Connection Pooling tab.
12. Select Don't pool connection to this driver and click OK.
13. Click OK on the ODBC Data Source Administrator window to finish configuration of the data
source.
On the summary screen click Test Data Source. If error messages display, resolve them before
proceeding.
To install MS SQL Server Client software for remote database access (optional for Process Engine)
Ensure that all users and groups defined on the local server are also defined and granted security
permissions on the database server.
Install the MS SQL Server Client software (SQL Server 2000)
1. Log on with an account that has local administrator privileges on the computer where the MS
SQL Server client software will be installed.
2. Install the SQL Server Client Tools Only.
3. When the installation is complete, start the Client Network Utility and clear the Automatic ANSI
to OEM conversion on the DB-Library Options tab.
4. Test the database connection.
Install the MS SQL Server Client software (SQL Server 2005)
1. Log on with an account that has local administrator privileges on the computer where the MS
SQL Server client software will be installed.
2. Install Workstation components, Books Online and development tools and from the
Advanced options, select Client Components.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
122
Task 7a: Verify that Microsoft SQL Server Client Is Installed for IBM FileNet P8
To install MS SQL Server Client software for remote database access (optional for Process Engine)
Install SQL Server patches and service packs
Refer to the IBM FileNet P8 Hardware and Software Requirements for required operating-system
and database patch sets, and service packs. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23. Verify that
the required service pack has been installed before proceeding.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
123
Task 7b: Verify that Oracle Client Is Installed for IBM FileNet P8
To install the Oracle client
Task 7b: Verify that Oracle Client Is Installed for IBM
FileNet P8
Use the procedures in this topic to install the Oracle Client software to prepare for the installation
of Process Engine. Content Engine does not require installation of Oracle client software in the
4.0.x version of IBM FileNet P8 software. For information regarding installation of Oracle Client
and Rendition Engine, see IBM FileNet P8 guide FileNet P8 System Installation > Rendition Engine
Installation and Upgrade.
NOTES
•
Install Oracle Client on any machine that will host Process Engine, Rendition Engine, or any
other IBM FileNet P8 component except Content Engine (such as Enterprise Manager) that
needs to access an Oracle database.
•
Make sure that the machine where you will install Oracle Client satisfies all pre-installation
requirements specified in the Oracle9i or Oracle 10g installation documentation.
•
If you will be installing Process Engine on a UNIX machine hosting Oracle Client software, be
sure that the value of the Oracle environment variable ORACLE_HOME (the pathname for the
Oracle Client software) is a string of at most 53 characters. If the string has more than 53
characters, the Process Engine installer will not find the Oracle software, causing the
installation to fail.
•
Refer to the IBM FileNet P8 Hardware and Software Requirements for required operatingsystem and database patch sets, and Service Packs. To download this guide from the IBM
support page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on
page 23. The Oracle patches are available at the Oracle website. The Oracle patch-installation
procedure may be less complicated if done before you create any databases.
To install the Oracle client
The following procedure shows the minimal choices (specific to the needs of Process Engine) for
installing a database client. Consult the Oracle9i or Oracle 10g installation documentation for
complete preinstallation requirements and instructions.
1. For Oracle 9i, choose the following from the list of available product components.
•
Oracle9i Client
•
Oracle Network Utilities
•
Oracle Database Utilities
•
SQL*PLUS
•
(Windows) Oracle Windows Interfaces
–
Oracle Services for Microsoft Transaction Server
2. For Oracle 10g, choose the following from the list of available product components.
•
Oracle10g Client
•
Oracle Network Utilities
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
124
Task 7b: Verify that Oracle Client Is Installed for IBM FileNet P8
To install the Oracle client
•
Oracle Database Utilities
•
SQL*PLUS
•
(Windows) Oracle Windows Interfaces
–
Oracle Services for Microsoft Transaction Server
3. Using Oracle Net Configuration Assistant, test the connection to the Oracle database server
with an appropriate Oracle user and password.
4. If you are going to install Process Engine software on this machine, and your remote Oracle
database uses the Unicode character set AL32UTF8, then for each user who will access
Process Engine software on the machine, set the value of the Oracle environment variable
parameter NLS_LANG to reflect the PE-supported locale and (non-Unicode) character set on
the machine.
•
(Windows) Set/modify the value of the NLS_LANG key via System Properties in the Control Panel.
•
(UNIX) Add NLS_LANG to the shell environment login files for each user who will be logging onto
the machine to run IBM FileNet P8 software.
NOTE To affect the environment for only Process Engine, set NLS_LANG for just the fnsw
user. (On Windows platforms, fnsw is created by the Process Engine installer; on UNIX
platforms, you manually create fnsw as part of the Process Engine installation task.)
5. If you are going to install Process Engine software on this machine to connect to a remote
Oracle database, set the value of an environment variable for the oracle user to a default
connect identifier, such as the Oracle net service name or the database service name. The
name of the environment variable depends on which operating system is on this machine:
•
(Windows) LOCAL
•
(UNIX) TWO_TASK
6. If you are going to install Process Engine software on a UNIX machine to connect to a remote
Oracle database, set the following environment variables in the startup file of the default oracle
user.
•
ORACLE_SID
•
ORACLE_HOME
•
Set PATH to:
$ORACLE_HOME/bin (HP-UX and 32-bit Solaris only)
•
Set LD_LIBRARY_PATH to:
$ORACLE_HOME/lib (HP-UX and 32-bit Solaris only)
•
Set LD_LIBRARY_PATH to:
$ORACLE_HOME/lib32 (64-bit Solaris only)
•
Set LD_LIBRARY_PATH_64 to:
$ORACLE_HOME/lib (64-bit Solaris only)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
125
Task 7b: Verify that Oracle Client Is Installed for IBM FileNet P8
To install the Oracle client
•
Set LIBPATH to:
$ORACLE_HOME/lib32:$ORACLE_HOME/lib (AIX only)
•
Set SHLIB_PATH to:
$ORACLE_HOME/lib32 (HP-UX only)
7. If you are going to install Process Engine on this machine, verify/add/edit/uncomment the
following lines in the file sqlnet.ora (create the file if it doesn’t exist) while the Oracle services/
processes are stopped:
NAMES.DIRECTORY_PATH=(TNSNAMES)
SQLNET.AUTHENTICATION_SERVICES=(NTS)
sqlnet.ora is typically in $ORACLE_HOME/network/admin on UNIX or
ORACLE_HOME\network\admin on Windows operating systems.
8. Install all required Oracle patches, as specified in the IBM FileNet P8 Hardware and Software
Requirements. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23. These patches are available at
the Oracle website.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
126
Task 7c: Verify that DB2 Client Is Installed for IBM FileNet P8
To install DB2 client software
Task 7c: Verify that DB2 Client Is Installed for IBM
FileNet P8
Use the procedures in this topic to install the DB2 Client software to prepare for the installation of
Process Engine. Content Engine does not require installation of DB2 client software in the 4.0.x
version of IBM FileNet P8 software.
In this task you will:
•
Install and configure the DB2 client software
•
Create several operating system users
•
Create a client instance to connect to the remote DB2 server instance (Process Engine, UNIX
only)
NOTES
Before starting this task you will need the following information:
•
The database name on the remote database server for theProcess Engine database
•
On UNIX Process Engine servers you must install DB2 version 8 client software, regardless of
whether the remote database server is running DB2 version 8 or 9
•
DB2 instance port numbers from the remote database server
•
Process Engine runtime database user (f_sw or alias) password
•
Process Engine maintenance database user (f_maint or alias) password
Make note of the DB2 client database alias created during this task as it will be needed in the
Process Engine installation steps. This information will be entered in response to the prompt for
the database alias name in Process Engine Setup.
To install DB2 client software
To install the DB2 Client, log on as root user (UNIX) or as Administrator (Windows).
Install the DB2 Administration Client or the DB2 Run-Time Client. Process Engine needs a 32-bit
DB2 Client instance.
NOTE On Windows, an DB2 Client instance is automatically created during installation of the
client software.
When the installation is finished, view the status report or go to /tmp (UNIX) or \My
Documents\DB2log (Windows) to view all DB2 install logs to ensure there are no errors.
To create DB2 users and groups (Process Engine, UNIX only)
Create the following operating system user and group accounts for the DB2 Client instance, but
only if Process Engine will be installed on UNIX.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
127
Task 7c: Verify that DB2 Client Is Installed for IBM FileNet P8
To create DB2 Client instances for Process Engine (UNIX only)
NOTE You can specify your own user and group names, but they must adhere to system and DB2
naming rules.
•
Instance Owner
•
Instance Owner primary group
The instance owner home directory is where the DB2 Client instance will be created.
•
Fenced User
•
Fenced User primary group
The fenced user runs user-defined functions (UDFs) and stored procedures outside the
address space used by the DB2 database.
Each instance must have its own home file system.
Each instance owner must have a unique home directory. All of the files necessary to run the
instance are created in the home directory of the instance owner’s user ID/name.
The instance owner and its primary group are associated with every instance. The instance owner
is assigned during the process of creating the instance.
The primary group of the instance owner automatically becomes the system administration group
for the instance and gains SYSADM authority as a database administrator (DBA) over the
instance. Other user IDs or user names that are members of the primary group of the instance
owner also gain this level of authority.
NOTE The root user cannot act as a DBA. You must log on as the instance owner to act as the
DBA.
When the database authentication type is set to SERVER or SERVER_ENCRYPT, two additional
operating system users must be created on the database server where the DB2 database resides.
You will be provided details in “To create additional DB2 users and groups (Process Engine CLIENT
authentication only)” on page 128.
To create DB2 Client instances for Process Engine (UNIX only)
Depending upon your configuration, create at least one 32-bit DB2 Client instance for Process
Engine.
To create additional DB2 users and groups (Process Engine CLIENT authentication only)
Create the following two additional operating system users with SYSADM authority to access the
DB2 database.
•
Process Engine runtime database user (f_sw or alias)
–
Primary runtime Process Engine database user
–
Used only by the Process Engine software to access the DB2 database.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
128
Task 7c: Verify that DB2 Client Is Installed for IBM FileNet P8
To catalog the DB2 server node
•
Process Engine maintenance database user (f_maint or alias)
–
Process Engine Database maintenance user
–
Mainly used by the customer for database maintenance
Unlike the instance owner user, these users don’t need to have separate file systems for their
home directories.
After creating the new users and setting their group memberships, log off as root user, log on as
each of the new users, and change the password to avoid connection problems the first time
they’re used. For DB2 Client authentication these are the users and passwords that will be
entered into Process Engine Setup to be used by the Process Engine software. Currently, you
must ensure that each Process Engine in a farm environment using DB2 Client authentication has
the same runtime user name.
To catalog the DB2 server node
1. Reboot the server and log on as the instance owner on the Process Engine.
2. Use the db2ca tool, or catalog the DB2 server node as follows:
db2 catalog tcpip node <server alias> remote <server name> server <server side instance
tcpip port #>
For example:
db2 catalog tcpip node aix20nod remote hqvwais20 server 60004
To catalog the Process Engine DB2 databases
Use the db2ca tool, or create aliases for the DB2 database.
For example:
db2 catalog database PEDBAIX at node aix20nod [as <alias name>]
To verify the connection to the DB2 database
Since the DB2 database is located on a remote server, verify that TCP/IP communications have
been configured successfully on both server and client computers.
To do so on a Windows client, you can use the DB2 Configuration Assistant by entering one of the
following commands at a command prompt to connect the DB2 Client to the DB2 database on the
remote database server:
db2ca
db2
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
129
Task 7c: Verify that DB2 Client Is Installed for IBM FileNet P8
To verify the ability to log on to the DB2 database
To verify the ability to log on to the DB2 database
After successfully connecting to the remote DB2 database, check the connection using either the
Command Line Processor (CLP) or db2. For example, launch the Command Line Processor and
enter the following command:
db2 connect to <database_name> user <PE runtime user> using <password>
where:
<database_name> is your Process Engine DB2 database name
<PE runtime user> is the Process Engine runtime user (f_sw or alias)
<password> is the Process Engine runtime user password in the Process Engine database
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
130
Task 7d: Verify the Ability to Connect to the Database
To Verify the Process Engine Database Connection (Oracle)
Task 7d: Verify the Ability to Connect to the Database
Use the procedures in this topic to verify the ability to connect to the database. These procedures
can be executed after initial configuration of the database and immediately prior to installation of
Process Engine software. Execute these steps on the database server or the client according to
whether the database is local to or remote from Process Engine.
To Verify the Process Engine Database Connection (Oracle)
Take the following steps to verify that the Oracle database instance used by Process Engine is
accessible. How you log on to sqlplus will vary, depending upon how you will choose to execute
the SQL scripts. This procedure will verify that you can connect to the Oracle database in the
same way Process Engine Setup will. Make whatever corrections are necessary before
proceeding.
To verify the Process Engine database connection (Oracle)
1. Execute the following at a command prompt:
su - oracle -c "sqlplus"
2. Enter one of the following commands at the SQLPlus prompt, as follows:
•
If the Process Engine pre-installation SQL scripts will be run from Process Engine Setup by
prompting for the sys password, type the following command:
sys/<password> as sysdba
•
If the SQL scripts will be run from Process Engine Setup by using operating system authentication,
type the following command:
/ as sysdba
3. At the prompt, enter the following SQL command:
SQL> select instance_name, host_name, version from v$instance;
The following represents an example of the information returned:
INSTANCE_NAME
---------------HOST_NAME
---------------------------------------------------------------VERSION
----------------p8dbshr
HQVWBUCS
9.2.0.7.0
Where:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
131
Task 7d: Verify the Ability to Connect to the Database
To Verify the Process Engine Database Connection (DB2)
p8dbshr is the instance ORACLE_SID
hqvwbucs is the database server name
9.2.0.7 is the Oracle server version
To Verify the Process Engine Database Connection (DB2)
Verify the connection to the remote DB2 Process Engine database using the DB2 Control Center
tool, or by executing the following commands.
To verify the Process Engine database connection (DB2)
1.
Log on to the DB2 Control Center tool, as follows:
(Windows)
At a command prompt, start the DB2 Command Line Processor by typing the following
command:
db2cmd
and, at the subsequently displayed prompt, enter the following command:
db2
(UNIX)
Log on as the client instance owner and execute the following at a command prompt:
db2
2. At the DB2 prompt, enter the following command:
connect to <database alias> user <f_sw> using <f_sw password>
where:
<database alias> is the alias name of the Process Engine database.
<f_sw> is the Process Engine runtime user, either the default f_sw user or the assigned alias
<f_sw password> is the runtime user’s password.
DB2 will display the database connection information.
Following is an example of the database connection command and the information returned:
db2 => connect to pedbinst user f_sw using fswpassword
Database Connection Information
Database server
= DB2/AIX64 8.2.0
SQL authorization ID = F_SW
Local database alias = PEDBINST
In this example, the database alias is pedbinst, the user is f_sw, and the f_sw user password
is fswpassword.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
132
Task 7d: Verify the Ability to Connect to the Database
To Verify the Process Engine Database Connection (SQL Server)
To Verify the Process Engine Database Connection (SQL Server)
Take the following steps to verify that the SQL Server database instance used by Process Engine is
accessible. You will need to know both the Process Engine database and filegroup names. Make whatever
corrections are necessary before proceeding.
In this example, the database is VWdb and the filegroup name is vwdata_fg. Both the database name and
filegroup name must match what was defined when the database MS SQL server was installed and
configured.
To verify the Process Engine database connection (SQL Server)
1. Log on as a member of the local Administrators group or a user with equivalent permissions. The user
you log on as must also be a database administrator. If the database is remote, the SQL
connection must also be a trusted connection.
2. At a command prompt, enter:
osql -E -D<DSN>
where <DSN> is the ODBC data source name created in “Verify that Microsoft SQL Server Client Is
Installed for IBM FileNet P8” on page 121 for Process Engine use.
This command puts Process Engine into osql interactive mode.
3. At the osql prompt, enter:
1> use <VWdb>
2> go
where <VWdb> is the Process Engine database name created in “Verify that Microsoft SQL Server Is
Installed for IBM FileNet P8” on page 101.
This command verifies that the Process Engine database has been created. If you get another prompt
with no error, you are attached to that database.
4. Verify that the correct Process Engine filegroup was created. At the osql prompt, enter:
1> select substring(groupname,1,20) from sysfilegroups where groupname = '<defined filegroup>'
2> go
where <defined filegroup> is the default filegroup created in “Verify that Microsoft SQL Server Is
Installed for IBM FileNet P8” on page 101.
A listing of the Process Engine filegroups will display, for example:
___________
vwdata_fg
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
133
Task 8a: Configure an Application Server for Content Engine (WebSphere)
To specify the WebSphere environment variables
Task 8a: Configure an Application Server for Content
Engine (WebSphere)
Content Engine requires a profile if it is to be deployed on WebSphere Application Server. A
default profile (called default) is part of the initial WebSphere Application Server installation. You
can use this profile, or create another one.
Do the following procedure to specify the WebSphere environment variable for the JDBC driver
corresponding to the type of database (DB2, Oracle, or SQL Server) where the Global
Configuration Data (GCD) database will reside.
To specify the WebSphere environment variables
1. Refer to the IBM FileNet P8 Hardware and Software Requirements for information on how to
obtain the JDBC driver file for the database type that you need for the GCD or for an object store
you will be creating later. To download this guide from the IBM support page, see “Access IBM
FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
2. Depending on your database types, copy the appropriate JDBC driver file to a directory on the
WebSphere machine.
For example, you can copy the JDBC driver file to one of the following locations:
•
(UNIX) /opt/jars
•
(Windows) C:\jars
CAUTION Do not copy the JDBC driver file to either of the following directories.
•
(UNIX) ...WebSphere/AppServer/lib/ext
•
(Windows) ...WebSphere\AppServer\lib\ext
3. If your WebSphere environment includes managed nodes, do the following:
a. Access the latest Content Engine installation software and extract the file FNDSHelper.jar.
NOTE The FNDSHelper.jar file is in the Content Engine 4.0.1 Service Pack.
b. Copy FNDSHelper.jar to the <WebSphere_Install_Path>/lib/ext directory on each managed
node.
4. If you already have a profile for Content Engine to use, continue at Step 5; or run the command
script at one of the following (default) locations to create a new profile:
•
(AIX) /usr/IBM/WebSphere/AppServer/wasprofile.sh
•
(Other UNIX) /opt/IBM/WebSphere/AppServer/wasprofile.sh
•
(Windows) C:\Program Files\IBM\WebSphere\AppServer\wasprofile.bat
NOTE Remember the profile name, as you will need to specify it when installing Content
Engine.
5. Start the WebSphere administrative console and log on to your profile.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
134
Task 8a: Configure an Application Server for Content Engine (WebSphere)
To specify the WebSphere environment variables
6. Navigate to one of the following:
•
(WebSphere 5.1.x) Environment > Manage WebSphere Variables
•
(WebSphere 6.0.x) Environment > WebSphere Variables
•
(WebSphere 6.1.x) Environment > WebSphere Variables
7. (WebSphere 5.1.x or 6.0.x) Click Cell.
8. (WebSphere 6.1.x) Click Node. From the drop-down list, choose your profile for Content Engine.
9. Depending on your database and the operating system of the WebSphere machine, create a
JDBC environment variable, as shown in the following table, and set its path to the location you
specified in Step 2. Example paths are as follows:
•
(UNIX) /opt/jdbc
•
(Windows) C:\jars
Database
JDBC Environment Variable
SQL Server
MSSQLSERVER_JDBC_DRIVER_PATH
Oracle
ORACLE_JDBC_DRIVER_PATH
DB2
DB2UNIVERSAL_JDBC_DRIVER_PATH
10. Navigate to one of the following:
•
(WebSphere 5.1.x) Environment > Manage WebSphere Variables
•
(WebSphere 6.0.x) Environment > WebSphere Variables
•
(WebSphere 6.1.x) Environment > WebSphere Variables
and then click Node (WebSphere 5.1.x or 6.0.x) or Cell (WebSphere 6.1.x).
11. Repeat Step 9.
12. Navigate to Application server > server1 > Java and Process Management > Process Definition
> Java Virtual Machine, where server1 is the name of the server you created to host Content
Engine.
a. Set the Initial Heap Size to 512 or a desired size.
b. Set the Maximum Heap Size to 1024 or a desired size.
13. Save your changes to the master configuration
14. If any of your object stores will be of a database type that differs from those whose JDBC
environment variables you have already specified in this procedure, return to Step 1; otherwise,
continue at Step 15.
15. Stop and start WebSphere Application Server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
135
Task 8a: Configure an Application Server for Content Engine (WebSphere)
To adjust the WebSphere transaction timeout value (optional)
To adjust the WebSphere transaction timeout value (optional)
Content Engine relies on WebSphere’s transaction-timeout value, whose default may be too short
for some standard or administrative processes (such as adding an expansion product or
upgrading to the latest version of Content Engine). You can increase the value via the WebSphere
administrative console, as follows:
1. Log on to the WebSphere administrative console.
2. Navigate to Servers > Application Servers > server_instance > Transaction Service, where
server_instance is the name of the WebSphere server instance you created for Content Engine.
3. Change the value of the Total transaction lifetime timeout parameter to 600 (seconds) or more.
CAUTION A large enough timeout value is critical if you are upgrading Content Engine from
version 3.5.x; otherwise, the upgrade may fail.
4. Save your change.
To use WebSphere 6.1 federated user repository (optional)
If you want to create a multi-realm installation of Content Engine with WebSphere, you must use
WebSphere 6.1. Earlier releases of WebSphere cannot support multiple user repositories.
WebSphere 6.1’s federated user repository feature provides the ability to map entries from
multiple individual user repositories into a single virtual repository.
NOTE In a change from earlier versions, Content Engine Setup no longer enables or checks the
status of WebSphere’s own internal security. Enabling global security (WebSphere 5.1 and 6.0) or
administrative security (WebSphere 6.1) is now the responsibility of the WebSphere administrator
and can be done anytime before or after running Content Engine Setup. But you must enable
global or administrative security, depending on your version of WebSphere, before putting an IBM
FileNet P8 system into production.
1. Start the WebSphere 6.1 Administrative Console and log on to your profile.
2. Configure federated user repositories. Refer to your WebSphere documentation for detailed
instructions.
NOTE You must enter information about all these user repositories while running Content
Engine Enterprise Manager’s Directory Configuration Wizard, one time for each user
repository. See “To configure directory service authentication” on page 221.
3. Select both Enable administrative security and Enable application security.
CAUTION Do not select Enable Java 2 security as this will add a security layer that Content
Engine cannot address.
4. Confirm that the WebSphere administrative account that you plan to enter into the Content
Engine Setup program is unique and not duplicated in any user repository that will be included
in the federated user repository.
CAUTION Entering a non-unique WebSphere administrative account into Content Engine
Setup could potentially lock you out of your WebSphere 6.1 console as soon as you enable
Administrative Security.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
136
Task 8a: Configure an Application Server for Content Engine (WebSphere)
To use WebSphere 6.1 federated user repository (optional)
5. Stop and start WebSphere Application Server. This will turn on administrative security.
Important points to remember if you have configured federated user repository:
•
When you run Content Engine Setup and you are asked which components to install, do not
select the Application Server Authentication Provider component, as this will replace and
overwrite your existing federated user repository configuration with whatever WebSphere
authentication settings you subsequently enter into the Content Engine Setup program.
•
As explained in “To configure directory service authentication” on page 221, you will run Enterprise
Manager’s Directory Configuration Wizard once for each of the federated user repositories.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
137
Task 8b: Configure an Application Server for Content Engine (WebLogic)
Configure WebLogic 8.1
Task 8b: Configure an Application Server for Content
Engine (WebLogic)
NOTE This task assumes you have already installed WebLogic Server on the machine where you
are going to install and deploy Content Engine.
Before installing and deploying Content Engine on a WebLogic machine, you need to create a
WebLogic domain and install JDBC drivers. (The drivers must be installed on the WebLogic
machine whether your database is collocated or not.) If you are running WebLogic 8.1.5 on
Windows, you must install a BEA WebLogic patch. You need to install two Microsoft components if
WebLogic is on a Windows machine. The steps are as follows:
1. Depending on your version of WebLogic, do one of the following procedures to create a
WebLogic domain for Content Engine:
•
“To configure WebLogic 8.1.x” on page 138
•
“To configure WebLogic 9.2.x” on page 140
2. Depending on your database, do one of the following procedures to install the JDBC drivers:
•
“To install WebLogic JDBC drivers (DB2)” on page 143
•
“To install WebLogic JDBC drivers (MS SQL Server)” on page 143
•
“To install WebLogic JDBC drivers (Oracle)” on page 144
3. (Windows only) Install the following Microsoft components on the WebLogic machine:
•
Microsoft .NET 2.0 Framework
•
Microsoft Web Services Enhancements 3.0
4. If your authentication provider will utilize single sign-on (SSO) create the LDAP provider now,
using the WebLogic Server Administration Console.
Configure WebLogic 8.1
To configure WebLogic 8.1.x
1. Start WebLogic Configuration Wizard.
2. In the Create or Extend a Configuration screen, click Create a new WebLogic configuration, and
then click Next.
3. In the Select a Configuration Template screen, select Basic WebLogic Server Domain in the
Templates pane, and then click Next.
4. In the Choose Express or Custom Configuration screen, click Express (to accept all default
settings in the template) or Custom (to enable you to modify default settings), and then click
Next.
5. In the Configure Administrative User and Password screen, type an (internal WebLogic)
administrative username (at least eight characters) and password, and then click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
138
Task 8b: Configure an Application Server for Content Engine (WebLogic)
To configure WebLogic 8.1.x
6. In the Configure Server Start Mode and Java SDK screen do the following and then click Next:
a. Click Production Mode.
b. Click BEA Supplied SDKs and select the version of the JRockit SDK specified in the section
Supported platforms for server components > Application Engine/Content Engine >
Application/Web server layer of the IBM FileNet P8 Hardware and Software Requirements.
To download this guide from the IBM support page, see “Access IBM FileNet Documentation,
Compatibility Matrices, and Fix Packs” on page 23.
NOTE When running in Production mode, you must supply a username and a password to
stop and start WebLogic.
7. In the Create WebLogic Configuration screen, type a configuration (domain) name
(FNCEDomain, for example, in this procedure) and location, and then click Create.
8. In the Creating Domain screen, after the message “Configuration Created Successfully!”
appears, click Done.
9. If you haven’t already done so, go to http://java.com/en/download/windows_ie.jsp to download and
install the latest Java Runtime Environment for the operating system where WebLogic runs.
10. Start WebLogic Server Administration Console.
11. (Optional) When running Content Engine Setup (see “Install and Deploy Content Engine” on
page 187) you can have it create a WebLogic authentication provider (by installing the
Application Server Authentication Provider component).
If you want Content Engine Setup to create the provider, skip to Step 12; otherwise, you must
create the provider before running Content Engine Setup. To create the provider:
a. Navigate within the tree view of the WebLogic Server Administration Console to Security >
Realms > myrealm > Providers > Authentication.
b. In the list view, click one of the supported authentication providers and specify the required
configuration information.
12. Do the following to allow or prohibit logons to FNCEDomain by LDAP-authenticated users who
are not in FNCEDomain’s active security realm:
a. Navigate in the tree view to FNCEDomain > Security > Realms > myrealm > Providers >
Authentication > DefaultAuthenticator and click the General tab.
b. In the Control Flag drop-down list, choose SUFFICIENT to allow logons by users not in the
active security realm; choose REQUIRED to prohibit such logons.
c. Click Apply.
13. If WebLogic is using multiple authentication providers in an Active Directory environment of
multi-forest domains, reorder (as needed) the list of providers, as follows, so that the mostfrequently-used provider is first in the list, and the least-frequently-used is last.
NOTE Reordering is necessary to prevent logon failures when IBM FileNet P8 Workplace is
being accessed by many users simultaneously.
a. In WebLogic Server Administration Console, select Security > Realms in the tree view and
then click the realm whose providers you are going to reorder.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
139
Task 8b: Configure an Application Server for Content Engine (WebLogic)
Configure WebLogic 9.2.x
b. Click the Providers:Authentication tab and then click Reorder.
c. Use the arrow buttons to reorder the providers as needed.
d. Save your changes.
14. In the Details tab of the authentication provider to be used by Content Engine, set the values
(specified for performance reasons) that control searches within the authentication provider, as
shown in the following table:
Parameter
Value
Description
Group Membership Searching
unlimited
Group searches are unlimited in depth
Max Group Membership Search Level
0
Only direct group members are found
NOTE If performance problems are encountered, change the Group Membership Searching
parameter value to limited.
15. Specify the following heap sizes for the JVM:
•
Initial Java heap size (-Xms): 512 MB
•
Maximum Java heap size (-Xmx): 1024 MB
Do Step 16 and Step 17 only for WebLogic 8.1.5 on Windows; otherwise, skip to Step 18.
16. Go to http://support.bea.com and download the patch file CR247206_810sp5.jar to a directory on
the Windows WebLogic machine, for example C:\WebLogic815Patch.
17. In the file startWebLogic.cmd for the domain you created, insert the following line immediately
after the first line that starts with set CLASSPATH=...
set LDAP_JAR=C:\WebLogic815Patch\CR247206_810sp5.jar;%CLASSPATH%
18. Continue at one of the following procedures, depending on your database:
•
(DB2) “To install WebLogic JDBC drivers (DB2)” on page 143
•
(MS SQL Server) “To install WebLogic JDBC drivers (MS SQL Server)” on page 143
•
(Oracle) “To install WebLogic JDBC drivers (Oracle)” on page 144
Configure WebLogic 9.2.x
To configure WebLogic 9.2.x
1. Start WebLogic Configuration Wizard.
2. In the Welcome screen, click Create a new WebLogic domain, and then click Next.
3. In the Select Domain Source screen,
a. Click Generate a domain configured automatically to support the following BEA products.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
140
Task 8b: Configure an Application Server for Content Engine (WebLogic)
To configure WebLogic 9.2.x
b. Select the WebLogic Server (Required) check box, if it isn’t already selected.
c. Click Next.
4. In the Configure Administrator User and Password screen, specify an (internal WebLogic)
administrative username (at least eight characters), a password, a description, and then click
Next.
5. In the Configure Server Start Mode and Java TM Development Kit (JDK) screen do the following,
and then click Next:
a. Click Production Mode and BEA Supplied SDKs.
b. Refer to the section Supported platforms for server components > Application Engine/
Content Engine > Application/Web server layer of the IBM FileNet P8 Hardware and
Software Requirements for the supported version of JRockit SDK or the JDK, depending on
the operating system where WebLogic is hosted. To download this guide from the IBM
support page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs”
on page 23.
c. Select one of the following, depending on the operating system where WebLogic is hosted:
•
(Windows) The version of the JRockit SDK specified in the Third Party Support
Information section of the IBM FileNet P8 Hardware and Software Requirements. To
download this guide from the IBM support page, see “Access IBM FileNet Documentation,
Compatibility Matrices, and Fix Packs” on page 23.
•
(AIX) IBM SDK 1.5.0 at /usr/java5
6. In the Customize Environment and Services Settings screen, click Yes, and then click Next.
7. In the Configure the Administration Server screen, accept the default values for the each field,
including SSL not enabled, and then click Next.
8. In the Configure Managed Servers screen, click Next.
9. In the Configure Machines screen, click Next.
10. In the Review WebLogic Domain screen, review the information and click Next.
11. In the Create WebLogic Domain screen, type a domain name (FNCEDomain, for example, in this
procedure) and location, and then click Create.
12. In the Creating Domain screen, after the message “Domain Created Successfully!” appears,
click Done.
13. Start WebLogic Server Administration Console.
14. (Optional) When running Content Engine Setup (see “Install and Deploy Content Engine” on
page 187) you can have it create a WebLogic authentication provider (by installing the
Application Server Authentication Provider component).
NOTE In some situations (for example, if you have a single-sign-on provider, such as Netegrity
SiteMinder), Content Engine Setup cannot configure a WebLogic authentication provider.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
141
Task 8b: Configure an Application Server for Content Engine (WebLogic)
To configure WebLogic 9.2.x
If you want Content Engine Setup to create the provider, skip to Step 15; otherwise, you must
create the provider before running Content Engine Setup. To create the provider:
a. Navigate within the tree view of the WebLogic Server Administration Console to Services >
Security Realms.
b. In the list view, click myrealm, click the Providers tab, and then click New.
c. Specify the required configuration information for the authentication provider.
d. In the Provider Specific tab, set the values (specified for performance reasons) that control
searches within the authentication provider, as shown in the following table:
Parameter
Value
Description
Group Membership Searching
unlimited
Group searches are unlimited in depth
Max Group Membership Search Level
0
Only direct group members are found
NOTE If performance problems are encountered, change the Group Membership
Searching parameter value to limited.
15. Do the following to allow or prohibit logons to FNCEDomain by LDAP-authenticated users in the
DefaultAuthenticator who are not in FNCEDomain’s active security realm:
a. Start WebLogic Server Administration Console and navigate in the tree view to
FNCEDomain > Security > Realms > myrealm > Providers > DefaultAuthenticator.
b. In the Control Flag drop-down list, choose SUFFICIENT to allow logons by users not in the
active security realm (such as users in your authentication domain); choose REQUIRED to
prohibit such logons.
If you choose REQUIRED, all the users you wish to authenticate for Content Engine must
exist not only in the LDAP directory, but also exist as WebLogic users who are in the
Default Authenticator provider.
c. Click Apply.
16. If WebLogic is using multiple authentication providers in an Active Directory environment of
multi-forest domains, reorder (as needed) the list of providers so that the most-frequently-used
provider is first in the list, and the least-frequently-used is last:
a. In WebLogic Server Administration Console, navigate in the tree view to FNCEDomain >
Security > Realms > myrealm > Providers > Authentication Providers.
b. Click Re-order the Configured Authentication Providers.
c. Use the arrow buttons to reorder the providers as needed.
d. Click OK.
NOTE Reordering is necessary to prevent logon failures when IBM FileNet P8 Workplace is
being accessed by many users simultaneously.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
142
Task 8b: Configure an Application Server for Content Engine (WebLogic)
Install JDBC drivers
17. Specify the following heap sizes for the JVM:
•
Initial Java heap size (-Xms): 512 MB
•
Maximum Java heap size (-Xmx): 1024 MB
18. Continue at one of the following procedures, depending on your database:
•
(DB2) “To install WebLogic JDBC drivers (DB2)” on page 143
•
(MS SQL Server) “To install WebLogic JDBC drivers (MS SQL Server)” on page 143
•
(Oracle) “To install WebLogic JDBC drivers (Oracle)” on page 144
Install JDBC drivers
To install WebLogic JDBC drivers (DB2)
1. Obtain the latest version of the Redistributable DB2 JDBC Driver Type 4 driver v8 from the IBM web
site (http://www.ibm.com) by searching for “JDBC Type 4”.
2. Add the following JAR files to the WebLogic classpath:
•
db2jcc.jar
•
db2jcc_license_cu.jar
For example,
set CLASSPATH=%CLASSPATH%;c:\db2\jdbc\db2jcc.jar;c:\db2\jdbc\db2jcc_license_cu.jar
3. Stop and then start WebLogic Server.
To install WebLogic JDBC drivers (MS SQL Server)
1. Download and unzip Microsoft SQL Server Driver 2005 JDBC Driver from Microsoft Support to
a directory <jdbc_path> on your application server machine, such as:
•
(UNIX) /opt/jars
•
(Windows) C:\jars
2. (WebLogic on Windows) Edit the file startWebLogic.cmd (by default, in the directory
C:\bea\user_projects\domains\FNCEDomain) for the WebLogic domain you created, as follows:
•
(WebLogic 8.1.5) Edit the file startWebLogic.cmd by inserting the following two lines
immediately after the first occurrence of the line CLASSPATH=...
set JDBC_PATH=<jdbc_path>\sqljdbc_1.0\enu\sqljdbc.jar
set CLASSPATH=%JDBC_PATH%;%LDAP_JAR%;%CLASSPATH%
•
(WebLogic 8.1.6) Edit the file startWebLogic.cmd by inserting the following two lines
immediately after the first occurrence of the line CLASSPATH=...
set JDBC_PATH=<jdbc_path>\sqljdbc_1.1\enu\sqljdbc.jar
set CLASSPATH=%JDBC_PATH%;%CLASSPATH%
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
143
Task 8b: Configure an Application Server for Content Engine (WebLogic)
To install WebLogic JDBC drivers (Oracle)
•
(WebLogic 9.2.x) Edit the file startWebLogic.cmd by inserting the following two lines immediately
after the first occurrence of the line CLASSPATH=...
set JDBC_PATH=<jdbc_path>\sqljdbc_1.0\enu\sqljdbc.jar
set CLASSPATH=%JDBC_PATH%;%CLASSPATH%
3. (WebLogic on AIX) Add the following line to the file setDomainEnv.sh file:
JAVA_OPTIONS="$JAVA_OPTIONS -Dcom.sun.xml.namespace.QName.useCompatibleSerialVersionUID=1.0"
4. (WebLogic on UNIX) Edit the file startWebLogic.sh by inserting the following two lines
immediately after the first occurrence of the line CLASSPATH=...
JDBC_PATH=<jdbc_path>/sqljdbc_1.0/enu/sqljdbc.jar
CLASSPATH=$JDBC_PATH:$CLASSPATH
5. Stop and then start WebLogic Server.
To install WebLogic JDBC drivers (Oracle)
1. Check to see if the Oracle JDBC Driver file is already on your WebLogic machine by searching
for ojdbc##.jar in the <wls_install_path>/server/lib directory, where <wls_install_path> is the
WebLogic Server installation path, such as C:\bea\weblogic92.
2. If no Oracle JDBC Driver file is present, download the file (the one that matches the version of
the JDK on your WebLogic machine) from the Oracle JDBC Driver Downloads web site (http://
www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html) to a directory on the WebLogic
machine.
NOTE If you intend to install AddOns (extensions to IBM FileNet P8 core components), and
your Content Engine database will be Oracle, your Oracle JDBC Driver file requirements may
be more restrictive. For the required version and patch number, see the IBM FileNet P8
Hardware and Software Requirements. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
3. From the Oracle web site, apply the patches Oracle Patch Ojdbc14.
4. Edit the file startWebLogic.cmd in your WebLogic domain <WL_DomainName> by adding the
following line immediately after the first line that starts with set CLASSPATH.
•
(Windows)
set JDBC_PATH=<jdbc_path>\ojdbc##.jar
set CLASSPATH=%JDBC_PATH%;%CLASSPATH%;
•
(UNIX)
JDBC_PATH=<jdbc_path>/ojdbc##.jar
CLASSPATH=$JDBC_PATH:$CLASSPATH;
5. Stop and then start WebLogic Server.
Adjust transaction timeout value
To adjust the WebLogic 8.1.x transaction timeout value (optional)
On WebLogic 8.1.x, Content Engine relies on the transaction-timeout value, whose default may be
too short for some standard or administrative processes (such as adding an expansion product or
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
144
Task 8b: Configure an Application Server for Content Engine (WebLogic)
To adjust the WebLogic 9.2 transaction timeout value (optional)
upgrading to the latest version of Content Engine). You can increase the value via WebLogic
Server Administration Console, as follows:
1. Log on to WebLogic Server Administration Console.
2. On the left-side pane, open the Services > JTA node.
3. Change the value of Timeout Seconds to at least 600 seconds.
4. Save your change.
To adjust the WebLogic 9.2 transaction timeout value (optional)
On WebLogic 9.2, Content Engine relies on the transaction-timeout value, whose default may be
too short for some standard or administrative processes (such as adding an expansion product or
upgrading to the latest version of Content Engine). You can increase the value via WebLogic
Server Administration Console, as follows:
1. Log on to WebLogic Server Administration Console.
2. Click Lock and Edit.
3. On the left-side pane, open the Services > JTA node.
4. Change the value of Timeout Seconds to at least 600 seconds.
5. Save your change.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
145
Task 8c: Configure an Application Server for Content Engine (JBoss)
To configure JBoss for Content Engine
Task 8c: Configure an Application Server for Content
Engine (JBoss)
NOTE This task assumes you have already installed JBoss Application Server on the machine
where you are going to install and deploy Content Engine.
To configure JBoss for Content Engine
1. Navigate to the JBoss directory JBOSS_DIST/server, which contains configuration file sets.
2. Create a new configuration file set by copying the default configuration file set to a new directory
(called server1 in this procedure) within the server directory.
3. Edit the run.conf configuration file, located at JBOSS_DIST/bin, as follows:
a. Add a line to specify the path to the JDK provided by JBoss, as shown in the following
example:
JAVA_HOME="<path_to_Java_JDK>"
b. In the JAVA_OPTS line, change the -Xms and -Xmx values from
-Xms128m -Xmx512m
to
-Xms512m -Xmx1024m
c. Save your edits.
4. Open the file login-config.xml for editing. This file is typically at .../server/myserver/conf, where
myserver is the name of the JBoss server instance.
a. In the <!DOCTYPE declaration, change
"http://www.jboss.org/j2ee/dtd/security_config.dtd"
to
"<jboss_install_dir>/docs/dtd/security_config.dtd"
where <jboss_install_dir is the directory where JBoss is installed.
b. Save your edit.
5. (DB2 only) Download the DB2 JDBC Driver referenced in the IBM FileNet P8 Hardware and
Software Requirements and place it in CLASSPATH by copying the driver to directory
JBOSS_DIST/server/server1/lib. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
6. (MS SQL Server only) Download the Microsoft SQL Server 2005 JDBC Driver, sqljdbc.jar,
referenced in the IBM FileNet P8 Hardware and Software Requirements and place it in
CLASSPATH by copying it to directory JBOSS_DIST/server/server1/lib. To download this guide
from the IBM support page, see “Access IBM FileNet Documentation, Compatibility Matrices, and
Fix Packs” on page 23.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
146
Task 8c: Configure an Application Server for Content Engine (JBoss)
Manually Configure JBoss Data Sources for the GCD (Optional)
7. (Oracle only) Download the Oracle JDBC Driver, ojdbc14.jar, that is referenced in the IBM
FileNet P8 Hardware and Software Requirements and place it in CLASSPATH by copying it to
directory JBOSS_DIST/server/server1/lib. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
8. If it isn’t already running, start JBoss as follows, and leave the command window open:
•
(UNIX) ./run.sh -c server1
•
(Windows) run.bat -c server1
Manually Configure JBoss Data Sources for the GCD (Optional)
The Global Configuration Data (GCD) requires data sources for database connectivity. Create the
data sources manually, as shown in the following procedures; or have Content Engine Setup
create them, in which case skip these procedures and go to “Installation Tasks” on page 156.
The procedures for creating data sources assume the following environment for your JBoss
installation (substitute your own environment in its place where applicable):
•
JBOSS_DIST is the home directory of your JBoss installation
•
server1 is the JBoss server instance on which you will install and deploy Content Engine.
To configure JBoss 4.0.x database connectivity (DB2)
1. Copy the files FNGCD-Unix-ds.xml and FNGCD-Unix-xa-ds.xml in directory JBOSS_DIST/
samples to JBOSS_server/server1/deploy and rename the file FNGCD-ds.xml and FNGCD-xads.xml, respectively.
2. In the non-XA data source file, edit the section titled <sample datasource for DB2> in the file
FNGCD-ds.xml:
a. Set the content of the <jndi-name> element to FNGCDDS.
b. Set the content of the <connection-url> element to
jdbc:db2://<JBoss_host_name>:<DB_port>/<dbname>
where <dbname> is the name of the database that will contain the GCD.
c. Change the content of the <user-name> and <password> elements to that of the user and
password of the tablespace to be used for the GCD.
d. Save your edits.
3. In the XA data source file, edit the section titled <sample datasource for DB2> in the file
FNGCD-Unix-xa-ds.xml:
a. Set the content of the <jndi-name> element to FNGCDDSXA.
b. Set the content of the <xa-datasource-property name="ServerName"> element to the IP
address of the machine where DB2 is installed.
c. Set the content of the <xa-datasource-property name="DatabaseName"> element to the
name of the database that will contain the GCD.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
147
Task 8c: Configure an Application Server for Content Engine (JBoss)
To configure JBoss 4.0.x database connectivity (MS SQL Server)
d. Set the content of the <xa-datasource-property name="PortNumber"> element to the port
used by DB2.
e. Change the content of the <user-name> and <password> elements to that of the user and
password of the tablespace to be used for the GCD.
f.
Save your edits.
To configure JBoss 4.0.x database connectivity (MS SQL Server)
1. Copy the files FNGCD-Unix-ds.xml and FNGCD-Unix-xa-ds.xml in directory JBOSS_DIST/
samples to JBOSS_server/server1/deploy and rename the file FNGCD-ds.xml and FNGCD-xads.xml, respectively.
2. In the non-XA data source file, edit the section titled <sample datasource for MS SQLServer> in
the file FNGCD-ds.xml:
a. Set the content of the <jndi-name> element to FNGCDDS.
b. Set the content of <connection-url> element to
jdbc:sqlserver://<dbserver>:<db_port>;DatabaseName=<dbname>
where <dbname> is the name of the database that will contain the GCD.
c. Change the content of the <user-name> and <password> elements to that of the user and
password of the database to be used for the GCD.
d. Save your edits.
3. In the XA data source file, edit the section titled <sample datasource for MS SQLServer> in the
file FNGCD-xa-ds.xml:
a. Set the content of the <jndi-name> element to FNGCDDSXA.
b. Set the content of the <xa-datasource-property name="ServerName"> element to the IP
address of the machine where MS SQL Server is installed.
c. Set the content of the <xa-datasource-property name="DatabaseName"> element to the
name of the database that will contain the GCD.
d. If MS SQL Server is not using the default port number (1433), add this XML element:
<xa-datasource-property name="PortNumber">dbport</xa-datasource-property>
where dbport is the port number used by the MS SQL Server database instance.
e. Change the content of the <user-name> and <password> elements to that of the user and
password of the database to be used for the GCD.
f.
Save your edits.
To configure JBoss 4.0.x database connectivity (Oracle)
1. Copy the files FNGCD-Unix-ds.xml and FNGCD-Unix-xa-ds.xml in directory JBOSS_DIST/
samples to JBOSS_server/server1/deploy and rename the file FNGCD-ds.xml and FNGCD-xads.xml, respectively.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
148
Task 8c: Configure an Application Server for Content Engine (JBoss)
Encrypt LDAP Password (Optional)
2. In the non-XA data source file, edit the section titled <sample datasource for Oracle> in the file
FNGCD-Unix-ds.xml:
a. Set the content of the <jndi-name> element to FNGCDDS.
b. Set the content of <connection-url> element to
jdbc:oracle:thin:@<dbserver>:<db_port>:<Oracle_SID>
where dbserver is the name of the database machine and port is the port used by the
database that will contain the GCD.
c. Change the content of the <user-name> and <password> elements to that of the user and
password of the tablespace to be used for the GCD.
d. Save your edits.
3. In the XA data source file, edit the section titled <sample datasource for Oracle> in the file
FNGCD-xa-ds.xml:
a. Set the content of the <jndi-name> element to FNGCDDSXA.
b. Set the content of the <xa-datasource-property name="URL"> element to
jdbc:oracle:thin:@<dbserver>:<db_port>:<Oracle_SID>
where dbserver is the name of the database machine and port is the port used by the
database that will contain the GCD.
c. Change the content of the <xa-datasource-property name=”User”> and <xa-datasourceproperty name=”Password”> elements to that of the user and password of the tablespace to
be used for the GCD.
d. Save your edits.
Encrypt LDAP Password (Optional)
Do the following procedure to encrypt the password used by JBoss to query an LDAP directory
server.
NOTES
•
Substitute your own value (at least eight characters) for the Salt attribute in place of the value
twasalt12 used in this procedure.
•
Substitute your own obscuring and encrypted LDAP passwords in place of the passwords
Magic and Secret used in this procedure.
•
Assume the path to the JBoss conf directory is .../server/myserver/conf, where myserver is the
name of the JBoss server. Use your own value in place of myserver.
To encrypt the LDAP password
1. Edit the file jboss-service.xml in the conf directory by adding the following text at the end of the
Security section of the file, just before the Transactions section:
<mbean code="org.jboss.security.plugins.JaasSecurityDomain"
name="jboss.security:service=JaasSecurityDomain,domain=ServerMasterPassword">
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
149
Task 8c: Configure an Application Server for Content Engine (JBoss)
Encrypt GCD Data Source Passwords (Optional)
<constructor>
<arg type="java.lang.String" value="ServerMasterPassword"/>
</constructor>
<!-- The opaque master password file used to decrypt the encrypted database
password key -->
<attribute name="KeyStorePass">
{CLASS}org.jboss.security.plugins.FilePassword:${jboss.server.home.dir}/
conf/server.password
</attribute>
<attribute name="Salt">twsalt12</attribute>
<attribute name="IterationCount">13</attribute>
</mbean>
2. Choose an obscuring password in place of Magic, the password used in this procedure.
3. Run the following commands from the command prompt to create the server.password file:
cd %JBOSS_HOME%\server\myserver\conf
If an old server.password file exists, delete it:
del server.password
Create the server.password file by running the following command (without carriage returns):
java -cp ..\lib\jbosssx.jar org.jboss.security.plugins.FilePassword twsalt12 13
“Magic” server.password
4. Run the following two commands, substituting your obscuring password and real LDAP
password in place of Magic and Secret, respectively:
cd %JBOSS_HOME%\server\myserver\conf
java -cp ..\lib\jbosssx.jar org.jboss.security.plugins.PBEUtils twsalt12 13 “Magic”
“Secret”
Copy to the clipboard the encrypted password ( Fm/hKKlyXZj, for example) displayed on the
command console.
5. Edit login-config.xml in the conf directory, as follows:
a. Paste the encrypted password ( Fm/hKKlyXZj, for example) for LdapExtLoginModule, as
shown below:
<module-option name="bindCredential">Fm/hKKlyXZj</module-option>
b. Add the following XML element below the line you added in step 4a:
<module-option name="jaasSecurityDomain">
jboss.security:service=JaasSecurityDomain,domain=ServerMasterPassword
</module-option>
Encrypt GCD Data Source Passwords (Optional)
To encrypt the GCD passwords (XA and non-XA), do the procedure “To encrypt data source
passwords” on page 284 in “Configure Content Engine Application Server Database Connectivity (JBoss
4.0.x)” on page 281.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
150
Task 9a: Configure an Application Server for Application Engine (WebSphere)
To Configure WebSphere for Application Engine
Task 9a: Configure an Application Server for
Application Engine (WebSphere)
You must install WebSphere Application Server on the machine where you are going to install and
deploy Application Engine.
Application Engine can be collocated with Content Engine as long as the server is appropriately
sized. However, each instance of the Application Engine and each instance of the Content Engine
must run in its own JVM. For assistance in sizing your system, contact your service
representative.
To Configure WebSphere for Application Engine
1. Verify that the application server is set to use JSESSIONID as default cookie name.
To avoid forcing end users to log in individually applets such as Process Designer, Search
Designer, and Process Simulator, configure the application server to use JSESSIONID as
cookie name, and not use application-unique cookie names. Using JSESSIONID is typically
the default setting for the supported application servers. Application Engine uses cookie
names for passing session information between Application Engine and the client browser.
2. The Task “Configure Application Engine (WebSphere)” will ask you to set the Initial and
Maximum Heap Size. Refer to your application server vendor's recommendation for Initial and
Maximum heap size values. For IBM specific recommendations, see the IBM FileNet P8
Platform Performance Tuning Guide. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 21.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
151
Task 9b: Configure an Application Server for Application Engine (WebLogic)
To Configure WebLogic for Application Engine
Task 9b: Configure an Application Server for
Application Engine (WebLogic)
You must install WebLogic Application Server on the machine where you are going to install and
deploy Application Engine.
Application Engine can be collocated with Content Engine as long as the server is appropriately
sized. However, each instance of the Application Engine and each instance of the Content Engine
must run in its own JVM. For assistance in sizing your system, contact your service
representative.
To Configure WebLogic for Application Engine
1. Verify that the application server is set to use JSESSIONID as default cookie name.
To avoid forcing end users to log in individually applets such as Process Designer, Search
Designer, and Process Simulator, configure the application server to use JSESSIONID as
cookie name, and not use application-unique cookie names. Using JSESSIONID is typically
the default setting for the supported application servers. Application Engine uses cookie
names for passing session information between Application Engine and the client browser.
2. Create a WebLogic domain before installing and deploying Application Engine. Refer to your
BEA documentation for detailed instructions.
3. Make a backup copy of the application server startup script.
Backup startWebLogic.cmd for Windows or startWebLogic.sh for UNIX.
NOTE If you are not using a WebLogic domain, backup startWLS.cmd for Windows or
startWLS.sh for UNIX.
4. Edit the application server startup script MEM_ARGS settings.
Adjusting this setting prevents the application server from running out of memory, a condition
in which users would not be able to log in to Workplace.
NOTE If the MEM_ARGS variable doesn't exist, add it to the startup script.
•
For all systems except those using JRockit JAVA.
Append the following to the MEM_ARGS variable:
–XX:MaxPermSize=<size>m
where <size> is the value, in MB, of the MaxPermSize.
Refer to your application server vendor's recommendation for Initial and Maximum heap
size values. For IBM specific recommendations, see the IBM FileNet P8 Platform
Performance Tuning Guide. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
For systems using JRockit JAVA.
Append the following to the MEM_ARGS variable:
–Xgc:gencon
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
152
Task 9b: Configure an Application Server for Application Engine (WebLogic)
To Configure WebLogic for Application Engine
5. (WebLogic 8.1.5 on Windows with container-managed authentication) Install the patch file
CR247206_810sp5.jar from http://support.bea.com.
a. Go to http://support.bea.com and download the patch file CR247206_810sp5.jar to a directory
on the Windows WebLogic machine, for example C:\WebLogic815Patch.
b. In the file startWebLogic.cmd for the domain you created, insert the following line
immediately after the first line that starts with set CLASSPATH=...
set LDAP_JAR=C:\WebLogic815Patch\CR247206_810sp5.jar;%CLASSPATH
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
153
Task 9c: Configure an Application Server for Application Engine (JBoss)
To Configure JBoss for Application Engine
Task 9c: Configure an Application Server for
Application Engine (JBoss)
You must install JBoss Application Server on the machine where you are going to install and
deploy Application Engine.
Application Engine can be collocated with Content Engine as long as the server is appropriately
sized. However, each instance of the Application Engine and each instance of the Content Engine
must run in its own JVM. For assistance in sizing your system, contact your service
representative.
To Configure JBoss for Application Engine
1. Verify that the application server is set to use JSESSIONID as default cookie name.
To avoid forcing end users to log in individually applets such as Process Designer, Search
Designer, and Process Simulator, configure the application server to use JSESSIONID as
cookie name, and not use application-unique cookie names. Using JSESSIONID is typically
the default setting for the supported application servers. Application Engine uses cookie
names for passing session information between Application Engine and the client browser.
2. Make a backup copy of the application server startup script.
Backup run.bat (Windows) or run.sh (UNIX).
3. Edit the application server startup script Java settings.
a. Add a line to specify the path to the JDK provided by JBoss, as shown in the following
example (Windows):
set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_06
NOTE If your JDK is different from version 1.5.0, substitute your version for the one listed
above.
b. Update the JAVA_OPTS memory settings.
Adjusting this setting prevents the application server from running out of memory, a
condition in which users would not be able to log in to Workplace.
In the JAVA_OPTS line, change the -Xms and -Xmx values (bold) for your configuration.
Example (Windows):
set JAVA_OPTS=%JAVA_OPTS% -Xms128m -Xmx512m
Refer to your application server vendor's recommendation for Initial and Maximum heap
size values. For IBM specific recommendations, see the IBM FileNet P8 Platform
Performance Tuning Guide. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
c. Save your edits.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
154
Task 9c: Configure an Application Server for Application Engine (JBoss)
To Configure JBoss for Application Engine
4. Start JBoss as follows, and leave the command window open:
•
(UNIX) ./run.sh
•
(Windows) run.bat
5. (Optional) Disable JBoss logging.
In development mode, JBoss creates a large number of HTTP Access, “INFO”, “DEBUG” and
“TRACE” log messages. This can cause unexpected behavior in the deployed IBM FileNet
software. Using the following procedure, you can limit this type of excessive JBoss logging.
NOTE When logging is disabled, error messages will still be displayed in the JBoss console.
a. Edit the log4j.xml file (<JBOSS_home>/server/default/conf/log4j.xml).
i.
Change all threshold values and priority values from "INFO", "DEBUG", or "TRACE" to
"ERROR".
ii.
Delete or comment out the "Preserve messages in a local file" to turn off the server log.
b. To turn off HTTP access logging, open jboss-service.xml with a text editor and delete or
comment out the "Access logger" section.
Location of jboss-service.xml:
•
JBoss 4.05 - <JBoss_Home>/server/default/deploy/jbossweb-tomcat55.sar/META-INF
c. Open web.xml and change the logVerbosityLevel to "FATAL".
Location of web.xml:
•
d.
JBoss 4.05 - <JBoss_Home>/server/default/deploy/jbossweb-tomcat55.sar/conf
Restart the JBoss server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
155
Installation Tasks
To install the core IBM FileNet P8 Platform components
Installation Tasks
To install the core IBM FileNet P8 Platform components
1. Install IBM FileNet P8 Platform documentation on your application server. Do one of the
following:
•
Task 10a on page 158 (WebSphere)
•
Task 10b on page 163 (WebLogic)
•
Task 10c on page 169 (JBoss)
2. Install Content Search Engine. Do Task 11 on page 174.
3. Set up Content Engine. Do the following:
a. Install and deploy Content Engine. Do Task 12 on page 187.
b. Install Content Engine software updates. Do Task 13 on page 204.
c. Install Process Engine Client file updates on Content Engine servers. Do Task 14 on page
205.
d. Redeploy Content Engine. Do Task 15 on page 208.
e. Complete Post-Install Content Engine Configuration. Do Task 16 on page 212.
f.
Install Enterprise Manager. Do Task 17 on page 217.
g. Establish the IBM FileNet P8 Domain and Global Configuration Data (GCD). Do Task 18 on
page 221.
h. Configure database connectivity on the Content Engine application server. Do one of the
following:
•
Task 19a on page 227 (WebSphere 5.1.x)
•
Task 19b on page 240 (WebSphere 6.0.x)
•
Task 19c on page 254 (WebSphere 6.1.x)
•
Task 19d on page 270 (WebLogic 8.1.x)
•
Task 19e on page 275 (WebLogic 9.2.x)
•
Task 19f on page 281 (JBoss 4.0.x)
i.
Create object stores. Do Task 20 on page 286.
j.
Verify the Content Engine installation. Do Task 21 on page 291.
4. Install Content Search Engine Software Updates. Do Task 22 on page 293.
5. Set up Process Engine. Do the following:
a. Install Process Engine. Do one of the following:
•
Task 23a on page 294 (Windows 2003)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
156
Installation Tasks
To install the core IBM FileNet P8 Platform components
•
Task 23b on page 311 (Sun Solaris)
•
Task 23c on page 325 (AIX)
•
Task 23d on page 337 (HP-UX)
b. Install Process Engine Software Updates. Do Task 24 on page 350.
c. Install the Latest Content Engine Client Files on Process Engine Servers. Do Task 25 on
page 351.
d. Configure Process Task Manager. Do Task 26 on page 352.
e. Complete Process Engine Configuration. Do Task 27 on page 354.
6. Set up Application Engine. Do the following:
a. Install Application Engine. Do Task 28 on page 357.
b. Configure Application Engine. Do one of the following:
•
Task 29a on page 369 (WebSphere)
•
Task 29b on page 388 (WebLogic)
•
Task 29c on page 396 (JBoss)
c. Install Application Engine Software Updates. Do Task 30 on page 398.
d. Install Content Engine Client file updates. Do Task 31 on page 399.
e. Install Process Engine Client file updates. Do Task 32 on page 400.
f.
Deploy Application Engine. Do one of the following:
•
Task 33a on page 403 (WebSphere)
•
Task 33b on page 409 (WebLogic)
•
Task 33c on page 412 (JBoss)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
157
Task 10a: Install IBM FileNet P8 Platform Documentation (WebSphere)
Overview of Procedures
Task 10a: Install IBM FileNet P8 Platform
Documentation (WebSphere)
This topic covers the installation, and (if necessary) search-related reindexing of your IBM FileNet
P8 Platform documentation on a WebSphere application server. Because the IBM FileNet P8
Platform documentation includes a Java-based full-text search engine, it must be run as a webbased application.
You must install the documentation for IBM FileNet P8 Platform and its expansion products on a
web application server if you intend to access online help from within any IBM FileNet P8
applications (for example, Workplace, Enterprise Manager, and Process Task Manager) or use the
full-text search feature.
NOTES
•
You may collocate the IBM FileNet P8 documentation on an IBM FileNet P8 Application Engine
or IBM FileNet P8 Content Engine machine.
•
To ensure proper documentation search functionality, make sure that JavaScript™ support is
enabled on each user's browser client.
•
Because of the number of possible network and web configurations, contact your network or
web administrator for specific system, software, and security requirements.
•
The requirements described in this topic may also exist for associated custom application
help, or for any customizations you may have applied to the IBM FileNet P8 documentation.
For further details on customizing or localizing IBM FileNet P8 documentation, see the file
ecm_help/transkit/P8DocTransKit.htm on the IBM FileNet P8 Documentation package or
wherever you install the IBM FileNet P8 documentation.
•
If you are upgrading your IBM FileNet P8 Platform installation and have downloaded a refresh
of the documentation from the IBM Information Management support page on www.ibm.com, see
“Upgrade IBM FileNet P8 Documentation” on page 496 for instructions on upgrading the
documentation.
•
Under WebSphere, IBM FileNet P8 documentation must be installed and deployed as a WAR
file (ecm_help.war). You cannot deploy as an EAR file because in that case the IBM FileNet P8
help remains packaged and the internal documentation search engine will not function as
expected.
Overview of Procedures
Perform the procedures in the following subtopics in the order presented, unless otherwise
directed below:
•
“Install IBM FileNet P8 Platform Documentation” on page 159 -- Begin here if you are installing the
IBM FileNet P8 Platform documentation for the first time.
•
“Install Expansion Product Documentation” on page 159 -- Begin here if you have already installed
the IBM FileNet P8 Platform documentation and need to add on the documentation for IBM
FileNet expansion products (for example, Process Analyzer, Process Simulator, IBM FileNet
P8 eForms, Content Federation Services for Image Services, or IBM FileNet P8 Portlets).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
158
Task 10a: Install IBM FileNet P8 Platform Documentation (WebSphere)
Install IBM FileNet P8 Platform Documentation
•
“Update Documentation Search Index” on page 161 -- Perform this procedure only after you have
added on documentation for your expansion products. Otherwise, if you install only IBM
FileNet P8 Platform documentation, which has a baseline search index, you may skip this
procedure.
•
“Complete and Verify the Documentation Installation” on page 162 -- Perform this final procedure in
all cases, but only after you have installed the IBM FileNet P8 Platform documentation, added
on documentation for your expansion products, and (where required) regenerated the search
index.
Install IBM FileNet P8 Platform Documentation
This procedure establishes the web application for documentation associated with the IBM FileNet
P8 Platform. It assumes that your WebSphere application server is already installed and
operational.
NOTE Depending on your operating system and WebSphere versions, your WebSphere screens
may be slightly different than those documented in the examples below.
To install the IBM FileNet P8 Platform documentation on WebSphere
1. Access the IBM FileNet P8 Platform Documentation package.
2. Copy the IBM FileNet P8 ecm_help.war file from the IBM FileNet P8 documentation package to
a location on the local hard drive (for example, .../p8docs/ecm_help).
3. If it is not running, start the WebSphere server, and start the WebSphere administrative console.
4. From the WebSphere administrative console, select Applications > Install a New Application.
5. Enter the Local Path location or Browse to the ecm_help.war file.
6. Enter a Context Root, then click Next and follow all WebSphere installation screens.
NOTE The Context Root (for example, ecm_help) and installation directory can be userdefined, so substitute your actual values when prompted if you do not want to take the
WebSphere default values.
7. Save your changes to the WebSphere Master Configuration.
8. Continue as follows:
•
If you need to add documentation for any IBM FileNet P8 expansion product, go on to the
procedure in the following topic, “Install Expansion Product Documentation” on page 159.
•
If you have no further documentation to install, go on to the procedure in the topic “Complete and
Verify the Documentation Installation” on page 162.
Install Expansion Product Documentation
Use the procedure in this topic to install documentation for expansion products onto an existing
IBM FileNet P8 Platform documentation server. If you have no such documentation to add on, skip
to the procedure “Complete and Verify the Documentation Installation” on page 162.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
159
Task 10a: Install IBM FileNet P8 Platform Documentation (WebSphere)
To install expansion product documentation
To install expansion product documentation
1. Determine the expansion product documentation media source or location:
•
For most expansion products, use the Documentation package included as part of the particular
software.
•
For Content Federation Services for Image Services, use the Documentation directory in the
software package.
2. If the IBM FileNet P8 Platform documentation application (ecm_help) is running, stop it. Verify
that no processes are accessing the documentation web application.
NOTE On UNIX or Windows, stop the ecm_help application from the WebSphere
administrative console.
3. Copy the expansion product documentation to IBM FileNet P8 Platform documentation server,
as follows:
•
(UNIX) When copying expansion product documentation, use a cp copy command from a terminal
to copy the ecm_help directory structure from the associated Documentation package over the
ecm_help directory installed on the existing IBM FileNet P8 Platform documentation server.
cp -r <mount_location> <target_destination>
WARNING Care should be taken when copying folders in UNIX. Dropping-and-dragging of
folders replaces any existing folder(s) of the same name. Also note that your switch ( -R)
requirement may be different from the example shown. Contact your system administrator
if you have questions about proper syntax.
•
(Windows) Use a copy command from a command prompt or drag-and-drop the files to the
ecm_help directory installed on the existing IBM FileNet P8 Platform documentation server.
•
(Content Federation Services for Image Services) Copy the cfs_guide.pdf file from the
Documentation directory on the software package into the ecm_help/cfs_help directory
deployed on the existing IBM FileNet P8 Platform documentation site.
NOTE Repeat this step for each of your expansion products or custom applications. You can
copy more than one expansion product documentation set to the documentation application
server before continuing (for example, IBM FileNet P8 eForms and IBM FileNet P8 Portlets) so
you end up with one ecm_help directory structure containing multiple sets of expansion
product documentation files added to it.
4. Download the latest web-posted updates of installation and upgrade guide PDFs for the IBM P8
Platform and various functional expansion products. Check the documentation page on the IBM
Information Management support page on www.ibm.com for the latest versions of these guides.
See “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23 for
details.
5. Go on to the procedure in the following topic, “Update Documentation Search Index” on page 161.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
160
Task 10a: Install IBM FileNet P8 Platform Documentation (WebSphere)
Update Documentation Search Index
Update Documentation Search Index
Perform this procedure only if you have refreshed the core IBM FileNet P8 Platform
documentation, or installed expansion product documentation onto your IBM FileNet P8 Platform
documentation server. Otherwise, skip to the procedure in the following topic, “Complete and Verify
the Documentation Installation” on page 162.
NOTE Any time you update the documentation search index, a backup of the files in the existing
Index/core directory will be automatically copied to the Index/IndexOld subdirectory. You can
reapply these backed-up files to the core subdirectory (after first removing the new files created
there) if you need to return to your previous indexed state.
To update the documentation search index
1. If the IBM FileNet P8 Platform documentation application (ecm_help) is running, stop it. Verify
that no processes are accessing the documentation application.
NOTE Make sure you have copied the help for all your various expansion products to a
designated application server location containing the IBM FileNet P8 Platform documentation.
Otherwise, you will have to repeat this procedure if you add additional documentation later.
2. Open a command prompt or terminal on the application server.
3. From the command line, navigate to the search subdirectory under the application root directory,
for example, ecm_help.
4. Using a text editor, open the search-indexing script file that is appropriate for your operating
system:
NOTE You may need to set the permissions on this file, as it is set to read-only in the
documentation package.
(UNIX) indexFiles.sh
(Windows) indexFiles.bat
5. If necessary, set the JAVA_HOME variable in the script file with the path to your Java TM Runtime
Environment (JRE) installation. The default examples are:
(UNIX) JAVA_HOME="/usr/java/j2sdk1.4.1_02"
(Windows) SET JAVA_HOME=c:\j2sdk1.4.2
NOTE The Java JRE installation subdirectory can be user-defined, so substitute your actual
location, as appropriate.
6. Save your changes and close the text editor.
NOTE If you intend to run the search indexer on a UNIX application server, ensure that you
add execute permissions (chmod 755) to the indexFiles.sh file.
7. From the ecm_help/search folder, execute the updated search-indexing script file that is
appropriate to your application server operating system.
(UNIX) indexFiles.sh
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
161
Task 10a: Install IBM FileNet P8 Platform Documentation (WebSphere)
Complete and Verify the Documentation Installation
(Windows) indexFiles.bat
NOTE As you run the search-indexing script, you may notice periodic Parse Abort errors. You
can ignore these error conditions, as they are benign and do not affect the overall indexing
process.
8. Go on to the next procedure.
Complete and Verify the Documentation Installation
Perform this procedure after you have installed (and, if necessary, reindexed) the IBM FileNet P8
documentation on the application server.
To complete and verify the documentation installation on WebSphere
1. Start the IBM FileNet P8 documentation application from the WebSphere administrative
console, Applications > Enterprise Applications.
2. Verify that the WebSphere application server and the new IBM FileNet P8 documentation web
site are running:
a. From your web browser, access the following URL. The documentation's Help Directory
should open.
http://<docserver>:<port#>/<contextRoot>/
where:
docserver is the name of the Java web server.
port# is the port number (for example, 9080).
contextRoot is the value of the Map to URL field that you specified when you deployed
the IBM FileNet P8 Platform documentation application. If you specified /ecm_help,
then the contextRoot is ecm_help.
Example: http://yourdocserver:9080/ecm_help/
NOTE You can use multi-part root directories (for example, /docs/ecm_help) if your
application server supports them.
b. Click the Search link on the Help Directory toolbar. The documentation Search page should
open.
c. Enter a value for your Search query.
d. Select one of the Search query result links. The associated help page should open.
NOTE When it is time to configure the online help location for the various IBM FileNet P8
components, either while running Setup programs or later via site preferences settings, use
the URL in Step a on page 162.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
162
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic)
Overview of Procedures
Task 10b: Install IBM FileNet P8 Platform
Documentation (WebLogic)
This topic covers the installation, and (if necessary) search-related reindexing of your IBM FileNet
P8 documentation on a WebLogic application server. Because the IBM FileNet P8 documentation
includes a Java-based full-text search engine, it must be run as a web-based application.
You must install the documentation for the IBM FileNet P8 Platform and its expansion products on
a web application server if you intend to access online help from within any IBM FileNet P8
applications (for example, Workplace, Enterprise Manager, and Process Task Manager) or use the
full-text search feature.
NOTES
•
You may collocate the IBM FileNet P8 Platform documentation on an IBM FileNet P8
Application Engine or IBM FileNet P8 Content Engine machine.
•
To ensure proper documentation search functionality, make sure that JavaScript support is
enabled on each user's browser client.
•
Because of the number of possible network and web configurations, contact your network or
web administrator for specific system, software, and security requirements.
•
The requirements described in this topic may also exist for associated custom application
help, or for any customizations you may have applied to the IBM FileNet P8 Platform
documentation. For further details on customizing or localizing IBM FileNet P8 Platform
documentation, see the file ecm_help/transkit/P8DocTransKit.htm in the IBM FileNet P8 Platform
Documentation package or wherever you install the IBM FileNet P8 Platform documentation.
•
If you are upgrading your IBM FileNet P8 Platform installation and have downloaded a refresh
of the documentation from the IBM Information Management support page on www.ibm.com, see
“Upgrade IBM FileNet P8 Documentation” on page 496 for instructions on upgrading the
documentation.
•
Under WebLogic, you must install and deploy IBM FileNet P8 documentation as a flat-file
directory (example, /ecm_help). You cannot deploy the documentation as a WAR file or EAR
file because, in both cases, the IBM FileNet P8 help remains packaged and the internal
documentation search engine will not function as expected.
•
For WebLogic application server, you cannot directly deploy from the package. Therefore, you
must first copy the IBM FileNet P8 Platform documentation files from the package to the PC
where WebLogic is running, as described in this procedure.
•
Depending on your operating system and WebLogic versions, your WebLogic screens may be
slightly different than those documented in the examples below.
Overview of Procedures
Perform the procedures in the following subtopics in the order presented, unless otherwise
directed below:
•
“Install the IBM FileNet P8 Platform Documentation” on page 164 -- Begin here if you are installing
the IBM FileNet P8 Platform documentation for the first time.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
163
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic)
Install the IBM FileNet P8 Platform Documentation
•
“Install Expansion Product Documentation” on page 165 -- Begin here if have already installed the
IBM FileNet P8 Platform documentation and need to add on the documentation for IBM
FileNet expansion products (for example, Process Analyzer, Process Simulator, IBM FileNet
P8 eForms, Content Federation Services for Image Services, or IBM FileNet P8 Portlets).
•
“Update the Documentation Search Index” on page 166 -- Perform this procedure only after you
have added on documentation for your expansion products. Otherwise, if you install only IBM
FileNet P8 Platform documentation, which has a baseline search index, you may skip this
procedure.
•
“Complete and Verify the Documentation Installation” on page 168 -- Perform this final procedure in
all cases, but only after you have installed the IBM FileNet P8 Platform documentation, added
on documentation for your expansion products, and (where required) regenerated the search
index.
Install the IBM FileNet P8 Platform Documentation
This procedure establishes the web application for documentation associated with IBM FileNet P8
Platform. It assumes that your WebLogic application server is already installed and operational.
To install the IBM FileNet P8 Platform documentation on WebLogic 8.x
1. Access the IBM FileNet P8 Platform Documentation package.
2. Copy the /ecm_help folder structure from the package to a location on the local hard drive (for
example, ...P8docs/ecm_help).
3. If it is not running, start the WebLogic Server.
4. Start the WebLogic Server Administration Console.
5. From the WebLogic Server Administration Console, select <mydomain> > Deployments > Web
Application Modules.
6. Click Deploy a new Web Application Module...
7. From the right pane of the WebLogic Server Administration Console, browse to and select the
radio button for the ecm_help folder.
8. Click Target Module.
9. Click Deploy.
10. Continue as follows:
•
If you need to add on documentation for expansion products, go on to the procedure in the
following topic, “Install Expansion Product Documentation” on page 165.
•
If you have no further documentation to install, then go on to the procedure in the topic “Complete
and Verify the Documentation Installation” on page 168.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
164
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic)
To install the IBM FileNet P8 Platform documentation on WebLogic 9.x
To install the IBM FileNet P8 Platform documentation on WebLogic 9.x
1. If this is a Windows server, verify that Microsoft Windows Internet Information Services (IIS
Admin Service, Simple Mail Transport Protocol (SMTP), and World Wide Web Publishing
Service are stopped and set to manual.
2. Access the IBM FileNet P8 Platform Documentation package.
3. Copy the /ecm_help folder structure from the package to a location on the local hard drive (for
example, ...P8docs/ecm_help).
4. If it is not running, start the WebLogic Server.
5. Start the WebLogic Server Administration Console.
6. From the WebLogic Server Administration Console, select <mydomain> > Deployments > Web
Application Modules.
7. Click Deployments.
8. Click Lock and Edit.
9. Click Install.
10. Navigate to the documentation location.
11. Select the radio button for the ecm_help folder and click Next.
12. Select Install this deployment as an application and click Next.
13. Name the site and click Finish.
14. Click Activate Changes.
15. Select the site (check) and select Start > Servicing all requests and click Yes.
16. Continue as follows:
•
If you need to add on documentation for expansion products, go on to the procedure in the
following topic, “Install Expansion Product Documentation” on page 165.
•
If you have no further documentation to install, then go on to the procedure in the topic “Complete
and Verify the Documentation Installation” on page 168.
Install Expansion Product Documentation
Use the procedure in this topic to install documentation for expansion products into an existing
IBM FileNet P8 Platform documentation application. If you have no such documentation to add on,
skip to the procedure “Complete and Verify the Documentation Installation” on page 168.
To install expansion product documentation
1. Determine the documentation media source or location:
•
For most expansion products, use the Documentation package included as part of the particular
software.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
165
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic)
Update the Documentation Search Index
•
For Content Federation Services for Image Services, use the Documentation directory on the
software package.
NOTE Make sure you have copied the help for all your various expansion products to a
designated application server location containing the IBM FileNet P8 Platform documentation.
Otherwise, you will have to repeat this procedure if you add additional documentation later.
2. Identify the directory where you deployed the IBM FileNet P8 Platform documentation
application. This is the directory location where you copied the expanded ecm_help, or
extracted ecm_help.war to the ecm_help directory.
3. Stop the WebLogic server where you deployed the IBM FileNet P8 Platform documentation
application.
4. Copy the expansion product documentation to the IBM FileNet P8 Platform documentation
server, as follows:
•
(UNIX) When copying expansion product documentation, use a cp copy command from a terminal
to copy the ecm_help directory structure from the associated Documentation package over the
ecm_help directory installed on the existing IBM FileNet P8 Platform documentation server.
cp -r <mount_location> <target_destination>
WARNING Care should be taken when copying folders in UNIX. Dragging-and-dropping of
folders replaces any existing folder(s) of the same name. Also note that your switch ( -r)
requirements may be different from the example shown. Contact your system administrator
if you have questions about proper syntax.
•
(Windows) Use a copy command from a command prompt or drag-and-drop the files to the
ecm_help directory installed on the existing IBM FileNet P8 Platform documentation server.
•
(Content Federation Services for Image Services) Copy the cfs_guide.pdf file from the
Documentation directory in the software package into the ecm_help/cfs_help directory on the
IBM FileNet P8 Platform documentation server.
NOTE Repeat this step for each of your expansion products. You can copy more than one
expansion product documentation set to the documentation application server before
continuing (for example, IBM FileNet P8 eForms and IBM FileNet P8 Portlets) so you end up
with one ecm_help directory structure containing multiple sets of expansion product
documentation files added to it.
5. Download the latest web-posted updates of installation and upgrade guide PDFs for the IBM P8
Platform and various functional expansion products. Check the documentation page on the IBM
Information Management support page on www.ibm.com for the latest versions of these guides.
See “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23 for
details.
6. Go on to the procedure in the following topic, “Update the Documentation Search Index” on
page 166.
Update the Documentation Search Index
Perform this procedure only if you have refreshed the core IBM FileNet P8 Platform
documentation, or installed expansion product documentation onto your IBM FileNet P8 Platform
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
166
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic)
To update the documentation search index
documentation server. Otherwise, skip to the procedure in the following topic, “Complete and Verify
the Documentation Installation” on page 168.
NOTE Any time you update the documentation search index, a backup of the files in the existing
Index/core directory will be automatically copied to the Index/IndexOld subdirectory. You can
reapply these backed-up files to the core subdirectory (after first removing the new files created
there) if you need to return to your previous indexed state.
To update the documentation search index
1. Make sure the WebLogic server where you deployed the IBM FileNet P8 Platform
documentation application is stopped. For the search indexer to run, no other processes can be
accessing the IBM FileNet P8 Platform documentation.
2. Open a command prompt or terminal on the application server.
3. From the command line, navigate to the search subdirectory under the application root directory,
for example, ecm_help.
4. Using a text editor, open the search-indexing script file that is appropriate to your operating
system:
NOTE You may need to set the permissions on this file, as it is set to read-only in the
documentation package.
(UNIX) indexFiles.sh
(Windows) indexFiles.bat
5. If necessary, set the JAVA_HOME variable in the script file with the path to your JRE installation.
The default examples are:
(UNIX) JAVA_HOME="/usr/java/j2sdk1.4.1_02"
(Windows) SET JAVA_HOME=c:\j2sdk1.4.2
NOTE The Java JRE installation subdirectory can be user-defined, so substitute your actual
location, as appropriate.
6. Save your changes and close the text editor.
NOTE If you intend to run the search indexer on a UNIX application server, ensure that you
add execute permissions (chmod 755) to the indexFiles.sh file.
7. Run the following updated search-indexing script file that is appropriate to your operating
system.
(UNIX) indexFiles.sh
(Windows) indexFiles.bat
NOTE As you run the search-indexing script, you may notice periodic Parse Abort errors. You
can ignore these error conditions, as they are benign and do not affect the overall indexing
process.
8. Go on to the next procedure.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
167
Task 10b: Install IBM FileNet P8 Platform Documentation (WebLogic)
Complete and Verify the Documentation Installation
Complete and Verify the Documentation Installation
Perform this procedure after you have installed (and, if necessary, reindexed) the IBM FileNet P8
documentation on the application server.
To complete and verify the documentation installation on WebLogic
1. If the WebLogic server where you deployed IBM FileNet P8 documentation application is not
running, start it.
2. Verify that the application server and the new IBM FileNet P8 documentation web site are
running, as follows:
a. From your web browser, access the following URL. The documentation's Help Directory
should open.
http://<docserver>:<port#>/<contextRoot>/
where:
docserver is the name of the Java web server.
port# is the port number (for example, 7001).
contextRoot is the value of the Map to URL field that you specified when you deployed
the IBM FileNet P8 Platform documentation application. If you specified /ecm_help,
then the contextRoot is ecm_help.
Example: http://yourdocserver:7001/ecm_help/
NOTE You can use multi-part root directories (for example, /docs/ecm_help) if your
application server supports them.
b. Click the Search link on the Help Directory toolbar. The documentation Search page should
open.
c. Select one of the Search query result links. The associated help page should open.
NOTE When it is time to configure the online help location for the various IBM FileNet P8
components, either while running Setup programs or later via site preferences settings, use
the URL in Step a on page 168.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
168
Task 10c: Install IBM FileNet P8 Platform Documentation (JBoss)
Overview of procedures
Task 10c: Install IBM FileNet P8 Platform
Documentation (JBoss)
This topic covers the installation, and (if necessary) search-related reindexing of your IBM FileNet
P8 Platform documentation on a JBoss application server. Because the IBM FileNet P8 Platform
documentation includes a Java-based, full-text search engine, it must be ran as a web-based
application.
You must install the IBM FileNet P8 Platform documentation on a web application server if you
intend to access online help from within any IBM FileNet P8 applications (for example, Workplace,
Enterprise Manager, Process Task Manager, and Records Manager) or use the full-text search
feature.
NOTES
•
You may install the IBM FileNet P8 Platform documentation and Application Engine on the
same machine.
•
A valid Java JSDK must be installed for the JBoss application server.
•
To ensure proper documentation search functionality, enable JavaScript support on the user's
browser client.
•
Because of the number of possible network and web configurations, contact your network or
web administrator for specific system, software, and security requirements.
•
The requirements described in this topic may also exist for associated custom application
help, or for any customizations you may have applied to the IBM FileNet P8 Platform
documentation. This documentation requirement may also exist for associated custom
applications. For further details on customizing or localizing IBM FileNet P8 Platform
documentation, see the file ecm_help/transkit/P8DocTransKit.htm on the IBM FileNet P8 Platform
Documentation package or wherever you install the IBM FileNet P8 Platform documentation.
•
If you are upgrading your IBM FileNet P8 Platform installation and have downloaded a refresh
of the documentation from the IBM Information Management support page on www.ibm.com see
“Upgrade IBM FileNet P8 Documentation” on page 496 for instructions on upgrading the
documentation.
Overview of procedures
Perform the procedures in the following subtopics in the order presented, unless otherwise
directed below:
•
“Install the IBM FileNet P8 Platform documentation” on page 170 - Begin here if you are installing
the IBM FileNet P8 Platform documentation for the first time.
•
“Install functional expansion documentation” on page 170 - Begin here if have already installed the
IBM FileNet P8 Platform documentation and need to add on the documentation for IBM
FileNet functional expansions (e.g., Process Analyzer, Process Simulator, IBM FileNet P8
eForms, Content Federation Services for Image Services, Records Manager, or IBM FileNet
P8 Portlets).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
169
Task 10c: Install IBM FileNet P8 Platform Documentation (JBoss)
Install the IBM FileNet P8 Platform documentation
•
“Update the documentation search index” on page 171 - Perform this procedure only after you
have added on documentation for your functional expansions. Otherwise, if you install only
IBM FileNet P8 Platform documentation, which has a baseline search index, you may skip this
procedure.
•
“Complete and verify the documentation installation” on page 173 - Perform this final procedure in
all cases, but only after you have installed the IBM FileNet P8 Platform documentation, added
on documentation for your functional expansions, and (where required) regenerated the
search index.
Install the IBM FileNet P8 Platform documentation
This procedure establishes the web application for documentation associated with IBM FileNet P8
Platform. It assumes that your JBoss application server is already installed and operational.
To install the IBM FileNet P8 Platform documentation
1. Access the IBM FileNet P8 Platform Documentation package.
2. Create a directory for the IBM FileNet P8 Platform documentation. For example:
(UNIX) /home/usr/apps/jboss_ver/server/default/deploy/p8_docs.war
(Windows) C:\jboss-4.0.5\server\default\deploy\p8_docs.war
NOTES
•
The installation directory must have a .war extension as shown above.
•
The installation directory can be user-defined, so substitute your actual location for these
commands.
3. Unpack the ecm_help.war file or copy the ecm_help directory contents to the directory you just
created.
4. Continue as follows:
•
If you need to install documentation for functional expansions, go on to the procedure in the
following topic, “Install functional expansion documentation” on page 170.
•
If you have no further documentation to install, go on to the procedure in the topic “Complete and
verify the documentation installation” on page 173.
Install functional expansion documentation
Use the procedure in this topic to install documentation for functional expansions onto an existing
IBM FileNet P8 Platform documentation server. If you have no such documentation to add on, skip
to the procedure “Complete and verify the documentation installation” on page 173.
To install functional expansion documentation
1. Determine the functional expansion documentation media source location:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
170
Task 10c: Install IBM FileNet P8 Platform Documentation (JBoss)
Update the documentation search index
•
For most functional expansions, use the Documentation package included as part of the particular
software.
•
For Content Federation Services for Image Services, use the Documentation directory on the
software package.
2. If the application server is running, use the following command to stop it on the machine where
the documentation is installed, and verify that no processes are accessing the documentation
web application:
(UNIX) <path> /shutdown.sh -S
(Windows) <path> \shutdown.bat -S
3. Copy the functional expansion documentation to IBM FileNet P8 Platform documentation server,
as follows:
•
(UNIX) When copying functional expansions, use a cp copy command from a terminal to copy the
ecm_help directory structure from the associated Documentation package over the ecm_help
directory installed on the existing IBM FileNet P8 Platform documentation server.
cp -irv --reply=no <mount_location> <target_destination>
WARNING Care should be taken when copying folders in UNIX. Dropping-and-dragging of
folders ‘replaces’ any existing folder(s). Also note that your switch ( -irv) requirements
may be different from the example shown. Contact your system administrator if you have
questions about proper syntax.
•
(Windows) Use a copy command from a command prompt or drag-and-drop the files to the
ecm_help directory installed on the existing IBM FileNet P8 Platform documentation server.
•
(Content Federation Services for Image Services) Copy the cfs_guide.pdf from the
Documentation directory in the software package into the ecm_help/cfs_help directory deployed
on the existing IBM FileNet P8 Platform documentation server.
NOTE Repeat this step for each of your functional expansions or custom applications. You can
copy more than one functional expansion documentation set to the documentation application
server before continuing (for example, eForms) so you end up with one ecm_help directory
containing multiple sets of functional expansion files added in.
4. Download the latest web-posted updates of installation and upgrade guide PDFs for the IBM P8
Platform and various functional expansion products. Check the documentation page on the IBM
Information Management support page on www.ibm.com for the latest versions of these guides.
See “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23 for
details.
5. Continue with “Update the documentation search index” on page 171.
Update the documentation search index
Perform this procedure only if you have refreshed the core IBM FileNet P8 Platform
documentation, or installed functional expansion documentation onto your IBM FileNet P8
Platform documentation server. Otherwise, skip to the procedure in the following topic, “Complete
and verify the documentation installation” on page 173.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
171
Task 10c: Install IBM FileNet P8 Platform Documentation (JBoss)
To update the documentation search index
NOTE Any time you update the documentation search index, a backup of the files in the existing
Index/core directory will be automatically copied to the Index/IndexOld subdirectory. You can
reapply these backed-up files to the core subdirectory (after first removing the new files created
there) if you need to return to your previous indexed state.
To update the documentation search index
1. If the JBoss server is running, use the following command to stop it on the machine where the
documentation is installed, and verify that no processes are accessing the documentation web
application:
(UNIX) <path> /shutdown.sh -S
(Windows) <path> \shutdown.bat -S
NOTE Make sure you have copied the help for all your various functional expansions to a designated
application server location containing the IBM FileNet P8 Platform documentation. Otherwise, you will
have to repeat this procedure if you add new help later.
2. Open a command prompt (or terminal) on the application server.
3. From the command prompt (or terminal), navigate to the search subdirectory under your
ecm_help root directory.
4. Using a text editor, open the search-indexing script file that is appropriate to your application
server operating system:
NOTE You may need to set the permissions on this file as it is set to read-only on the
documentation package.
(UNIX) indexFiles.sh
(Windows) indexFiles.bat
5. Modify the JAVA_HOME variable in the script file with the path to your JRE installation. The default
examples are:
(UNIX) JAVA_HOME="/usr/java/j2sdk1.4.1_02"
(Windows) SET JAVA_HOME=c:\j2sdk1.4.2
NOTE The Java JRE installation subdirectory can be user-defined, so substitute your actual location,
as appropriate.
6. Save your changes and close the text editor.
NOTE If you intend to run the search indexer on a UNIX application server, ensure that you add
execute permissions (chmod 755) to the indexFiles.sh file.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
172
Task 10c: Install IBM FileNet P8 Platform Documentation (JBoss)
Complete and verify the documentation installation
7. Run the following updated search-indexing script file that is appropriate to your application server
operating system.
(UNIX) indexFiles.sh
(Windows) indexFiles.bat
NOTE As you run the search-indexing script, you may notice periodic Parse Abort errors. You can
ignore these error conditions, as they are benign and do not affect the overall indexing process.
8. Go on to the next procedure.
Complete and verify the documentation installation
Perform this procedure after you have installed (and, if necessary, reindexed) the IBM FileNet P8 Platform
documentation on the application server.
To complete and verify the JBoss documentation installation
1. Start the IBM FileNet P8 Platform documentation web application by running the following JBoss
command:
(UNIX) run.sh
(Windows) run.bat
2. Verify that the application server and the new IBM FileNet P8 Platform documentation web site
are running, as follows:
a. From your web browser, access the following URL. The documentation's Help Directory
should open.
http://<docserver>:<port#>/<contextRoot>/
where:
docserver is the name of the Java web server.
port# is the port number (def: 80 or 8080).
contextRoot is the value of the Map to URL field that you specified when you deployed
the IBM FileNet P8 Platform documentation application. If you specified /ecm_help,
then the contextRoot is ecm_help.
Example: http://yourdocserver:80/ecm_help/
NOTE You can use multi-part root folders (e.g., /docs/ecm_help) if your application server
supports them.
b. Click the Search link on the Help Directory toolbar. The documentation Search page should
open.
c. Select one of the Search query result links. The associated help page should open.
NOTE When it is time to configure the online help location for the various IBM FileNet P8
components, either while running Setup programs or later via site preferences settings, use
the URL in Step a on page 173.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
173
Task 11: Install and Configure Content Search Engine
Task 11: Install and Configure Content Search Engine
This task describes how to install and configure the initial Administration Server for the IBM
FileNet P8 Content Search Engine, an optional component based on the Autonomy K2 product. In
effect, you will set up an Autonomy K2 Master Administration Server required for any single and
multi-server K2 configuration.
The Autonomy K2 software that underlies the IBM FileNet P8 Content Search Engine has many
inherent features not discussed in the IBM FileNet P8 Help that you might want to configure. For
details see the Autonomy documentation set that is installed on the Autonomy K2 Master
Administration Server. The K2 PDF/HTML documentation set is located at: http://<hostname>:9990/
verity_docs/ after installation. This K2 documentation set is not searchable from the IBM FileNet
P8 Help but does have its own internal index and search functionality.
CAUTION Although the K2 Dashboard provides you with documentation for, and direct interfaces
to, the K2 collections, IBM FileNet requires that you use Enterprise Manager to manage
collections associated with Content Search Engine index areas (for example, to add and remove
index areas).
NOTES
•
Autonomy K2 was previously known as Verity K2, and you will see Verity still used in many of
the interfaces described in the following procedures.
•
Autonomy K2 must be installed on the same operating system as your Content Engine. For
UNIX, it doesn’t have to be the same flavor.
•
To install the Content Search Engine software silently, you can create your own script to run
the command-line steps presented in the procedures in this topic.
•
Where machine name variables are required, IP addresses will not validate. The name must
be entered.
•
The following procedures suggest the recommended installation path. You may install to
another location.
•
If you unimport the style set, the original files will be deleted from your system. In this
scenario, if you wish to re-import the style set, you will need to recover it from your installation
disk. In order to avoid this situation, you can either enter a unique name for the Style Set Alias
during the initial Content Search Engine (Autonomy K2) installation, or make a backup copy of
the original style set. If you enter a unique name for the style set during installation, ensure
you use that name when you configure Content Engine for Content-Based Retrieval.
•
Stop word files can be used to increase performance by about 30%. You can put a file named
style.stp into the stylefiles directory to list words you do not want full-text indexed (for
example, short words such as a, the, and). However, using a stop word file also prevents
searching on these words. See the K2 documentation for more details. To create a stop word
file you can typically copy a file named vdk30.stp from either the main K2 install directory or
the foreign language locales package over to the main stylefile directory, and then rename it to
style.stp. You must do this copy operation before you create collections.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
174
Task 11: Install and Configure Content Search Engine
To install Autonomy K2 Master Administration Server on Windows
To install Autonomy K2 Master Administration Server on Windows
1. Create the required accounts and groups with related permissions as specified in “To create
Content Search Engine accounts on page 93".
2. Access the host machine and log onto the directory service as K2 Operating System User .
NOTE Ensure K2 Operating System User is an operating system administrator on this
machine.
3. Insert the IBM FileNet Autonomy K2 installation CD and extract the contents of K2-win.zip to the
following location:
C:\Program Files\filenet\contentengine\verity\
4. Set the Java_Home environment variable as follows:
a. Open the System control panel.
b. Click the Advanced tab.
c. Click Environment Variables.
d. Click New under System Variables.
e. Set the variable information as follows:
Variable name: Java_Home
Variable value: <Java1.5.0xx_JDK_install_path>
5. Open C:\Program Files\filenet\contentengine\verity\config.vcnf in a text editor and make the
following modifications in the file:
•
Replace the instance of <myMode> with Master.
•
Replace all instances of <myLocalHostName> with the machine name you are installing on.
•
Replace all instances of <myMasterHostName> with the machine name you are installing on.
•
Replace all instances of <installDir> with C:\Program Files\filenet\contentengine\verity.
•
Replace the instance of <JavaHome> with the path to the installed Java 1.5.0_xx JDK.
6. Open a command line and change directory to C:\Program Files\filenet\contentengine\verity.
7. Enter the following at the command line:
k2\_nti40\bin\vconfig -cfg "C:\Program
Files\filenet\contentengine\verity\config.vcnf" -dir "C:\Program
Files\filenet\contentengine\verity" -verbose -log log.txt
The Autonomy K2 Administration Server service will be installed and running at the
completion of the vconfig command.
8. Close the command window.
NOTE It is important that you close this command window instance.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
175
Task 11: Install and Configure Content Search Engine
To install Autonomy K2 Master Administration Server on Windows
9. Update the documentation XML file and set the access path:
a. Access C:\Program Files\filenet\contentengine\verity\appserver\conf\Catalina\localhost.
b. Right-click the k2_docs.xml file and select Edit.
c. Replace <installDir> with C:\Program Files\filenet\contentengine\verity.
For example:
<Context path="/verity_docs" docBase="c:\program
files\filenet\contentengine\verity/data/docs"
debug="0" reloadable="true" crossContext="false">
</Context>
10. Update the K2 Dashboard shortcut:
a. Access C:\Program Files\filenet\contentengine\verity.
b. Right-click the K2 Dashboard shortcut and select Properties.
c. Replace <myhostname> with the name of the machine on which you are installing.
11. Update the K2 Doc shortcut:
a. Access C:\Program Files\filenet\contentengine\verity.
b. Right-click the K2 doc shortcut and select Properties.
c. Replace <myhostname> with the name of the machine on which you are installing.
12. Update web.xml:
a. Access C:\Program Files\filenet\contentengine\verity\data\docs\WEB-INF.
b. Right-click web.xml and select Edit.
c. Replace <myHostName> with the machine name on which you are installing.
13. Open a new command line window and change directory to C:\Program
Files\filenet\contentengine\verity\appserver\bin.
14. Enter the following command:
service.bat install k2
15. Enter the following command to launch the Tomcat application server:
startup
16. Set K2 Administration Server service to run as K2 Operating System User, as follows:
a. Access Component Services.
b. Stop the Verity K2 6.1.1 Administration Server service.
c. Change the logon settings and set the service to Log On as K2 Operating System User.
d. Start the Verity K2 6.1.1 Administration Server service.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
176
Task 11: Install and Configure Content Search Engine
To install Autonomy K2 Master Administration Server on UNIX
17. See “To configure Autonomy K2 for Content-Based Retrieval on page 180" to configure this
Autonomy K2 installation.
To install Autonomy K2 Master Administration Server on UNIX
NOTE For HP-UX installations, manually configure the kernel with following parameters before you
begin the Autonomy K2 Master Administration Server installation:
Value
Setting
maxdsiz
1.9 Gbytes (0x7B033000)
maxfiles
2048 Kbytes
maxfiles_lim
2048 Kbytes
maxssiz
160 Mbytes (0xA000000)
max_thread_proc
1024
maxswapchunks
8192
maxtsiz
1 Gbyte (0x40000000)
maxuprc
512
maxusers
128
nkthread
1024
nproc
517
1. Create the required accounts and groups and related permissions as specified in “To create
Content Search Engine accounts on page 93".
2. Log onto the UNIX machine as the K2 Operating System User.
3. Insert the IBM FileNet Autonomy K2 installation CD and extract the contents of K2<platform>.tar.gz to /opt/verity using the following commands:
a. gzip -d <platform>.tar.gz
b.
tar -xvf <plaftorm>.tar
NOTE If you install to a directory other than /opt/verity, you must create a soft link using the
following command:
ln –s <InstallPath> /opt/verity
4. Change directory to /opt/verity.
5. Edit /opt/verity/config.vcnf as follows:
•
Replace the instance of <myMode> with Master.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
177
Task 11: Install and Configure Content Search Engine
To install Autonomy K2 Master Administration Server on UNIX
•
Replace all instances of <myLocalHostName> with the name of the machine on which you are
installing.
•
Replace all instances of <myMasterHostName> with the name of the machine on which you are
installing.
•
Replace the instance of <JavaHome> with the path to the installed Java 1.5.0_xx JDK.
6. Set the Java_home variable:
JAVA_HOME=<java_install_path>/jdk1.5.0_xx
export JAVA_HOME
NOTE Place the above entry in a user’s .profile file to make the setting available each time
the user logs in.
7. Append the following environment variables according to your platform:
(HP-UX)
PATH=$PATH:/opt/verity/k2/_hpux/bin
export PATH
SHLIB_PATH=$SHLIB_PATH:/opt/verity/k2/_hpux/bin
export SHLIB_PATH
(AIX)
PATH=$PATH:/opt/verity/k2/_rs6k43/bin
export PATH
LIBPATH=$LIBPATH:/opt/verity/k2/_rs6k43/bin
export LIBPATH
(Solaris)
PATH=$PATH:/opt/verity/k2/_ssol26/bin
export PATH
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/verity/k2/_ssol26/bin
export LD_LIBRARY_PATH
(Linux)
PATH=$PATH:/opt/verity/k2/_ilnx21/bin
export PATH
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/verity/k2/_ilnx21/bin
export LD_LIBRARY_PATH
8. Change directory to /opt/verity/
9. Enter the following command:
k2/<platform>/bin/vconfig -cfg "/opt/verity/config.vcnf" -dir "/opt/verity" verbose -log log.txt
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
178
Task 11: Install and Configure Content Search Engine
To install Autonomy K2 Master Administration Server on UNIX
Substitute one of the following for <platform>:
•
_ssol26 (Solaris 8.0, 9.0 or 10.0)
•
_hpux (HP-UX 11i with -AA compiler flag)
•
_rs6k43 (AIX 5.2 and 5.3)
•
_ilnx21 (Red Hat Advanced Server 3.0 and 4.0, SUSE 8 and 9)
The Autonomy K2 Administration Server service and Tomcat will be installed and running at
the completion of the vconfig command.
NOTE To manually start or stop the Autonomy K2 Administration Server service, use the
follow commands, according to your environment:
(HP-UX)
Start Service:
nohup /<device >/<verity_install_dir>/k2/_hpux/bin/k2adminstart &
Stop Service:
/<device >/<verity_install_dir>/k2/_hpux/bin/k2adminstop
(AIX)
Start Service:
nohup /<device >/<verity_install_dir>/k2/_rs6k43/bin/k2adminstart &
Stop Service:
/<device >/<verity_install_dir>/k2/_rs6k43/bin/k2adminstop
(Solaris)
Start Service:
nohup /<device>/<verity_install_dir>/k2/_ssol26/bin/k2adminstart &
Stop Service:
/<device>/<verity_install_dir>/k2/_ssol26/bin/k2adminstop
(Linux)
Start Service:
nohup /<device >/<verity_install_dir>/k2/_ilnx21/bin/k2adminstart &
Stop Service:
/<device >/<verity_install_dir>/k2/_ilnx21/bin/k2adminstop
10. See “To configure Autonomy K2 for Content-Based Retrieval on page 180" to configure this
Autonomy K2 installation.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
179
Task 11: Install and Configure Content Search Engine
To install additional Autonomy K2 Administration Servers
To install additional Autonomy K2 Administration Servers
You will likely need to install additional 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.
To install additional Autonomy K2 Administration Servers, follow the procedure outlined in Task 51
"Install Additional Content Search Engine Servers" on page 464, then follow the procedure below to
configure the new Administration Server.
To configure Autonomy K2 for Content-Based Retrieval
This procedure outlines how to create and configure the minimum set of server services required
on the K2 Master Administration Server, and on additional Administration Servers you may install,
for IBM FileNet P8 Content Engine. All servers are configured through the Master Administration
Server Dashboard.
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. If multiple Brokers are assigned, then if one goes down the
others will be used. But, 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 “To enable additional K2 Index Servers
and Search Servers on page 419" for details.
•
Each K2 Administration Server must contain a Ticket Server for Content Engine.
•
For good stability and performance, it is recommended that Broker Servers be attached to
local Ticket Servers for security on each machine.
NOTES
•
When naming particular servers you create with this procedure, it’s a good idea to indicate the
type of server you’ve created. Otherwise, when you configure Content Engine, discerning
which server is which could be confusing. For example, <servername>_broker to indicate that
this is a Broker Server.
•
Ensure you carefully record the server names, ports 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.
•
The following procedures suggest the recommended ports, however, you may choose which
ports to use. Multiple servers will require multiple ports.
1. 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
http://tomcat.apache.org/tomcat-5.5-doc/ssl-howto.html
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
180
Task 11: Install and Configure Content Search Engine
To configure Autonomy K2 for Content-Based Retrieval
2. Access the K2 Dashboard by launching your browser and entering: http://<hostname>:9990/
verity_dashboard/main.jsp.
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. If multiple Administration Servers are installed, select the server on which you want to
create the service and click continue.
d.
Enter the following information on the Configure basic settings for the new K2 Index Server
page:
–
Service Alias: <server_name>_index_server
–
Port: 9960
e. Click Next to continue with the installation.
f.
Enter the following information on the Configure threads for the K2 Index Server page:
–
Synchronous Threads: 25
–
Asynchronous Threads: 3
–
Access Type: Authorized Administrator
g. 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. If multiple Administration Servers are installed, select on which of these you want to create
the service and click continue.
d. Enter the following information on the Configure basic settings for the new K2 Broker page:
–
Service Alias: <servername>_broker
–
Port: 9900
e. Click Finish.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
181
Task 11: Install and Configure Content Search Engine
To configure Autonomy K2 for Content-Based Retrieval
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. If multiple Administration Servers are installed, select which Administration Server you want
to create the service on and click continue.
d. Enter the following information on the Configure basic settings for the new K2 Server page:
–
Service Alias: <server_name>_search_server
–
Port: 9920
e. Click Next.
f.
Click Next on the Set security options for this service page.
g. Enter the following information on the Attach to K2 Brokers page:
–
h.
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, <servername>_broker.
Click Finish.
7. Import the IBM FileNet Styleset.
NOTE Using a stop words file will increase your performance by about 30%. You can put a file
named style.stp into the stylefiles it will not full-text index short words like a, the, and. This
involves copying vdk30.stp over to stylefile directory and renaming it to style.stp. See the
Verity documentation for more details.
a. Click Collections under System View.
b. Click Manage Style Sets under Actions on the Collection Summary page.
c. Click Import on the Manage Style Sets page.
d. Enter the following information on the Import page:
–
Style Set Alias: FileNet_FileSystem_PushAPI
–
Gateway Type: --Auto-detect--
–
Source Administration Server (if multiple servers are installed). Choose which server.
–
Source Path:
•
(Windows) C:\Program
Files\filenet\contentengine\verity\data\stylesets\FileNet_FileSystem_PushAPI
•
(UNIX) /opt/verity/data/stylesets/FileNet_FileSystem_PushAPI
e. Click Import.
8. 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
182
Task 11: Install and Configure Content Search Engine
To configure Autonomy K2 for Content-Based Retrieval
c. If multiple K2 Administration Servers are installed, select on which you want to create the
service and click continue.
d. Enter the following information on the Configure basic settings for the new K2 Ticket Server
page:
–
Service Alias: <server_name>_ticket_server
–
Port: 9910
e. Click Next.
f.
Enter the following information on the Configure the login module to use with this K2 Ticket
Server page:
–
Select which Login Module type to use with this K2 Ticket Server:
•
Windows
•
UNIX
NOTE LDAP Ticket Servers are not currently supported.
–
Default Domain (Windows only): Enter the domain on which this K2 Server is
authenticated.
g. Click Next.
h. Enter the following information on the Configure the persistent store module to use with this K2
Ticket Server page:
–
Select the Persistent Store Module type to use with this K2 Ticket Server: Choose File
and Memory.
i.
Click Finish.
j.
Click Edit Properties.
k. Click Windows Login Module.
l.
Check Use Local Credentials:.
m. Check Enable Built-in Groups.
n. Click Modify.
9. 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:
–
Select a K2 Ticket Server to configure for administration security: From the drop-down
menu, select the K2 Ticket Server you just created.
–
User Name: Enter the K2 Operating System User. For UNIX installs, this is the user
you logged in as to run the install in Step 2 on page 177. For more detail on required
accounts, see “To create Content Search Engine accounts on page 93".
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
183
Task 11: Install and Configure Content Search Engine
To configure Autonomy K2 for Content-Based Retrieval
–
Password: Enter the authentication password.
–
Default Domain: Enter the domain on which this user and K2 Server are authenticated.
d. Click Modify.
K2 will authenticate the user using 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 in again as the Dashboard Administrator to complete the configuration.
10. Launch the K2 Dashboard and log in.
11. 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. You’ll need to perform either a Quick Restart or a Full Restart.
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.
12. Enable additional K2 Admin Users (optional).
a. From the K2 Dashboard home page, click Administration Servers.
b. Click Manage K2 Administrative Users.
c. Click Add User on the Manage K2 Administrative Users page.
d. Enter the name of an authenticated user on the directory service that you want to make a K2
Administrator and click Add.
13. 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 <ticket_servername>.
c. Click Manage K2 Broker/K2 Server Security in the Services Secured by this K2 Ticket Server
section at the bottom of the page.
d. Click the K2 Servers button on the Manage K2 Broker/K2 Server Security page.
e. One-at-a-time, click the service listed in the window on the right to enable security.
f.
Click the K2 Brokers button on the Manage K2 Broker/K2 Server Security page.
g. One-at-a-time, click each service listed in the window on the right to enable security.
h. Click Modify to save your changes.
14. 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. You’ll need to perform either a Quick Restart or a Full Restart.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
184
Task 11: Install and Configure Content Search Engine
To configure Autonomy K2 for Content-Based Retrieval
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.
15. Install additional locales from CD. Complete this step only if you require locales other than
English.
Windows:
a. Create a directory <Program Files>\Common Files\InstallShield\Universal\<Win
platform>\x86\<machine_name>\Gen1\_vpddb
<Program Files> is the system Program Files folder, such as C:\Program Files
<Win platform> is the Windows version. Valid options:
–
Windows XP
–
Windows 2000
–
Windows 2003
<machine_name> machine name on which you are installing
Example: C:\Program Files\Common Files\InstallShield\Universal\Windows
2003\x86\myMachine\Gen1\_vpddb
b. Locate the vpd.script file in the K2 CLI setup root folder. Modify all the variable instances in
the string as follows:
–
Replace <K2InstallDir> with the K2 root folder. For example, C:\Program
Files\FileNet\ContentEngine\verity
–
Replace <myHostName> with the machine name.
–
Replace <WinVersion> with the Windows version.
Ensure the entries in the vpd.script file match the folder path in Step a.
c. Copy the vpd.script to the location in Step a of this procedure.
d. Run the installer. Navigate to the decompressed locale installer location and execute the
respective installer launcher. The locale installer will locate the K2 installation and start,
based on the settings you completed above.
NOTE The locale installer requires the following license key: 2UV4MPT-2KPEQBJ-1D6A6KT2KPE6KT-2KPE6KS
UNIX:
To install locales from the Locale CD after Content Search Engine (Autonomy K2) has been
installed, prepare your system with the following:
export variable VERITY_CFG
VERITY_CFG=/opt/verity/k2/common/verity.cfg
export VERITY_CFG
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
185
Task 11: Install and Configure Content Search Engine
To configure Autonomy K2 for Content-Based Retrieval
To run the installer, navigate to the decompressed locale installer location and execute the
respective installer launcher. The locale installer will locate the K2 installation and start,
based on the settings you completed above.
NOTE The locale installer requires the following license key: 2UV4MPT-2KPEQBJ-1D6A6KT2KPE6KT-2KPE6KS
16. If you are adding Content Search Engine to an already functioning and updated IBM FileNet
P8 Platform system, skip to Task 22 Install Content Search Engine Software Updates to apply any
available service packs, interim fixes, or fix packs and then complete Task 34 Configure Content
Engine for Content-Based Retrieval. Otherwise, move on to Task 12 "Install and Deploy Content
Engine" on page 187.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
186
Task 12: Install and Deploy Content Engine
Task 12: Install and Deploy Content Engine
The procedures in this task show how to install and deploy Content Engine on an application
server. Do these procedures whether you are installing Content Engine as a new application or
upgrading from an old version.
CAUTION Before doing any procedures in this task, be sure you have completed all the applicable
tasks in “Prerequisite Tasks” on page 50.
After upgrading from an old version, you will also need to run utilities to migrate items (such as
databases and object stores) from the old version of Content Engine to the new version (see
“Upgrade Content Engine Software” on page 505).
You can install Content Engine interactively, via Content Engine Setup, or silently, via a commandline interface.
Before doing a silent install, you must first record a response file (also known as an options file)
by running Content Engine Setup interactively, typically in a development or test setting. You then
use the response file to run a silent install of Content Engine in a production environment.
In your production environment, install Content Engine first on the application server master
(administrative) node. You can then use the administrative console of the application server to
deploy Content Engine to other managed servers (see “Deploy Content Engine to Other Application
Servers” on page 455).
You can install some or all of the following Content Engine components on a given machine,
depending on the specifics of your configuration:
•
Content Engine Server. Your first installation of Content Engine must include this component.
•
Application Server Authentication Provider. If your LDAP provider uses single sign-on, create
the provider (through the administrative console of your application server) prior to installing
Content Engine.
•
Administration Tools - Enterprise Manager and COM Compatibility Client API. These are .NET
clients that can be installed only on a Windows machine. (In this document, the terms
“Enterprise Manager” and “IBM FileNet Enterprise Manager” refer to the same component and
are used interchangeably.)
Your initial installation of Content Engine does not need to include Enterprise Manager.
However, until you install Enterprise Manager, you will not be able to administer Content
Engine.
CAUTION You cannot install version 4.0.x of Enterprise Manager on a machine where version
3.5.x of the component is already installed.
NOTE If you intend to enable content-based retrieval (CBR), you must run your Content Engine
servers and associated Content Search Engine (Autonomy K2) servers on the same operating
system.
NOTE On each HP-UX 11 or HP-UX 11i machine where you will install Content Engine (a JVMbased component), ensure that the values of the kernel parameters max_thread_proc (maximum
number of threads per process) and nkthread (maximum number of kernel threads in the system)
are larger than their default values, which are too small for IBM FileNet P8.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
187
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
At the HP web site, refer to the document titled HP-UX Programmer’s Guide for Java 2 for tools to
determine values of these two kernel parameters that suffice for IBM FileNet P8.
The machine where you will install Content Engine Server is referred to in the following procedure
as the Content Engine machine. The procedure assumes you have a WebLogic domain called
FNCEDomain, a WebSphere profile called default, or a JBoss server instance. Substitute your
own domain, profile, or server name in place of a default value.
WARNING If you need to rename a machine, do so before installing Content Engine on it.
To run Content Engine Setup
1. Log on to the machine where you will run the Content Engine Setup program. Logging on as a
member of the local Administrators group (Windows) or the root user (UNIX) gives you sufficient
privileges to run the program. On most operating systems, you can run the program with lesser
privileges, as shown in the following table:
Operating
User Requirements for Running Content Engine Setup
System
AIX
Must be root user
HP-UX 11
HPUX 11i
Linux
Solaris
•
Must be a member of the adm group
•
Must have read/write/execute permission to the following:
Windows
–
Device/location where Content Engine is to be installed
–
Device/location where the application server has been installed
•
Must have write permission to the directories where you will create file
storage areas, index areas, and content caches
•
Must have write permission on the /tmp directory
•
Must be the user (or a member of the group) that launched the application
server instance where you will deploy Content Engine
•
Must be a member of the Local Administrators group
•
If application server is WebLogic, must also have write permission to directory
<WebLogic_Install_Directory>/user_projects/domains/FNCEDomain
2. (WebLogic and WebSphere) Stop and start the application server on the Content Engine.
NOTE On UNIX, you can start WebSphere as the root user, or as a normal user with read/
write/execute permissions on <WebSphere_Install_Directory>/profiles/<profile_name>.
3. If you previously uninstalled and undeployed version 4.0.x of Content Engine on this machine,
delete the following directory if you are going to run Content Engine Setup interactively:
C:\Program Files\Common Files\InstallShield\Universal\FileNet\ContentEngine
4. Access the Content Engine software package, and navigate to the ContentEngine directory.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
188
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
Do one of the following to start Content Engine Setup, provided you have not yet applied a
service pack or interim fix to the Content engine software on this machine:
•
If you are doing an interactive (non-silent) install, run one of the commands in the following table:
Platform
Command line
AIX
P8CE-4.0.0-AIX.bin
HP-UX 11
P8CE-4.0.0-HPUX.bin
HP-UX 11i
On WebLogic 9.2 (replacing /opt/java 1.5 with the path name to your
version 1.5 JVM):
P8CE-4.0.0-HPUXi.bin -is:javahome /opt/java1.5
On non-WebLogic 9.2:
P8CE-4.0.0-HPUXi.bin
Linux
P8CE-4.0.0-Linux.bin
Solaris (SPARC)
P8CE-4.0.0-Sol.bin
Windows
P8CE-4.0.0-Win.exe
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
189
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
•
If you are going to record a response file for a subsequent silent install, run one of the commands
in the following table, replacing /opt/response.txt or C:\response.txt with the path and name of
your response file, provided you have not yet applied a service pack or interim fix to the
Content engine software on this machine:
Platform
Command line
AIX
P8CE-4.0.0-AIX.bin -options-record '/opt/response.txt'
HP-UX 11
P8CE-4.0.0-HPUX.bin -options-record '/opt/response.txt'
HP-UX 11i
On WebLogic 9.2 (replacing /opt/java 1.5 with the path name to your
version 1.5 JVM):
P8CE-4.0.0-HPUXi.bin -is:javahome /opt/java1.5 -options-record
'/opt/response.txt'
On non-WebLogic 9.2:
P8CE-4.0.0-HPUXi.bin -options-record '/opt/response.txt'
Linux
P8CE-4.0.0-Linux.bin -options-record '/opt/response.txt'
Solaris (SPARC)
P8CE-4.0.0-Sol.bin -options-record '/opt/response.txt'
Solaris (x86)
P8CE-4.0.0-Solx86.bin -options-record '/opt/response.txt'
Windows
P8CE-4.0.0-Win.exe -options-record 'C:\response.txt'
NOTE The first Content Engine Setup screen may not appear for 30 seconds or more after you
launch the command.
CAUTION If it detects an earlier version of Content Engine software on this machine, Content
Engine Setup displays a warning message: If version 3.5.x of Enterprise Manager is running
on the machine, and you want to retain it to prepare object stores for upgrade to version 4.0.x,
do not select .NET Clients for installation in the Select Components wizard screen (see “Select
Components” on page 191). After you have upgraded all object stores to version 4.0.x, you can
run Content Engine Setup again on this machine to install .NET clients.
5. Complete the Content Engine Setup screens as follows:
In this screen...
Perform this action...
Welcome
Click Next to proceed with the Content Engine installation.
NOTE Click Back at any time while running Content Engine
Setup to make changes in any previous screens. Click Cancel to
exit Content Engine Setup.
License Agreement
Review and accept the license agreement, and then click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
190
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Specify Installation
Location and Local Host
Name
Accept the default (or browse to another) Content Engine
installation directory, specify the local host name or IP address,
and then click Next.
NOTE (UNIX) The account running Content Engine Setup must
have read, write, and execute access to both the installation
directory and the /tmp directory.
Select Components
From the list on the screen, select components to be installed
and then click Next:
•
Content Engine Server
You must select this component in your initial installation of
Content Engine software.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
191
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Select Components
•
Application Server Authentication Provider
Select this component if you want the installer to create and
configure J2EE application server authentication in a later
screen of Content Engine Setup.
WEBSPHERE WebSphere 6.0.x and earlier support only a
single user registry for authentication. Do not select this
component if you have already configured WebSphere’s
Global Security > LDAP User Registry. If you do, Content
Engine Setup will overwrite that configuration with
information provided during Content Engine installation.
This could have unintended consequences on your
environment, including any non-IBM FileNet P8 applications
already deployed on this application server. CAUTION For
WebSphere 6.1: do not select this component if you have
already configured WebSphere authentication; if you are
using WebSphere 6.1 federated user repositories, you
should already have done the procedure “To use WebSphere
6.1 federated user repository (optional)” on page 136.
WEBLOGIC WebLogic supports multiple security realms and
multiple authentication providers per realm. If you select
this component, Content Engine Setup will add a new
authentication provider to any that already exist. In
WebLogic 8, Content Engine uses the default security realm
with the default name of “myrealm”. In WebLogic 9, Content
Engine uses the default security realm; if there is more than
one, the Summary of Security Realms in the WebLogic
Administration Console displays which is the default.
JBOSS JBoss supports multiple security realms. If you
select this component, Content Engine Setup will edit the
JBoss login-config.xml file and add several new
<authentication> sections to join any that already exist.
NOTE If you wish to configure the application server’s
authentication yourself, rather than having Content Engine
Setup do so, exit Content Engine Setup now and perform
these tasks as described in the administration guide of your
application server, and then run Content Engine Setup
again, making sure not to select this component to install.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
192
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Select Components
•
.NET Clients
The .NET client software is installable only on Windows. If
Content Engine Setup is running on UNIX, you can install
the .NET software on a Windows machine (see “Install an
Additional Instance of Enterprise Manager” on page 445) after
Content Engine Setup finishes.
NOTE If you intend to install Records Manager, you must
select the COM Compatibility Clients API component.
•
Java Clients
You must select this component; otherwise, you will not be
able to run the Object Store 3.5 to 4.0 Upgrade Tool to
upgrade object stores you created in a previous version of
Content Engine.
.NETFramework and
WSE Requirements
This screen appears only if all the following conditions apply:
•
Content Engine Setup is running on Windows
•
Microsoft .NET Framework 2.0 and Web Services
Enhancements (WSE) 3.0 are not both installed on the
application server where you are running Content Engine
Setup
•
You selected .NET Clients or one of its subcomponents in
“Select Components” on page 191
If you have later or compatible versions of these components,
click Next; otherwise, click Cancel to exit Content Engine Setup
and install the two components, as you cannot proceed beyond
this screen.
Specify Documentation
URL
This URL is for accessing IBM FileNet P8 documentation from
Enterprise Manager and other IBM FileNet P8 components.
NOTE This screen
appears only if Content
Engine Setup is running
on Windows.
If you have already installed IBM FileNet P8 documentation, as
instructed earlier, and want to test access to it now, type its
URL, click Test, and then click Next.
Choose Application
Server
Click the option button for the application server where you are
installing Content Engine.
If you prefer to specify the URL after Content Engine Setup
finishes, click Next and continue at “Choose Application Server”
on page 193.
If applicable, select an application server version from the dropdown list, and then click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
193
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Review Installation
Summary
Verify your component selections and click Install to start
installing Content Engine.
Depending on your application server, continue at one of the
following screens:
Specify WebLogic
Directories
•
“Specify WebLogic Directories” on page 194
•
“Specify WebSphere Directory” on page 195
•
“Jboss Configuration” on page 196
Accept the default pathname, or browse to another location, for
the following three directories:
•
WebLogic Root Directory
•
WebLogic Configuration Tool Directory
•
WebLogic Domains Directory
Click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
194
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Specify WebLogic
Information
Specify the following information and then click Next:
•
Domain Name: The name of the WebLogic domain (default
is FNCEDomain) where this Content Engine instance will be
installed.
NOTE The WebLogic domain name is case sensitive. An
incorrectly specified name will cause installation of Content
Engine to fail.
•
Administration Server Name: The WebLogic Server instance
(administration server) where Content Engine will be
deployed.
NOTE If you are installing Content Engine in a managed
server environment, specify the host name of the
Administrator node.
•
WebLogic Administration Server Port: The port (7001, by
default) assigned to WebLogic.
•
Administrator Login Name: The user name (weblogic, by
default) for logging on to WebLogic Server Administration
Console. This is the same user you specified in one of the
following:
•
–
Step 5 of “To configure WebLogic 8.1.x” on page 138 or
–
Step 4 of “To configure WebLogic 9.2.x” on page 140
Administrator Password: The password (at least eight
characters) for the administrator login name.
If WebLogic is not already running, Content Engine Setup tries
to start it (this will take a few minutes) and displays a message
saying so. Click OK.
If WebLogic won’t start, Content Engine Setup prompts you to
run the tool startWebLogic:
•
(Windows) startWebLogic.cmd
•
(UNIX) startWebLogic.sh
Continue at “GCD JNDI Configuration” on page 196.
Specify WebSphere
Directory
Specify the location where WebSphere Application Server is
installed and then click Next.
NOTE When installing into a managed Server environment
using Network Deployment or Deployment Manager, specify the
installation location of WebSphere Network Deployment or
Deployment Manager, respectively.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
195
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Specify WebSphere
Information
Specify the following information and then click Next.
•
Profile: The name of the WebSphere profile you created for
this instance of Content Engine.
•
Cell: The name of WebSphere (multi-machine)
environment.
•
Node: The name of the machine on which WebSphere is
managed.
NOTE If you are installing Content Engine in a managed
server configuration using Network Deployment or
Deployment Manager, specify the host name of the
Deployment Manager node.
•
Server: The name of the WebSphere instance.
•
SOAP Port: SOAP port assignment.
•
HTTP Port: HTTP port assignment.
Specify WebSphere
Administrator Account
If WebSphere Global Security (Administrative Security in
version 6.1) is turned on, type the name and password of the
WebSphere administrator. If it is not turned on, type any name.
Click Next and continue at “GCD JNDI Configuration” on page 196.
Jboss Configuration
Specify the directory where JBoss is installed and then click
Next.
Specify the instance in the JBoss Server box,
Specify 8080 the HTTP port 8080.
GCD JNDI Configuration
Click either the option button for Content Engine Setup to
create new XA and non-XA JDBC Providers (WebSphere only)
and/or XA and non-XA data sources/connection pools, or the
option button for Content Engine Setup to use existing ones,
and then click Next.
If you choose to use existing ones, be sure to specify the exact,
case-sensitive JNDI names for the data sources. If you wish to
create new ones, specify the JNDI names you want Content
Engine Setup to create.
Configure JDBC
From the drop-down lists, choose the database type and (for
WebSphere and WebLogic only) the corresponding JDBC
driver, and then click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
196
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Configure JDBC
Connection Pools
CAUTION Your database/tablespace for the GCD must already
exist. If you haven’t created it yet, exit from Content Engine
Setup now and continue at one of the following, depending on
your database vendor:
•
“Verify that Microsoft SQL Server Is Installed for IBM FileNet P8”
on page 101
•
“Verify that Oracle Server Is Installed for IBM FileNet P8” on
page 106
•
“Verify that DB2 Server Is Installed for IBM FileNet P8” on
page 114
Specify the following information and then click Next.
Specify Database User
•
JDBC Connection Pool Name: The name of the connection
pool used for local (non-distributed) connections to the GCD
database. Content Engine Setup will create an additional
connection pool, based on this name, for global (distributed)
connections.
•
Database Name: The name of the database to be used by
the GCD. (For Oracle, the database name must be the SID
value in the listener.ora file).
•
Database Host Name: The name or IP address of the
machine where the database is located.
•
Database Port: The port used by the database/tablespace.
Specify the user name (ce_login, by default) and password that
Content Engine will use to access the GCD database, and then
click Next.
If you did not choose Application Server Authentication Provider
in “Select Components” on page 191, skip to “Setup Content Engine
Bootstrap Properties” on page 201.
Specify Authentication
Provider
NOTE This screen
appears only if you
selected to install the
Application Server
Authentication Provider
component.
From the drop-down list, choose an authentication provider. If
your application server is WebLogic, also specify a provider
name. Select or clear the Kerberos checkbox as needed, and
then click Next.
NOTE (WebLogic) Do not specify a provider name already
being used on the WebLogic instance; otherwise, Content
Engine Setup will overwrite that authentication provider.
CAUTION If you are running Content Engine Setup as part of
an upgrade to version 4.0.x, your authentication provider must
be the same one you used in version 3.5.x.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
197
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Configure Authentication
Provider
Specify the following authentication provider information:
NOTE This screen
appears only if you
selected to install the
Application Server
Authentication Provider
component.
•
Host: The machine hosting the authentication provider.
•
Port: The port on which the authentication provider listens.
This port must be non-SSL while Content Engine Setup is
running. After Content Engine Setup finishes, you can set
up SSL communication (see “Set Up Content Engine and
Client Transport SSL Security” on page 430).
•
Directory Service User: The distinguished name of the user
that Content Engine will use to connect to the directory
server. (This is the user you will specify in “To configure
directory service authentication” on page 221.)
If your authentication provider is Windows Active Directory,
an example distinguished name is:
cn=administrator,cn=users,dc=redwood,dc=local
•
Password: The password for this user account.
Click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
198
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Specify Authentication
Provider User Account
Parameters
NOTE For details on these parameters, see the IBM FileNet P8
help topic FileNet P8 Administration > Enterprise-wide
Administration > FileNet P8 Security > Directory Service Providers,
and navigate to the section about your directory service
provider.
NOTE This screen
appears only if you
selected to install the
Application Server
Authentication Provider
component.
Specify the following information, which will be used to by the
authentication provider to authenticate users, and click Next.
•
User Base DN
If your authentication provider is Windows Active Directory,
an example distinguished name is:
cn=users,dc=redwood,dc=local
•
User Name Attribute
•
User From Name Filter
JBoss only Ensure that the base DN you specify includes a
node/container at least one level above the root domain
container. For example, instead of specifying just your domain
for authentication on the whole realm, specify
DC=<your_domain>,CN=Users, DC=your_domain.
To specify additional containers, modify the login-conf.xml after
the CE installation to include other containers. Refer to IBM
FileNet P8 help topic FileNet P8 Administration > Enterprise-wide
Administration > FileNet P8 Security > How to > Configure multiple
realms.
Weblogic and JBoss By entering a User Base DN here you will
create an authentication realm that will join any that already
exist. You can add additional realms when Content Engine
Setup is finished.
WebSphere Websphere 6.0.x and earlier support only a single
authentication realm, so entering account parameters here
establishes that realm. However, you can later run the Directory
Configuration Wizard multiple times to establish multiple
authorization Base DNs as long as they are all included within
the single authentication Base DN provided here. WebSphere
6.1 supports federated user repositories, explained in “To use
WebSphere 6.1 federated user repository (optional)” on page 136.
All application servers To configure multiple realms following
installation, refer to IBM FileNet P8 help topic FileNet P8
Administration > Enterprise-wide Administration > FileNet P8
Security > How to > Configure for multiple realms.
Click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
199
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Specify Authentication
Provider Group Account
Parameters
NOTE For details on these parameters, see the IBM FileNet P8
help topic FileNet P8 Administration > Enterprise-wide
Administration > FileNet P8 Security > Directory Service Providers,
and navigate to the section about your directory service
provider.
NOTE This screen
appears only if you
selected to install the
Application Server
Authentication Provider
component.
Specify the following information, which will be used by the
authentication provider to authenticate groups, and then click
Next.
•
Group Base DN
If your authentication provider is Windows Active Directory,
an example distinguished name is
cn=users,dc=redwood,dc=local
•
Group From Name Filter
•
Static Group Name Attribute
JBoss only Ensure that the base DN you specify includes a
node/container at least one level above the root domain
container. For example, instead of specifying just your domain
for authentication on the whole realm, specify
DC=<your_domain>,CN=Users, DC=your_domain.
To specify additional containers, you must modify the loginconf.xml after the CE installation to include other containers.
Refer to IBM FileNet P8 help topic FileNet P8 Administration >
Enterprise-wide Administration > FileNet P8 Security > How to >
Configure multiple realms.
Depending on your application server, continue at one of the
following:
Specify WebSphere
Administrative Login
•
(WebSphere) “Specify WebSphere Administrative Login” on
page 200
•
(WebLogic or JBoss) “Setup Content Engine Bootstrap
Properties” on page 201.
Type the user name of an account in your authentication
provider to serve as a WebSphere administrator, and then click
Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
200
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Setup Content Engine
Bootstrap Properties
Specify the administrator login name and password, needed to
create a FileNet P8 domain and then click Next:
CAUTION Content Engine will fail to start if you specify the
wrong login name or password, or if these values are altered on
the directory server after Content Engine is installed.
To recover from such a condition, refer to the P8 Help topic
FileNet P8 Administration > Enterprise-wide Administration > FileNet
P8 Security > Security tools and procedures > CE Bootstrap
properties.
Specify GCD Master Key
•
Administrator Login Name: The account (referred to in
documentation as the “Content Engine system user”) under
which Content Engine will run. It must be a directory service
account. For WebSphere and WebLogic, it will also serve as
an application server console administrator. You will use
this account to create the IBM FileNet P8 domain later on.
•
Administrator Password: The password of the Administrator
Login account.
Specify and confirm a word or phrase for encrypting sensitive
GCD entries, and then click Next.
NOTE Store the master key in a secure location, as it is not
retrievable. You will need it to install updated EAR files in
interim fixes, or to access the GCD from applications built with
non-IBM FileNet APIs.
Compatibility COM API
(CCL) Configuration
NOTE This screen
appears only if you chose
to install Client
Connectivity (“Select
Components” on
page 191).
Accept the default values or enter your own values for the
following parameters to allow .NET clients to connect to Content
Engine, and then click Next:
•
Connection: The protocol (HTTP or HTTPS) for
communicating with Content Engine
•
Server: The name of the machine where you are installing
Content Engine
•
Application Server: The type of application server on which
Content Engine is to be deployed
•
Path
•
URL
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
201
Task 12: Install and Deploy Content Engine
To run Content Engine Setup
In this screen...
Perform this action...
Verify Installation
Review the summary information about the Content Engine
installation and click Finish to exit Content Engine Setup.
If you have run Content Engine Setup as part of an upgrade,
apply the latest Content Engine service pack before using
Enterprise Manager to configure the IBM FileNet P8 domain.
6. If you ran Content Engine Setup to create a response file for a silent install of Content Engine, continue
at “To install and deploy Content Engine silently” on page 203.
7. (WebLogic only) Stop and start the application server when Content Engine Setup exits, and
then continue at “Install Content Engine Software Updates” on page 204.
8. (WebSphere 5.1 and 6.0 only) Enable global security.
9. (WebSphere 6.1 only) Enable administrative security and application security, and disable Java
2 security.
10. (WebSphere only) Stop and start the application server. If the application server fails to start, or
if you want to verify the LDAP user registry settings:
a. Navigate to the directory containing the wsadmin (Windows) or wsasdmin.sh (UNIX)
command on your WebSphere installation path:
•
(WebSphere 5.1.x) <Install_path>/bin
•
(WebSphere 6.0.x) <Install_path>/profiles/<profile>/bin
•
(WebSphere 6.1.x) <Install_path>/profiles/bin
b. Run the following wsadmin command, as follows:
•
(UNIX) wsadmin.sh –conntype NONE
•
(Windows) wsadmin -conntype NONE
c. At the wsdmin> prompt, type:
wsadmin> securityoff
wsadmin> exit
d. Restart the application server, verify global security LDAP user registry modifications and
repeat Step 8 or Step 9.
11. (JBoss only) Verify the following:
•
The FileNet/ContentEngine directory exists and contains a nonempty file named servers.xml
•
The FileNet/ContentEngine/lib directory contains the file Engine-jb.ear.
12. Continue at “Install Content Engine Software Updates” on page 204.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
202
Task 12: Install and Deploy Content Engine
To install and deploy Content Engine silently
To install and deploy Content Engine silently
NOTE Before doing a silent install of Content Engine, you must have recorded a response file in
“To run Content Engine Setup” on page 188.
Before you run Content Engine Setup, you can manually edit the response file to suit your
installation environment. See “Encrypt Passwords for Silent Installations and Upgrades” on page 666
for a description of this file. Once you have completed your edits, do the following steps:
1. On the machine where you want to install Content Engine, log on as a user satisfying the
requirements specified in Step 1 on page 188.
2. (WebLogic and WebSphere only) Start the application server on the Content Engine machine if
it is not already running.
NOTE On UNIX, you can start WebSphere Application Server as the root user, or as a normal
user with read/write/execute permissions on <WebSphere_Install_Directory>/profiles/
<profile_name>.
3. (WebSphere on Windows only) If Windows Active Directory is going to be your directory
service, set the primary DNS server IP address on your Content Engine machine to the IP
address of the machine where DNS is installed.
4. Access the Content Engine software package, and navigate to the ContentEngine directory.
Run one of the commands shown in the following table to silently install Content Engine
(replacing /opt/response.txt or C:\response.txt with the path to your response file):
Platform
Command line
AIX
P8CE-4.0.0-AIX.bin -options '/opt/response.txt' -silent
HP-UX 11
P8CE-4.0.0-HPUX.bin -options '/opt/response.txt' -silent
HP-UX 11i
On WebLogic 9.2 (replacing /opt/java 1.5 with the path name
to your version 1.5 JVM):
P8CE-4.0.0-HPUXi.bin -is:javahome /opt/java1.5 -options
'/opt/response.txt' -silent
On non-WebLogic 9.2:
P8CE-4.0.0-HPUXi.bin -options '/opt/response.txt' -silent
Linux
P8CE-4.0.0-Linux.bin -options '/opt/response.txt' -silent
Solaris (SPARC)
P8CE-4.0.0-Sol.bin -options '/opt/response.txt' -silent
Solaris (x86)
P8CE-4.0.0-Solx86.bin -options '/opt/response.txt' -silent
Windows
P8CE-4.0.0-Win.exe -options 'C:\response.txt' -silent
5. Continue at Step 7 on page 202.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
203
Task 13: Install Content Engine Software Updates
To install the Content Engine software updates
Task 13: Install Content Engine Software Updates
Install any service packs, fix packs and/or interim fixes required for Content Engine.
To install the Content Engine software updates
1. To download the latest software update, and to determine whether additional interim fixes are
needed, contact your service representative.
2. Open the readmes for the following software updates and perform the installation procedures
provided:
a. P8 CE 4.0.1 Service Pack
b. Any subsequent interim fixes (typically optional)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
204
Task 14: Install the Latest Process Engine Client Files on Content Engine Servers
To install the Process Engine Client files
Task 14: Install the Latest Process Engine Client Files
on Content Engine Servers
Install the Process Engine Client files for the 4.0.x release or fix pack version of Process Engine
you intend to run. Perform the following steps on all Content Engine servers. These steps apply to
WebSphere, WebLogic, and JBoss (except where noted).
To install the Process Engine Client files
1. To download the latest software updates, and to determine which of these updates may be
required for use with other components and expansion products, contact your service
representative.
2. Log on to the Content Engine server as a user who has permission to install software.
3.
Verify that there is a current backup.
4. Download and expand the appropriate tar or zip file to the Content Engine server and extract the
contents to a local directory.
5. (WebSphere only) Make a note of the max and min connection settings from the
FileNetConnectionFactory.
You will need to reset these when you redeploy Content Engine. For details, see the task
“Redeploy Content Engine” on page 208.
6. Close all instances of Enterprise Manager (EM) and any other Content Engine client
applications, such as Application Engine. From the application server administrative console,
stop and un-deploy Content Engine.
•
WebSphere: Stop and un-deploy the FileNet Content Engine Application (Engine-ws.ear).
•
WebLogic: Stop and un-deploy the FileNet Content Engine Application (Engine-wl.ear).
•
JBoss: Execute the shutdown command.
7. (WebLogic only) Manually delete the following application server cache directories, substituting
your domain name and machine name in place of mydomain and myserver, respectively:
WebLogic 8.1.x UNIX:
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/tmp/_WL_user\Engine-wl
/opt/ bea/user_projects/domains/mydomain/servers/.wlnotdelete
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/cache/
EJBCompilerCache
WebLogic 8.1.x Windows:
C:\bea\user_projects\domains\FNCEDomain\myserver\.wlnotdelete\EJBCompilerCache
C:\bea\user_projects\domains\FNCEDomain\myserver\.wlnotdelete
WebLogic 9.2.x UNIX:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
205
Task 14: Install the Latest Process Engine Client Files on Content Engine Servers
To install the Process Engine Client files
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/tmp/_WL_user\Engine-wl
/opt/ bea/user_projects/domains/mydomain/servers/.wlnotdelete
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/cache/
EJBCompilerCache
WebLogic 9.2.x Windows:
C:\bea\user_projects\domains\mydomain\servers\AdminServer\tmp\_WL_user\Engine-wl
C:\bea\user_projects\domains\mydomain\servers\.wlnotdelete
C:\bea\user_projects\domains\mydomain\servers\AdminServer\cache\EJBCompilerCache
8. Start the Process Engine client install process.
•
To install the Process Engine client interactively:
i.
Access the IBM FileNet Process Engine client update software.
ii.
Launch the appropriate install program, where PE_version is the version of Process
Engine you intend to run, for example, 4.0.3.
•
Windows:
P8PEClientUpdater-<PE_version>-Win.exe
•
UNIX:
P8PEClientUpdater-<PE_version>-<operating system>.bin
iii. Continue with Step 9 on page 207 below.
•
To install the Process Engine client silently:
i.
Access the IBM FileNet Process Engine client update software package, and copy the
P8PEClient_silent_input.txt file to a local directory.
ii.
Follow the instructions in the silent input file to edit the file to reflect the appropriate
responses for your update.
iii. Run the PE Client installer with the following arguments, where PE_version is the version
of Process Engine you intend to run, for example, 4.0.3.
Windows:
P8PEClientUpdater-<PE_version>-Win.exe -silent -options
<path>\<P8PEClient_silent_input.txt>
UNIX:
P8PEClientUpdater-<PE_version>-<operating system>.bin -silent -options
<path>/<P8PEClient_silent_input.txt>
iv. Continue with Step 10 on page 207 below.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
206
Task 14: Install the Latest Process Engine Client Files on Content Engine Servers
To install the Process Engine Client files
9. Complete the Setup screens as follows:
In this screen...
Perform this action...
Products to Update
Select Content Engine.
Depending on the
version of Content
Engine detected by the
installer, you will see one
of the following:
Select Content
Engine EAR File to
Update
Select the appropriate EAR file. In most cases, this will be the
deployed EAR file.
Select Content
Engine Server to
Update
Choose a Content Engine Server instance from the drop-down
list.
or
Stop Running Software
If prompted, stop all running software components
Installation Summary
Validate that the information displayed is correct and that there
is enough space to complete the installation.
Software Components
Select the software components to automatically start after the
installation is complete.
10. Redeploy the Content Engine application, using the instructions in “Redeploy Content Engine” on
page 208.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
207
Task 15: Redeploy Content Engine
To redeploy Content Engine on WebSphere 5.1.x and 6.0.x
Task 15: Redeploy Content Engine
The procedures in this topic explain how to redeploy Content Engine on a standalone server. For
Content Engine in a managed server environment, see the procedures in “Deploy Multiple Content
Engine Instances” on page 454. For Content Engine in a clustered environment, see the IBM FileNet
P8 High Availability Technical Notice. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Perform the redeployment procedure appropriate for your Content Engine application server type:
•
“To redeploy Content Engine on WebSphere 5.1.x and 6.0.x” on page 208
•
“To redeploy Content Engine on WebSphere 6.1.x” on page 209
•
“To redeploy Content Engine on WebLogic” on page 211
•
“To redeploy Content Engine on JBoss” on page 211
To redeploy Content Engine on WebSphere 5.1.x and 6.0.x
1. From the WebSphere administrative console, go to Applications > Install New Application.
2. From the EAR/WAR/JAR module page, in the local or remote file system:
a. Navigate to the new Engine-ws.ear file.
b. Click Next.
c. Accept the defaults. When you see the "Provide options to perform the EJB Deploy" step,
change the "Database Type" to the current GCD database type (for example,
MSSQLSERVER_2000).
3. Save the changes to the master configuration.
4. Create a new J2C connection factory.
a. Go to Applications> Enterprise Applications> FileNetEngine> Connector Modules>
engine.ear> Resource Adapter> J2C Connection Factories.
b. If a connection factory already exists, click the factory name, and modify the properties as
follows. If a connection factory does not exist, click New to create a new J2C connection
factory:
Name: FileNetConnectionFactory
JNDI name: FileNet/Local/ConnectionFactory
c. Click Apply, then click Save.
5. (Optional) Set Connection Pool Properties.
a. Click Connection Pool Properties.
b. Set the following parameter values:
Max Connections: 100
Min Connections: 10
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
208
Task 15: Redeploy Content Engine
To redeploy Content Engine on WebSphere 6.1.x
c. Click Apply, then click Save.
6. Set the Class Loader properties.
a. Go to Applications > Enterprise Applications > FileNet Engine.
b. Change the following configuration settings:
Class loader mode: PARENT_LAST
WAR Class loader policy: Application
c. Click Apply, then click Save to update the master configuration.
7. Go to Applications> Enterprise Applications and start the FileNetEngine application.
8. (WebSphere 5 only) Update the Systinet plug-in:
a. From the WebSphere administrative console, navigate to Environment> Update Web Server
Plugin.
b. Click OK.
c. Click View or download the current web server plug in the configuration file to verify the
WSDL file is installed correctly.
d. Open a web browser and verify that the URL http://localhost:9080/wsi/admin/console directs
you to the Systinet administrative console.
Do this only once per new WSDL.
9. Verify a successful deployment by entering the following into a web browser:
http://<ce_app_server_machine_name>:<port>/FileNet/Engine
NOTE The default port is 9080. This port number can be different than the default. Enter the
port number accordingly.
If the deployment is successful, this action will return a “P8 CEMP Startup:” message.
To redeploy Content Engine on WebSphere 6.1.x
1. From the WebSphere administrative console, go to Applications > Install New Application.
2. From the EAR/WAR/JAR module page, in the local or remote file system:
a. Navigate to the new Engine-ws.ear file.
b. Click Next.
c. Accept the defaults, except in step 3 (of the WebSphere administrative console)
deployment process, select both Engine-init.war and FileNet CE-MP WebService, and set
their values to default_host.
3. Save the changes to the master configuration.
4. Create a new J2C connection factory:
a. Go to Applications > Enterprise Applications > FileNetEngine > Manage Modules > FileNet
P8 Connector > Resource Adapter> J2C connection factories.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
209
Task 15: Redeploy Content Engine
To redeploy Content Engine on WebSphere 6.1.x
b. If a connection factory already exists, click the factory name, and modify the properties as
follows. If a connection factory does not exist, click New to create a new J2C connection
factory, and set the following properties:
Name: FileNetConnectionFactory
JNDI Name: FileNet/Local/ConnectionFactory
c. Click Apply, then click Save.
5. Change the following three entries, under Container-managed authentication to "None", and
click Apply.
•
Container-managed authentication alias
•
Authentication preference
•
Mapping-configuration alias
6. (Optional) Set the Connection Pool Properties to the following values, and click Apply.
•
Max Connections: 100
•
Min Connections: 10
7. Save your changes to the master configuration.
8. Change the Class Loading and update detection settings, as follows:
a. Go to Applications > Enterprise Applications > FileNet Engine > Class Loading and update
detection.
b. Change the polling interval to 3 (seconds).
c. Change the Class loader order to Classes loaded with application class loader first.
d. Change the WAR class loader policy to Single class loader for application.
e. Save your changes to the master configuration.
9. Change Class Loader order.
a. Go to Applications > Enterprise Applications > FileNetEngine > Manage Modules > FileNet
CEMP Web Service.
b. Change the class loader order to Classes loaded with application class loader first.
c. Click Apply.
d. Save your changes to the master configuration.
10. Verify a successful deployment by entering the following into a web browser:
http://<ce_app_server_machine_name>:<port>/FileNet/Engine
NOTE The default port is 9080. This port number can be different than the default. Enter the
port number accordingly.
If the deployment is successful, this action will return a “P8 CEMP Startup:” message.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
210
Task 15: Redeploy Content Engine
To redeploy Content Engine on WebLogic
To redeploy Content Engine on WebLogic
1. Deploy the new Engine-wl.ear file. (On WebLogic 9.2 you will also need to accept the defaults
for roles, security, and so on.)
2. Restart Content Engine (the Engine-wl application).
3. Verify a successful deployment by entering the following into a web browser:
http://<ce_app_server_machine_name>:<port>/FileNet/Engine
NOTE The default port number is 7001. This port number can be different than the default.
Enter the port number accordingly.
If the deployment is successful, this action will return a “P8 CEMP Startup:” message.
To redeploy Content Engine on JBoss
1. Copy the new Engine-jb.ear or the new Engine-jbc.ear file to the server instance deploy
directory.
2. Restart the server instance.
3. Verify a successful deployment by entering the following into a web browser:
http://ce_app_server_machine_name>:<port>/FileNet/Engine
NOTE The default port number is 8080. This port number can be different than the default.
Enter the port number accordingly.
If the deployment is successful, this action will return a “P8 CEMP Startup:” message.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
211
Task 16: Complete Post-Install Content Engine Configuration
Install Centera Shared Libraries
Task 16: Complete Post-Install Content Engine
Configuration
Install Centera Shared Libraries
If you are going to access Centera fixed content devices with your IBM FileNet P8 system, you
must install the Centera shared libraries on each machine where you deploy Content Engine
Server. The following two procedures install the libraries on UNIX and Windows machines:
•
“To install Centera shared libraries (UNIX)” on page 212
•
“To install Centera shared libraries (Windows)” on page 213
Do the procedure corresponding to the operating system that hosts Content Engine Server.
To install Centera shared libraries (UNIX)
NOTE The path names and environment variables in this procedure are appropriate for the AIX
operating system and may differ for other UNIX systems.
1. If you haven't already done so, log on as a user with write permission on the directory in which
you will install the Centera shared libraries, for example /usr/local.
2. Access the Content Engine installation software Insert and mount the Content Engine
installation CD in the CD drive.
3. Navigate to the Centera/install directory and copy this directory to a temporary location (where
you have execute permission), from which you will install the Centera libraries.
Note that the Centera directory contains install and lib subdirectories. The install directory
contains the installation and setup scripts (install.sh and setCenteraLibPath.sh); the lib
directory contains the Centera shared libraries.
4. Navigate to the Centera/install directory in the temporary location and do the following substeps
to install the Centera shared libraries:
a. Launch the installation script install.sh:
./install.sh
b. The script will prompt you to specify an installation directory, as in the following example:
Introduce install directory [/usr/local/Centera_SDK]:
Accept the default installation directory, /usr/local/Centera_SDK, or specify another one,
and then press <Enter>. You do not need to create the installation directory in advance; if
the directory doesn’t exist, the script will create it.
If your UNIX system is Solaris or HP-UX 11i, install.sh creates subdirectories lib/32 and
lib/64 under the installation directory you specify, and installs both the 32-bit and 64-bit
libraries. On other UNIX systems, install.sh creates only subdirectory lib/32.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
212
Task 16: Complete Post-Install Content Engine Configuration
To install Centera shared libraries (Windows)
5. Navigate to Centera/install directory at the temporary location, open the file
setCenteraLibPath.sh in a text editor, and verify that it contains the following lines:
CENTERA_LIB_PATH=/usr/local/Centera_SDK/lib/32
LIBPATH=$LIBPATH:$CENTERA_LIB_PATH
export LIBPATH
NOTE On HP-UX 11i, SHLIB_PATH appears in place of LIBPATH.
6. Edit setCenteraLibPath.sh and save your changes, as follows:
a. If you did not accept the default installation directory in Step 4, replace /usr/local/
Centera_SDK with the value you did specify.
b. If your UNIX system is Solaris or HP-UXZ 11i, the default value for the first line in Step 5 is
as follows:
CENTERA_LIB_PATH=/opt/Centera_SDK/lib/32
If your Solaris or HP-UX 11i system is 64-bit, change the line above to this:
CENTERA_LIB_PATH=/opt/Centera_SDK/lib/64
7. Open your application server startup script in a text editor:
•
(WebSphere) setupCmdLine.sh
•
(WebLogic 8.1.x) startWebLogic.sh
•
(WebLogic 9.2) setDomainEnv.sh
•
(JBoss) run.sh
8. Add a line to the application server startup script to run the setCenteraLibPath.sh script and
save your edits. Continuing the example from Step 4:
./usr/local/Centera_SDK/setCenteraLibPath.sh
9. Stop and start the application server to run the startup script.
10. If you did this procedure as part of your first deployment of Content Engine Server, continue at
“To verify the GCD data sources and connection pools” on page 214. If you did this procedure as
part of deploying Content Engine to an additional server, exit this task.
To install Centera shared libraries (Windows)
1. If you haven't already done so, log on as a user with write permission on the drive where you will
install the Centera shared libraries, for example C:.
2. Access the Content Engine installation software.
3. Navigate to the Centera\ directory and copy this directory to a temporary location, from which
you will install the Centera libraries.
Note that the Centera directory contains install and lib subdirectories. The install directory
contains the installation and setup scripts; the lib directory contains the Centera shared
libraries.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
213
Task 16: Complete Post-Install Content Engine Configuration
Verify the Data Sources and Connection Pools
4. Navigate to the Centera\install directory at the temporary location and run the installation script
install.bat to install the Centera shared libraries, as follows:
install.bat INSTALL_DIR
where INSTALL_DIR is the installation directory where you want to install the Centera shared
libraries, for example, C:\Centera_SDK.
You do not need to create the installation directory in advance; if the directory doesn’t exist,
the installation script will create it.
5. Navigate to the Centera\install directory at the temporary location, open the file
setCenteraLibPath.bat in a text editor, and verify that it contains the following lines:
set CENTERA_LIB_PATH=C:\Centera_SDK\lib
set PATH=%PATH%;%CENTERA_LIB_PATH%
If you did not specify C:\Centera_SDK as the installation directory in Step 4, change
C:\Centera_SDK in the first line above to the location you did specify.
6. Open your application server startup script in a text editor:
•
(WebSphere) setupCmdLine.cmd
•
(WebLogic 8.1.x) startWebLogic.cmd
•
(WebLogic 9.2) setDomainEnv.cmd
•
(JBoss) run.bat
7. Add the following line to your application server startup script to run the setCenteraLibPath.bat
script and save your edits. Continuing the example:
set CENTERA_LIB_PATH=C:\Centera_SDK\lib
set PATH=%PATH%;%CENTERA_LIB_PATH%
8. Stop and start the application server to run the startup script.
Verify the Data Sources and Connection Pools
To verify the GCD data sources and connection pools
1. If WebLogic is your application server, do the following:
a. If you ran Content Engine Setup on a machine where a browser is installed, WebLogic
Server Administration Console automatically starts after you click Finish in “Verify
Installation” on page 202; otherwise, on a machine where a browser is installed, start
WebLogic Server Administration Console by going to the following web address:
http://<WebLogic_Machine_Name>:7001/console
where WebLogic_Machine_Name is the name of the WebLogic machine on which you ran
Content Engine Setup.
b. Log on to WebLogic Server Administration Console as the user you specified in “Specify
WebLogic Information” on page 195, and verify that the data sources and connection pools
you specified in Content Engine Setup have been created.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
214
Task 16: Complete Post-Install Content Engine Configuration
Verify That Content Engine Has Deployed
c. Log out of WebLogic Server Administration Console.
d. Stop and start WebLogic Application Server.
NOTE If there are too few connection pools for a GCD data source, an IBM FileNet P8 client
application will encounter errors. Depending on the number of object stores you will create,
and the number of users who will concurrently access the GCD, you may want to modify, via
WebLogic Administration Console, the number of connection pools (XA and non-XA) for each
GCD data source. As a general rule, this number should be <number of object stores> * 16 +
<number of concurrent users>.
2. If WebSphere is your application server, do the following:
a. Stop and start WebSphere.
b. Log on to WebSphere administrative console as the user you specified in “Specify
WebSphere Administrative Login” on page 200.
c. Verify that the data sources and connection pools you created are present.
d. Navigate to Applications > Enterprise Applications and verify that FileNetEngine is in the
Enterprise Applications list and has a right-pointing green arrow in the Application Status
column.
3. If JBoss is your application server, do the following:
a. Verify that the data sources and connection pools you created are present.
b. Verify that Content Engine is deployed.
4. Continue at “To verify that Content Engine has deployed” on page 215.
Verify That Content Engine Has Deployed
To verify that Content Engine has deployed
Do the following steps to verify that Content Engine is deployed on your application server:
1. Open a browser on the Content Engine machine and navigate to the following location:
http://localhost:<port>/FileNet/Engine
where the default value of <port> is one of the following:
•
(WebSphere) 9080
•
(WebLogic) 7001
•
(JBoss) 8080
2. Verify that this location displays Content Engine information similar to the following:
Startup
Message
P8 CEMP Startup: 4.0 dap430.1089 Copyright (c) 2006, 2007 IBM
Corporation. All rights reserved.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
215
Task 16: Complete Post-Install Content Engine Configuration
Enable Log4J Logging API (Optional)
3. If you have not previously selected Administration Tools - Enterprise Manager for installation in
“Select Components” on page 193, continue at “Install Enterprise Manager” on page 217. Otherwise,
continue at “To create a FileNet P8 domain” on page 221.
Enable Log4J Logging API (Optional)
To enable the Log4j logging API (optional)
The log4j.properties.client file is used for Log4j logging by IBM FileNet P8 client applications. To
allow Log4J logging in an IBM FileNet P8 client application, you need to copy and rename this file
as follows:
1. Navigate to the directory FileNet/ContentEngine/config/samples.
2. Copy the log4j.properties.client file to the FileNet/ContentEngine/config directory and rename
the file log4j.properties.
3. Depending on whether you ran Content Engine Setup as an upgrade to an earlier version of
Content Engine, or as a new installation, continue as follows:
•
If you are upgrading, continue at procedure “To prepare NetApp SnapLock Volumes for the
upgrade” on page 511 in “Upgrade Content Engine Software” on page 505.
•
If you are running a new installation, continue at “Install Enterprise Manager” on page 217.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
216
Task 17: Install Enterprise Manager
To install Enterprise Manager interactively or to record a response file
Task 17: Install Enterprise Manager
By installing Enterprise Manager on a single client machine, you can administer multiple object
stores in a single IBM FileNet P8 domain.
NOTES
•
You can install Enterprise Manager only on a Windows machine, and only using the Windows
version of the Content Engine installation media.
•
If you installed Content Engine Setup on a Windows machine, you can skip “Establish the
FileNet P8 Domain and Global Configuration Data (GCD)” on page 221, as Content Engine Setup
has already installed Enterprise Manager.
On a machine where you are going to install Enterprise Manager, you must first install Microsoft
.NET Framework and Web Services Enhancements (WSE). Check the IBM FileNet P8 Hardware
and Software Requirements for the latest version requirements of these two components. To
download this guide from the IBM support page, see “Access IBM FileNet Documentation,
Compatibility Matrices, and Fix Packs” on page 23. Enterprise Manager requires no other Content
Engine services or files.
You can install Enterprise Manager interactively, via Content Engine Setup, or silently, via a
command-line interface.
Before doing a silent install of Enterprise Manager, you must first record a response file by
running Content Engine Setup interactively, typically in a development or test setting. You then
use the response file to run a silent install of Enterprise Manager in a production environment.
CAUTION Do not install Enterprise Manager 4.0.x on any machine running the 3.5.x version, at
least until the Content Engine 4.0.x upgrade is complete. Otherwise, you will no longer be able to
run Enterprise Manager 3.5.x against any remaining 3.5.x object stores.
To install Enterprise Manager interactively or to record a response file
1. Log on to the Windows machine with an account that has local administrator privileges.
2. Access the Content Engine software package, and navigate to the directory
\ContentEngine\CEMP.Windows.
3. Start Content Engine Setup, as follows.
NOTE If you are installing on a server where you have already applied a Content Engine 4.0
software update (Service Pack or fix pack), when you issue setup commands you must include
two additional -W switches and associated parameters to disable version checking, as noted
below.
•
If you are doing an interactive (non-silent) install, run this command:
(On a server having no Content Engine 4.0 software updates applied)
P8CE-4.0.0-Win.exe
(On a server having Content Engine 4.0 software updates applied)
P8CE-4.0.0-Win.exe -W updateCheck.active=false -W installCheck.active=false
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
217
Task 17: Install Enterprise Manager
To install Enterprise Manager interactively or to record a response file
•
If you are recording a response file for a subsequent silent install, run the following command
(replacing C:\response.txt with the path to your response file):
(On a server having no Content Engine 4.0 software updates applied)
P8CE-4.0.0-Win.exe -options-record “C:\response.txt”
(On a server having Content Engine 4.0 software updates applied)
P8CE-4.0.0-Win.exe -options-record “C:\response.txt” -W updateCheck.active=false
-W installCheck.active=false
The first Content Engine Setup screen may not appear for 30 seconds or more after you run
the command to start it.
4. Start the Content Engine Setup program using one of the following commands, depending on
whether you want the program to record a response file and whether you have applied a service
pack or interim fix to the Content Engine software on this machine.
NOTE The first Content Engine Setup screen may not appear for 30 seconds or more after you
run the command to start it.
•
If you have not yet applied a service pack or interim fix and want a response file:
P8CE-4.0.0-Win.exe -options-record “C:\response.txt”
•
If you have already applied a service pack or interim fix and want a response file:
P8CE-4.0.0-Win.exe -options-record “C:\response.txt” -W updateCheck.active=false
-W installCheck.active=false
•
If you have not applied a service pack or interim fix and do not want a response file:
P8CE-4.0.0-Win.exe
•
If you have already applied a service pack ro interim fix and do not want a response file:
P8CE-4.0.0-Win.exe -options -W updateCheck.active=false -W
installCheck.active=false
5. Complete the Content Engine Setup wizard screens as follows:
In this screen...
Perform this action...
Welcome
Click Next to proceed with the Content Engine installation.
NOTE Click Back at any time while running Content Engine
Setup to make changes in any previous screens. Click Cancel to
exit Content Engine Setup.
FileNet Notice to End
User
Review and accept the license agreement for IBM FileNet P8
software products, and then click Next.
Specify Installation
Location
Accept the default (or browse to another) Content Engine
installation directory, and then click Next.
Select Components
From the list shown on the screen, select the Administrative
Tools - Enterprise Manager check box, clear all other check
boxes, and then click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
218
Task 17: Install Enterprise Manager
To install Enterprise Manager silently
In this screen...
Perform this action...
.NET Framework and
WSE Requirements
This screen appears only if Microsoft .NET Framework 2.0 and
Web Services Enhancements (WSE) 3.0 are not both installed
on the machine where you are running Content Engine Setup.
Select the Continue? check box if you have later or compatible
versions of these components, and then click Next. Otherwise,
click Cancel to exit Content Engine Setup and install these two
components.
Specify Documentation
URL
If you have already installed IBM FileNet P8 Documentation,
specify its URL and click Test to verify the connection. This
setting enables access from Enterprise Manager and other IBM
FileNet P8 tools and interfaces.
Alternatively, you can specify the URL after Content Engine
Setup finishes, using the General tab of the Root node
properties of Enterprise Manager.
Click Next.
Review Installation
Summary
Verify your component selections and click Install to start
installing Content Engine.
Verify Installation
Review the summary information about the installation and click
Finish to exit Content Engine Setup.
When Content Engine Setup exits, do one of the following:
•
If you ran Content Engine Setup to create a response file for a silent install of Enterprise
Manager, continue at “To install Enterprise Manager silently” on page 219.
•
If you ran Content Engine Setup interactively (that is, without creating a response file), do one
of the following:
–
If this is the first instance of Enterprise Manager you have installed, continue at “Establish
the FileNet P8 Domain and Global Configuration Data (GCD)” on page 221.
–
If this is an additional instance of Enterprise Manager, exit this task.
To install Enterprise Manager silently
NOTE Before doing a silent install of Enterprise Manager, you must have recorded a response file
in “To install Enterprise Manager interactively or to record a response file” on page 217.
You can manually edit the response file to suit your installation environment before you install
Enterprise Manager (see “Encrypt Passwords for Silent Installations and Upgrades” on page 666 for a
description of this file). Once you have completed your edits, do the following steps:
1. Log on to the Windows machine where you want to install Enterprise Manager as a member of
the local Administrators group.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
219
Task 17: Install Enterprise Manager
To install Enterprise Manager silently
2. Access the Content Engine software package, and navigate to the ContentEngine directory.
3. Silently install Enterprise Manager (replacing C:\response.txt with the path to your response
file) using one of the following commands:
•
If you have not yet applied a service pack or interim fix to the Content Engine software on this
machine, run this command:
P8CE-4.0.0-Win.exe -options “C:\response.txt” -silent
•
If you are installing an instance of Enterprise Manager on a machine after having applied a service
pack or interim fix to the Content Engine software on that machine, run the following command
(without carriage returns) with two -W parameters to disable version checking, as follows:
P8CE-4.0.0-Win.exe -options “C:\response.txt” -silent -W updateCheck.active=false
-W installCheck.active=false
4. When Content Engine Setup exits, do one of the following:
•
If this is the first instance of Enterprise Manager you have installed, continue at “Establish the
FileNet P8 Domain and Global Configuration Data (GCD)” on page 221.
•
If this is an additional instance of Enterprise Manager, continue at “Install an Additional Instance of
Enterprise Manager” on page 445.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
220
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD)
To create a FileNet P8 domain
Task 18: Establish the FileNet P8 Domain and Global
Configuration Data (GCD)
To create a FileNet P8 domain
With Content Engine installed and deployed, you must now use Enterprise Manager to create a
FileNet P8 domain.
1. Start Enterprise Manager by double-clicking the FileNet Enterprise Manager SnapIn 4.0 on the
desktop, or by choosing Start > All Programs > FileNet P8 Platform > Enterprise Manager
SnapIn 4.0.
2. In the FileNet P8 Logon dialog box, click Add, to create a FileNet P8 domain configuration.
NOTE For subsequent logons to Enterprise Manager, you can access an existing FileNet P8
domain by clicking Connect.
3. In the Add Domain Configuration dialog box, specify the following information and then click OK:
•
Nickname - an identifier (not part of any credentials) that can be used to connect to Content
Engine
•
Username - the name of the Content Engine system user, which must be the account you
specified earlier in the Setup Content Engine Bootstrap Properties screen of Content Engine
Setup.
•
Remember password - Select the check box if you want to avoid typing the password each time
you log on as this user. (The password will be encrypted.)
•
Use integrated - Select the check box if you want Kerberos authentication for this user
4. In the FileNet P8 Logon dialog box, click Connect.
5. In the Create P8 Domain screen, enter the name for a new FileNet P8 domain and click
Continue to launch the Create a Directory Configuration wizard.
6. In the FileNet P8 - Domain Logon dialog box, type the user name and password and click OK.
Continue at “To configure directory service authentication” on page 221.
To configure directory service authentication
NOTE The configuration parameters required by the Create a Directory Configuration wizard are
in many cases the same as those you provided to Content Engine Setup while configuring the
application server’s authentication provider. Refer also to the topic for your directory server within
the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8
Security > Directory service providers.
1. In the Welcome screen of the Create a Directory Configuration wizard, click Next.
2. In the Select Type and Name Directory Configuration screen, as follows:
a. Choose the same directory service from the Type drop-down list that you selected earlier
while running Content Engine Setup.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
221
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD)
To configure directory service authentication
b. Type a display name (unique across all FileNet P8 domains in a forest) for the new directory
configuration.
c. Click OK.
If you chose Windows Active Directory, continue at Step 3; if you chose any of the following
directory services, continue at Step 6.
•
ADAM
•
IBM Tivoli Directory Server
•
Novell eDirectory
•
Sun Java System Directory Server
3. In the Select General Directory Configuration Properties screen, specify the following
information and then click Next:
Parameter
Value and Description
Host
The name or IP address of the host where the Windows domain
controller is installed. In a forest environment, the Windows domain
names must be distinct if name you specify must be unique within each.
Port
The LDAP port number (389, by default).
Directory Service User
Distinguished name of Content Engine user who will access the
directory service provider. This is the same user you specified when
running Content Engine Setup (see “Configure Authentication Provider”
on page 198).
Password
Password of the directory service user.
Is SSL Enabled
True or False.
Return Name as DN
Choose whether to return names from the directory service
provider in distinguished-name format.
4. In the Select User Directory Configuration Properties screen, specify the following information
and then click Next:
Parameter
Value and Description
User Base DN
Base distinguished string to use in LDAP user searches.
User Search Filter
LDAP search filter for finding user names.
User Display Name Attribute
cn, by default.
User Short Name Attribute
samAccountName, by default.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
222
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD)
To configure directory service authentication
5. In the Select Group Directory Configuration Properties screen, specify the following information,
click Next, and continue at Step 9:
Parameter
Value and Description
Group Base DN
Base distinguished string to use in LDAP group
searches.
Group Search Filter
LDAP search filter for finding group names.
Group Display Name Attribute
cn, by default.
Group Short Name Attribute
cn, by default.
Search Cross Forest Group Membership
False, by default.
6. In the Select General Directory Configuration Properties screen, specify the following
information and then click Next:
Parameter
Value and Description
Host
Name or IP address of machine where the directory server is installed.
Port
LDAP port number (389, by default).
Directory Service User
Distinguished name of Content Engine user who will access the
directory service provider.
Password
Password of directory service user.
Is SSL Enabled
True or False.
7. In the Select User Directory Configuration Properties screen, specify the following information
and then click Next:
Parameter
Value and Description
User Base DN
Base distinguished string to use in LDAP user searches.
User Search Filter
LDAP search filter for finding user names.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
223
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD)
To configure directory service authentication
Parameter
Value and Description
User Display Name Attribute
•
User Short Name Attribute
cn, by default, for the following:
–
ADAM
–
IBM Tivoli Directory Server
–
Novell eDirectory
•
uid, for Sun Java System Directory Server
•
cn, by default, for the following:
•
–
ADAM
–
IBM Tivoli Directory Server
–
Novell eDirectory
uid, for Sun Java System Directory Server
8. In the Select Group Directory Configuration Properties screen, specify the following information,
click Next, and continue at Step 9:
Parameter
Value and Description
Group Base DN
Base distinguished string to use in LDAP group searches.
Group Search Filter
LDAP search filter for finding group names.
Group Display Name
Attribute
cn, by default.
Group Short Name
Attribute
cn, by default.
Group Membership
Search Filter
The search filter for group membership queries.
9. In the Completing the Create a Directory Configuration Wizard screen, click Finish.
10. 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. Continue at “To configure permissions for a FileNet P8
domain” on page 225.
NOTE For multi-realm authorization, run the Directory Configuration Wizard once for each realm.
Refer to FileNet P8 Administration > Enterprise-wide Administration > FileNet P8 Security > How to >
Configure for multiple realms.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
224
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD)
To configure permissions for a FileNet P8 domain
To configure permissions for a FileNet P8 domain
1. In the Welcome screen of the Configure New Domain Permissions wizard, click OK.
2. In the Specify domain administrators screen,
a. Click Add to load the Select Users and Groups dialog box that lets you add users and
groups to the list of GCD administrators.
b. (Optional) Click Remove to remove the Content Engine system user.
c. Click Next.
3. In the Completing the Configure New Domain Permissions Wizard screen, click Finish.
4. In the Configure New Domain Permissions message box, click OK.
NOTE To edit the list of accounts having administrative access to the FileNet P8 domain, refer to
the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > FileNet P8
Security > How to... > Add or remove a GCD administrator.
To set the Statement Cache Size value for the GCD database
If you are using Microsoft SQL Server 2005 JDBC Driver, you need to set the Statement Cache
Size parameter value to 0 for each data source you created to access the GCD database, as
shown in the following steps:
1. Access the page containing the Statement Cache Size parameter:
•
(WebSphere) Navigate to the WebSphere administrative console page containing the field
Statement Cache Size property. For example, in WebSphere 6.0.x, navigate to Resources > JDBC
Providers > JDBC_provider > Data sources > data_source > WebSphere Application Server
connection properties.
•
(WebLogic 8.1.x) Navigate in the tree view of WebLogic Administration Console to FNCEDomain
> Services > JDBC > Connection Pools > Connection_Pool_Name.
•
(WebLogic 9.2.x) Navigate in the tree view of WebLogic Administration Console to
FNCEDomain > Services > JDBC > Data Sources > Data_Source_Name > Connection Pool
2. Set the Statement Cache Size to 0 and save your change.
3. Depending on whether you ran Content Engine Setup as an upgrade to an earlier version of
Content Engine, or as a new installation, continue as follows:
•
If you are upgrading, continue at procedure “To prepare NetApp SnapLock Volumes for the
upgrade” on page 511 in “Upgrade Content Engine Software” on page 505.
•
If you are running a new installation, continue at one of the following:
–
Task 19a “Configure Content Engine Application Server Database Connectivity (WebSphere
5.1.x)” on page 227
–
Task 19b “Configure Content Engine Application Server Database Connectivity (WebSphere
6.0.x)” on page 240
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
225
Task 18: Establish the FileNet P8 Domain and Global Configuration Data (GCD)
To set the Statement Cache Size value for the GCD database
–
Task 19c “Configure Content Engine Application Server Database Connectivity (WebSphere
6.1.x)” on page 254
–
Task 19d “Configure Content Engine Application Server Database Connectivity (WebLogic
8.1.x)” on page 270
–
Task 19e “Configure Content Engine Application Server Database Connectivity (WebLogic
9.2.x)” on page 275
–
Task 19f “Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)”
on page 281
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
226
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (DB2)
Task 19a: Configure Content Engine Application
Server Database Connectivity (WebSphere 5.1.x)
In this task, you will set up the data sources, connection pools, and (optionally) the distributed
(XA) and non-distributed (non-XA) JDBC providers for Content Engine to communicate with the
databases or tablespaces associated with the object stores you will create in a later task.
Perform one of the following procedures for each object store, depending on your database type:
•
“To configure WebSphere 5.1.x database connectivity (DB2)” on page 227
•
“To configure WebSphere 5.1.x database connectivity (MS SQL Server)” on page 232
•
“To configure WebSphere 5.1.x database connectivity (Oracle)” on page 235
NOTE If you are upgrading from version 3.5.x of Content Engine, specify the 3.5.x database or
tablespace information in these procedures.
To configure WebSphere 5.1.x database connectivity (DB2)
1. Start the WebSphere administrative console (if it isn’t already running).
2. For each object store, you need to create a database user alias associated with a unique
database and database user, as follows:
a. Navigate to Security > JAAS Configuration > J2C Authentication Data. In the right-hand
pane, notice that there is already an alias (created by Content Engine Setup) for the GCD
tablespace user.
b. Click New to create an alias and specify the following information:
•
Alias
•
User (object store tablespace user)
•
Password (object store tablespace user password)
•
Description (optional)
c. Click Apply, and then click Save.
3. Navigate to Resources > JDBC Providers, click Cell and then click Apply. If you chose to have
Content Engine Setup create the JNDI names for the GCD data sources, you should see both
distributed (XA) and non-XA JDBC providers listed.
You need only one pair (XA and non-XA) of JDBC providers for all your object stores. If you
intend to use the JDBC providers created by Content Engine Setup, rather than create new
ones, skip to Step 6; otherwise, continue at Step 4.
4. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers, verify that the Cell option button is selected, and
click New.
b.
In the Configuration tab, set the value of the JDBC Providers property to DB2 Universal
JDBC Driver Provider, and then click Apply.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
227
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (DB2)
c. Specify the values shown in the following table:
Property
Value
Name
<User-defined non-XA JDBC provider name>
Description
(Optional)
Classpath
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/
db2jcc_license_cu.jar
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc.jar
Native Library Path
(none)
Implementation Classname
com.ibm.db2.jcc.DB2ConnectionPoolDataSource
d. Click OK to view the table that shows your new JDBC provider.
5. Create an XA JDBC provider as follows:
a. Verify that the Cell option button is still selected, and then click New.
b. In the Configuration tab, set the value of the JDBC Providers property to DB2 Universal
JDBC Driver Provider (XA), and then click Apply
c. Specify the values shown in the following table:
Property
Value
Name
XA JDBC provider name
Classpath
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/
db2jcc_license_cu.jar
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc.jar
Native Library Path
(none)
Implementation Classname
com.ibm.db2.jcc.DB2XADataSource
d. Click OK to view the table that shows your new JDBC provider.
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
6. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the entry for
the DB2 non-XA JDBC provider that Content Engine Setup created or that you created in
Step 4.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
228
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (DB2)
b. Under Additional Properties, click Data Sources, click New, specify the information in the
following table, and then click Apply.
Parameter
Value
Name
Data source name
JNDI Name
The name of the data source to be used by the Create Object
Store wizard.
Datasource Helper
Classname
DB2 Universal data store helper
com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper
Component-managed
Authentication Alias
<Node>/<alias> created in created in Step 2 on page 227
Container-managed
Authentication Alias
(none)
Mapping-configuration
Alias
(none)
c. Click Apply, click Custom Properties in the Additional Properties table, and specify the
values shown in the following table:
Parameter
Value
databaseName
Name of DB2 database
driverType
4
serverName
Host name of machine where DB2 is installed
portNumber
50000 (by default)
resultSetHoldability
1
fullyMaterializeLobData
See Note below.
NOTE The default value of fullyMaterializeLobData is true; but you may want to set it to
false if both of the following conditions apply:
•
You will be creating an object store (see “Create Object Stores” on page 286) with a
database storage area as the content storage location.
•
Users will be storing large content elements (for example, larger than 300 MB).
Setting the value of fullyMaterializeLobData to false prevents performance degradation or
memory-related errors during retrieval or indexing of large content elements. Alternatively,
specify a file storage area instead of a database storage area when creating an object
store.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
229
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (DB2)
d. Click New and specify the the property values shown in the following table:
Name
Value
Type
webSphereDefaultIsolationLevel
2
java.lang.Integer
e. Click Apply.
f.
Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
7. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the non-XA JDBC provider created by
Content Engine Setup created or that you created in Step 4).
b. Under Additional Properties, click Data Sources, select the check box for the non-XA data
source, and then click Test Connection to test the connection.
8. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the XA entry
for the DB2 database type of JDBC provider.
b. Under Additional Properties, click Data Sources, click New, specify the information in the
following table, and then click Apply.
Parameter
Value
Name
The data source name.
JNDI Name
The name of the data source to be used by the Create
Object Store wizard.
Datastore Helper
Classname
DB2 Universal data store helper
com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelpe
r
Component-managed
Authentication Alias
<Node>/<alias> created in created in Step 2 on page 227
Container-managed
Authentication Alias
(none)
Mapping-Configuration
Alias
(none)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
230
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (DB2)
c. Click Apply, click Custom Properties in the Additional Properties table,and specify the
values shown in the following table:
Parameter
Value
databaseName
Name of DB2 database
driverType
4
serverName
Host name of machine where DB2 is installed
portNumber
50000 (by default)
fullyMaterializeLobData
See Note below.
NOTE The default value of fullyMaterializeLobData is true; but you may want to set it to
false if both of the following conditions apply:
•
You will be creating an object store (see “Create Object Stores” on page 286) with a
database storage area as the content storage location.
•
Users will be storing large content elements (for example, larger than 300 MB).
Setting the value of fullyMaterializeLobData to false prevents performance degradation or
memory-related errors during retrieval or indexing of large content elements. Alternatively,
specify a file storage area instead of a database storage area when creating an object
store.
d. Click New and specify the the property values shown in the following table:
Name
Value
Type
webSphereDefaultIsolationLevel
2
java.lang.Integer
e. Click Apply.
f.
Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
9. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the XA JDBC provider created by
Content Engine Setup created or that you created in step Step 5).
b. Under Additional Properties, click Data Sources, select the check box for the XA data
source, and then click Test Connection to test the connection.
10. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
231
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (MS SQL Server)
To configure WebSphere 5.1.x database connectivity (MS SQL Server)
1. Start the WebSphere administrative console (if it isn’t already running).
2. Navigate to Security > JAAS Configuration > J2C Authentication Data. In the right-hand pane,
note the alias created for the GCD database user, as you will use this alias for data source
connectivity.
3. Navigate to Resources > JDBC Providers. Click Cell and then click Apply. If you chose to have
Content Engine Setup create the JNDI names for the GCD data sources, you should see both
XA and non-XA JDBC providers listed.
You need only one pair (XA and non-XA) of JDBC providers for all your object stores. If you
intend to use the JDBC providers created by Content Engine Setup, rather than create new
ones, skip to Step 6; otherwise, continue at Step 4.
4. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers, click Cell, and then click New.
b. In the Configuration tab, set the value of the JDBC Providers property to WebSphere
embedded ConnectJDBC driver for MS SQL Server, and then click Apply.
c. Specify the values shown in the following table:
Property
Value
Name
<User-defined non-XA JDBC provider name>
Classpath
${MSSQLSERVER_JDBC_DRIVER_PATH}/sqljdbc.jar
Native Library
Path
(none)
Implementation
Classname
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
d. Click OK to view the table that shows your new JDBC provider.
5. Create an XA JDBC provider, as follows:
a. Verify that the Cell option button is still selected, and then click New.
b. In the Configuration tab, set the value of the JDBC Providers property to WebSphere
embedded ConnectJDBC driver for MS SQL Server (XA), and then click Apply.
c. Specify the values shown in the following table:
Property
Value
Name
<User-defined XA JDBC provider name>
Classpath
${MSSQLSERVER_JDBC_DRIVER_PATH}/sqljdbc.jar
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
232
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (MS SQL Server)
Property
Value
Native Library
Path
(none)
Implementation
classname
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
d. Click Apply to view the page with the new JDBC provider settings.
e. Click Save to save your settings to the master configuration, and then click Save to update
the master repository with your changes.
6. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, select the non-XA
entry for the SQL Server database type of JDBC provider that Content Engine Setup created
or that you created in Step 4.
b. Under Additional Properties, click Data Sources, click New, specify the values in the
following table, and then click Apply.
Parameter
Value
Name
The data source name
JNDI Name
The name to be used by the Create Object Store wizard
Statement Cache Size
0
Datasource Helper
Classname
com.filenet.engine.util.DataStoreHelper
Component-managed
Authentication Alias
<Node>/<alias> created by the CE installer
Container-managed
Authentication Alias
(none)
Mapping-Configuration
Alias
(none)
c. Under Additional Properties, click Connection Pool and set the Min. Connections value to 1,
and the Max. Connections value to 150, and click OK.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
233
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (MS SQL Server)
d. Under Additional Properties, click Custom Properties and add the custom properties, shown
in the following table. (To create a property, click New, specify the values, and then click
OK):
Name
Value
Type
databaseName
<DB_Name>
java.lang.String
serverName
<Host_Name>
java.lang.String
portNumber
1433 (default)
java.lang.Integer
selectMethod
direct
java.lang.String
enable2Phase
false
java.lang.Boolean
e. Click Save to apply changes to the master configuration and then click Save to update the
master repository with your changes.
7. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, select the XA
entry for the SQL Server database type of JDBC provider.
b. Under Additional Properties, click Data Sources, click New, specify the information in the
following table, and then click Apply.
Parameter
Value
Name
The data source name
JNDI Name
The name to be used by the Create Object Store wizard
Statement Cache Size
0
Datastore Helper
Classname
com.filenet.engine.util.DataStoreHelper
Component-managed
authentication Alias
<Node>/<alias> created by the CE installer
Container-managed
Authentication Alias
(none)
Mapping-configuration
Alias
(none)
c. Under Additional Properties, click Connection Pool and set the Min. Connections value to 1,
and the Max. Connections value to 150, and click OK.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
234
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (Oracle)
d. Under Additional Properties, click Custom Properties and add the custom properties, shown
in the following table. (To create a property, click New, specify the values, and then click
OK):
Name
Value
Type
databaseName
<DB_Name>
java.lang.String
serverName
<Host_Name>
java.lang.String
portNumber
1433 (default)
java.lang.Integer
selectMethod
direct
java.lang.String
enable2Phase
true
java.lang.Boolean
e. Click Save to apply changes to the master configuration and then click Save to update the
master repository with your changes.
8. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the XA JDBC provider created by
Content Engine Setup created or that you created in Step 5).
b. Under Additional Properties, click Data Sources, select the check box for the XA data
source, and then click Test Connection to test the connection.
9. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebSphere 5.1.x database connectivity (Oracle)
1. Start the WebSphere administrative console (if it isn’t already running).
2. For each object store, you need to create a database user alias associated with a unique
database and database user, as follows:
a. Navigate to Security > JAAS Configuration > J2C Authentication. In the right-hand pane,
note there is already an alias created for the GCD tablespace user.
b. Click New to create another one for an object store with the following information:
•
Alias
•
User (object store tablespace user)
•
Password (object store tablespace user password)
•
Description (optional)
c. Click Apply, and then click Save.
3. Navigate to Resources > JDBC Providers. Click Cell and then click Apply. If you chose to have
Content Engine Setup create the JNDI names for the GCD data sources, you should see both
XA and non-XA JDBC providers listed.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
235
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (Oracle)
You need only one pair (XA and non-XA) of JDBC providers for all your object stores. If you
intend to use the JDBC providers created by Content Engine Setup, rather than create new
ones, skip to Step 6; otherwise, continue at Step 4.
4. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers, verify that the Cell option button is selected and
click New.
b. In the Configuration tab, set the value of the JDBC Providers property Oracle JDBC Driver,
and then click Apply.
c. Specify the values shown in the following table:
Property
Value
Name
Non-XA JDBC provider name
Classpath
${ORACLE_JDBC_DRIVER_PATH}/ojdbc14.jar
Native Library Path
(none)
Implementation Classname
oracle.jdbc.pool.OracleConnectionPoolDataSource
d. Click OK to view the table that shows your new JDBC provider.
5. Create an XA JDBC provider, as follows:
a. Verify that the Cell option button is still selected, and then click New.
b. In the Configuration tab, set the value of the JDBC Providers property to OracleJDBC Driver
(XA), and then click Apply.
c. Specify the values shown in the following table:
Property
Value
Name
XA JDBC provider name
Classpath
${ORACLE_JDBC_DRIVER_PATH}/ojdbc14.jar
Native Library Path
(none)
Implementation Classname
oracle.jdbc.xa.client.OracleXADataSource
d. Click OK to view the table that shows your new JDBC provider.
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with yoyur changes.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
236
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (Oracle)
6. Create a non-XA data source, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the entry for
the Oracle non-XA JDBC provider that Content Engine Setup created or that you created in
Step 4.
b. Under Additional Properties, click Data Sources, click New, specify the values in the
following table, and then click Apply.
Parameter
Value
Name
The data source name
JNDI Name
The name to be used by the Create Object Store wizard
Datasource Helper
Classname
com.ibm.websphere.rsadapter.ConnectJDBCDataStoreHelper
Component-managed
Authentication Alias
<Node>/<alias> created in Step 2 on page 235
Container-managed
Authentication Alias
(none)
Mapping-configuration
Alias
(none)
c. Under Additional Properties, click Connection Pool, set the Min. Connections value to 1, and
the Max. Connections value to 150, and then click OK.
d. Click Apply, click Custom Properties in the Additional Properties table, and specify the
values shown in the following table (click the parameter name, specify the value, and then
click OK):
Parameter
Value
driverType
2
databaseName
Name of Oracle database
serverName
Host name of machine where Oracle is installed
portNumber
1521 (by default)
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
7. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the non-XA JDBC provider created by
Content Engine Setup created or that you created in Step 4).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
237
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (Oracle)
b. Under Additional Properties, click Data Sources, select the check box for the non-XA data
source, and then click Test Connection to test the connection.
8. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the XA entry
for the Oracle database type of JDBC provider.
b. Under Additional Properties, click Data Sources, click New, specify the values in the
following table, and then click Apply.
Parameter
Value
Name
The data source name
JNDI Name
The name to be used by the Create Object Store wizard
Datasource Helper
Classname
com.ibm.websphere.rsadapter.ConnectJDBCDataStoreHelper
Component-managed
Authentication Alias
<Node>/<alias> created in Step 2 on page 235
Container-managed
Authentication Alias
(none)
Mapping-configuration
Alias
(none)
c. Under Additional Properties, click Connection Pool, set the Min. Connections value to 1, and
the Max. Connections value to 150, and then click OK.
d. Click Custom Properties in the Additional Properties table, and specify the values shown in
the following table (click the parameter name, specify the value, and then click OK):
Parameter
Value
driverType
2
databaseName
Name of Oracle database
serverName
Host name of machine where Oracle is installed
portNumber
1521 (by default)
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
9. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the XA JDBC provider created by
Content Engine Setup created or that you created in Step 5).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
238
Task 19a: Configure Content Engine Application Server Database Connectivity (WebSphere 5.1.x)
To configure WebSphere 5.1.x database connectivity (Oracle)
b. Under Additional Properties, click Data Sources, select the check box for the non-XA data
source, and then click Test Connection to test the connection.
10. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
239
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (DB2)
Task 19b: Configure Content Engine Application
Server Database Connectivity (WebSphere 6.0.x)
In this task, you will set up the data sources, connection pools, and (optionally) the distributed
(XA) and non-distributed (non-XA) JDBC providers for Content Engine to communicate with the
databases or tablespaces associated with the object stores you will create in a later task.
Perform one of the following procedures for each object store, depending on your database type:
•
“To configure WebSphere 6.0.x database connectivity (DB2)” on page 240
•
“To configure WebSphere 6.0.x database connectivity (MS SQL Server)” on page 245
•
“To configure WebSphere 6.0.x database connectivity (Oracle)” on page 249
NOTE If you are upgrading from version 3.5.x of Content Engine, specify the 3.5.x database or
tablespace information in these procedures.
To configure WebSphere 6.0.x database connectivity (DB2)
1. Start the WebSphere administrative console (if it isn’t already running).
2. For each object store, you need to create a database user alias associated with a unique
database and database user, as follows:
a. Navigate to Security > Global Security > JAAS Configuration > J2C Authentication data. In
the right-hand pane, notice that there is already an alias (created by Content Engine Setup)
for the GCD tablespace user.
b. Click New to create an alias and specify the following information:
•
Alias
•
User ID (object store tablespace user)
•
Password (object store tablespace user password)
•
Description (optional)
c. Click Apply, and then click Save to apply changes to the master configuration, and then click
Save to update the master repository.
3. Navigate to Resources > JDBC Providers, click Cell and then click Apply. If you chose to have
Content Engine Setup create the JNDI names for the GCD data sources, you should see both
distributed (XA) and non-XA JDBC providers listed.
You need only one pair (XA and non-XA) of JDBC providers for all your object stores. If you
intend to use the JDBC providers created by Content Engine Setup, rather than create new
ones, skip to Step 6; otherwise, continue at Step 4.
4. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers, click Cell, and then click Apply.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
240
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (DB2)
b. Click New, set the property values shown in the following table, and then click Next:
Property
Value
Database type
DB2
Provider type
DB2 Universal JDBC Driver Provider
Implementation
type
Connection pool data source
c. Set the property values shown in the following table:
Property
Value
Name
<User-defined non-XA JDBC provider name>
Class path
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc_license_cu.jar
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc.jar
Native library path
(none)
Implementation
class name
com.ibm.db2.jcc.DB2ConnectionPoolDataSource
d. Click OK to view the page with your new JDBC provider.
5. Create an XA JDBC provider, as follows:
a. Verify that the Cell option button is still selected, and then click New.
b. Click New, and set the property values shown in the following table, and then click Next:
Property
Value
Database type
DB2
Provider type
DB2 Universal JDBC Driver Provider
Implementation
type
XA data source
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
241
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (DB2)
c. Set the property values shown in the following table:
Property
Value
Name
<User-defined XA JDBC provider name>
Class path
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc_license_cu.jar
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc.jar
Native library path
(none)
Implementation
class name
com.ibm.db2.jcc.DB2XADataSource
d. Click OK to view the page with your new JDBC provider.
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
6. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the entry for
the DB2 non-XA JDBC provider that Content Engine Setup created or that you created in
Step 4.
b. Under Additional Properties, click Data Sources, click New, specify the information in the
following table, and then click Apply.
Parameter
Value
Name
<User-defined data source name>
JNDI Name
<User-defined JNDI name> to be used by the Create Object
Store wizard.
Data store helper
class name
DB2 Universal data store helper
(com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper)
Component-managed
authentication alias
<Node>/<alias> created in created in Step 2 on page 240
Container-managed
authentication
(none)
Mappingconfiguration alias
(none)
Database name
<DB2 database name>
Driver type
4
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
242
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (DB2)
Parameter
Value
Server name
Host name or IP address of machine where DB2 is installed
Port number
50000 (by default)
c. Under Additional Properties, click Custom properties, specify the property values shown in
the following table (click the parameter name, specify the value, and then click OK):
Name
Value
Type
resultSetHoldability
1
java.lang.Integer
fullyMaterializeLobData
See Note below.
java.lang.Boolean
NOTE The default value of fullyMaterializeLobData is true; but you may want to set it to
false if both of the following conditions apply:
•
You will be creating an object store (see “Create Object Stores” on page 286) with a
database storage area as the content storage location
•
Users will be storing large content elements (for example, larger than 300 MB)
Setting the value of fullyMaterializeLobData to false prevents performance degradation or
memory-related errors during retrieval or indexing of large content elements. Alternatively,
specify a file storage area instead of a database storage area when creating an object
store.
d. Click New and create the custom property shown in the following table:
Name
Value
Type
webSphereDefaultIsolationLevel
2
java.lang.Integer
e. Click OK to verify that your new custom property is in the custom property table.
f.
Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
7. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the non-XA JDBC provider created by
Content Engine Setup created or that you created in Step 4).
b. Under Additional Properties, click Data Sources, select the check box for the non-XA data
source, and then click Test Connection to test the connection.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
243
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (DB2)
8. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the entry for
the DB2 XA JDBC provider that Content Engine Setup created or that you created in Step 5.
b. Under Additional Properties, click Data Sources, click New, specify the information in the
following table, and then click Apply.
Parameter
Value
Name
The data source name.
JNDI Name
The name of the data source to be used by the Create Object
Store wizard.
Datastore Helper
Classname
DB2 Universal data store helper
com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper
Component-managed
Authentication Alias
<Node>/<alias> created in created in Step 2 on page 240
Container-managed
Authentication
(none)
Mapping-configuration
alias
(none)
Database name
Name of DB2 database
Driver type
4
Server name
Host name of machine where DB2 is installed
Port number
50000 (by default)
c. Under Additional Properties, click Custom properties, specify the property values shown in
the following table, and then click Apply:
Name
Value
Type
fullyMaterializeLobData
See Note below.
java.lang.Boolean
NOTE
The default value of fullyMaterializeLobData is true; but you may want to set it to false if
both of the following conditions apply:
•
You will be creating an object store (see “Create Object Stores” on page 286) with a
database storage area as the content storage location.
•
Users will be storing large content elements (for example, larger than 300 MB).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
244
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (MS SQL Server)
Setting the value of fullyMaterializeLobData to false prevents performance degradation or
memory-related errors during retrieval or indexing of large content elements. Alternatively,
specify a file storage area instead of a database storage area when creating an object
store.
d. Click New and create the custom property shown in the following table:
Name
Value
Type
webSphereDefaultIsolationLevel
2
java.lang.Integer
e. Click OK to verify that your new custom property is in the custom property table.
f.
Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
9. Test the connection as follows:
a. Navigate to Resources > JDBC Providers and click the XA JDBC provider created by
Content Engine Setup created or that you created in Step 5).
b. Under Additional Properties, click Data Sources, select the check box for the XA data
source, and then click Test Connection to test the connection.
10. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebSphere 6.0.x database connectivity (MS SQL Server)
1. Start the WebSphere administrative console (if it isn’t already running).
2. Navigate to Security > Global Security > JAAS Configuration > J2C Authentication Data. In the
right-hand pane, note the alias created for the GCD database user, as you will use this alias for
data source connectivity.
3. Navigate to Resources > JDBC Providers, click Cell, and then click Apply. If you chose to have
Content Engine Setup create the JNDI names for the GCD data sources, you should see both
distributed and non-XA JDBC providers listed.
You need only one pair (XA and non-XA) of JDBC providers for all your object stores. If you
intend to use the JDBC providers created by Content Engine Setup, rather than create new
ones, skip to Step 6; otherwise, continue at Step 4.
4. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers, click Cell, and then click Apply.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
245
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (MS SQL Server)
b. Click New and set the property values shown in the following table:
Property
Value
Database type
SQL Server
Provider type
WebSphere embedded ConnectJDBC driver for MS SQL Server
Implementation
type
Connection pool data source
c. Click Next.
Property
Value
Name
<User-defined non-XA JDBC provider name>
Class path
${MSSQLSERVER_JDBC_DRIVER_PATH}/sqljdbc.jar
Native library
path
(none)
Implementation
class name
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
d. Click OK to view the page with your new JDBC provider.
5. Create an XA JDBC provider, as follows:
a. Verify that the Cell option button is still selected, and then click New..
b. Click New and set the property values shown in the following table:
Property
Value
Database type
SQL Server
Provider type
WebSphere embedded ConnectJDBC driver for MS SQL Server
Implementation type
XA data source
c. Click Next.
d. Set the property values shown in the following table:
Property
Value
Name
<User-defined XA JDBC provider>
Class path
${MSSQLSERVER_JDBC_DRIVER_PATH}/sqljdbc.jar
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
246
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (MS SQL Server)
Property
Value
Native library path
(none)
Implementation
class name
com.microsoft.sqlserver.jdbcSQLServerXADataSource
e. Click OK to view the page with your new JDBC provider.
f.
Click Save to apply your changes to the master confiugration, and then click Save to update
the master repository with your changes.
6. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the non-XA
entry for the SQL Server database type of JDBC provider.
b. Under Additional Properties, click Data sources, click New, specify the information in the
following table:
Parameter
Value
Name
<User-defined non-XA data source name>
JNDI name
<User-defined JNDI name> to be used by the Create Object
Store wizard.
User-defined data
store helper
com.filenet.engine.util.DataStoreHelper
Component-managed
authentication alias
<Node>/<alias> created by Content Engine Setup
Container-managed
Authentication
(none)
Mapping-configuration
alias
(none)
c. Click Apply.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
247
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (MS SQL Server)
d. Click Custom Properties, and create the properties shown in the following table (To create a
property, click New, specify the value, and then click OK):
Name
Value
Type
databaseName
<DB_Name>
java.lang.String
serverName
Host name or IP address of
machine where MS SQL Server is
installed
java.lang.String
portNumber
1433
java.lang.Integer
selectMethod
direct
java.lang.String
enable2Phase
false
java.lang.Boolean
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
f.
Navigate to Resources > JDBC Providers, click on the non-XA JDBC provider. Under
Additional Properties, click Data sources. Click the non-XA data source.
g. Under Additional Properties, click WebSphere Application Server data source properties,
set the value of Statement cache size to 0, and click OK.
h. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
7. Select the check box for the non-XA data source, and then click Test Connection to test the
connection.
8. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the XA entry
for the SQL Server database type of JDBC provider.
b. Under Additional Properties, click Data sources, click New, specify the information in the
following table:
Parameter
Value
Name
<User-defined XA data source name>
JNDI name
<User-defined JNDI name> to be used by the Create Object
Store wizard.
User-defined data
store helper
com.filenet.engine.util.DataStoreHelper
Component-managed
authentication alias
<Node>/<alias> created by Content Engine Setup
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
248
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (Oracle)
Parameter
Value
Container-managed
Authentication
(none)
Mapping-configuration
alias
(none)
c. Click Apply.
d. Click Custom Properties, and create the properties shown in the following table (To create a
property, click New, specify the value, and then click OK):
Name
Value
Type
databaseName
<DB_Name>
java.lang.String
serverName
Host name or IP address of
machine where MS SQL Server is
installed
java.lang.String
portNumber
1433
java.lang.Integer
selectMethod
direct
java.lang.String
enable2Phase
true
java.lang.Boolean
e. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
f.
Navigate to Resources > JDBC Providers, click on the non-XA JDBC provider. Under
Additional Properties, click Data sources. Click the non-XA data source.
g. Under Additional Properties, click WebSphere Application Server data source properties,
set the value of Statement cache size to 0, and click OK.
h. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
9. Select the check box for the XA data source, and then click Test Connection to test the
connection.
10. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebSphere 6.0.x database connectivity (Oracle)
1. Start the WebSphere administrative console (if it isn’t already running).
2. For each object store, you need to create a database user alias associated with a unique
tablespace and tablespace user, including any temporary tablespaces.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
249
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (Oracle)
a. Navigate to Security > Global Security > JAAS Configuration > J2C Authentication data. In
the right-hand pane, notice that there is already an alias (created by Content Engine Setup)
for the GCD tablespace user.
b. Click New to create an alias and specify the following information:
•
Alias
•
User ID (object store tablespace user)
•
Password (object store tablespace user password)
•
Description (optional)
c. Click Apply, click Save to apply changes to the master configuration, and then click Save to
update the master repository.
3. Navigate to Resources > JDBC Providers, click Cell, and then click Apply. If you chose to have
Content Engine Setup create the JNDI names for the GCD data sources, you should see both
distributed (XA) and non-XA JDBC providers listed.
You need only one pair (XA and non-XA) of JDBC providers for all your object stores. If you
intend to use the JDBC providers created by Content Engine Setup, rather than create new
ones, skip to Step 6; otherwise, continue at Step 4.
4. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers and click Cell to create a cell-level JDBC provider
and then click Apply.
b. Click New, set the property values shown in the following table:
Property
Value
Database type
Oracle
Provider type
Oracle JDBC Driver
Implementation type
Connection pool data source
c. Click Next.
d. Set the property values shown in the following table:
Property
Value
Name
<User-defined non-XA JDBC provider name>
Class path
${ORACLE_JDBC_DRIVER_PATH}/ojdbc14.jar
Native library path
(none)
Implementation class name
oracle.jdbc.pool.OracleConnectionPoolDataSource
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
250
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (Oracle)
e. Click OK to view the page with your new JDBC provider.
5. Create an XA JDBC provider, as follows:
a. Navigate to Resources > JDBC Providers and click Cell to create a cell-level JDBC provider
and then click Apply.
b. Click New, set the property values shown in the following table:
Property
Value
Database type
Oracle
Provider type
Oracle JDBC Driver
Implementation type
XA data source
c. Click Next.
d. Specify the property values shown in the following table:
Property
Value
Name
<User-defined non-XA data source name>
Class path
${ORACLE_JDBC_DRIVER_PATH}/ojdbc14.jar
Native library path
(none)
Implementation class name
oracle.jdbc.xa.client.OracleXADataSource
e. Click OK to view the page with your new JDBC provider.
6. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the entry for
the Oracle non-XA JDBC provider that Content Engine Setup created or that you created in
Step 4.
b. Under Additional Properties, click Data Sources, click New, and specify the information in
the following table:
Parameter
Value
Name
<User-defined non-XA data source name>
JNDI Name
<User-defined JNDI name> to be used by the Create Object
Store wizard.
Use this Data source in
container managed
persistence (CMP)
Clear the check box
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
251
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (Oracle)
Parameter
Value
Data store helper class
name
com.ibm.websphere.rsadapter.Oracle10gDataStoreHelper
Component-managed
authentication alias
<Node>/<alias> created in Step 2 on page 249
Container-managed
Authentication
(none)
URL
jdbc:oracle:thin:@<DB_HostName>:<Port>:<SID>
Default <Port>: 1521 (by default)
<DB_HostName>: host name or IP address of machine
where Oracle is installed
<SID>: the Oracle system identifier.
c. Click OK.
d. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
7. Select the check box for the non-XA data source, and then click Test Connection to test the
connection.
8. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC Providers. In the table of JDBC providers, click the entry for
the Oracle XA JDBC provider that Content Engine Setup created or that you created in
Step 5.
b. Under Additional Properties, click Data Sources, click New, and specify the information in
the following table:
Parameter
Value
Name
<User-defined XA data source name>
JNDI Name
<User-defined JNDI name> to be used by the Create Object
Store wizard.
Use this Data source in
container managed
persistence (CMP)
Clear the check box
Data store helper class
name
com.ibm.websphere.rsadapter.Oracle10gDataStoreHelper
Component-managed
authentication alias
<Node>/<alias> created in Step 2 on page 249
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
252
Task 19b: Configure Content Engine Application Server Database Connectivity (WebSphere 6.0.x)
To configure WebSphere 6.0.x database connectivity (Oracle)
Parameter
Value
Authentication alias for
XA recovery
Click Use component-managed authentication alias option
button
Container-managed
Authentication
(none)
URL
jdbc:oracle:thin:@<DB_HostName>:<Port>:<SID>
Default <Port>: 1521 (by default)
<DB_HostName>: host name or IP address of machine
where Oracle is installed
<SID>: Oracle system identifier
c. Click OK.
d. Click Save to apply your changes to the master configuration, and then click Save to update
the master repository with your changes.
9. Select the check box for the XA data source, and then click Test Connection to test the
connection.
10. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
253
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (DB2)
Task 19c: Configure Content Engine Application
Server Database Connectivity (WebSphere 6.1.x)
In this task, you will set up the data sources, connection pools, and (optionally) the distributed
(XA) and non-distributed (non-XA) JDBC providers for Content Engine to communicate with the
databases or tablespaces associated with the object stores you will create in a later task.
Perform one of the following procedures for each object store, depending on your database type:
NOTE If you are upgrading from version 3.5.x of Content Engine, specify the 3.5.x database or
tablespace information in these procedures.
•
“To configure WebSphere 6.1.x database connectivity (DB2)” on page 254
•
“To configure WebSphere 6.1.x database connectivity (MS SQL Server)” on page 260
•
“To configure WebSphere 6.1.x database connectivity (Oracle)” on page 265
To configure WebSphere 6.1.x database connectivity (DB2)
1. Start the WebSphere administrative console (if it isn’t already running).
2. For each object store, create a database user alias associated with a unique database and
database user, as follows:
a. Navigate to Security > Secure administration, applications, and infrastructure > Java
Authentication and Authorization Service > J2C authentication data. In the right-hand pane,
notice that there is already an alias (created by Content Engine Setup) for the GCD
tablespace user.
b. Click New to create a J2C authentication alias and specify the following information:
•
Alias
•
User ID (object store tablespace user)
•
Password (object store tablespace user password)
•
Description (optional)
c. Click Apply and then click Save.
Create (non-XA and XA) JDBC providers, as shown in Step 3 and Step 4, to serve your object
stores. Or skip to Step 5 on page 256 and use the existing JDBC providers Content Engine
Setup created for the GCD.
3. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC > JDBC Providers, and choose Cell from the Scope dropdown list.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
254
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (DB2)
b. Click New and set the property values shown in the following table, and then click Next:
Property
Value
Database type
DB2
Provider type
DB2 Universal JDBC Driver Provider
Implementation type
Connection pool data source to create a non-XA JDBC provider
Name
<User-defined non-XA JDBC_Provider_Name>
Description
An optional comment
c. Specify or verify the following values, and then click Next:
Property
Value
Class
path
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc.jar
Directory
location
Accept the value you specified in “Configure an Application Server for
Content Engine (WebSphere)” on page 134.
Native
library
path
(None)
${DB2UNIVERSAL_JDBC_DRIVER_PATH}db2jcc_license_cu.jar
d. View the Summary of the new JDBC provider, click Finish, and then click Save.
4. Create an XA JDBC provider, as follows:
a. Click New, set the property values shown in the following table, and then click Next:
Property
Value
Database type
DB2
Provider type
DB2 Universal JDBC Driver Provider
Implementation type
XA data source to create an XA data source
Name
<User-defined XA JDBC_Provider_Name>
Description
An optional comment
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
255
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (DB2)
b. Specify or verify the following values, and then click Next:
Property
Value
Class
path
${DB2UNIVERSAL_JDBC_DRIVER_PATH}/db2jcc.jar
Directory
location
Accept the value you specified in “Configure an Application Server
for Content Engine (WebSphere)” on page 134.
Native
library
path
(None)
${DB2UNIVERSAL_JDBC_DRIVER_PATH}db2jcc_license_cu.jar
5. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC > Data sources, choose Cell from the Scope drop-down list,
and then click New.
b. Specify the values in the following table and then click Next:
Parameter
Value
Data source name
<User-defined_data_source_name>
JNDI name
User-defined_JNDI_name> The name of the data
source to be used by the Create Object Store
wizard.
Component-managed
authentication alias and XA
recovery authentication
Specify the J2C authentication alias created for
this object store in Step 2 on page 254.
c. Click the Select an existing JDBC provider option. Choose, from the drop-down list, one of
the following, and then click Next.
•
JDBC Provider for GCD Datatsource (created by Content Engine Setup)
•
The JDBC provider you created in Step 3 on page 254, and then click Next.
d. Specify the values in the following table, and then click Next:
Parameter
Value
Database name
Name of DB2 database
Driver type
4
Server name
Host name or IP address of machine where DB2 is installed
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
256
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (DB2)
Parameter
Value
Port number
<DB_Port_Number>
(default is 50000)
Use this data source
in container managed
persistence (CMP)
Clear the check box
e. Review the Summary page, click Finish, and then click Save.
f.
If you have created all your non-XA data sources, continue at Step 6; otherwise, jump back
to Step b on page 256 to create a non-XA data source for another object store.
6. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC > Data sources, and choose Cell from the Scope drop-down
list.
b. Click New and specify the values in the following table and then click Next:
Parameter
Value
Data source name
<User-defined_data_source_name>
JNDI name
User-defined_JNDI_name> The name of the data
source to be used by the Create Object Store
wizard.
Component-managed
authentication alias and XA
recovery authentication alias
Specify the J2C authentication alias created for
this object store in Step 2 on page 254.
c. Click the Select an existing JDBC provider option. Choose, from the drop-down list, one of
the following, and then click Next.
•
JDBC Provider for GCD Datatsource (created by Content Engine Setup).
•
The JDBC provider you created in Step 4 on page 255.
d. Specify the values in the following table, and then click Next:
Parameter
Value
Database name
Name of DB2 database
Driver type
4
Server name
Host name or IP address of machine where DB2 is installed
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
257
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (DB2)
Parameter
Value
Port number
<DB_Port_Number>
(default is 50000)
Use this data source
in container managed
persistence (CMP)
Clear the check box
e. Review the Summary page, click Finish, and then click Save.
f.
If you have created all your XA data sources, continue at Step 7; otherwise, jump back to
Step b on page 257 to create an XA data source for another object store.
7. For each non-XA data source you created in Step 5 on page 256, edit its custom properties, as
follows:
a. Navigate to Resources > JDBC > Data sources.
b. Select a non-XA data source.
c.
Under Additional Properties, click Custom Properties, click New and create the custom
properties shown in the following table (click OK after specifying the value):
Name
Value
Type
webSphereDefaultIsolationLevel
2
java.lang.Integer
resultSetHoldability
1
java.lang.Integer
fullyMaterializeLobData
See Note below.
java.lang.Boolean
NOTE The default value of fullyMaterializeLobData is true; but you may want to set it to
false if both of the following conditions apply:
•
You will be creating an object store (see “Create Object Stores” on page 286) with a
database storage area as the content storage location
•
Users will be storing large content elements (for example, larger than 300 MB)
d. Setting the value of fullyMaterializeLobData to false prevents performance degradation or
memory-related errors during retrieval or indexing of large content elements. Alternatively,
specify a file storage area instead of a database storage area when creating an object store.
e. Click Save.
f.
If you have edited the custom properties for all your non-XA data sources, continue at
Step 8; otherwise, jump back to Step b on page 258 to edit the custom properties for another
non-XA data source.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
258
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (DB2)
8. For each XA data source you created in Step 6 on page 257, edit its custom properties, as
follows:
a. Navigate to Resources > JDBC > Data sources.
b. Select a XA data source that you created in Step 6 on page 257.
c. Under Additional Properties, click Custom Properties, (click OK after specifying the value):
Name
Value
Type
webSphereDefaultIsolationLevel
2
java.lang.Integer
fullyMaterializeLobData
See Note below.
java.lang.Boolean
NOTE The default value of fullyMaterializeLobData is true; but you may want to set it to
false if both of the following conditions apply:
•
You will be creating an object store (see “Create Object Stores” on page 286) with a
database storage area as the content storage location.
•
Users will be storing large content elements (for example, larger than 300 MB).
Setting the value of fullyMaterializeLobData to false prevents performance degradation or
memory-related errors during retrieval or indexing of large content elements. Alternatively,
specify a file storage area instead of a database storage area when creating an object
store.
d. Click Save.
e. If you have edited the custom properties for all your XA data sources, continue at Step 9;
otherwise, jump back to Step b on page 259 to edit the custom properties for another XA data
source.
9. Edit the connection pool settings for the (non-XA and XA) data sources, as follows:
a. Navigate to Resources > JDBC > Data sources.
b. For each data source in the data source list, do the following:
i.
Click on the data source.
ii.
Under Additional Properties, click Connection pool properties, and set the parameter
values shown in the following table:
Parameter
Value
Maximum connections
[7 * (# of object stores)] + (# of execution threads) + 2
Minimum connections
(# of execution threads) + 10
iii. Save your changes.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
259
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (MS SQL Server)
10. Test data source connectivity, as follows:
a. Navigate to Resources > JDBC > Data sources.
b. Select the check boxes for the non-XA and XA data sources you created in this procedure.
c. Click Test connection and verify that all test connection operations were successful.
11. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebSphere 6.1.x database connectivity (MS SQL Server)
1. Start the WebSphere administrative console (if it isn’t already running).
2. Navigate to Security > Secure administration, applications, and infrastructure > Java
Authentication and Authorization Service > J2C Authentication Data. In the right-hand pane note
the alias of the GCD database user.
If you will be using the same MS SQL Server user to connect to all your databases, use this
alias to configure database connectivity and skip to Step 3; otherwise, create a J2C
authentication alias for each database, as follows:
a. Click New to create an alias and specify the following information:
•
Alias
•
User (object store database user)
•
Password (object store database user password)
•
Description (optional)
b. Save your changes.
c. If you have created all your J2C authentication aliases, continue at Step 3; otherwise, jump
back to Step a to create another J2C authentication alias.
Create (non-XA and XA) JDBC providers, as shown in Step 3 and Step 4, to serve your object
stores. Or skip to Step 5 on page 261 and use the existing JDBC providers Content Engine
Setup created for the GCD.
3. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC > JDBC Providers, and select Cell = <profileNodeCell> from
the scope drop-down list, where profile is the name of the profile you created for this
instance of Content Engine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
260
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (MS SQL Server)
b. Click New and set the property values shown in the following table for the non-XA data
source:
Property
Value
Database type
User-defined
Implementation
class name
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSourc
e
Name
<non-XA User-defined JDBC_Provider_Name>
Description
An optional comment
c. Click Next and then specify the value for Class path:
${MSSQLSERVER_JDBC_DRIVER_PATH}/sqljdbc.jar
d. Click Next, and then click Finish and Save.
4. Create an XA JDBC provider, as follows:
a. Navigate to Resources > JDBC > JDBC Providers, and select Cell = <profileNodeCell> from
the scope drop-down list.
b. Click New and set the property values shown in the following table for the XA data source:
Property
Value
Database type
User-defined
Implementation
class name
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
Name
<XA User-defined JDBC_Provider_Name>
Description
An optional comment
c. Click Next and then specify the value for Class path:
${MSSQLSERVER_JDBC_DRIVER_PATH}/sqljdbc.jar
d. Click Next, and then click Finish and Save.
5. Create a non-XA data source for each object store, as follows:
a. Click the non-XA JDBC provider you created in Step 3 on page 260.
b. Click Data sources under Additional Properties and then click New.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
261
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (MS SQL Server)
c. Specify the information in the following table, and then click Apply:
Parameter
Value
Data source name
<User-defined_data_source_name>
JNDI name
<User-defined_JNDI_name> The name of the data source to
be used by the Create Object Store wizard.
Component-managed
authentication alias
and XA recovery
authentication alias
<Node>/<alias>
If all databases will be accessed by only one MS SQL Server
user, specify the alias created by Content Engine Setup.
If each database will be accessed by its own MS SQL Server
user, specify an alias defined in Step 2 on page 260.
d. Click Next and then specify the information in the following table:
Parameter
Value
Data store helper
class name
com.filenet.engine.util.DataStoreHelper
Use this data source
in container managed
persistence (CMP)
Clear the check box
e. Click Next. Review the Summary page, click Finish, and then click Save to save the changes
to the master configuration.
f.
If you have created all your non-XA data sources, continue at Step 6; otherwise, jump back
to Step b to create a non-XA data source for another object store.
6. Create an XA data source for each object store, as follows:
a. Navigate to Resources > JDBC > JDBC Providers. In the table of JDBC providers, click the
XA User-Defined JDBC provider.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
262
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (MS SQL Server)
b. Under Additional Properties, click Data Sources, click New, specify the information in the
following table, and then click Apply:
Parameter
Value
Data source name
<User-defined_data_source_name>
JNDI name
<User-defined_JNDI_name> The name of the data source to
be used by the Create Object Store wizard.
Component-managed
authentication alias
<Node>/<alias>
If all databases will be accessed by only one MS SQL Server
user, specify the alias created by Content Engine Setup.
If each database will be accessed by its own MS SQL Server
user, specify an alias defined in Step 2 on page 260.
c. Click Next, and then specify the information in the following table:
Parameter
Value
Data store helper
class name
com.filenet.engine.util.DataStoreHelper
Use this data source
in container managed
persistence (CMP)
Clear the check box
d. Click Next. Review the Summary page, click Finish and then click Save to save the changes
to the master configuration.
e. If you have created all your XA data sources, continue at Step 7; otherwise, jump back to
Step b to create a non-XA data source for another object store.
7. For each non-XA data source you created in Step 5 on page 261, edit its custom properties, as
follows:
a. Navigate to Resources > JDBC > Data sources.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
263
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (MS SQL Server)
b. Under Additional Properties, click Custom Properties, and select and specify values for
each of the properties in the following table (click OK after specifying each value):
Name
Value
Type
databaseName
<DB_Name>
java.lang.String
portNumber
<DB_Port_Number>
(default is 1433)
java.lang.Integer
selectMethod
direct
java.lang.Integer
serverName
<DB_HostName> or IP address
java.lang.String
c. Click New and create the custom property shown in the following table:
Name
Value
Type
enable2Phase
false
java.lang.Boolean
resultSetHoldability
1
java.lang.Integer
d. Click Save.
e. If you have edited the custom properties for all your non-XA data sources, continue at
Step 8; otherwise, jump back to Step b on page 264 to edit the custom properties for another
non-XA data source.
8. For each XA data source you created in Step 6 on page 262, edit its custom properties, as
follows:
a. Navigate to Resources > JDBC > Data sources.
b. Select the XA data source that you created in Step 6 on page 262, edit its custom properties
c. Under Additional Properties, click Custom Properties, and select and specify values for
each of the properties in the following table (click OK after specifying each value:
Name
Value
Type
databaseName
<DB_Name>
java.lang.String
portNumber
<DB_Port_Number>
(default is 1433)
java.lang.Integer
selectMethod
direct
java.lang.Integer
serverName
<DB_HostName> or IP address
java.lang.String
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
264
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (Oracle)
d. Click New and create the custom property shown in the following table (click OK after
specifying the value):
Name
Value
Type
enable2Phase
true
java.lang.Boolean
e. Click Save.
f.
If you have edited the custom properties for all your XA data sources, continue at Step 9;
otherwise, jump back to Step b on page 264 to edit the custom properties for another XA data
source.
9. Edit the connection pool settings for the (non-XA and XA) data sources, as follows:
a. Navigate to Resources > JDBC > Data sources.
b. For each data source in the data source list, do the following:
i.
Click on the data source.
ii.
Under Additional Properties, click Connection pool properties, and set the parameter
values shown in the following table:
Parameter
Value
Maximum connections
[7 * (# of object stores)] + (# of execution threads) + 2
Minimum connections
(# of execution threads) + 10
iii. Save your changes.
10. Test data source connectivity, as follows:
a. Navigate to Resources > JDBC > Data sources.
b. Select the check boxes for the non-XA and XA data sources you created in this procedure.
c. Click Test connection and verify that all test connection operations were successful.
11. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebSphere 6.1.x database connectivity (Oracle)
1. Start the WebSphere administrative console (if it isn’t already running).
2. For each object store, create a database user alias associated with a unique tablespace and
tablespace user, including any temporary tablespaces, as follows:
a. Navigate to Security > Secure administration, applications, and infrastructure > JAAS
Configuration - J2C authentication data. In the right-hand pane, notice that there is already
an alias (created by Content Engine Setup) for the GCD tablespace user.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
265
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (Oracle)
b. Click New to create an alias and specify the following information:
•
Alias
•
User (object store tablespace user)
•
Password (object store tablespace user password)
•
Description (optional)
c. Click Apply and then click Save.
Create (non-XA and XA) JDBC providers, as shown in Step 3 and Step 4, to serve your object
stores. Or skip to Step 5 on page 267 and use the existing JDBC providers content Engine
Setup created for the GCD.
3. Create a non-XA JDBC provider, as follows:
a. Navigate to Resources > JDBC > JDBC Providers, and choose Cell from the Scope dropdown list.
b. Click New, set the property values as shown in the following table and then click Next:
Property
Value
Database type
Oracle
Provider type
Oracle JDBC Driver
Implementation type
Connection pool data source
Name
<User-defined non-XA JDBC_Provider_Name>
Description
An optional comment
c. Specify or verify the values in the following table, and then click Next:
Property
Value
Class
path
${ORACLE_JDBC_DRIVER_PATH}/ojdbc14.jar
Directory
location
Accept the value you specified in “Configure an Application Server for
Content Engine (WebSphere)” on page 134.
d. View the Summary of the new JDBC provider, click Finish, and then click Save.
4. Create an XA JDBC provider, as follows:
a. Navigate to Resources > JDBC > JDBC Providers and click Cell from the drop-down list.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
266
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (Oracle)
b. Click New, set the property values shown in the following table, and then click Next:
Property
Value
Database type
Oracle
Provider type
Oracle JDBC Driver
Implementation type
XA data source
Name
<User-defined XA JDBC_Provider_Name>
Description
An optional comment
c. Specify or verify the values in the following table, and then click Next:
Property
Value
Class
path
${ORACLE_JDBC_DRIVER_PATH}/ojdbc14.jar
Directory
location
Accept the value you specified in “Configure an Application Server
for Content Engine (WebSphere)” on page 134.
d. View the Summary of the new JDBC provider, click Finish, and then click Save.
5. Create a non-XA data source for each object store, as follows:
a. Navigate to Resources > JDBC > Data sources, and choose Cell from the Scope drop-down
list.
b. Click New and specify the values in the following table and then click Next:
Parameter
Value
Data source name
<User-defined_data_source_name>
JNDI name
User-defined_JNDI_name> The name of the data
source to be used by the Create Object Store
wizard.
Component-managed
authentication alias and XA
recovery authentication
Specify the J2C authentication alias created for
this object store in Step 2 on page 265.
c. Click the Select an existing JDBC provider option and then choose, from the drop-down list,
one of the following:
•
JDBC provider for GCD Datasource, which Content Engine Setup created,
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
267
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (Oracle)
•
The JDBC provider you created in Step 3 on page 266
d. Specify the values in the following table and then click Next:
Parameter
Value
URL
jdbc:oracle:thin:@<DB_HostName>:<Port>:<SID>
NOTE <Port> is 1521 by default. <SID> is the Oracle system
identifier.
Datastore Helper
Classname
Use this Data source in
container managed
persistence (CMP)
Depending on your Oracle version, choose one:
•
Oracle9i and prior data store helper
•
Oracle10g data store helper
Clear the check box
e. Review the Summary page, click Finish, and then click Save.
f.
If you have created all your non-XA data sources, continue at Step 6; otherwise, jump back
to Step b on page 267.
6. Create an XA data source for each store, as follows:
a. Navigate to Resources > JDBC > Data sources, and choose Cell from the Scope drop-down
list.
b. Click New and specify the values in the following table and then click Next:
Parameter
Value
Data source name
<User-defined_data_source_name>
JNDI name
User-defined_JNDI_name> The name of the data
source to be used by the Create Object Store
wizard.
Component-managed
authentication alias and XA
recovery authentication
Specify the J2C authentication alias created for
this object store in Step 2 on page 265.
c. Click the Select an existing JDBC provider option and then choose, from the drop-down list,
one of the following:
•
JDBC provider for GCD Datasource, which Content Engine Setup created,
•
The JDBC provider you created in Step 4 on page 266
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
268
Task 19c: Configure Content Engine Application Server Database Connectivity (WebSphere 6.1.x)
To configure WebSphere 6.1.x database connectivity (Oracle)
d. Specify the values in the following table and then click Next:
Parameter
Value
URL
jdbc:oracle:thin:@<DB_HostName>:<Port>:<SID>
NOTE <Port> is 1521 by default. <SID> is the Oracle system
identifier.
Datastore Helper
Classname
Use this Data source in
container managed
persistence (CMP)
Depending on your Oracle version, choose one:
•
Oracle9i and prior data store helper
•
Oracle10g data store helper
Clear the check box
e. Review the Summary page, click Finish, and then click Save.
f.
If you have created all your XA data sources, continue at Step 7; otherwise, jump back to
Step b on page 268.
7. Edit the connection pool settings for the (non-XA and XA) data sources, as follows:
a. Navigate to Resources > JDBC > Data sources.
b. For each data source in the data source list, do the following:
i.
Click on the data source.
ii.
Under Additional Properties, click Connection pool properties, and set the parameter
values shown in the following table:
Parameter
Value
Maximum connections
[7 * (# of object stores)] + (# of execution threads) + 2
Minimum connections
(# of execution threads) + 10
iii. Save your changes.
8. Test data source connectivity, as follows:
a. Navigate to Resources > JDBC > Data sources.
b. Select the check boxes for the non-XA and XA data sources you created in this procedure.
c. Click Test connection and verify that all test connection operations were successful.
9. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
269
Task 19d: Configure Content Engine Application Server Database Connectivity (WebLogic 8.1.x)
Task 19d: Configure Content Engine Application
Server Database Connectivity (WebLogic 8.1.x)
In this task, you will set up the data sources and connection pools needed for Content Engine to
communicate with the databases or tablespaces associated with the object stores you will create
in a later task.
Do the procedures in one of the following sections, depending on your database type.
The procedures in this topic use the terminology in the following table (where the abbreviation XA
means distributed, and non-XA means non-distributed). For each term in the table, you will
substitute a value appropriate to your configuration when you create the connection pools and
data sources.
Term
Meaning
AdminServer
The default name of the administration server for a WebLogic
Server domain
<ConnectionPoolName>
The names of the XA and non-XA connection pools
<DB_HostName>
The host name or IP address of the database machine
<DB>
The meaning depends on the database type:
•
(DB2) The name of the database containing the object store
tablespace
•
(MS SQL Server) The name of the object store database
•
(Oracle) The system identifier (SID) of the database
containing the object store tablespace
<DB_UserName> (MS SQL
Server)
The account Content Engine uses to access <DB>
<DB_Password> (MS SQL
Server)
The password for <DB_UserName>
<TS> (DB2 and Oracle)
The name of the object store tablespace
<DataSourceName>
The names of the XA and non-XA data sources
<DataSourceJNDI_Name>
The JNDI name of the data source
NOTE It is strongly recommended that <DataSourceJNDI_Name>
be identical to <DataSourceName>
<Port>
The port number used by the database engine:
•
50000 (default for DB2)
•
1433 (default for MS SQL Server)
•
1521 (default port for Oracle)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
270
Task 19d: Configure Content Engine Application Server Database Connectivity (WebLogic 8.1.x)
To configure WebLogic 8.1.x database connectivity (DB2)
As part of configuring database connectivity, you have the opportunity to customize the maximum
number of connection pools available for object-store data sources. Here are some guidelines for
choosing this value.
•
In general, the value should be proportional to the maximum number of concurrent users of
the object store.
•
A nominal value of 25 should be adequate for object stores.
CAUTION Due to a known problem in all versions of WebLogic supported by IBM FileNet P8, if
you intend to create an object store in the same database (MS SQL Server) or tablespace (Oracle
or DB2) as the GCD, use the data sources and connection pools you set up for the GCD. Do not
create separate data sources and connection pools. Be aware that the GCD can share its
database (tablespace) with at most one object store.
Do the procedures in one of the following sections, depending on your database type.
•
“To configure WebLogic 8.1.x database connectivity (DB2)” on page 271
•
“To configure WebLogic 8.1.x database connectivity (MS SQL Server)” on page 272
•
“To configure WebLogic 8.1.x database connectivity (Oracle)” on page 273
NOTE If you are upgrading from version 3.5.x of Content Engine, specify the 3.5.x database or
tablespace information in these procedures.
To configure WebLogic 8.1.x database connectivity (DB2)
Do this procedure on the WebLogic machine where Content Engine is installed.
1. Log on to WebLogic Server Administration Console.
2. Create two connection pools—one for XA transactions and one for non-XA transactions—with
the parameter values shown in the following table:
Parameter
Value
Database Type
DB2
Database Driver
Other
Name
<ConnectionPoolName>
Driver Class Name (XA)
com.ibm.db2.jcc.DB2XADataSource
Driver Class Name (non-XA)
com.ibm.db2.jcc.DB2Driver
URL of database
jdbc:db2://localhost:<Port>/<DB_Name>
Tablespace User Name
<TS_UserName>
Password (DB2 and Oracle
only)
<TS_Password>
Host Name
<DB_HostName>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
271
Task 19d: Configure Content Engine Application Server Database Connectivity (WebLogic 8.1.x)
To configure WebLogic 8.1.x database connectivity (MS SQL Server)
Parameter
Value
Port
<Port>
driverType
4
3. Create two data sources—one for XA and one for non-XA transactions—with the parameter
values shown in the following table:
Parameter
Value
Name
<DataSourceName>
JNDI Name
<DataSourceJNDI_Name>
Honor Global Transactions
•
Select for (XA transactions)
•
Clear (for non-XA transactions)
Emulate Two-Phase Commit
Clear
Pool Name
<ConnectionPoolName>
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebLogic 8.1.x database connectivity (MS SQL Server)
Perform this procedure on the WebLogic machine where Content Engine is installed.
1. Log on to WebLogic Server Administration Console.
2. Create two connection pools—one for XA and one for non-XA transactions—with the parameter
values shown in the following table:
Parameter
Value
Database Type
MS SQL Server
Database Driver
Other
Name
<ConnectionPoolName>
XA Driver Classname
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
Non-XA Driver Classname
com.microsoft.sqlserver.jdbc.SQLServerDriver
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
272
Task 19d: Configure Content Engine Application Server Database Connectivity (WebLogic 8.1.x)
To configure WebLogic 8.1.x database connectivity (Oracle)
Parameter
Value
URL of database
jdbc:sqlserver://<DatabaseHostName>:<Port>
Database username
<DB_UserName>
Properties
user=<DB_UserName>
portNumber=<Port>
databaseName=<DB_Name>
serverName=<DB_HostName>
Statement Cache Size
0
Enable XA Transaction Timeout
Select
3. Create two data sources—one for XA and one for non-XA transactions—with the parameter
values shown in the following table:
Parameter
Value
Name
<DataSourceName>
JNDI Name
<DataSourceJNDIName>
Honor Global Transactions
•
Select (for XA transactions)
•
Clear (for non-XA transactions)
Emulate Two-Phase Commit
Clear
Pool Name
<ConnectionPoolName>
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebLogic 8.1.x database connectivity (Oracle)
Perform this procedure on the WebLogic machine where Content Engine is installed.
1. Log on to WebLogic Server Administration Console.
2. Create two connection pools—one for distributed transactions (XA) and one for non-distributed
(non-XA) transactions—with the parameter values shown in the following table:
Parameter
Value
Database Type
Oracle
Database Driver
Oracle
Name
<ConnectionPoolName>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
273
Task 19d: Configure Content Engine Application Server Database Connectivity (WebLogic 8.1.x)
To configure WebLogic 8.1.x database connectivity (Oracle)
Parameter
Value
Driver Class Name (XA)
oracle.jdbc.xa.client.OracleXADataSource
Driver Class Name (non-XA)
oracle.jdbc.OracleDriver
URL of database
jdbc:oracle:thin:@<DB_HostName>:<Port>:<DB_Name
Tablespace username
<TablespaceUserName>
Password
<TablespacePassword>
Database Name
<DB>
Host Name
<DB_HostName>
Port
<Port>
Enable XA Transaction Timeout
(XA)
Select
NOTE To view this parameter,
select Advanced Options and
then click Show.
3. Create two data sources—one for XA and one for non-XA transactions—with the parameter
values shown in the following table:
Parameter
Value
Name
<DataSourceName>
JNDI Name
<DataSourceJNDIName>
Honor Global Transactions
•
Select (for XA transactions)
•
Clear (for non-XA transactions)
Emulate Two-Phase Commit
Clear
Pool Name
<ConnectionPoolName>
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
274
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x)
Task 19e: Configure Content Engine Application
Server Database Connectivity (WebLogic 9.2.x)
In this task, you will set up the data sources and connection pools needed for Content Engine to
communicate with the databases or tablespaces associated with the object stores you will create
in a later task.
Do the procedures in one of the following sections, depending on your database type.
The procedures in this topic use the terminology in the following table (where the abbreviation XA
means distributed, and non-XA means non-distributed). For each term in the table, you will
substitute a value appropriate to your configuration when you create the connection pools and
data sources.
Term
Meaning
AdminServer
The default name of the administration server for a WebLogic
Server domain
<ConnectionPoolName>
The names of the XA and non-XA connection pools
<DB_HostName>
The host name or IP address of the database machine
<DB>
The meaning depends on the database type:
•
(DB2) The name of the database containing the object store
tablespace
•
(MS SQL Server) The name of the object store database
•
(Oracle) The system identifier (SID) of the database
containing the object store tablespace
<DB_UserName>
The account Content Engine uses to access <DB>
<DB_Password>
The password for <DB_UserName>
<TS>
The name of the object store tablespace (DB2 and Oracle)
<TS_UserName>
The account Content Engine uses to access <TS>
<TS_Password>
The password for <TS_Name>
<DataSourceName>
The names of the XA and non-XA data sources
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
275
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x)
To configure WebLogic 9.2.x database connectivity (DB2)
Term
Meaning
<DataSourceJNDI_Name>
The JNDI name of the data source
NOTE It is strongly recommended that <DataSourceJNDI_Name>
be identical to <DataSourceName>
<Port>
The port number used by the database engine:
•
50000 (default for DB2)
•
1433 (default for SQL Server)
•
1521 (default port for Oracle)
As part of configuring database connectivity, you have the opportunity to customize the maximum
number of connection pools available for object-store data sources. Here are some guidelines for
choosing this value.
•
In general, the value should be proportional to the maximum number of concurrent users of
the object store.
•
A nominal value of 25 should be adequate for object stores.
CAUTION Due to a known problem in all versions of WebLogic supported by IBM FileNet P8, if
you intend to create an object store in the same database as the GCD, use the data sources and
connection pools you set up for the GCD. Do not create separate data sources and connection
pools.
Do the procedures in one of the following sections, depending on your database type.
•
“To configure WebLogic 9.2.x database connectivity (DB2)” on page 276
•
“To configure WebLogic 9.2.x database connectivity (MS SQL Server)” on page 278
•
“To configure WebLogic 9.2.x database connectivity (Oracle)” on page 279
NOTE If you are upgrading from version 3.5.x of Content Engine, specify the 3.5.x database or
tablespace information in these procedures.
To configure WebLogic 9.2.x database connectivity (DB2)
Perform this procedure on the WebLogic machine where Content Engine is installed.
1. Log on to WebLogic Server Administration Console.
2. Create two data sources—one for distributed transactions (XA) and one for non-distributed (nonXA) transactions—with the parameter values shown in the following table:
Parameter
Value
Name
<DataSourceName>
JNDI Name
<DataSourceJNDIName>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
276
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x)
To configure WebLogic 9.2.x database connectivity (DB2)
Parameter
Value
Database Type
DB2
Database Driver
Other
Support Global Transactions
•
Select (for XA)
•
Clear (for non-XA)
Emulate Two-Phase Commit
Clear (XA only)
Database Name
<DB_Name>
Host Name
<DB_HostName>
Port
<Port>
Database User Name
<DB_DB2_Login>
Password
<DB_DB2_Password>
Set XA Transaction Timeout
Select
In the Test Database Connection screen, specify the parameter values in the following table:
Parameter
Value
Driver Class Name (XA)
com.ibm.db2.jcc.DB2XADataSource
Driver Class Name (non-XA)
com.ibm.db2.jcc.DB2Driver
URL
jdbc:db2://<DB_HostName>:<port>/<DB_Name>
Database User Name
<DB_UserName>
Password
<DB_Password>
Properties
user=<DB_UserName>
databaseName=<DB_Name>
portnumber=<Port>
serverName=<DB_HostName>
selectMode=default (XA only)
driverType=4 (XA only)
Test Table Name
SQL select count(*) from SYSIBM.SYSTABLES
Select Targets
AdminServer
3. In the Test Database Connection screen, click Test Configuration to verify the database
connection.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
277
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x)
To configure WebLogic 9.2.x database connectivity (MS SQL Server)
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebLogic 9.2.x database connectivity (MS SQL Server)
Perform this procedure on the WebLogic machine where Content Engine is installed.
1. Log on to WebLogic Server Administration Console.
2. Create two data sources—one for distributed transactions (XA) and one for non-distributed (nonXA) transactions—with the parameter values shown in the following tables:
Parameter
Value
Name
<DataSourceName>
JNDI Name
<DataSourceJNDIName>
Database Type
MS SQL Server
Database Driver
Other
Support Global Transactions
•
Select (for distributed transactions)
•
Clear (for non-distributed transactions)
Emulate TwoPhase Commit
Clear
(XA only)
Database Name
<DB_Name>
Host Name
<DB_HostName>
Port
<Port>
Database User Name
<DB_UserName>
Password
<DB_Password>
Driver Classname (XA)
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
Driver Classname (Non-XA)
com.microsoft.sqlserver.jdbc.SQLServerDriver
URL of database
jdbc:sqlserver://<DatabaseHostName>:<PortNumber>
Properties
user=<DB_UserName>
portNumber=<Port>
databaseName=<DB_Name>
serverName=<DB_HostName>
Statement Cache Size
0
Test Table Name
SQL select count(*) from sysusers
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
278
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x)
To configure WebLogic 9.2.x database connectivity (Oracle)
Parameter
Value
Select Targets
AdminServer
Set XA Transaction Timeout
Select
3. In the Test Database Connection screen, click Test Configuration to verify the database
connection.
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure WebLogic 9.2.x database connectivity (Oracle)
Perform this procedure on the WebLogic machine where Content Engine is installed.
1. Log on to WebLogic Server Administration Console.
2. Create two data sources—one for distributed transactions (XA) and one for non-distributed (nonXA) transactions—with the parameter values shown in the following table:
Parameter
Value
Name
<DataSourceName>
JNDI Name
<DataSourceJNDIName>
Database Type
Oracle
Database Driver
•
Oracle's Driver (XA Thin) (for XA)
•
Oracle's Driver (Thin) (for non-XA)
•
Select (for XA)
•
Clear (for non-XA)
Support Global Transactions
Emulate Two-Phase Commit
Clear (XA only)
Database Name
<DB>
Host Name
<DB_HostName>
Port
<Port>
Database User Name
<DB_UserName>
Password
<DB_Password>
Set XA Transaction Timeout
Select
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
279
Task 19e: Configure Content Engine Application Server Database Connectivity (WebLogic 9.2.x)
To configure WebLogic 9.2.x database connectivity (Oracle)
In the Test Database Connection screen, specify the parameter values in the following table:
Parameter
Value
Driver Class Name (XA)
oracle.jdbc.xa.client.OracleXADataSource
Driver Class Name (non-XA)
oracle.jdbc.OracleDriver
URL
jdbc:oracle:thin:@<DB_HostName>:<port>:<DB_Name>
Database User Name
<DB_UserName>
Password
<DB_Password>
Properties
user=<DB_UserName>
databaseName=<DB_Name>
portnumber=<Port>
serverName=<DB_HostName>
selectMode=default (XA only)
Test Table Name
SQL select count(*) from dual
Select Targets
AdminServer
3. In the Test Database Connection screen, click Test Configuration to verify the database
connection.
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
280
Task 19f: Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)
To configure JBoss 4.0.x database connectivity (DB2)
Task 19f: Configure Content Engine Application Server
Database Connectivity (JBoss 4.0.x)
In this task, you will set up the XA (distributed) and non-XA data sources needed for Content
Engine to communicate with the databases or tablespaces associated with the object stores you
will create in a later task.
Do the procedures in one of the following sections, depending on your database type. These
procedures assume the following environment for your JBoss installation (substitute your own
environment in its place where applicable):
•
JBOSS_DIST is the home directory of your JBoss installation.
•
server1 is the JBoss server instance on which you will install and deploy Content Engine.
•
os1-ds.xml and os1-xa-ds.xml are non-XA and XA data sources for object store os1.
To configure JBoss 4.0.x database connectivity (DB2)
1. To create data sources for an object store, do the following:
a. Copy files FNGCD-ds.xml and FNGCD-xa-ds.xml from directory JBOSS_DIST/server/
server1/deploy to new files, os1-ds.xml and os1-xa-ds.xml, respectively, in this directory.
NOTE The name of each XML file you create for your data sources must end in -ds.xml.
b. Edit os1-ds.xml as follows:
i.
Remove the <local-tx-datasource> XML elements for MS SQL Server and Oracle.
ii.
Change the content of the <jndi-name> element from FNGCDDS to os1ds.
iii. Set the content of the <connection-url> element to:
jdbc:db2://<JBoss_host_name>:<DB_port>/<dbname>
where <dbname> is the name of the database that will contain the object store data.
iv. Change the content of the <user-name> and <password> elements to that of the user
and password of the tablespace you intend to use for your object store.
c. Edit os1-xa-ds.xml as follows:
i.
Remove the <xa-datasource> XML elements for MS SQL Server and Oracle.
ii.
Change the content of the <jndi-name> element from FNGCDDSXA to os1dsxa.
iii. Set the content of the <xa-datasource-property name="ServerName"> element to the
fully qualified domain name of the machine where DB2 is installed.
iv. Set the content of the <xa-datasource-property name="DatabaseName"> element to the
name of the database that will contain the object store.
v.
Set the content of the <xa-datasource-property name="PortNumber"> element to the
port used by DB2.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
281
Task 19f: Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)
To configure JBoss 4.0.x database connectivity (MS SQL Server)
vi. Change the content of the <user-name> and <password> elements to that of the user
and password of the tablespace to be used by your object store.
d. Save your edits to os1-ds.xml and os1-ds.
2. Repeat Step 1 on page 281 for each additional object store you intend to create (substituting
different names for the XML files and XML elements).
3. (Optional) Encrypt the passwords for your XA and non-XA data sources, as shown in“To encrypt
data source passwords” on page 284.
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure JBoss 4.0.x database connectivity (MS SQL Server)
1.
To create data sources for an object store, do the following:
a. Copy files FNGCD-ds.xml and FNGCD-xa-ds.xml from directory JBOSS_DIST/server/
server1/deploy to new files, os1-ds.xml and os1-xa-ds.xml, respectively, in this directory.
NOTE The name of each XML file you create for your data sources must end in -ds.xml.
b. Edit os1-ds.xml as follows:
i.
Remove the <local-tx-datasource> XML elements for DB2 and Oracle.
ii.
Change the content of the <jndi-name> element from FNGCDDS to os1ds.
iii. Set the content of <connection-url> element to:
jdbc:sqlserver://<dbserver>:<db_port>;DatabaseName=<dbname>
where <dbname> is the name of the database that will contain the object store data.
iv. Change the content of the <user-name> and <password> elements to that of the user
and password of the database you intend to use for your object store.
c. Edit os1-xa-ds.xml as follows:
i.
Remove the <xa-datasource> XML elements for DB2 and Oracle.
ii.
Change the content of the <jndi-name> element from FNGCDDSXA to os1dsxa.
iii. Set the content of the <xa-datasource-property name="ServerName"> element to the
fully qualified domain name of the machine where MS SQL Server is installed.
iv. Set the content of the <xa-datasource-property name="DatabaseName"> element to the
name of the database that will contain the object store.
v.
If MS SQL Server is not using the default port number (1433), add this XML element:
<xa-datasource-property name="PortNumber">dbport</xa-datasource-property>
where dbport is the port number used by the MS SQL Server database instance.
vi. Change the content of the <user-name> and <password> elements to that of the user
and password of the database to be used by your object store.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
282
Task 19f: Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)
To configure JBoss 4.0.x database connectivity (Oracle)
d. Save your edits to os1-ds.xml and os1-ds.
2. Repeat Step 1 on page 282 for each additional object store you intend to create (substituting
different names for the XML files and XML elements).
3. (Optional) Encrypt the passwords for your XA and non-XA data sources, as shown in“To encrypt
data source passwords” on page 284.
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To configure JBoss 4.0.x database connectivity (Oracle)
1. To create data sources for an object store, do the following:
a. Copy files FNGCD-ds.xml and FNGCD-xa-ds.xml from directory JBOSS_DIST/server/
server1/deploy to new files, os1-ds.xml and os1-xa-ds.xml, respectively, in this directory.
NOTE The name of each XML file you create for your data sources must end in -ds.xml.
b. Edit os1-ds.xml as follows:
i.
Remove the <local-tx-datasource> XML elements for DB2 and MS SQL Server.
ii.
Change the content of the <jndi-name> element from FNGCDDS to os1ds.
iii. Set the content of <connection-url> element to:
jdbc:oracle:thin:@<dbserver>:<db_port>:<Oracle_SID>
where dbserver is the name of the database machine and port is the port used by the
database that will contain the GCD.
iv. Change the content of the <user-name> and <password> elements to that of the user
and password of the tablespace you intend to use for your object store.
c. Edit os1-xa-ds.xml as follows:
i.
Remove the <xa-datasource> XML elements for DB2 and MS SQL Server.
ii.
Change the content of the <jndi-name> element from FNGCDDSXA to os1dsxa.
iii. Set the content of the <xa-datasource-property name="URL"> element to:
jdbc:oracle:thin:@<dbserver>:<db_port>:<Oracle_SID>
where dbserver is the name of the database machine and port is the port used by the
database that will contain the GCD.
iv. Change the content of the <xa-datasource-property name=”User”> and <xa-datasourceproperty name=”Password”> elements to that of the user and password of the
tablespace to be used for the object store.
d. Save your edits to os1-ds.xml and os1-ds.
2. Repeat Step 1 on page 283 for each additional object store you intend to create (substituting
different names for the XML files and XML elements).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
283
Task 19f: Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)
To encrypt data source passwords
3. (Optional) Encrypt the passwords for your XA and non-XA data sources, as shown in“To encrypt
data source passwords” on page 284.
4. If you are upgrading Content Engine, go to “To edit the upgrader utility file” on page 525; otherwise,
continue at “Prepare Storage Areas for Object Stores” on page 95.
To encrypt data source passwords
Use the following procedure to generate an encrypted data source password.
NOTES
•
Substitute your own value (at least eight characters) for the Salt attribute in place of the value
twasalt12 used in this procedure.
•
Choose an obscuring password in place of Magic, which is used in this procedure.
•
Choose a real LDAP password in place of Secret, which is used in this procedure.
•
Assume the path to the JBoss conf directory is ...\server\myserver\conf, where myserver is the
name of the JBoss server.
1. Edit the file jboss-service.xml in the conf directory by adding the following text at the end of the
Security section of the file, just before the Transactions section.
<mbean code="org.jboss.security.plugins.JaasSecurityDomain"
name="jboss.security:service=JaasSecurityDomain,domain=ServerMasterPassword">
<constructor>
<arg type="java.lang.String" value="ServerMasterPassword"/>
</constructor>
<!-- The opaque master password file used to decrypt the encrypted database
password key -->
<attribute name="KeyStorePass">
{CLASS}org.jboss.security.plugins.FilePassword:${jboss.server.home.dir}/
conf/server.password
</attribute>
<attribute name="Salt">twsalt12</attribute>
<attribute name="IterationCount">13</attribute>
</mbean>
2. Create the server.password file, as follows:
a. Navigate to the conf directory:
cd %JBOSS_HOME%\server\myserver\conf
b. If the server.password file already exists, run the following command to delete it:
del server.password
c. Run the following command (with no carriage return) to create the server.password file:
java -cp ...\lib\jbosssx.jar org.jboss.security.plugins.FilePassword twsalt12 13
"Magic" server.password
3. Use the obscuring password Magic to encrypt your real LDAP password Secret, as follows:
a. Navigate to the conf directory:
cd %JBOSS_HOME%\server\myserver\conf
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
284
Task 19f: Configure Content Engine Application Server Database Connectivity (JBoss 4.0.x)
To encrypt data source passwords
b. Run the following command to encrypt your real LDAP password:
java -cp ..\lib\jbosssx.jar org.jboss.security.plugins.PBEUtils twsalt12 13
"Magic" "Secret"
c. Note the command output, for example Encoded password: Fm/hKKlyXZj, which you will use
in step 4.
4. Edit login-config.xml in the conf directory by pasting the encrypted password for
LdapExtLoginModule, as shown below:
<module-option name="bindCredential">Fm/hKKlyXZj</module-option>
<module-option
name="jaasSecurityDomain">jboss.security:service=JaasSecurityDomain,
domain=ServerMasterPassword
</module-option>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
285
Task 20: Create Object Stores
Task 20: Create Object Stores
CAUTION
•
Do the procedure in this section only if you are installing version 4.0.0 of Content Engine as a
new application. If you are upgrading from version 3.5.x of Content Engine, skip to “Verify the
Content Engine Installation” on page 291.
•
Before creating object stores, be sure you have installed the latest Content Engine service
pack, as indicated in “Install Content Engine Software Updates” on page 204.
In this task you will create object stores. If you haven’t already done so, set up the initial storage
areas of the object stores (see “Prepare Storage Areas for Object Stores” on page 95).
NOTES
Object Store Notes
•
To create an object store, you need to know the following:
–
Display name for new object store
–
Object store description (optional)
–
JNDI names associated with the data sources for your database
–
Database engine (DB2, SQL Server, or Oracle)
–
(SQL Server) Type of authentication: Windows Authentication or Database Engine
Authentication
–
(Oracle) User name and password for the tablespace corresponding to the object store
–
Database alias
–
•
(DB2) Tablespace name
•
(SQL Server) Database name
•
(Oracle) Net service name
Initial administrative and user groups that can access the object store
Deployment Notes
•
You must create at least one object store in your FileNet P8 domain.
•
The name you assign to an object store has the following characteristics:
–
Can be no more than 64 alphanumeric characters.
–
Can be different from the name of the associated database (SQL Server) or tablespace
(DB2 or Oracle).
–
Must be different from any other object store name within the FileNet P8 domain.
–
There may be other restrictions imposed by the underlying database programs. Consult
your database documentation or administrator for any restrictions.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
286
Task 20: Create Object Stores
To create an object store
Authentication Notes
•
Each object store can have a different set of default users and groups. IBM FileNet P8 does
not support distribution groups.
•
Once an object store is in production and contains many objects, you must use the Security
Script wizard of Enterprise Manager to add new users and groups so that they have access to
those existing objects. Therefore, you should be careful to add all the default users and groups
to the object store before putting it into production.
Database Notes
•
All the object stores you create for Content Engine must be based on the same database type.
For example, you cannot have one object store based on Oracle and another based on SQL
Server.
•
You cannot create an object store with an Oracle tablespace user name that contains a space
or has mixed-case characters.
•
Before creating an object store, you must create the following:
–
an associated DB2 tablespace, Oracle tablespace, or SQL Server database.
–
a pair of connection pools—one for distributed transactions (XA) and one for non-distributed
(non-XA) transactions.
–
a pair of data sources—one for XA transactions and one for non-XA transactions.
•
The Create Object Store wizard will fail if you try to assign a new object store to a database/
tablespace that is not completely empty.
•
Once an object store is created, you can refine its definition and add content to it.
To create an object store
1. Log on as the Content Engine operating system user to a machine where Enterprise Manager is
installed.
2. Launch the Enterprise Manager (double-click the desktop shortcut) and log on.
NOTE You will be required to log on when the Enterprise Manager is started. (Windows
Integrated authentication will not require a password.)
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 FileNet P8 Domain Logon screen, log on as a GCD administrator, and then click OK to
start Enterprise Manager.
5. In the tree view, right-click the Object Stores container and choose New Object Store.
6. Work through the initial Create Object Store wizard screens as follows:
In this screen...
Perform this action...
Welcome
Click Next to proceed with creating an object store.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
287
Task 20: Create Object Stores
To create an object store
In this screen...
Perform this action...
Name and Describe the
Object Store
Type the display name for the object store. The symbolic name
and description are entered automatically as you type the
display name, but you can edit them before leaving this screen.
Click Next.
NOTE The symbolic name, used for internal programmatic
purposes, must contain only ASCII characters and must begin
with an alphabetic character.
Specify the Data Sources
Specify the JNDI names associated with the data sources for
your database, as follows:
•
JNDI Data Source Name: The data source that binds the
non-XA connection pool to the database/tablespace.
•
JNDIXA Data Source Name: The data source that binds the
XA connection pool to the database/tablespace.
Click Next.
Specify the default
Content Store
Specify File Storage
Area Directory
Click one of the following to specify the default location for the
content of the object store, and then click Next. If you clicked
•
Database Storage Area – continue at “Specify object store
administrators” on page 289
•
File Storage Area – continue at “Specify File Storage Area
Directory” on page 288
•
Fixed Storage Area – continue at “Fixed Storage Area” on
page 288
Type, or browse (Windows only) to, the pathname of the
directory to contain the file storage area
Specify the UNC of the network share to contain the file storage
area.
NOTE Refer to “Users and Groups” on page 97 for information on
the permissions required on the directory where your file
storage area will be created.
Click Next and continue at “Specify object store administrators” on
page 289.
Fixed Storage Area
If you specified Fixed Storage Area as your default Content
Store, choose a fixed content device from the drop-down list,
and specify the staging area path. Click Next and continue at
“Specify object store administrators” on page 289.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
288
Task 20: Create Object Stores
To create an object store
In this screen...
Perform this action...
Specify object store
administrators
An object store administrator can log on to Enterprise Manager,
has administrative (add/delete/change) access to the object
store, and is in security lists on objects. The initial object-store
administrators list includes the account that creates the object
store.
To add object store administrators to the list, do the following:
a. Click Add....
b. In the Select Users and Groups screen, specify object
type, realm, and search criteria as needed, and then click
Find to display a list from which to select object store
administrators.
c. Select a single item, or press and hold the CTRL (or
SHIFT) key, and use the left mouse button to select
multiple items (or the first and last of a range of items).
d. Release the CTRL (or SHIFT) key and click OK.
To remove object store administrators from the list, do the
following:
a. Select a single item, or press and hold the CTRL (or
SHIFT) key, and use the left mouse button to select
multiple items (or the first and last of a range of items).
b. Release the CTRL (or SHIFT) key and click OK.
When your list is complete, click Next and continue at “Specify
Initial User Groups” on page 290.
NOTE If you specify an empty list, the wizard automatically
adds #AUTHENTICATED-USERS, which gives all network users
in the authentication realm administrative access to the object
store (for example, under Windows authentication, all accounts
in Domain Users).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
289
Task 20: Create Object Stores
To create an object store
In this screen...
Perform this action...
Specify Initial User
Groups
User groups have non-administrative (browse directories and
read documents) access to the object store. Specify the initial
list of groups, as follows:
To add user groups to the list, do the following:
a. Click Add....
b. In the Select Users and Groups screen, specify object
type, realm, and search criteria as needed, and then click
Find to display a list from which to select user groups.
c. Select a single item, or press and hold the CTRL (or
SHIFT) key, and use the left mouse button to select
multiple items (or the first and last of a range of items).
d. Release the CTRL (or SHIFT) key and click OK.
To remove user groups from the list, do the following:
a. Select a single item, or press and hold the CTRL (or
SHIFT) key, and use the left mouse button to select
multiple items (or the first and last of a range of items).
b. Release the CTRL (or SHIFT) key and click OK.
When your list is complete, click Next.
NOTE If you specify an empty list, the wizard automatically
adds #AUTHENTICATED-USERS, which gives nonadministrative access to all network users in the authentication
realm.
Completing the Create
an Object Store Wizard
Review your selections and click Finish to create the object
store. When the status displayed in the Object Store Create
Status window shows that the object store has been
successfully created, click OK.
NOTE If, as an object store administrator, you need to add more users or groups to the object
store, refer to the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide
Administration > FileNet P8 Security > How to... > Update object store with new users and groups.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
290
Task 21: Verify the Content Engine Installation
To verify the Content Engine installation
Task 21: Verify the Content Engine Installation
To verify that the Content Engine installation succeeded, do the following procedure to confirm
that, via Enterprise Manager, you can
•
Create folders and documents
•
Check documents in and out.
CAUTION Do the procedure in this section only if you are installing version 4.0.0 of Content
Engine as a new application. If you are upgrading from version 3.5.x of Content Engine, continue
at “Upgrade Content Engine Data” on page 523.
To verify the Content Engine installation
1. In Enterprise Manager, create a subfolder as follows:
a. Expand the Object Stores container and expand the node for the object store you just
created.
b. Right-click the Root Folder icon, and select New Sub Folder.
c. Enter the Folder Name and click Create.
2. Create a document as follows:
a. Expand the Root Folder container.
b. Right-click the subfolder you just created, and select New Document.
c. Enter the Document Title (for example, Coffee Bean.bmp), click With content, and click
Next.
d. Click Browse/Add to select a file (for example, c:\winnt\Coffee Bean.bmp), click Open, and
then click Create.
NOTE The new containment name should be Coffee Bean with a major version of 1.
3. Check out a document as follows:
a. Right-click the document object (Coffee Bean.bmp) you just created, and select Exclusive
Check Out (Default).
b. Navigate to the folder where you want the checked-out document to reside and click Open.
c. Click Yes to edit the file.
d. Make some change to the file and save it.
e. Close the application you used to edit the file.
4. Check in a document, as follows:
a. Right-click the document object (Coffee Bean.bmp) you just edited, and select Check In.
b. In the File Name field, click Browse/Add.
c. Select the file you have checked out (e.g., Coffee Bean.bmp) and click Open.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
291
Task 21: Verify the Content Engine Installation
To enable Enterprise Manager to display file storage area status
d. Click Check In.
e. Right-click the document object you just checked in and click the Versions tab of the
Properties dialog box.
f.
You should now see the Major Version field change once the document is checked in.
To enable Enterprise Manager to display file storage area status
The Windows user who logged on to Enterprise Manager as a FileNet P8 user and then created a
file storage area will see the status of the file storage area as online, and will be able to add
content to it. All other Windows users, even if logged on to Enterprise Manager as the same
FileNet P8 user who created the file storage area, will see its status as offline, and thus will not be
able to add content to it.
To enable a Windows logon user to see an online status for a file storage area and to add content
to it, you must add the user to the directory security of the file storage area with the following
permissions: Modify, Read & Execute, List Folder Contents, Read, and Write. Alternatively, as a
member of the Local Administrators group you can add the Windows logon user to a group
account, as explained in the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide
Administration > FileNet P8 Security > Authorization > Storage area security.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
292
Task 22: Install Content Search Engine Software Updates
To install the Content Search Engine software updates
Task 22: Install Content Search Engine Software
Updates
Install any service packs, fix packs and/or interim fixes required for Content Search Engine.
To install the Content Search Engine software updates
1. To download the latest software updates, and to determine which of these updates may be
required for use with other components and expansion products, contact your service
representative.
2.
Open the readmes for the following software updates and perform the installation procedures
provided:
a. Content Search Engine 4.0.1 Service Pack
b. Any subsequent fix pack (P8CSE-4.0.1-001 or later)
c. Any subsequent interim fixes (typically optional)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
293
Task 23a: Install Process Engine (Windows)
To verify the database connection
Task 23a: Install Process Engine (Windows)
Use the procedures in this topic to install Process Engine on Windows.
NOTES
•
Ensure that all applicable tasks listed in the “Configure Windows” on page 64 have been
completed before beginning this task.
•
If Process Engine will be installed by a domain user rather than a local user, see “Specify IBM
FileNet P8 Accounts” on page 72 for details on creating required users and groups.
•
Be sure to have the correct database information. See “Database Considerations” on page 29 for
the specific requirements. Entering incorrect information during Process Engine installation
could cause the installation to fail. Recovery could mean uninstalling and re-installing the
Process Engine software.
•
Determine whether Process Engine will be installed by running the setup program interactively
or in silent mode. Once you have run the procedure in “To verify the database connection” on
page 294 you must either install Process Engine interactively (using the procedure in“To install
the Process Engine software interactively” on page 294) or silently (using the procedure in “To
Install the Process Engine software silently” on page 306). Then perform the procedure in “To
Complete Additional Configuration” on page 307 and proceed through the remainder of this task.
To verify the database connection
Verify the database connection between the Process Engine and the database. See “Verify the
Ability to Connect to the Database” on page 131 for details.
To install the Process Engine software interactively
The Process Engine installation occurs in two parts that are separated by a restart of the system.
After the restart, the second part of the installation continues automatically.
1. Log on as a member of the local Administrators group or a user with equivalent permissions. If you
plan to run the SQL scripts from Process Engine Setup, the user you log on as must also be a
database administrator. See “Specify IBM FileNet P8 Accounts” on page 72 for information on
requirements for logging on as a Windows domain user for Process Engine installation.
NOTE This user does not need to be a database administrator unless you will be executing the
SQL scripts from Process Engine Setup.
2. Access the Process Engine software package, and start the P8PE-4.0.3-Win.exe setup program.
NOTE To run the Process Engine Setup from disk, you must copy the installation files to a disk
volume where 8.3 name generation is enabled, or if 8.3 name generation is disabled, you must
copy the installation to a path the uses only short (8.3) names.
CAUTION When running from disk, either interactively or silently, be aware that Process
Engine Setup has a 64-character path limitation when the path is expressed in 8.3 format.
This limitation applies to the IMSInst subdirectory where the underlying Image Services (IS)
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
294
Task 23a: Install Process Engine (Windows)
To install the Process Engine software interactively
mini-installer setup.exe is located. For example, the original path where the IS mini-installer
resides is:
\\server08\Software\InstallationDisks\FileNet\Release P8 4.0.3\ProcessEngine\Windows\IMSInst
When expressed in 8.3 format the path might be:
\\server08\Software\INSTAL~1\FileNet\RELEAS~1.0\PROCES~1\Windows\IMSInst
This compressed path is 73 characters long, exceeding the 64-character limit.
3. Complete the Process Engine Setup screens, as follows:
In this screen...
Perform this action...
Welcome to Process
Engine Setup
Click Next on the Welcome screen to proceed with the
installation.
License Agreement
Review and accept the license agreement.
Specify the
Documentation URL
Enter the Documentation URL, which is where the IBM FileNet
P8 Platform Documentation is installed. Your entry must be in
the following format:
http://<docserver:port#>/<ecm_help>
where:
docserver is the name of the Java web server.
port# is the port number.
ecm_help is the root folder of the documentation web site. You
can use multi-part root folders.
(for example, /docs/ecm_help) if your application server
supports them.
Specify Installation
Location for Common
Files
Choose the destination directory for configuration files that will
be shared with other IBM FileNet P8 components. Accept the
default location or click Browse to change the location.
Specify Installation
Location for Program
Files
Indicate the installation location for the executable files. This is
the drive where the \FNSW directory will be created. Select a
local drive in a cluster configuration.
Specify Installation
Location for Data Files
Indicate the installation location for the configuration and data
files. This is the drive where the \FNSW_LOC directory will be
created. Select a shared drive in a cluster configuration.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
295
Task 23a: Install Process Engine (Windows)
To install the Process Engine software interactively
In this screen...
Perform this action...
Specify Network
Clearinghouse Domain
Name
Enter <domain name>:<organization>, where:
•
The maximum length of your <domain name> entry does not
exceed 19 characters.
•
The maximum length of your <organization> entry does not
exceed 19 characters.
•
Both your <domain name> and <organization> entries contain
only alphanumeric characters and underscores.
A typical convention is to enter <your PE machine name>:<your
company name>. If the machine name or company name include
hyphens, replace them with underscores in your entry.
Specify the Database
Location
Indicate whether the database will be local or remote.
Specify the Database
Type
Indicate whether the database will be:
•
Oracle
•
SQL Server
•
DB2
4. Depending on the type and location of the database you selected above, continue at one of the
following procedures:
•
“To complete local or remote SQL Server database screens” on page 297
•
“To complete remote Oracle database screens” on page 299
•
“To complete local Oracle database screens” on page 301.
•
“To complete remote DB2 database screens” on page 303
NOTE Only remote DB2 databases are supported.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
296
Task 23a: Install Process Engine (Windows)
To complete local or remote SQL Server database screens
To complete local or remote SQL Server database screens
Complete the Process Engine Setup screens that are specific to local or remote SQL Server
databases, as follows:
In this screen...
Perform this action...
Specify Execution Mode
for SQL Server Scripts
The SQL Server pre-install scripts must be run by Setup or
manually. These scripts create database users and passwords
for FileNet P8 and create stored procedures. Please select one
of the options listed below. If you select the prompted password
option, the next screen will ask you for the SQL Server sa
password. If you select the silent option, your SQL Server
database must allow operating system authentication. Refer to
the “Process Engine SQL Scripts” on page 671 for instructions on
how to run these scripts manually.
Select from the following options:
•
I have already run the pre-install scripts manually.
•
I want to run the scripts with a prompted password.
•
I want to run the scripts silently using OS authentication.
Validation of the SQL Server connection will also occur if you
choose to run the scripts now, either with a prompted password
or using operating system authentication. No validation of the
database connection will be done if you indicate that you have
already run the SQL scripts manually.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
Specify the SQL Server
System Administrator
Password
Enter the SQL Server sa password.
NOTE This prompt only
appears if you indicated
that you want to run the
SQL scripts with a
prompted password.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
297
Task 23a: Install Process Engine (Windows)
To complete local or remote SQL Server database screens
In this screen...
Perform this action...
Specify SQL Server
Configuration
Parameters
Enter the following information:
•
ODBC data source name
•
Database name
•
Filegroup name
This is the default filegroup name defined in “Verify that
Microsoft SQL Server Is Installed for IBM FileNet P8” on
page 101.
NOTE You might notice a slight delay before the next Setup
screen displays if you chose to run the SQL Scripts from the
setup program. Validation of the database connection will
be done after clicking Next on this screen. If validation is
successful you will see the next screen. If validation fails, an
error will be returned and you must resolve the problem
before proceeding. No validation of the database
connection will be done if you indicate that you have already
run the SQL scripts manually.
Specify SQL Server
Version
Indicate whether you will be using SQL Server 2000 or SQL
Server 2005 for the Process Engine database.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
298
Task 23a: Install Process Engine (Windows)
To complete remote Oracle database screens
To complete remote Oracle database screens
Complete the Process Engine Setup screens that are specific to remote Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Execution Mode
for Oracle Scripts
The Oracle pre-install SQL scripts must be run by setup or
manually. These scripts create database users and passwords
for FileNet P8 and create stored procedures. Please select one
of the options listed below. If you select the prompted password
option, the next screen will ask you for the Oracle Sys
password. If you want to run the scripts silently, your Oracle
database server must allow operating system authentication.
Refer to the “Process Engine SQL Scripts” on page 671 for
instructions on how to run these scripts manually.
Select from the following options:
•
I have already run the pre-install scripts manually.
•
I want to run the scripts with a prompted password.
•
I want to run the scripts silently using OS authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
Specify the Oracle SYS
Password
Enter the Oracle SYS password.
NOTE This prompt
appears only if you
indicated that you want
to run the scripts with a
prompted password.
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory.
The Oracle Home path you enter refers to the local Oracle
installation directory.
To find the Oracle Home directory, type the following command
at a command prompt and look for the Oracle_Home variable:
set
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
299
Task 23a: Install Process Engine (Windows)
To complete remote Oracle database screens
In this screen...
Perform this action...
Specify Remote Oracle
Configuration
Parameters
Enter the following Oracle database configuration parameters.
•
Global Database Name (as identified in the tnsnames.ora
file)
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more
than one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
300
Task 23a: Install Process Engine (Windows)
To complete local Oracle database screens
To complete local Oracle database screens
Complete the Process Engine Setup screens that are specific to local Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Execution Mode
for Oracle Scripts
The Oracle pre-install SQL scripts must be run by setup or
manually. These scripts create database users and passwords
for FileNet P8 and create stored procedures. Please select one
of the options listed below. If you select the prompted password
option, the next screen will ask you for the Oracle Sys
password. If you want to run the scripts silently, your Oracle
database server must allow operating system authentication.
Refer to the “Process Engine SQL Scripts” on page 671 for
instructions on how to run these scripts manually.
Select from the following options:
•
I have already run the pre-install scripts manually.
•
I want to run the scripts with a prompted password.
I want to run the scripts silently using OS authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
Specify the Oracle SYS
Password
Enter the Oracle SYS password.
NOTE This prompt only
appears if you indicated
that you want to run the
SQL scripts with a
prompted password.
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory.
The Oracle Home path you enter refers to the local Oracle
installation directory.
To find the Oracle Home directory, ype the following command
at a command prompt and look for the Oracle_Home variable:
set
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
301
Task 23a: Install Process Engine (Windows)
To complete local Oracle database screens
In this screen...
Perform this action...
Specify Local Oracle
Configuration
Parameters
Enter the following Oracle database configuration parameters.
•
Oracle SID
To find the Oracle SID, type the following command at a
command prompt and look for the Oracle_SID variable:
set
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more
than one data and optional index tablespace indicate the
default tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
302
Task 23a: Install Process Engine (Windows)
To complete remote DB2 database screens
To complete remote DB2 database screens
In this screen...
Perform this action...
Database Alias Name
Enter the database alias name as assigned in “Verify that DB2
Client Is Installed for IBM FileNet P8” on page 127.
Data Tablespace name
Defaults to VWDATA_TS.
If you created more than one tablespace in “Verify that DB2
Server Is Installed for IBM FileNet P8” on page 114, indicate the
default tablespace.
To complete final Process Engine Setup screens
Complete the screens to finalize the Process Engine installation, as follows:
In this screen...
Perform this action...
Determine Administrative
User and Group Aliasing
Method
Determine whether FileNet default operating system and
database users and groups will be used, or if you want to define
aliases for these users and groups.
SQL Script Passwords
NOTE This screen
appears only if you
selected an option to
have setup run the SQL
scripts.
•
Yes, configure aliases
•
No, use actual account names for aliases
You have selected an option to have setup run the pre-install
SQL scripts. Setup needs to know if you have changed the
default passwords that are specified in these script files.
Select from the following options:
•
I have not changed the default FileNet passwords specified
in the SQL scripts
•
I have changed the default FileNet passwords specified in
the SQL scripts
If you have changed the default passwords you will be prompted
to enter those passwords on a later screen.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
303
Task 23a: Install Process Engine (Windows)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Specify Passwords
Specify the passwords for the f_sw and f_maint users (or their
aliases).
NOTE This screen
appears after Specify
Administrative User and
Group Aliases if you
choose to define aliases.
For DB2 these are operating system users and the values here
must match the passwords already assigned to these users.
For Oracle and SQL Server these are database users. The
passwords entered here must match the passwords created
when the Oracle or SQL scripts were executed.
If default passwords were created when the scripts ran for
Oracle or SQL Server databases, leave these fields blank.
Specify Administrative
User and Group Aliases
Indicate the alias you want to create for each of the following
users and groups.
NOTE This screen is only
presented if you chose to
configure aliases.
•
FNADMIN OS group
•
FNUSR OS group
•
FNOP OS group
•
FNSW OS user
•
f_sw DB user
•
f_maint DB user
NOTES For Oracle and SQL Server databases, these are
database users. For DB2, these are operating system users.
If you ran SQL scripts for SQL Server or Oracle manually before
starting Process Engine Setup, the aliases here for f_sw and
f_maint must match the users specified as runtime and
maintenance users. For DB2 databases, these user names
must match the operating system names created when the
database was installed. See “Verify that DB2 Server Is Installed for
IBM FileNet P8” on page 114.
If you are logged on as a domain user for this installation the
fnadmin, fnop and fnuser groups and the fnsw user, or aliases
for them have already been defined on this server. Assign the
same alias here as was defined earlier.
The f_sw and f_maint users should be dedicated users for IBM
FileNet use.
The default password for the fnsw user (or its alias) will be set
and must not be changed until Process Engine installation is
complete. “To Complete Additional Configuration” on page 307 for
information on changing the fnsw password and associated
changes to Windows services.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
304
Task 23a: Install Process Engine (Windows)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Choose an Application
Server
Select an application server and version from the drop-down
list.You must use the same application server type and version
as Content Engine.
Content Engine API
Configuration
Configure the Content Engine API, as follows:
•
Transport Method
Select WSI from the drop-down list.
•
Content Engine Client Software URL
Replace the sample server name and port number
(CEserver.example.com:7001) with the host name of the
Content Engine application server to which Process Engine
will connect. The port number depends on the application
server type. For example:
WebSphere
http://hqcemp2:9080/wsi/FNCEWS40DIME
WebLogic
http://hqcemp1:7001/wsi/FNCEWS40DIME
JBoss
http://hqcemp3:8080/wsi/FNCEWS40DIME
Do not modify the remainder of the string from the default
values.
NOTE To change the Content Engine server host name
later, or to connect to a different Content Engine server, edit
the WcmApiConfig.properties file. For information, see the
IBM FileNet P8 help topic FileNet P8 Administration >
Application Engine Administration > Key configuration files and
logs.
Please Read the
Summary Information
Below
Verify your selections, and click Install to install Process
Engine.
Completing the Setup
wizard
Click Finish to complete the Process Engine installation.
5. Setup will run a number of steps but to complete the installation the computer must be restarted.
When prompted, select Yes, restart my computer and click Finish.
6. When the system restarts, log on using the same account you used in Step 1. After you log on,
Process Engine Setup will continue. Click Next to continue the installation.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
305
Task 23a: Install Process Engine (Windows)
To Install the Process Engine software silently
If installation fails at this point, correct the errors that caused the failure and run the post-boot
setup program by navigating to the Process Engine\IMSInst install folder and executing:
setup.exe
-postboot
NOTE Not all error conditions can be resolved in this way. It might be necessary to uninstall
the Process Engine software and re-run Setup.
7. When the dialog box informs you that Process Engine has been successfully installed, click
Finish.
8. Check the following log files and correct any errors or failures indicated before proceeding to the
next step:
Log
Location
Process Engine logs
C:\Program Files\FileNet\PE\PE403_setup.log
C:\Program Files\FileNet\PE
C:\FNSW
IS mini-installer logs
<Windir>\mini_installer.log, Windows Event logs,
and log files under \FNSW_LOC\logs
Output files from SQL
Script validation (only if the
SQL scripts were executed
from Process Engine
Setup).
C:\Program Files\FileNet\PE
9. Proceed to “To Complete Additional Configuration” on page 307.
To Install the Process Engine software silently
Complete all preceeding tasks in this topic, up to “To install the Process Engine software interactively”
on page 294. Then take the following steps to silently install Process Engine on a Windows
machine.
1. Access the Process Engine software package, and copy its contents to a temporary directory on
the local disk.
Setup will run a number of steps but to complete the installation the computer must be
restarted.
2. Edit the PE_silent_input.txt file to reflect the appropriate responses for your installation. See
“Encrypt Passwords for Silent Installations and Upgrades” on page 666 for information on use of the
password encryption tool.
3. Save the edited response file to your temporary directory.
4. Log on as a member of the local Administrators group or a user with equivalent permissions. The user
you log on as must also be a database administrator. See “Specify IBM FileNet P8 Accounts” on
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
306
Task 23a: Install Process Engine (Windows)
To Complete Additional Configuration
page 72 for information on requirements for logging on as a Windows domain user for Process
Engine installation.
5. Open a command prompt and navigate to the temporary directory. Execute:
P8PE-4.0.3-Win.exe -silent -options PE_silent_input.txt
Process Engine Setup will reboot the server, after which it will continue with the post-boot
operations.
6. Proceed to “To Complete Additional Configuration” on page 307.
To Complete Additional Configuration
For Oracle and SQL Server databases, if default users and passwords were configured, Process
Engine Setup automatically creates several internally required local users. Because these users
are created with default passwords, it is best practice to reset their passwords to maintain system
security on each Process Engine Server.
User Name
User Type
Description
How to modify
f_maint
Database
(Oracle, SQL)
Has DBA
privileges.
Used for
RDBMS
maintenance.
Also referred
to as the
database
maintenance
user.
Execute Xdbconnect -r
Database
(Oracle, SQL)
Has privileges
only for
database
objects
created by
Process
Engine. Used
for RDBMS
maintenance.
Also referred
to as the
database
runtime user.
Execute Xdbconnect -r
f_sw
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
See steps below.
See steps below.
307
Task 23a: Install Process Engine (Windows)
To verify the connection to the Process Engine database
User Name
User Type
Description
How to modify
fnsw or alias
Operating
System
Primary
Process
Engine user.
Used to
execute
Process
Engine
software and
services.
Execute Windows Control
Panel > Administrative Tools >
Computer Management
>System Tools >Local Users
and Groups.
After you change the
password for the fnsw user,
you must also use the
Windows Services tool to
update the Log On tab for the
IMS ControlService because
the fnsw user is used to start
that service. Process Engine
Services Manager is started
as the Local System account
accordingly.
NOTE Process Engine activity
will cease if the fnsw user’s
password expires.
To verify the connection to the Process Engine database
Verify the ability to connect to the Process Engine database using the run-time user name and
password.
At a command prompt, execute:
vwcemp -l
If the connection is successful, you will receive a message indicating that the Content Engine has
not been configured yet. Because there are no security settings configured, the above command
should return a message similar to “….no object service is configure….”
Unsuccessful connection to the database will return an exception.
If the connection is not successful, there could be a mismatch between the password entered for
the f_sw user in Process Engine Setup and the password created by execution of the SQL scripts
(Oracle) or for the operating system runtime user (DB2).
To determine if a failure to connect to the database is due to a password mismatch, use the steps
in “To set the f_maint and f_sw passwords” on page 308.
To set the f_maint and f_sw passwords
For added security, Process Engine stores an encrypted version of the passwords for the f_sw and
f_maint users, or their aliases, in a file called rdbup.bin. This is in addition to passwords for these
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
308
Task 23a: Install Process Engine (Windows)
To re-enable Oracle Password Complexity Verification
users in the Oracle or SQL Server database, or the DB2 operating system user’s password. The
encrypted password and the database or operating system user’s passwords must match.
To verify that the passwords match, use the following procedure to start the Xdbconnect utility.
Xdbconnect works only if the passwords in the encrypted file and the database match.
Use the following procedure to change thepasswords for the f_maint and f_sw users after
installing the Process Engine software. For Oracle and SQL Server databases, both the encrypted
file and the database passwords will be updated. For DB2, only the encrypted file will be updated.
1. Start the Database Server Connect application by executing the following:
Xdbconnect -r
2. Log on as SysAdmin.
3. Change the primary password for the users f_sw and f_maint (or their alias) to match the
database password (Oracle and SQL Server) or operating system user’s password (DB2).
4. Exit the application.
To re-enable Oracle Password Complexity Verification
If, as directed earlier, you disabled the the Oracle Password Complexity Verification feature prior
to installing Process Engine, you can now re-enable it.
To verify the /etc/services file settings
1. Log on as the Administrator user and check the \Windows\system32\drivers\etc\services file to
verify the following parameters:
tms
cor
nch
fn_snmpd
fn_trapd
32768/tcp
32769/tcp
32770/udp
161/udp
35225/udp
2. If necessary, add the parameters to the file and save the changes.
To verify TCP/IP parameter settings
1. Log on as the Administrator user and run regedit to verify the following registry key values.
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\MaxUserP
ort => 65534 (default = 5000)
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\TcpTimed
WaitDelay => 90 (default = 240, or 4 min)
2. If necessary, add or modify a new DWORD value with the values as described above and save
the changes.
NOTE These values are decimal. The default in regedit is hexadecimal.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
309
Task 23a: Install Process Engine (Windows)
To redirect log messages to the Image Services error log
To redirect log messages to the Image Services error log
Enable the redirection of log messages to the Image Services error log. This redirection will log
message to the Image Services error log as well as to the default Windows Event Log. By
enabling this redirection, you will be able to monitor the progress of the database object upgrade
in a command window.
To enable the redirection, change the LogToFiles value from 0 to 1 for the following registry key.
HKEY_LOCAL_MACHINE>SOFTWARE>FileNET>IMS>CurrentVersion
(Optional; Oracle database only) To remove fnsw and oracle users from the ORA_DBA group
Remove the fnsw (or its alias) and oracle users from the ORA_DBA group. Process Engine Setup
creates these users, which are no longer required after installation is complete.
Proceed to “To install the Process Engine software updates” on page 350.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
310
Task 23b: Install Process Engine (Solaris)
To verify the database connection
Task 23b: Install Process Engine (Solaris)
Use the procedures in this topic to install Process Engine on Solaris.
NOTES
•
Before beginning this task, ensure that all applicable tasks listed in the “Installation Planning
Considerations” on page 26 and “Prerequisite Tasks” on page 50 have been completed.
•
You will find references to logging on as the root and fnsw users within the following
procedures. Take the following into account:
–
The root user must run in the Bourne or Korn shell.
–
The root user who will be doing a silent installation must run in the Korn shell.
–
The fnsw user must run in the Korn shell.
•
Before starting Process Engine installation, be sure to have the correct database information
including server names, database and instance names, and tablespace names. Entering
incorrect information during installation could cause the installation to fail. Recovery could
mean uninstalling and re-installing the Process Engine software.
•
You must either install Process Engine interactively (using the procedure in“To install the
Process Engine software interactively” on page 311) or silently (using the procedure in “To install
the Process Engine software silently” on page 320). After completing silent installation steps,
return to this task, at “To reset administrative user passwords” on page 321 and proceed through
the remainder of this task.
To verify the database connection
Verify the database connection between the Process Engine and the database. See “Verify the
Ability to Connect to the Database” on page 131 for details.
To install the Process Engine software interactively
1. Log on to the server as the root user.
NOTE This user does not need to be a database administrator unless you will be executing the
SQL scripts from Process Engine Setup.
2. Access the Process Engine software package.
3. From the console, launch the P8PE-4.0.3-Sol.bin setup program.
4. Wait for files to finish unpacking.
5. Complete the Process Engine Setup screens, as follows:
In this screen...
Perform this action...
Welcome to Process
Engine Setup
Click Next on the Welcome screen to proceed with the
installation.
License Agreement
Review and accept the license agreement, then click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
311
Task 23b: Install Process Engine (Solaris)
To install the Process Engine software interactively
In this screen...
Perform this action...
Specify the
Documentation URL
Enter the Documentation URL, which is where the IBM FileNet
P8 Platform Documentation is installed. Your entry must be in
the following format:
http://<docserver:port#>/<ecm_help>
where:
docserver is the name of the Java web server.
port# is the port number.
ecm_help is the root directory of the documentation web site.
You can use multi-part root directories.
(for example, /docs/ecm_help) if your application server
supports them.
Specify Installation
Location for Common
Files
Choose the destination directory for configuration files that will
be shared with other IBM FileNet P8 components.
Specify Network
Clearinghouse Domain
Name
Enter <domain name>:<organization>, where:
•
The maximum length of your <domain name> entry does not
exceed 19 characters.
•
The maximum length of your <organization> entry does not
exceed 19 characters.
•
Both your <domain name> and <organization> entries contain
only alphanumeric characters and underscores.
A typical convention is to enter <your PE machine name>:<your
company name>. If the machine name or company name include
hyphens, replace them with underscores in your entry.
Specify the Database
Location
Indicate whether the database will be local or remote.
Specify the Database
Type
Indicate whether the database will be:
NOTE This screen only
displays if a remote
database was selected.
•
Oracle
•
DB2
NOTE Only remote DB2 databases are supported.
6. Depending upon your selection here you will be presented with a number of additional screens
appropriate to database location and database software. Proceed as appropriate to:
•
“To complete remote DB2 database screens” on page 313
•
“To complete remote Oracle database screens” on page 313
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
312
Task 23b: Install Process Engine (Solaris)
To complete remote DB2 database screens
•
“To complete local Oracle database screens” on page 315.
To complete remote DB2 database screens
In this screen...
Perform this action...
Database Alias Name
Enter the database alias name as assigned in “Verify that DB2
Client Is Installed for IBM FileNet P8” on page 127.
Local DB2 instance
owner name
Enter the DB2 client instance owner’s name, which is case
sensitive.
FileNet Data Tablespace
name
defaults to VWDATA_TS
If you created more than one tablespace in “Verify that DB2
Server Is Installed for IBM FileNet P8” on page 114, indicate the
default tablespace.
To complete remote Oracle database screens
Complete the Process Engine Setup screens that are specific to remote Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory:
The Oracle Home path you enter refers to the local Oracle
installation directory.
The Oracle User Name created in “Accounts for Process Engine
(UNIX)” on page 86.
The Oracle DBA OS group name created in “Accounts for
Process Engine (UNIX)” on page 86.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
313
Task 23b: Install Process Engine (Solaris)
To complete remote Oracle database screens
In this screen...
Perform this action...
Specify Remote Oracle
Configuration
Parameters
Enter the following Oracle database configuration parameters.
•
Global Database Name (as identified in the tnsnames.ora
file)
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more than
one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
Specify Execution Mode
for Oracle Scripts
A series of SQL scripts must be executed. You could have
already run the scripts manually before starting Process Engine
Setup. If you did not run them manually, you need to indicate
how you want to run them now. You can run them as the Oracle
SYS user or as another user who can be authenticated through
the operating system.
•
I have already run the pre-install scripts manually.
•
I want to run the scripts in an xterm window.
•
I want to run the scripts silently using operating system
authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
314
Task 23b: Install Process Engine (Solaris)
To complete local Oracle database screens
To complete local Oracle database screens
Complete the Process Engine Setup screens that are specific to local Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory:
The Oracle Home path you enter refers to the local Oracle
installation directory.
To find the Oracle Home directory, type the following command
at a command prompt and look for the Oracle_Home variable:
set
The Oracle User Name modified in “Accounts for Process Engine
(UNIX)” on page 86.
The Oracle DBA OS group name modified in “Accounts for
Process Engine (UNIX)” on page 86.
Oracle Database
Information
Enter the following Oracle database configuration parameters.
•
Oracle SID
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more
than one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
315
Task 23b: Install Process Engine (Solaris)
To complete local Oracle database screens
In this screen...
Perform this action...
Specify Execution Mode
for Oracle Scripts
A series of SQL scripts must be executed. You could have
already run the scripts manually before starting Process Engine
Setup. If you did not run them manually, you need to indicate
how you want to run them now. You can run them as the Oracle
SYS user or as another user who can be authenticated through
the operating system.
•
I have already run the pre-install scripts manually.
•
I want to run the scripts in an xterm window.
•
I want to run the scripts silently using operating system
authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
316
Task 23b: Install Process Engine (Solaris)
To complete final Process Engine Setup screens
To complete final Process Engine Setup screens
Complete the screens to finalize the Process Engine installation, as follows:
In this screen...
Perform this action...
Determine Administrative
User and Group Aliasing
Method
Determine whether FileNet default operating system and
database users and groups will be used, or if you want to define
aliases for these users and groups.
SQL Script Passwords
NOTE This screen
appears only if you
selected an option to
have setup run the SQL
scripts.
•
Yes, configure aliases
•
No, use actual account names for aliases
You have selected an option to have setup run the pre-install
SQL scripts. Setup needs to know if you have changed the
default passwords that are specified in these script files.
Select from the following options:
•
I have not changed the default FileNet passwords specified
in the SQL scripts
•
I have changed the default FileNet passwords specified in
the SQL scripts
If you have changed the default passwords you will be prompted
to enter those passwords on a later screen.
Specify Passwords
NOTE This screen
appears after Specify
Administrative User and
Group Aliases if you
choose to define aliases.
Specify the passwords for the f_sw and f_maint users (or their
aliases).
For DB2 these are operating system users and the values here
must match the passwords already assigned to these users.
For Oracle, these are database users. The passwords entered
here must match the passwords created when the Oracle
scripts were executed.
If default passwords were created when Oracle SQL scripts ran,
leave these fields blank.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
317
Task 23b: Install Process Engine (Solaris)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Specify Administrative
User and Group Aliases
Indicate the alias you want to create for each of the following
users and groups.
NOTE This screen is
presented only if you
chose to configure
aliases.
•
FNADMIN OS group
•
FNUSR OS group
•
FNOP OS group
•
FNSW OS user
•
f_sw DB user
•
f_maint DB user
NOTE For Oracle databases, these are database users. For
DB2, these are operating system users.
If you ran SQL scripts for Oracle manually before starting
Process Engine Setup, the aliases here for f_sw and f_maint
must match the users specified as runtime and maintenance
users. For DB2 databases, these user names must match the
operating system names created when the database was
installed. See “Verify that DB2 Server Is Installed for IBM FileNet P8”
on page 114.
Specify Device File
Names
Enter the full pathname for the device files for the fn_SEC_DB0
and fn_SEC_RL0 volumes.
For example, if Solstice DiskSuite software was used, and
fn_SEC_DB0 was on the d100 raw device, the entry would be:
/dev/md/rdsk/d100
Choose an Application
Server
Select an application server and version from the drop-down
boxes.You must use the same application server type and
version as Content Engine.
Click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
318
Task 23b: Install Process Engine (Solaris)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Content Engine API
Configuration
Configure the Content Engine API, as follows:
•
Transport Method
Select WSI from the drop-down list.
•
Content Engine Client Software URL
Replace the sample server name and port number
(CEserver.example.com:7001) with the host name of the
Content Engine application server to which Process Engine
will connect. The port number depends on the application
server type. For example:
WebSphere
http://hqcemp2:9080/wsi/FNCEWS40DIME
WebLogic
http://hqcemp1:7001/wsi/FNCEWS40DIME
JBoss
http://hqcemp3:8080/wsi/FNCEWS40DIME
Do not modify the remainder of the string from the default
values.
NOTE To change the Content Engine server host name
later, or to connect to a different Content Engine server, edit
the WcmApiConfig.properties file. For information, see the
IBM FileNet P8 help topic FileNet P8 Administration >
Application Engine Administration > Key configuration files and
logs.
Click Next.
Please Read the
information below
Review the information on the installation process. Note that
you can check the progress of the installation in the /fnsw/local/
logs/wizard file. Click Next when you are ready to proceed.
Please Read the
Summary Information
Below
Verify your selections, and click Install to install Process
Engine.
xterm Window
Enter the SYS password for Oracle.
NOTE This window
displays if you chose to
run the SQL scripts in an
xterm window.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
319
Task 23b: Install Process Engine (Solaris)
To install the Process Engine software silently
In this screen...
Perform this action...
Completing the Setup
wizard
Click Finish to complete the Process Engine installation and
then as prompted, log off and log back in as fnsw or the alias
you defined in “Accounts for Process Engine (UNIX)” on page 86.
7. Monitor /fnsw/local/logs/wizard to check the progress of the installation since Setup will run for
several minutes,and its progress, though displayed, might not visibly advance for an extended
period of time.
8. Check the following log files and correct any errors or failures indicated before proceeding to the
next step:
Log
Location
Process Engine logs
/fnsw/local/logs/PE (if the install completes
successfully)
or
/fnsw/tmp_installer (if the install has errors)
IS mini-installer logs
/fnsw/local/logs/wizard and other subdirectories
under /fnsw/local/logs
9. Log off as the root user and log on as fnsw (or the alias).
10. Proceed to “To reset administrative user passwords” on page 321.
To install the Process Engine software silently
Complete all procedures in this topic, up to “To install the Process Engine software interactively” on
page 311. Then take the following steps to silently install Process Engine.
1. Access the Process Engine software package and copy the content to a temporary directory on
the local disk.
2. Edit the PE_silent_input.txt file to reflect the appropriate responses for your installation. See
“Encrypt Passwords for Silent Installations and Upgrades” on page 666 for information on use of the
password encryption tool.
3. Save the edited response file to your temporary directory.
4. Log on as the root user in the Korn shell.
5. Navigate to the temporary directory on the local disk.
6. Open a command prompt and execute:
P8PE-4.0.3-Sol.bin -silent -options PE_silent_input.txt
7. Proceed to “To reset administrative user passwords” on page 321.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
320
Task 23b: Install Process Engine (Solaris)
To reset administrative user passwords
To reset administrative user passwords
Process Engine Setup automatically creates several internally required local users. For Oracle
databases, if default users and passwords were configured, Process Engine Setup also creates
several database users. Because these users are created with default passwords, it is a best
practice to reset the passwords for these users to maintain system security, as shown in the
following table. See the IBM FileNet Image Services documentation for instructions on using the
referenced tools.
User Name
User Type
Description
How to modify
f_sw
Database (Oracle)
Has DBA privileges. Used
as the Process Engine
run-time user.
Execute
Xdbconnect. See
steps below.
f_maint
Database (Oracle)
Has DBA privileges. Used
for RDBMS maintenance.
Execute
Xdbconnect. See
steps below.
SysAdmin
SEC (internal Process
Engine security software)
Primary administrator user
for IBM FileNet software
tools.
FieldService
SEC
Used internally by
Process Engine software.
Execute Xapex ->
Security
Administration. Log
on as SysAdmin.
Operator
SEC
Used internally by
Process Engine software.
To verify the connection to the Process Engine database
Verify the ability to connect to the Process Engine database using the run-time user name and
password.
At a command prompt, execute:
vwcemp -l
If the connection is successful, you will receive a message indicating that the Content Engine has
not been configured yet. Because there are no security settings configured, the above command
should return a message similar to “….no object service is configure….”
Unsuccessful connection to the database will return an exception.
If the connection is not successful, there could be a mismatch between the password entered for
the f_sw user in Process Engine Setup and the password created by execution of the SQL scripts
(Oracle) or for the operating system runtime user (DB2).
To determine if a failure to connect to the database is due to a password mismatch, use the steps
in “To set the f_maint and f_sw passwords” on page 322.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
321
Task 23b: Install Process Engine (Solaris)
To set the f_maint and f_sw passwords
To set the f_maint and f_sw passwords
For added security, Process Engine stores an encrypted version of the passwords for the f_sw and
f_maint users, or their aliases, in a file called rdbup.bin. This is in addition to passwords for these
users in the Oracle or SQL Server database, or the DB2 operating system user’s password. The
encrypted password and the database or operating system user’s passwords must match.
To verify that the passwords match, use the following procedure to start the Xdbconnect utility.
Xdbconnect works only if the passwords in the encrypted file and the database match.
Use the following procedure to change the passwords for the f_maint and f_sw users after
installing the Process Engine software. For Oracle and SQL Server databases, both the encrypted
file and the database passwords will be updated. For DB2, only the encrypted file will be updated.
1. Start the Database Server Connect application by executing the following:
Xdbconnect -r
2. Log on as SysAdmin.
3. Change the primary password for the users f_sw and f_maint (or their alias) to match the
database password (Oracle and SQL Server) or operating system user’s password(DB2).
4. Exit the application.
To re-enable Oracle Password Complexity Verification
If, as directed earlier, you disabled the the Oracle Password Complexity Verification feature prior
to installing Process Engine, you can now re-enable it.
(Optional: Oracle databases only) To remove fnsw user from the Oracle database administrators
group
Process Engine Setup creates a user that is no longer required after installation is complete.
Remove the fnsw (or the alias) user from the <Oracle Database Administrators> group.
To restore any custom modifications for root and fnsw users.
Process Engine Setup creates a new versions of a number of files. If the previous versions of
these files contained any custom settings, edit the new files for the fnsw and root users
accordingly. Saved files are in <.filename>.old.<nn>, where <nn> is a sequential number. The
latest saved version will be in the highest numbered file. The following files are modified by
Process Engine Setup:
.Xdefaults
.Xresources
.dbxinit
.dtprofile
.env
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
322
Task 23b: Install Process Engine (Solaris)
To verify the /etc/services file settings
.login
.mwmrc
.xinitrc
.profile
.cshrc
To verify the /etc/services file settings
1. Log on as the root user and check the /etc/services file to verify the following parameters:
tms
32768/tcp
cor
32769/tcp
nch
32770/udp
fn_snmpd 161/udp
fn_trapd
35225/udp
2. If necessary, add the parameters to the file and save the changes.
To clean up before starting Process Engine
1. Log on as fnsw.
2. Execute:
killfnsw -DAyS
3. Execute:
ipcs -a
4. Verify there is no entry with 0x464 pattern. If there are any entries with this pattern, use ipcrm to
remove them.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
323
Task 23b: Install Process Engine (Solaris)
To edit the /etc/inittab file
To edit the /etc/inittab file
By default, the Process Engine software starts automatically when you restart the server and
needs its database started beforehand. If the database is not automatically started on server
restart, edit the /etc/inittab file on the Process Engine machine to comment out the autostart of
Process Engine.
For example, change:
fn:3:wait:/bin/sh /etc/rc.initfnsw </dev/console >/dev/console 2>&1
to
#fn:3:wait:/bin/sh /etc/rc.initfnsw </dev/console >/dev/console 2>&1
Proceed to “To install the Process Engine software updates” on page 350.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
324
Task 23c: Install Process Engine (AIX)
To verify the database connection
Task 23c: Install Process Engine (AIX)
Use the procedures in this topic to install Process Engine on AIX.
NOTES
•
Before beginning this task, ensure that all applicable tasks listed in the “Installation Planning
Considerations” on page 26 and “Prerequisite Tasks” on page 50 have been completed.
•
You will find references to logging on as the root and fnsw users within the following
procedures. The root user must run in the Bourne or Korn shell and the fnsw user must run in
the Korn shell.
•
Before starting Process Engine installation, be sure to have the correct database information
including server names, database and instance names, and tablespace names. Entering
incorrect information during installation could cause the installation to fail. Recovery could
mean uninstalling and re-installing the Process Engine software.
•
You must either install Process Engine interactively (using the procedure in“To install the
Process Engine software interactively” on page 325) or silently (using the procedure in “To install
the Process Engine software silently” on page 333). After completing silent installation steps,
return to this task, at “To reset administrative user passwords” on page 334 and proceed through
the remainder of this task.
To verify the database connection
Verify the database connection between the Process Engine and the database. See “Verify the
Ability to Connect to the Database” on page 131 for details.
To install the Process Engine software interactively
1. Log on to the server as the root user.
NOTE This user does not need to be a database administrator unless you will be executing the
SQL scripts from Process Engine Setup.
2. Access the Process Engine software package.
3. From the console, launch the P8PE-4.0.3-AIX.bin setup program.
4. Wait for files to finish unpacking.
5. Complete the Process Engine Setup screens, as follows :
In this screen...
Perform this action...
Welcome to Process
Engine Setup
Click Next on the Welcome screen to proceed with the
installation.
License Agreement
Review and accept the license agreement.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
325
Task 23c: Install Process Engine (AIX)
To install the Process Engine software interactively
In this screen...
Perform this action...
Specify the
Documentation URL
Enter the Documentation URL, which is where the IBM FileNet
P8 Platform Documentation is installed. Your entry must be in
the following format:
http://<docserver:port#>/<ecm_help>
where:
docserver is the name of the Java web server.
port# is the port number.
ecm_help is the root directory of the documentation web site.
You can use multi-part root directories. (for example, /docs/
ecm_help) if your application server supports them.
Specify Installation
Location for Common
Files
Choose the destination directory for configuration files that will
be shared with other IBM FileNet P8 components.
Specify Network
Clearinghouse Domain
Name
Enter <domain name>:<organization>, where:
•
The maximum length of your <domain name> entry does not
exceed 19 characters.
•
The maximum length of your <organization> entry does not
exceed 19 characters.
•
Both your <domain name> and <organization> entries contain
only alphanumeric characters and underscores.
A typical convention is to enter <your PE machine name>:<your
company name>. If the machine name or company name include
hyphens, replace them with underscores in your entry.
Specify the Database
Location
Indicate whether the database will be local or remote.
Specify the Database
Type
Indicate whether the database will be:
NOTE This screen only
displays if a remote
database was selected.
•
Oracle
•
DB2
NOTE Only remote DB2 databases are supported.
6. Depending upon your selection here you will be presented with a number of additional screens
appropriate to database location and database software. Proceed as appropriate to:
•
“To complete remote DB2 database screens” on page 327
•
“To complete remote Oracle database screens” on page 327
•
“To complete local Oracle database screens” on page 329.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
326
Task 23c: Install Process Engine (AIX)
To complete remote DB2 database screens
To complete remote DB2 database screens
In this screen...
Perform this action...
Database Alias Name
Enter the database alias name as assigned in “Verify that DB2
Client Is Installed for IBM FileNet P8” on page 127.
Local DB2 instance
owner name
Enter the DB2 client instance owner’s name, which is case
sensitive.
Data Tablespace name
defaults to VWDATA_TS
To complete remote Oracle database screens
Complete the Process Engine Setup screens that are specific to remote Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory:
The Oracle Home path you enter refers to the local Oracle
installation directory.
The Oracle User Name created in “Accounts for Process Engine
(UNIX)” on page 86.
The Oracle DBA OS group name created in “Accounts for
Process Engine (UNIX)” on page 86.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
327
Task 23c: Install Process Engine (AIX)
To complete remote Oracle database screens
In this screen...
Perform this action...
Specify Remote Oracle
Configuration
Parameters
Enter the following Oracle database configuration parameters.
•
Global Database Name (as identified in the tnsnames.ora
file)
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more than
one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
Specify Execution Mode
for Oracle Scripts
A series of SQL scripts must be executed. You could have
already run the scripts manually before starting Process Engine
Setup. If you did not run them manually, you need to indicate
how you want to run them now. You can run them as the Oracle
SYS user or as another user who can be authenticated through
the operating system.
•
I have already run the pre-install scripts manually.
•
I want to run the scripts in an xterm window.
I want to run the scripts silently using operating system
authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
328
Task 23c: Install Process Engine (AIX)
To complete local Oracle database screens
To complete local Oracle database screens
Complete the Process Engine Setup screens that are specific to local Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory:
The Oracle Home path you enter refers to the local Oracle
installation directory.
To find the Oracle Home directory, type the following command
at a command prompt and look for the Oracle_Home variable:
set
The Oracle User Name modified in “Accounts for Process Engine
(UNIX)” on page 86.
The Oracle DBA OS group name modified in “Accounts for
Process Engine (UNIX)” on page 86.
Oracle Database
Information
Enter the following Oracle database configuration parameters.
•
Oracle SID
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more than
one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
329
Task 23c: Install Process Engine (AIX)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Specify Execution Mode
for Oracle Scripts
A series of SQL scripts need to be executed. You could have
already run the scripts manually before starting Process Engine
Setup. If you did not run them manually, you need to indicate
how you want to run them now. You can run them as the Oracle
SYS user or as another user who can be authenticated through
the operating system.
•
I have already run the pre-install scripts manually.
•
I want to run the scripts in an xterm window.
•
I want to run the scripts silently using operating system
operating system authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
To complete final Process Engine Setup screens
Complete the screens to finalize the Process Engine installation, as follows:
In this screen...
Perform this action...
Determine Administrative
User and Group Aliasing
Method
Determine whether FileNet default operating system and
database users and groups will be used, or if you want to define
aliases for these users and groups.
SQL Script Passwords
NOTE This screen
appears only if you
selected an option to
have setup run the SQL
scripts.
•
Yes, configure aliases
•
No, use actual account names for aliases
You have selected an option to have setup run the pre-install
SQL scripts. Setup needs to know if you have changed the
default passwords that are specified in these script files.
Select from the following options:
•
I have not changed the default FileNet passwords specified
in the SQL scripts
•
I have changed the default FileNet passwords specified in
the SQL scripts
If you have changed the default passwords you will be prompted
to enter those passwords on a later screen.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
330
Task 23c: Install Process Engine (AIX)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Specify Passwords
Specify the passwords for the f_sw and f_maint users (or their
aliases).
NOTE This screen
appears after Specify
Administrative User and
Group Aliases if you
choose to define aliases.
For DB2 these are operating system users and the values here
must match the passwords already assigned to these users.
For Oracle these are database users. The passwords entered
here must match the passwords created when the Oracle
scripts were executed.
If default passwords were created when the scripts ran, leave
these fields blank.
Specify Administrative
User and Group Aliases
Indicate the alias you want to create for each of the following
users and groups.
NOTE This screen is
presented only if you
chose to configure
aliases.
•
FNADMIN OS group
•
FNUSR OS group
•
FNOP OS group
•
FNSW OS user
•
f_sw DB user
•
f_maint DB user
NOTE For Oracle databases, these are database users. For
DB2, these are operating system users.
If you ran SQL scripts for Oracle manually before starting
Process Engine Setup, the aliases here for f_sw and f_maint
must match the users specified as runtime and maintenance
users. For DB2 databases, these user names must match the
operating system names created when the database was
installed. See “Verify that DB2 Server Is Installed for IBM FileNet P8”
on page 114.
Choose an Application
Server
Select an application server and version from the drop-down
boxes.You must use the same application server type and
version as Content Engine.
Click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
331
Task 23c: Install Process Engine (AIX)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Content Engine API
Configuration
Configure the Content Engine API, as follows:
•
Transport Method
Select WSI from the drop-down list.
•
Content Engine Client Software URL
Replace the sample server name and port number
(CEserver.example.com:7001) with the host name of the
Content Engine application server to which Process Engine
will connect. The port number depends on the application
server type. For example:
WebSphere
http://hqcemp2:9080/wsi/FNCEWS40DIME
WebLogic
http://hqcemp1:7001/wsi/FNCEWS40DIME
JBoss
http://hqcemp3:8080/wsi/FNCEWS40DIME
Do not modify the remainder of the string from the default
values.
NOTE To change the Content Engine server host name
later, or to connect to a different Content Engine server, edit
the WcmApiConfig.properties file. For information, see the
IBM FileNet P8 help topic FileNet P8 Administration >
Application Engine Administration > Key configuration files and
logs.
Please Read the
information below
Review the information on the installation process. Note that
you can check the progress of the installation in the /fnsw/local/
logs/wizard file. Click Next when you are ready to proceed.
Please Read the
Summary Information
Below
Verify your selections, and click Install to install Process
Engine.
xterm Window
Enter the SYS password for Oracle.
NOTE This window
displays if you chose to
run the SQL scripts in an
xterm window.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
332
Task 23c: Install Process Engine (AIX)
To install the Process Engine software silently
In this screen...
Perform this action...
Completing the Setup
wizard
Click Finish to complete the Process Engine installation and
then as prompted, log off and log back in as fnsw or the alias
you defined in “Accounts for Process Engine (UNIX)” on page 86.
7. Monitor /fnsw/local/logs/wizard to check the progress of the installation since Setup will run for
several minutes,and its progress, though displayed, might not visibly advance for an extended
period of time.
8. Check the following log files and correct any errors or failures indicated before proceeding to the
next step:
Log
Location
Process Engine logs
/fnsw/local/logs/PE (if the install completes
successfully)
or
/fnsw/tmp_installer (if the install has errors)
IS mini-installer logs
/fnsw/local/logs/wizard and other subdirectories
under /fnsw/local/logs
9. Log off as the root user and log on as fnsw (or the alias).
10. Proceed to “To reset administrative user passwords” on page 334.
To install the Process Engine software silently
Complete all procedures in this topic, up to “To install the Process Engine software interactively” on
page 325. Then take the following steps to silently install Process Engine .
1. Access the Process Engine software package, and copy the contents to a local temporary
directory on the local disk.
2. Edit the PE_silent_input.txt file to reflect the appropriate responses for your installation. See
“Encrypt Passwords for Silent Installations and Upgrades” on page 666 for information on use of the
password encryption tool.
3. Save the edited response file to your temporary directory.
4. Log on as the root user in the Korn shell.
5. Navigate to the temporary directory on the local disk.
6. Open a command prompt and execute:
P8PE-4.0.3-AIX.bin -silent -options PE_silent_input.txt
7. Proceed to “To reset administrative user passwords” on page 334.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
333
Task 23c: Install Process Engine (AIX)
To reset administrative user passwords
To reset administrative user passwords
Process Engine Setup automatically creates several internally required local users. For Oracle
databases, if default users and passwords were configured, Process Engine Setup also creates
several database users. Because these users are created with default passwords, it is a best
practice to reset the passwords for these users. The following table lists the users created, the
level of system access each user has, and the tool used to change the password. See the IBM
FileNet Image Services documentation for instructions on using the referenced tools
User Name
User Type
Description
How to modify
f_sw
Database (Oracle)
Has DBA privileges. Used
as the Process Engine
run-time user.
Execute
Xdbconnect. See
steps below.
f_maint
Database (Oracle)
Has DBA privileges. Used
for RDBMS maintenance.
Execute
Xdbconnect. See
steps below.
SysAdmin
SEC (internal Process
Engine security software)
Primary administrator user
for IBM FileNet software
tools.
FieldService
SEC
Used internally by
Process Engine software.
Execute Xapex ->
Security
Administration. Log
on as SysAdmin.
Operator
SEC
Used internally by
Process Engine software.
To verify the connection to the Process Engine database
Verify the ability to connect to the Process Engine database using the run-time user name and
password.
At a command prompt, execute:
vwcemp -l
If the connection is successful, you will receive a message indicating that the Content Engine has
not been configured yet. Because there are no security settings configured, the above command
should return a message similar to “….no object service is configure….”
Unsuccessful connection to the database will return an exception.
If the connection is not successful, there could be a mismatch between the password entered for
the f_sw user in Process Engine Setup and the password created by execution of the SQL scripts
(Oracle) or for the operating system runtime user (DB2).
To determine if a failure to connect to the database is due to a password mismatch, use the steps
in “To set the f_maint and f_sw passwords” on page 335.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
334
Task 23c: Install Process Engine (AIX)
To set the f_maint and f_sw passwords
To set the f_maint and f_sw passwords
For added security, Process Engine stores an encrypted version of the passwords for the f_sw and
f_maint users, or their aliases, in a file called rdbup.bin. This is in addition to passwords for these
users in the Oracle or SQL Server database, or the DB2 operating system user’s password. The
encrypted password and the database or operating system user’s passwords must match.
To verify that the passwords match, use the following procedure to start the Xdbconnect utility.
Xdbconnect works only if the passwords in the encrypted file and the database match.
Use the following procedure to change the passwords for the f_maint and f_sw users after
installing the Process Engine software. For Oracle and SQL Server databases, both the encrypted
file and the database passwords will be updated. For DB2, only the encrypted file will be updated.
1. Start the Database Server Connect application by executing the following:
Xdbconnect -r
2. Log on as SysAdmin.
3. Change the primary password for the users f_sw and f_maint (or their alias) to match the
database password (Oracle and SQL Server) or operating system user’s password (DB2).
4. Exit the application.
To re-enable Oracle Password Complexity Verification
If, as directed earlier, you disabled the the Oracle Password Complexity Verification feature prior
to installing Process Engine, you can now re-enable it.
(Optional: Oracle databases only) To remove fnsw user from the Oracle database administrators
group
Process Engine Setup creates a user that is no longer required after installation is complete.
Remove the fnsw (or the alias) user from the <Oracle Database Administrators> group.
To restore any custom modifications for root and fnsw users.
Process Engine Setup creates a new versions of a number of files. If the previous versions of
these files contained any custom settings, edit the new files for the fnsw and root users
accordingly. Saved files are in <.filename>.old.<nn>, where <nn> is a sequential number. The
latest saved version will be in the highest numbered file. The following files are modified by
Process Engine Setup:
.Xdefaults
.Xresources
.dbxinit
.dtprofile
.env
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
335
Task 23c: Install Process Engine (AIX)
To verify the /etc/services file settings
.login
.mwmrc
.xinitrc
.profile
.cshrc
To verify the /etc/services file settings
1. Log on as the root user and check the /etc/services file to verify the following parameters:
smux
tms
cor
nch
fn_trapd
199/tcp
32768/tcp
32769/tcp
32770/udp
35225/udp
# snmpd smux port
2. If necessary, add the parameters to the file and save the changes.
To clean up before starting Process Engine
1. Log on as fnsw.
2. Execute:
killfnsw -DAyS
3. Execute:
ipcs -a
4. Verify there is no entry with 0x464 pattern. If there are any entries with this pattern, use ipcrm to
remove them.
To edit the /etc/inittab file
By default, the Process Engine software starts automatically when you restart the server and
needs its database started beforehand. If the database is not automatically started on server
restart, edit the /etc/inittab file on the Process Engine machine to comment out the autostart of
Process Engine.
For example, change:
rcfnsw:2:once:/etc/rc.initfnsw 2>&1 | alog -tboot > /dev/console 2>&1
to
#rcfnsw:2:once:/etc/rc.initfnsw 2>&1 | alog -tboot > /dev/console 2>&1
Proceed to “Install Process Engine Software Updates” on page 350.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
336
Task 23d: Install Process Engine (HP-UX)
To verify the database connection
Task 23d: Install Process Engine (HP-UX)
Use the procedures in this topic to install Process Engine on HP PA-RISC and Integrity platforms.
NOTES
•
Before beginning this task, ensure that all applicable tasks listed in the “Installation Planning
Considerations” on page 26 and “Prerequisite Tasks” on page 50 have been completed.
•
You will find references to logging on as the root and fnsw users within the following
procedures. The root user must run in the Bourne or Korn shell and the fnsw user must run in
the Korn shell.
•
Before starting Process Engine installation, be sure to have the correct database information
including server names, database and instance names, and tablespace names. Entering
incorrect information during installation could cause the installation to fail. Recovery could
mean uninstalling and re-installing the Process Engine software.
•
You must either install Process Engine interactively (using the procedure in“To install the
Process Engine software interactively” on page 337) or silently (using the procedure in “To install
the Process Engine software silently” on page 345). After completing silent installation steps,
return to this task, at “To reset administrative user passwords” on page 346 and proceed through
the remainder of this task.
To verify the database connection
Verify the database connection between the Process Engine and the database. See “Verify the
Ability to Connect to the Database” on page 131 for details.
To install the Process Engine software interactively
1. Log in as root.
NOTE This user does not need to be a database administrator unless you will be executing the
SQL scripts from Process Engine Setup.
2. Access the Process Engine software package and execute P8PE-4.0.3-HPUX.bin for PA-RISC,
or P8PE-4.0.3-HPUXi.bin for HP Integrity.
3. Wait for files to finish unpacking.
4. Complete the Process Engine Setup screens, as follows:
In this screen...
Perform this action...
Welcome to Process
Engine Setup
Click Next on the Welcome screen to proceed with the
installation.
License Agreement
Review and accept the license agreement.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
337
Task 23d: Install Process Engine (HP-UX)
To install the Process Engine software interactively
In this screen...
Perform this action...
Specify the
Documentation URL
Enter the Documentation URL, which is where the IBM FileNet
P8 Platform Documentation is installed. Your entry must be in
the following format:
http://<docserver:port#>/<ecm_help>
where:
docserver is the name of the Java web server.
port# is the port number.
ecm_help is the root directory of the documentation web site.
You can use multi-part root directories.
(for example, /docs/ecm_help) if your application server
supports them.
Specify Installation
Location for Common
Files
Choose the destination directory for configuration files that will
be shared with other IBM FileNet P8 components.
Specify Network
Clearinghouse Domain
Name
Enter <domain name>:<organization>, where:
•
The maximum length of your <domain name> entry does not
exceed 19 characters.
•
The maximum length of your <organization> entry does not
exceed 19 characters.
•
Both your <domain name> and <organization> entries contain
only alphanumeric characters and underscores.
A typical convention is to enter <your PE machine name>:<your
company name>. If the machine name or company name include
hyphens, replace them with underscores in your entry.
Specify the Database
Location
Indicate whether the database will be local or remote.
Specify the Database
Type
Indicate whether the database will be:
NOTE This screen only
displays if a remote
database was selected.
•
Oracle
•
DB2
NOTE Only remote DB2 databases are supported.
Depending upon your selection here you will be presented with a number of additional screens
appropriate to database location and database software. Proceed as appropriate to:
•
“To complete remote DB2 database screens” on page 339
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
338
Task 23d: Install Process Engine (HP-UX)
To complete remote DB2 database screens
•
“To complete remote Oracle database screens” on page 339
•
“To complete local Oracle database screens” on page 341.
To complete remote DB2 database screens
In this screen...
Perform this action...
Database Alias Name
Enter the database alias name as assigned in “Verify that DB2
Client Is Installed for IBM FileNet P8” on page 127.
Local DB2 instance
owner name
Enter the DB2 client instance owner’s name, which is case
sensitive.
FileNet Data Tablespace
name
defaults to VWDATA_TS
To complete remote Oracle database screens
Complete the Process Engine Setup screens that are specific to remote Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory:
The Oracle Home path you enter refers to the local Oracle
installation directory.
The Oracle User Name created in “Accounts for Process Engine
(UNIX)” on page 86.
The Oracle DBA OS group name created in “Accounts for
Process Engine (UNIX)” on page 86.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
339
Task 23d: Install Process Engine (HP-UX)
To complete remote Oracle database screens
In this screen...
Perform this action...
Specify Remote Oracle
Configuration
Parameters
Enter the following Oracle database configuration parameters.
•
Global Database Name (as identified in the tnsnames.ora
file)
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more than
one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
Specify Execution Mode
for Oracle Scripts
A series of SQL scripts need to be executed. You could have
already run the scripts manually before starting Process Engine
Setup. If you did not run them manually, you need to indicate
how you want to run them now. You can run them as the Oracle
SYS user or as another user who can be authenticated through
the operating system.
•
I have already run the pre-install scripts manually.
•
I want to run the scripts in an xterm window.
•
I want to run the scripts silently using operating system
authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
340
Task 23d: Install Process Engine (HP-UX)
To complete local Oracle database screens
To complete local Oracle database screens
Complete the Process Engine Setup screens that are specific to local Oracle databases, as
follows:
In this screen...
Perform this action...
Specify Oracle
Configuration
Parameters
Enter the appropriate values for the Oracle Home Directory:
The Oracle Home path you enter refers to the local Oracle
installation directory.
To find the Oracle Home directory, type the following command
at a command prompt and look for the Oracle_Home variable:
set
The Oracle User Name modified in “Accounts for Process Engine
(UNIX)” on page 86.
The Oracle DBA OS group name modified in “Accounts for
Process Engine (UNIX)” on page 86.
Oracle Database
Information
Enter the following Oracle database configuration parameters.
•
Oracle SID
•
Temporary Tablespace Name
Default value is VWTEMP_TS
•
Data Tablespace Name
Default value is VWDATA_TS
•
Index Tablespace Name
Default value is VWINDEX_TS
Enter the optional tablespace to be used by Process Engine
for indexes. The data tablespace will be used if no index
tablespace is designated.
All values for tablespace names must match those you used
when tablespaces were created in “Verify that Oracle Server Is
Installed for IBM FileNet P8” on page 106. If you created more than
one data and optional index tablespace indicate the default
tablespace names.
Specify Oracle Version
Both Oracle9i or Oracle 10g versions are supported. Indicate
which version of Oracle software to use on the database server
for Process Engine.
NOTE The Oracle versions must be the same on the client and
server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
341
Task 23d: Install Process Engine (HP-UX)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Specify Execution Mode
for Oracle Scripts
A series of SQL scripts need to be executed. You could have
already run the scripts manually before starting Process Engine
Setup. If you did not run them manually, you need to indicate
how you want to run them now. You can run them as the Oracle
SYS user or as another user who can be authenticated through
the operating system.
•
I have already run the pre-install scripts manually.
•
I want to run the scripts in an xterm window.
•
I want to run the scripts silently using operating system
authentication.
NOTE If the scripts set the default passwords, leave the
password fields blank at the prompts on the Specify Passwords
screen that follows.
To complete final Process Engine Setup screens
Complete the screens to finalize the Process Engine installation, as follows:
In this screen...
Perform this action...
Determine Administrative
User and Group Aliasing
Method
Determine whether FileNet default operating system and
database users and groups will be used, or if you want to define
aliases for these users and groups.
SQL Script Passwords
NOTE This screen
appears only if you
selected an option to
have setup run the SQL
scripts.
•
Yes, configure aliases
•
No, use actual account names for aliases
You have selected an option to have setup run the pre-install
SQL scripts. Setup needs to know if you have changed the
default passwords that are specified in these script files.
Select from the following options:
•
I have not changed the default FileNet passwords specified
in the SQL scripts
•
I have changed the default FileNet passwords specified in
the SQL scripts
If you have changed the default passwords you will be prompted
to enter those passwords on a later screen.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
342
Task 23d: Install Process Engine (HP-UX)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Specify Passwords
Specify the passwords for the f_sw and f_maint users (or their
aliases).
NOTE This screen
appears after Specify
Administrative User and
Group Aliases if you
choose to define aliases.
For DB2 these are operating system users and the values here
must match the passwords already assigned to these users.
For Oracle these are database users. The passwords entered
here must match the passwords created when the Oracle
scripts were executed.
If default passwords were created when the scripts ran, leave
these fields blank.
Specify Administrative
User and Group Aliases
Indicate the alias you want to create for each of the following
users and groups.
NOTE This screen is
presented only if you
chose to configure
aliases.
•
FNADMIN OS group
•
FNUSR OS group
•
FNOP OS group
•
FNSW OS user
•
f_sw DB user
•
f_maint DB user
NOTE For Oracle databases, these are database users. For
DB2, these are operating system users.
If you ran SQL scripts for Oracle manually before starting
Process Engine Setup, the aliases here for f_sw and f_maint
must match the users specified as runtime and maintenance
users. For DB2 databases, these user names must match the
operating system names created when the database was
installed. See “Verify that DB2 Server Is Installed for IBM FileNet P8”
on page 114.
Specify Device File
Names
Enter the full pathname for the device files for the fn_SEC_DB0
and fn_SEC_RL0 volumes.
Choose an Application
Server
Select an application server and version from the drop-down
boxes.You must use the same application server type and
version as Content Engine.
Click Next.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
343
Task 23d: Install Process Engine (HP-UX)
To complete final Process Engine Setup screens
In this screen...
Perform this action...
Content Engine API
Configuration
Configure the Content Engine API, as follows:
•
Transport Method
Select WSI from the drop-down list.
•
Content Engine Client Software URL
Replace the sample server name and port number
(CEserver.example.com:7001) with the host name of the
Content Engine application server to which Process Engine
will connect. The port number depends on the application
server type. For example:
WebSphere
http://hqcemp2:9080/wsi/FNCEWS40DIME
WebLogic
http://hqcemp1:7001/wsi/FNCEWS40DIME
JBoss
http://hqcemp3:8080/wsi/FNCEWS40DIME
Do not modify the remainder of the string from the default
values.
NOTE To change the Content Engine server host name
later, or to connect to a different Content Engine server, edit
the WcmApiConfig.properties file. For information, see the
IBM FileNet P8 help topic FileNet P8 Administration >
Application Engine Administration > Key configuration files and
logs.
Click Next.
Please Read the
information below
Review the information on the installation process. Note that
you can check the progress of the installation in the /fnsw/local/
logs/wizard file. Click Next when you are ready to proceed.
Please Read the
Summary Information
Below
Verify your selections, and click Install to install Process
Engine.
xterm Window
Enter the SYS password for Oracle.
NOTE This window
displays if you chose to
run the SQL scripts in an
xterm window.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
344
Task 23d: Install Process Engine (HP-UX)
To install the Process Engine software silently
In this screen...
Perform this action...
Completing the Setup
wizard
Click Finish to complete the Process Engine installation and
then as prompted, log off and log back in as fnsw or the alias
you defined in “Accounts for Process Engine (UNIX)” on page 86.
5. Monitor /fnsw/local/logs/wizard to check the progress of the installation since Setup will run for
several minutes,and its progress, though displayed, might not visibly advance for an extended
period of time.
6. Check the following log files and correct any errors or failures indicated before proceeding to the
next step:
Log
Location
Process Engine logs
/fnsw/local/logs/PE (if the install completes
successfully)
or
/fnsw/tmp_installer (if the install has errors)
IS mini-installer logs
/fnsw/local/logs/wizard and other subdirectories
under /fnsw/local/logs
7. Log off as the root user and log on as fnsw (or the alias).
8. Proceed to “To reset administrative user passwords” on page 346.
To install the Process Engine software silently
Complete all procedures in this topic, up to “To install the Process Engine software interactively” on
page 337. Then take the following steps to silently install Process Engine .
1. Access the Process Engine installation software, and copy the contents to a local temporary
directory on the local disk.
2. Edit the PE_silent_input.txt file to reflect the appropriate responses for your installation. See
“Encrypt Passwords for Silent Installations and Upgrades” on page 666 for information on use of the
password encryption tool.
3. Save the edited response file to your temporary directory.
4. Log on as the root user in the Korn shell.
5. Navigate to the temporary directory on the local disk.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
345
Task 23d: Install Process Engine (HP-UX)
To reset administrative user passwords
6. Open a command prompt and execute:
P8PE-4.0.3-HPUX.bin -silent -options PE_silent_input.txt
or
P8PE-4.0.3-HPUXi.bin -silent -options PE_silent_input.txt
7. Proceed to “To reset administrative user passwords” on page 346.
To reset administrative user passwords
Process Engine Setup automatically creates several internally required local users. For Oracle
databases, if default users and passwords were configured, Process Engine Setup also creates
several database users. Because these users are created with default passwords, it is a best
practice to reset the passwords for these users. The following table lists the users created, the
level of system access each user has, and the tool used to change the password. See the IBM
FileNet Image Services documentation for instructions on using the referenced tools.
User Name
User Type
Description
How to modify
f_sw
Database (Oracle)
Has DBA privileges. Used
as the Process Engine runtime user.
Execute Xdbconnect.
See steps below.
f_maint
Database (Oracle)
Has DBA privileges. Used
for RDBMS maintenance.
Execute Xdbconnect.
See steps below.
SysAdmin
SEC (internal
Process Engine
security software)
Primary administrator user
for IBM FileNet software
tools.
Execute Xapex ->
Security Administration.
Log on as SysAdmin.
FieldService
SEC
Used internally by Process
Engine software.
Operator
SEC
Used internally by Process
Engine software.
To verify the connection to the Process Engine database
Verify the ability to connect to the Process Engine database using the run-time user name and
password.
At a command prompt, execute:
vwcemp -l
If the connection is successful, you will receive a message indicating that the Content Engine has
not been configured yet. Because there are no security settings configured, the above command
should return a message similar to “….no object service is configure….”
Unsuccessful connection to the database will return an exception.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
346
Task 23d: Install Process Engine (HP-UX)
To set the f_maint and f_sw passwords
If the connection is not successful, there could be a mismatch between the password entered for
the f_sw user in Process Engine Setup and the password created by execution of the SQL scripts
(Oracle) or for the operating system runtime user (DB2).
To determine if a failure to connect to the database is due to a password mismatch, use the steps
in “To set the f_maint and f_sw passwords” on page 347.
To set the f_maint and f_sw passwords
For added security, Process Engine stores an encrypted version of the passwords for the f_sw and
f_maint users, or their aliases, in a file called rdbup.bin. This is in addition to passwords for these
users in the Oracle or SQL Server database, or the DB2 operating system user’s password. The
encrypted password and the database or operating system user’s passwords must match.
To verify that the passwords match, use the following procedure to start the Xdbconnect utility.
Xdbconnect works only if the passwords in the encrypted file and the database match.
Use the following procedure to change the passwords for the f_maint and f_sw users after
installing the Process Engine software. For Oracle and SQL Server databases, both the encrypted
file and the database passwords will be updated. For DB2, only the encrypted file will be updated.
1. Start the Database Server Connect application by executing the following:
Xdbconnect -r
2. Log on as SysAdmin.
3. Change the primary password for the users f_sw and f_maint (or their alias) to match the
database password (Oracle and SQL Server) or operating system user’s password (DB2).
4. Exit the application.
To re-enable Oracle Password Complexity Verification
If, as directed earlier, you disabled the the Oracle Password Complexity Verification feature prior
to installing Process Engine, you can now re-enable it.
(Optional: Oracle databases only) To remove fnsw user from the Oracle database administrators
group
Process Engine Setup creates a user that is no longer required after installation is complete.
Remove the fnsw (or the alias) user from the <Oracle Database Administrators> group.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
347
Task 23d: Install Process Engine (HP-UX)
To restore any custom modifications for root and fnsw users.
To restore any custom modifications for root and fnsw users.
Process Engine Setup creates a new versions of a number of files. If the previous versions of
these files contained any custom settings, edit the new files for the fnsw and root users
accordingly. Saved files are in <.filename>.old.<nn>, where <nn> is a sequential number. The
latest saved version will be in the highest numbered file. The following files are modified by
Process Engine Setup:
.Xdefaults
.Xresources
.dbxinit
.dtprofile
.env
.login
.mwmrc
.xinitrc
.profile
.cshrc
To verify the /etc/services file settings
1. Log on as the root user and check the /etc/services file to verify the following parameters:
snmp
snmp-trap
tms
cor
nch
fn_trapd
161/udp snmpd
162/udp trapd
32768/tcp
32769/tcp
32770/udp
35225/udp
# Simple Network Management Protocol Agent
# Simple Network Management Protocol Traps
2. If necessary, add the parameters to the file and save the changes.
To clean up before starting Process Engine
1. Log on as fnsw.
2. Execute:
killfnsw -DAyS
3. Execute:
ipcs -a
4. Verify there is no entry with 0x464 pattern. If there are any entries with this pattern, use ipcrm to
remove them.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
348
Task 23d: Install Process Engine (HP-UX)
To edit the /etc/inittab file
To edit the /etc/inittab file
By default, the Process Engine software starts automatically when you restart the server and
needs its database started beforehand. If the database is not automatically started on server
restart, edit the /etc/inittab file on the Process Engine machine to comment out the autostart of
Process Engine.
For example, change:
rcfn:2:once:/etc/rc.initfnsw 2>&1 | alog -tboot > /dev/console 2>&1
to
#rcfn:2:once:/etc/rc.initfnsw 2>&1 | alog -tboot > /dev/console 2>&1
To edit the ims_start file
If the value for the maxdsiz kernel parameter is > 1GB, edit the ims_start file.
Change:
nohup /usr/ccs/lbin/dldd32 2>&1 >/dev/null
to
nohup /usr/ccs/lbin/dldd32 +a 0x70000000 2>&1 >/dev/null
Proceed to “Install Process Engine Software Updates” on page 350.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
349
Task 24: Install Process Engine Software Updates
To install the Process Engine software updates
Task 24: Install Process Engine Software Updates
Install any service packs, fix packs and/or interim fixes required for Process Engine.
To install the Process Engine software updates
1. To download the latest software updates, and to determine which of these updates may be
required for use with other components and expansion products, contact your service
representative.
2. Open the readmes for the following software updates and perform the installation procedures
provided:
a. Process Engine 4.0.2 Service Pack
b. Any subsequent fix pack (P8PE-4.0.2-001 or later)
c. Any subsequent interim fixes (typically optional)
Proceed to “Install the Latest Content Engine Client Files on Process Engine Servers” on page 351.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
350
Task 25: Install the Latest Content Engine Client Files on Process Engine Servers
To install the Content Engine client files
Task 25: Install the Latest Content Engine Client Files
on Process Engine Servers
Install any Content Engine client file updates that are available.
To install the Content Engine client files
1. To download the latest software updates, and to determine which of these updates may be
required for use with other components and expansion products, contact your service
representative.
2. Open the readme for the P8CE-4.0.0-002 (or later) Fix Pack and perform the installation
procedures provided to install the Content Engine Java Client files:
a. Content Engine 4.0.1 Client Updater
b. Any subsequent fix pack (P8CE-4.0.1-001 or later)
c. Any subsequent interim fixes (typically optional)
Proceed to “Configure Process Task Manager” on page 352.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
351
Task 26: Configure Process Task Manager
To start the Process Task manager and software on the Process Engine
Task 26: Configure Process Task Manager
Complete this task to start the Process Task Manager and set initial configuration parameters.
To start the Process Task manager and software on the Process Engine
1. Log onto Process Engine as a member of fnadmin or the alias you assigned during Process
Engine installation.
On a Windows machine, Process Engine Setup either automatically creates the fnadmin group
and the fnsw user, and adds the fnsw user to the fnadmin group or aliases for the user and
group were designated during Process Engine Setup.
On a UNIX machine, this user and group were manually created before running Process
Engine Setup.
2. Start the Process Task Manager, as follows:
Windows: Select Start > Programs > FileNet P8 Platform > Process Engine > Process Task
Manager.
UNIX: Enter vwtaskman at the command prompt. The terminal should support X Windows and
the DISPLAY environment variable should be set.
3. Right-click your Process Engine server in the feature pane.
4. If the Process Engine software is not already running, start it by choosing Start from the Action
menu.
5. Select the Process Engine in the feature pane and click the Security tab to configure the
Security settings.
Provide the service username defined in “To create other Process Engine accounts” on page 91.
See the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration >
Process Task Manager > Process Engine > Configure the Process Engine > Security for details on
the user and groups.
NOTE The service username should be entered as a short name.
Once complete, click Apply. If errors are returned, additional information is available in:
Windows: \fnsw_loc\logs\TM_daemon\PEDirectoryServerConnectionDebug.txt
UNIX: /fnsw/local/logs/TM_daemon/PEDirectoryServerConnectionDebug.txt
6. Click Yes to restart the Process Task Manager.
7. Right-click on the Regions folder, select New to create a new region.
8. Click the Security subtab to set a region password.
NOTE The password must match the password that is entered when creating a Process
Engine Region in “Create a Process Engine Isolated Region” on page 426.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
352
Task 26: Configure Process Task Manager
To verify connection to the Process Engine database
9. If you will be using region recovery, click the Regions tab and the General subtab to:
a. Enable region backups.
b. Identify the tablespaces or filegroups to be used by the region
10. Click Yes to restart the Process Task Manager.
11. Click the General tab and make sure the language settings as well as the rest are all correct.
Click Apply if any changes had been made.
On both the General and Advanced tabs, enter the appropriate value for each property. Most
properties do not have a default value because they are system specific; not entering values or
entering incorrect values will disrupt runtime activity. For property descriptions, see the IBM
FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > Process Task
Manager > Process Engine > Configure the Process Engine > Security.
12. After all parameters have been entered, click Apply and restart the Process Service when
prompted. Receiving the message to restart the Process Service serves as verification of
successful connection to the Content Engine.
To verify connection to the Process Engine database
Check the database connection from Process Engine by executing the following command. This
will also verify that security settings were saved to the database. Execute:
vwcemp –l
If there are no security settings configured, the above command should return a message similar
to “….no object service is configure….”
If the security settings were saved, the above command will return the information you entered in
the Process Engine Task Manager.
Proceed to “Complete Post-Install Process Engine Configuration (Windows Only)” on page 354.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
353
Task 27: Complete Post-Install Process Engine Configuration (Windows Only)
To configure contiguous free memory for Process Engine (Windows only)
Task 27: Complete Post-Install Process Engine
Configuration (Windows Only)
Use the procedure in this task to enable Process Engine to use the largest available contiguous
free memory area for shared memory allocations. If you fail to perform this procedure, the system
will not allocate shared memory at some point during normal execution and will cease to function
correctly.
In the following steps. you will use vwtool to get the address for the largest free memory block and
use that address to create a new registry key. You will then verify that address by running
ipc_tool.
To configure contiguous free memory for Process Engine (Windows only)
1. Start vwtool at a command prompt. Log on using the Service Username you provided when
completing the steps in “Configure Process Task Manager” on page 352.
2. Use the processmap command to find the largest contiguous free memory area, as in:
<vwtool:1>processmap
vwtool returns the following:
Process Id (CR=this vwtool process):
Press Return (CR) to get the process map for this process, as in the following example, where
the process ID is 2592:
C:\FNSW\BIN\vwtool.exe (ID:2592)
Address
=======
Attrib
======
00000000
00010000
00013000
00020000
Free
Private
Free
Private
Size
====
Owner
=====
65536
12288
53248
4096
…….(pages of memory addresses omitted here)
7FFDE000
7FFDF000
7FFE0000
Private
Private
Private
4096
4096
65536
C:\FNSW\BIN\vwtool.exe (ID:2592)
Largest FREE block found : 453873664 bytes at address 0x4B577000
Rounded up to a 64K boundary, free block address 0x4B580000
In this example, 0x4B580000 is the address you will need in the next step. In some cases you
might see only the line referencing the largest free block because the value is already at a 64K
boundary.
3. Start regedit from the Windows > Start > Run command and perform the following steps to
create a DWORD value for IS StartShmAddress, using the address noted in step 2.
a. Navigate to the following regedit key:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
354
Task 27: Complete Post-Install Process Engine Configuration (Windows Only)
To configure contiguous free memory for Process Engine (Windows only)
HKEY_Local_Machine\Software\FileNet\IMS\CurrentVersion\
b. Create a new DWORD value named:.
StartShmAddress
c. Enter or verify the following in the Edit DWORD Value Screen:
Value name = StartShmAddress
Value data = <address of largest free memory block>
From the example above the value will be 4B580000.
Base is hexadecimal.
d. Click OK.
e. Exit from regedit.
4. Restart the Process Engine software.
5. Verify the setting you just applied for the shared memory address by executing the following at a
command prompt:
ipc_tool -A
The following is an example of the information that is returned.
Image Services software shared memory segment limit: 129 segments
Current configured segment size: 0x01000000 bytes (16 MB)
Before allocating shared memory for Image Services, the SysV library
performs a test to determine the system shared memory limit. This test
can be used as a reference for performance tuning. The test results vary
depending on the amount of memory in use by other processes. The actual
amount of shared memory available during operation may be less. The test
results are:
Successfully attached to 27 segments
Successfully obtained 432 MB of shared memory
The following table displays the number of shared memory segments currently
in use by Image Services. Segment #0 (called the address manager) is small.
The other segment(s) contain the actual Image Services data. Note that
running ipc_tool will force the creation of segments #0 and #1 even when no
other Image Services process is up.
Shared Memory Address Manager Information
Address
Shm id
Creator
Enter <space> to continue, 'q' to quit:
0 0x4b580000
FNSHM_464d0000
Shared address manager
1 0x4c580000
FNSHM_464a0000
FileNet server software
Total Image Services shared memory allocated: 16 MB
(This does not include segment #0)
NOTE The First shared memory address above 0x4B580000 is the value you would check for
this example.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
355
Task 27: Complete Post-Install Process Engine Configuration (Windows Only)
To configure contiguous free memory for Process Engine (Windows only)
6. Exit ipc_tool. If the shared memory address is correct, proceed to the next installation task. If
the value is not correct, verify Step 1 - Step 4 above before proceeding.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
356
Task 28: Install Application Engine
Task 28: Install Application Engine
This topic includes Application Engine installation instructions for all supported application
servers, for UNIX and Windows platforms.
NOTES
•
If you plan to install and use the IBM FileNet Workplace XT product, installing Application
Engine is not required.
•
Before installing Application Engine, check the latest version of the IBM FileNet P8 4.0.x
Release Notes for known issues that might impact this software installation. To download this
guide from the IBM support page, see “Access IBM FileNet Documentation, Compatibility Matrices,
and Fix Packs” on page 23.
•
Before you install Application Engine, read the following topics in this guide:
–
“Installation Planning Considerations” on page 26
–
“Security Considerations” on page 27
Also, make sure your installation location meets the requirements specific for Application
Engine outlined in the IBM FileNet P8 Hardware and Software Requirements. To download
this guide from the IBM support page, see “Access IBM FileNet Documentation, Compatibility
Matrices, and Fix Packs” on page 23.
•
The installer creates the folder structure and files needed for Application Engine.
•
Switching from WAR file to EAR file deployment.
If you decide to deploy Application Engine as a WAR file and later decide to redeploy as an
EAR file you must uninstall Application Engine and then reinstall the application, selecting
EAR file deployment, to add the required files to your setup. If this change of deployment type
seems likely for your setup we suggest that you install Application Engine as if you would
deploy an EAR file, which will create both WAR and EAR files, and then use the WAR file to
deploy your web application.
•
After installing, you must configure and start Application Engine application. See “Configure
Application Engine.” on page 368.
•
(Highly Available installations) To install Application Engine in a web farm or clustered
environment, follow the instructions in theIBM FileNet P8 Platform High Availability Technical
Notice. The document outlines the required HA install procedure and references this guide for
detailed installation and deployment instructions. To download this guide from the IBM support
page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
To ensure proper functionality and performance only install one instance of Application Engine
per application server (or virtual machine or WebSphere LPAR). You can, however, deploy
multiple instances of a single Application Engine version per application server, see “Deploy
Multiple Application Engine Instances” on page 461.
•
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 “Create Object Stores” on page 286 for more
information.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
357
Task 28: Install Application Engine
To install the Application Engine software
•
•
You must have installed and configured a supported application server for Application Engine.
Refer to the appropriate topic for your server type:
•
“Configure an Application Server for Application Engine (WebSphere)” on page 151
•
“Configure an Application Server for Application Engine (WebLogic)” on page 152
•
“Configure an Application Server for Application Engine (JBoss)” on page 154
If you run the installer to upgrade Application Engine, the installer verifies that the currently
installed version of Application Engine can be upgraded. See “Upgrade Application Engine” on
page 577 for more information.
To install the Application Engine software
1. Log on to the application server:
UNIX - Log on as a user with write access to the /bin directory and read, write, and
execute access to the directory where you plan to install Application Engine.
Windows - Log on as a member of the local Administrators group or a user with equivalent
permissions.
2. Start the installation process.
•
•
To install Application Engine interactively:
i.
Access the IBM FileNet Application Engine 4.0.1 Service Pack installation software.
ii.
Launch the appropriate Setup program (P8AE-4.0.1-<operating_system>.bin/.exe) and
continue with Step 3 on page 359 below.
To install Application Engine silently:
i.
Access the IBM FileNet Application Engine 4.0.1 installation software package, and copy
the appropriate AE_silent_input.txt or AE_silent_input_UNIX.txt file to a local directory.
ii.
Follow the instructions in the silent input file to edit the file to reflect the appropriate
responses for your installation.
CAUTION If you are modifying the silent input file to perform an upgrade from AE 3.5.x
to AE 4.0.1 you must modify all instances of <AE_install_path> in the script as follows:
•
UNIX
Change ../FileNet/AE to ../FileNet
•
Windows
Change ..\FileNet\AE to ..\FileNet
Change . .\\Filenet\\AE to ..\\Filenet
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
358
Task 28: Install Application Engine
To install the Application Engine software
iii. From a command prompt, navigate to, and execute the installer, then continue with
Step 4 “(UNIX only) Log out and log in again to set the environment variables.” on page 367.
–
For UNIX:
./P8AE-4.0.1-<operating system>.bin -silent -options
<path_to_edited_input_file>/AE_silent_input_UNIX.txt
–
For Windows:
P8AE-4.0.1-Win.exe -silent -options
<path_to_edited_input_file>\AE_silent_input.txt
3. Complete the Setup screens as follows:
In this screen...
Perform this action...
License Agreement
Review and accept the license agreement.
NOTE This screen
appears only when you
use the installer to
perform a fresh install.
Specify Installation
Location
For the Directory Name field, enter or browse to the location
where you want to install the Application Engine software
<AE_install_path>, or accept the default location:
•
UNIX - /opt/FileNet/AE/
•
Windows - C:\Program Files\FileNet\AE\
The installation program installs the Application Engine
software in this directory.
NOTES
•
•
•
The installer will use the <AE_install_path> to place a
number of other files in default locations. See:
–
“Specify Configuration Directory” on page 364
–
“Logfile Location” on page 365.
–
“Configure User Token Security” on page 366
On an UPGRADE the default <AE_install_path> will be:
–
UNIX - /opt/FileNet/
–
Windows - C:\Program Files\FileNet\
If you select a custom install location it is recommended to
follow the same directory structure as seen in a typical
install and retain the /FileNet/AE part of the path.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
359
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Choose the Installation
Type
Select the installation type.
•
Select Typical to install these components:
–
•
Workplace web application
Select Custom to select the individual components to
install:
–
Workplace web application
–
Workplace Source Code (for custom application
development)
Select Components
Select the components you want to install.
NOTE This screen is
displayed only if you
selected Custom as the
installation type.
•
Web Application
•
Workplace Source Code
Verify Upgrade
The Setup program detects supported older versions of
Application Engine.
NOTE This screen
appears only when you
use the installer to
perform an upgrade.
Choose an Application
Server
If the installer reports that no supported version of Application
Engine exists on your server or if you don’t want to upgrade
your Application Engine at this time, click Cancel to exit Setup.
Select an application server and version from the drop-down
lists.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
360
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Content Engine API
Configuration
Configure the Content Engine API, as follows:
a. Transport Method
Select EJB (Enterprise Java Beans) from the drop down
list.
b. Content Engine Client Software URL:
Replace the sample server name and port number
(CEserver:2809) with the Content Engine server name
port number for your Content Engine server. For
information, see “IBM FileNet P8 Port Numbers” on
page 667.
NOTE To verify the correct port to use, navigate to the
ports section on the application server where Content
Engine is deployed and check the
BOOTSTRAP_ADDRESS port.
NOTE To change the Content Engine name later, or to
connect to a different Content Engine, edit the
WcmApiConfig.properties file. For information, see the
IBM FileNet P8 help topic FileNet P8 Administration >
Application Engine Administration > Key configuration files
and logs.
c. Content Engine Upload URL
Replace the sample server name and port number
(CEserver:2809) with the Content Engine server name
and port number to use when uploading document
content to the Content Engine server.
d. Content Engine Download URL
Replace the sample server name and port number
(CEserver:2809) with the Content Engine server name
and port number for your Content Engine server from
which to download document content.
Component Manager
URL
Enter the URL for the Component Manager on Application
Engine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
361
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Choose Workplace
Deployment Type
Select the type of deployment supported by your application
server.
•
Select Deploy as WAR file if your server can deploy a WAR
file.
•
Select Deploy as EAR file if your server can deploy an EAR
file. Enter an Application Name for the deployed application.
The default is Workplace.
NOTE If you decide to deploy Application Engine as a WAR file
and later decide to redeploy as an EAR file you must uninstall
Application Engine and then reinstall the application, selecting
EAR file deploymen. For information, see “Switching from WAR
file to EAR file deployment.” on page 357.
Choose Authentication
Method
Select the authentication method for use at your site.
•
Application-Managed Authentication uses authentication
specific to the application and does not share credentials.
•
Container-Managed Authentication provides the ability to
use single sign-on (SSO) capabilities to share credentials
between Application Engine and custom applications.
When you select Container-Managed Authentication, Setup
installs a sample log-in application, and modifies the
web.xml file to support SSO. You will need to perform
additional configuration for SSO after Setup is finished.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
362
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Specify Documentation
URL
For the documentation URL, enter the Documentation Server
URL, which is where the IBM FileNet P8 Platform
Documentation is installed, then click Next.
Your entry must be in the following format:
http://<docserver:port#>/<ecm_help>/
where:
docserver is the name of the Java application server.
port# is the port number.
ecm_help is the root folder of the documentation website. You
can use multi-part root folders (for example, /docs/ecm_help) if
your application server supports them.
See “Install IBM FileNet P8 Platform Documentation (WebSphere)”
on page 158, “Install IBM FileNet P8 Platform Documentation
(WebLogic)” on page 163, or “Install IBM FileNet P8 Platform
Documentation (JBoss)” on page 169 for more information.
NOTE For information on how to reconfigure the Documentation
URL after installation is completed, see the IBM FileNet P8 help
topic FileNet P8 Administration > Application Engine Administration
> Key configuration files and logs > Bootstrap properties.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
363
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Specify Configuration
Directory
Accept the default location or browse to the location where you
want to store the configuration files.
The default location for the configuration files is in a separate
Config/AE directory one level up from the <AE_install_path>
directory selected earlier.
Default location of the configuration directory:
•
UNIX - /opt/FileNet/Config/AE/
•
Windows - C:\Program Files\FileNet\Config\AE\
CAUTION A UNC admin share (for example, \\server\C$) for a
shared location is not supported. You can use an ordinary file
share.
NOTES
Specify Upload Location
•
If you select a custom install location it is recommended to
follow the same directory structure as seen in a typical
install and retain the /FileNet/Config/AE part of the path.
•
The configuration files for an EAR file deployment, a web
farm, or a clustered environment must be located in a
shared folder that is accesible by all copies of the
Workplace application. For more information, see the IBM
FileNet P8 Platform High Availability Technical Notice. To
download this guide from the IBM support page, see “Access
IBM FileNet Documentation, Compatibility Matrices, and Fix
Packs” on page 23.
Select the Upload Directory.
The Upload Directory is the directory used by Workplace to
store temporary copies of files uploaded to Workplace.
Accept the default option or browse for a directory to hold the
temporary upload files.
CAUTION A UNC admin share (for example, \\server\C$) for a
shared upload directory location is not supported. You can use
an ordinary file share.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
364
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Specify Download
Location
Select the Download Directory.
The Download Directory is the directory used by Workplace to
store temporary copies of files downloaded from Workplace.
Accept the default option or browse for a directory to hold the
temporary download files.
CAUTION A UNC admin share (for example, \\server\C$) for a
shared download directory is not supported. You can use an
ordinary file share.
Logfile Location
Select the Log files directory.
The Log files is the directory used by the installer to store the
app_engine_install_log_401.txt log file.
Accept the default option or browse for a directory.
The default location for the log files is in a separate Logs
directory one level up from the <AE_install_path> directory
selected earlier.
Default location of the logs directory:
•
UNIX - /opt/FileNet/Logs/
•
Windows - C:\Program Files\FileNet\Logs\
NOTE If you select a custom install location it is recommended
to follow the same directory structure as seen in a typical install
and retain the /FileNet/Logs part of the path.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
365
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Configure User Token
Security
Configure user token security.
a. If needed, select the check box to create maximum
strength (448-bit) keys.
By default Setup creates limited strength (128-bit) keys.
b. Enter the number of keys to use.
NOTE Security generally increases with the number of
keys used.
c. Make a note of the user token crypto key path.
The UTCryptoKeyFile.properties file contains the user
token cryptography key used by IBM FileNet P8
applications to launch into each other without the need
for additional login.
The default location for the User Token Crypto Key file is
in a separate Authentication directory one level up from
the <AE_install_path> directory selected earlier.
Default location of the Authentication directory:
•
UNIX - /opt/FileNet/Authentication/
•
Windows - C:\Program Files\FileNet\Authentication\
NOTE If you select a custom install location it is
recommended to follow the same directory structure as
seen in a typical install and retain the /FileNet/
Authentication part of the path.
CAUTION For multiple applications to pass user tokens to each
other, each participating application must use the same
encryption key file. Copy the UTCryptoKeyFile.properties file
installed with Application Engine to all servers that are hosting
a token-sharing application.
For information, see the IBM FileNet P8 Developer Help topic
Developer Help > Workplace Integration and Customization
Introduction > User Tokens > Configuring Applications to Use Tokens.
User Selections
Review the list of selections you have made.
NOTE More than one panel may be needed to display your
selections.
Please Read the
Summary Information
Below
Verify your selections, and click Install.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
366
Task 28: Install Application Engine
To install the Application Engine software
In this screen...
Perform this action...
Completing Application
Engine Setup
Click Finish to complete the installation.
4. (UNIX only) Log out and log in again to set the environment variables.
5. View the app_engine_install_log_4_0_1.txt file located, located in <AE_install_path>/Logs.
Verify that no errors or failures were logged. Correct any errors before you proceed.
6. (Solaris only) Set the anon ports.
To use the IBM FileNet ports listed below for Component Manager on Solaris-based systems,
you must first enable the ports by setting the smallest anon port to 32778. When you do this,
the ports used by Solaris communication deamons will be 32778 or greater, leaving port
32777 available for IBM FileNet use.
When Solaris first starts up, it takes the first several ports, called anonports, for its
communication daemons. By default, the maximum tcp_smallest_anon_port is 32768. IBM
FileNet uses several ports higher than 32768. See “IBM FileNet P8 Port Numbers” on page 667
for details on which ports IBM FileNet uses.
The Solaris platform provides several different tools, such as the netstat command, to
determine if a port is in use.
a. Determine the current tcp_smallest_anon_port setting.
From a command prompt, enter the following:
ndd -get /dev/tcp tcp_smallest_anon_port
b. Enable port 32777.
If the port returned in the step above is less than 32778, you must enable port 32777.
•
Solaris 9
Edit the /etc/rc2.d/S69inet file.
Add the following line before the exit 0 entry at the bottom of the file:
ndd -set /dev/tcp tcp_smallest_anon_port 32778
•
Solaris 10
Edit the /lib/svc/method/net-init file.
Add the following line before the exit 0 entry at the bottom of the file:
ndd -set /dev/tcp tcp_smallest_anon_port 32778
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
367
Task 28: Install Application Engine
To install the Application Engine software
c. Reboot the Application Engine server.
You must reboot the Application Engine server to force the release of ports required by the
Application Engine that may be in use by the operating system.
CAUTION Failure to reboot after these changes are made can result in the port being
unavailable, generating OpenSocket errors.
7. (UNIX only) Verify that the P8TASKMAN_HOME system environment variable is set to the
following:
P8TASKMAN_HOME=<AE_install_path>/CommonFiles
8. Configure Application Engine.
Follow the instructions for your application server to configure Application Engine:
•
Task 29a “Configure Application Engine (WebSphere)” on page 369
•
Task 29b “Configure Application Engine (WebLogic)” on page 388
•
Task 29c “Configure Application Engine (JBoss)” on page 396
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
368
Task 29a: Configure Application Engine (WebSphere)
To edit web.xml for container-managed authentication or SSO
Task 29a: Configure Application Engine (WebSphere)
This topic covers the configuration of your Application Engine web application (Workplace) on
WebSphere. Perform the following high-level steps in the order listed, using the referenced
detailed procedures for each step.
1. If you are using WebSphere with container-managed authentication or SSO, edit web.xml. See
“To edit web.xml for container-managed authentication or SSO” on page 369.
2. If you are using SSO, edit web.xml. See “(SSO Only) To edit web.xml for SSO (optional)” on
page 372.
3. Configure the Application Engine. See “To configure Application Engine (WebSphere 5.1.x)” on
page 374 or “To configure Application Engine (WebSphere 6.1)” on page 382.
4. Configure the server ports. See “To configure the server ports” on page 386.
To edit web.xml for container-managed authentication or SSO
NOTE Perform this procedure only if your site uses WebSphere with container-managed
authentication or Single Sign-On (SSO). If you are using SSO, you must perform additional
configuration steps as directed at the end of this procedure.
1. Make a back-up copy of web.xml.
<AE_install_path>/Workplace/WEB-INF/web.xml
2. Edit web.xml.
NOTE Text in bold in the examples below indicates changes made to the original web.xml file.
a. Search for the parameter challengeProxyEnabled and set it to false.
<param-name>challengeProxyEnabled</param-name>
<param-value>false</param-value>
b. Search for the first instance of <web-resource-collection>, and uncomment the url-pattern
as noted in the file comments below.
<web-resource-collection>
<web-resource-name>action</web-resource-name>
<description>Define the container 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-resourcecollection> 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>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
369
Task 29a: Configure Application Engine (WebSphere)
To edit web.xml for container-managed authentication or SSO
<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>/portlets/Author/edit.jsp</url-pattern>
<url-pattern>/portlets/Author/portlet.jsp</url-pattern>
<url-pattern>/portlets/Browse/edit.jsp</url-pattern>
<url-pattern>/portlets/Browse/portlet.jsp</url-pattern>
<url-pattern>/portlets/ExternalUrl/edit.jsp</url-pattern>
<url-pattern>/portlets/ExternalUrl/portlet.jsp</url-pattern>
<url-pattern>/portlets/GroupPageDesign.jsp</url-pattern>
<url-pattern>/portlets/GroupPageSettings.jsp</url-pattern>
<url-pattern>/portlets/Inbox/edit.jsp</url-pattern>
<url-pattern>/portlets/Inbox/portlet.jsp</url-pattern>
<url-pattern>/portlets/MultiPagesDesign.jsp</url-pattern>
<url-pattern>/portlets/OrganizePages.jsp</url-pattern>
<url-pattern>/portlets/PortalPageDesign.jsp</url-pattern>
<url-pattern>/portlets/PortalPageInfo.jsp</url-pattern>
<url-pattern>/portlets/PortletAlias.jsp</url-pattern>
<url-pattern>/portlets/PortletSettings.jsp</url-pattern>
<url-pattern>/portlets/PreviewAndSetup.jsp</url-pattern>
<url-pattern>/portlets/PublicQueue/edit.jsp</url-pattern>
<url-pattern>/portlets/PublicQueue/portlet.jsp</url-pattern>
<url-pattern>/portlets/QuickSearch/edit.jsp</url-pattern>
<url-pattern>/portlets/QuickSearch/portlet.jsp</url-pattern>
<url-pattern>/portlets/Workflows/edit.jsp</url-pattern>
<url-pattern>/portlets/Workflows/portlet.jsp</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>/WcmPortletHelp.jsp</url-pattern>
<url-pattern>/WcmPortletSearch.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>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
370
Task 29a: Configure Application Engine (WebSphere)
To edit web.xml for container-managed authentication or SSO
<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>
c. Locate the section <auth-constraint>, comment the wild-card (*) role-name as noted in the
file comments below.
<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>
d. Locate the end of the </login-config> element, and add the All Authenticated users roleelement after the closing tag.
<security-role>
<description>All Authenticated</description>
<role-name>All Authenticated</role-name>
</security-role>
e. At the end of web.xml, comment out the <login-config> element, as follows:
<!-<login-config>
<auth-method>FORM</auth-method>
<realm-name>AE Workplace</realm-name>
<form-login-config>
<form-login-page>/ContainerLogin.jsp</form-login-page>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
371
Task 29a: Configure Application Engine (WebSphere)
(SSO Only) To edit web.xml for SSO (optional)
<form-error-page>/ContainerError.jsp</form-error-page>
</form-login-config>
</login-config>
-->
f.
Search for the first instance of a <security-constraint> tag, and add the following <securityconstraint> tag before that tag.
CAUTION 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>
3. Save your changes to web.xml and close the file.
4. If your site uses SSO, Continue on with “(SSO Only) To edit web.xml for SSO (optional)” on
page 372, otherwise continue with “To configure Application Engine (WebSphere 5.1.x)” on page 374
or “To configure Application Engine (WebSphere 6.1)” on page 382.
(SSO Only) To edit web.xml for SSO (optional)
NOTE Perform this procedure only if your site uses SSO with a proxy server. You must use this
procedure to modify web.xml to enable SSO.
1. Edit web.xml.
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.
The default settings are (in bold below):
<init-param>
<param-name>ssoProxyContextPath</param-name>
<param-value></param-value>
</init-param>
<init-param>
<param-name>ssoProxyHost</param-name>
<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>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
372
Task 29a: Configure Application Engine (WebSphere)
(SSO Only) To edit web.xml for SSO (optional)
In general, the init parameters above 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 deploy 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:
<param-name>ssoProxyContextPath</param-name>
<param-value>/fn/Workplace</param-value>
•
ssoProxyHost: Set the value to the SSO proxy host server name. Typically, this will be a full
domain-qualified hostname.
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:
<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 and/or used to
access Workplace pages.
For example:
<param-name>ssoProxySSLPort</param-name>
<param-value>443</param-value>
2. Save your changes to web.xml and close the file.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
373
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 5.1.x)
To configure Application Engine (WebSphere 5.1.x)
1. Open the WebSphere administrative console.
2. Set the JVM settings for JAAS login configuration, memory settings, and UTF-8 encoding.
a. Expand Servers.
b. Click Application Servers.
c. Click <server name>.
d. Under “Additional Properties,” select Process Definition, and then select Java Virtual
Machine.
e. Set the JAAS login entry in the JVM generic argument field to one of the following (do not
enter the linebreaks):
New Install
-Djava.security.auth.login.config=<AE_install_path>\CE_API\config
\jaas.conf.WebSphere
Upgrade
-Djava.security.auth.login.config=<AE_install_path>\CE_API\config
\jaas.conf.WebSphere
CAUTION (Windows only) On WebSphere/Windows the path cannot contain a space. You
must use 8.3-notation for the install path information.
If <AE_install_path> is:
C:\Program Files\FileNet\AE
use:
C:\Progra~1\FileNet\AE
f.
Set the Initial and Maximum Heap Size.
Refer to your application server vendor's recommendation for Initial and Maximum heap
size values. For IBM specific recommendations, see the IBM FileNet P8 Platform
Performance Tuning Guide. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
g. Click Apply to save your changes.
h. Click Custom Properties.
i.
Click New.
j.
In the Name field, enter
client.encoding.override
k. In the Value field, enter
UTF-8
l.
Click Apply, click Save, and then click Save Changes to the Master Configuration.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
374
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 5.1.x)
3. (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.
Perform the following steps on both the Content Engine profile and the Application Engine
profile:
a. Expand Servers.
b. Click Application Servers.
c. Click <server name>.
d. Under “Additional Properties,” select Process Definition, and then select Java Virtual
Machine.
e. Click Custom Properties.
f.
Click New.
g. In the Name field, enter
com.ibm.websphere.orb.uniqueServerName
h. In the Value field, enter
true
i.
Click Apply, click Save, and then click Save Changes to the Master Configuration.
j.
Restart WebSphere.
4. Enable Application Integration Installation.
a. From the Administrative Console, expand Environment. Click Virtual Hosts.
b. Click the default_host (or the host your application is deployed under).
c. Click MIME Types, then click New.
d. In the MIME Type field, enter application/octet-stream.
e. In the Extension(s) field, enter exe. Click OK.
f.
Click Apply, Save, then Save changes to the Master Configuration.
5. Configure Light weight Third Party Authentication (LTPA).
NOTE Skip this step if your Application Engine and Content Engine are located on the same
WebSphere application server profile.
NOTE If you are already using LTPA with your Content Engine application server, you only
need to export the existing keys per Step vii thru Step ix below.
a. On the Content Engine server, do the following:
i.
Log in to the WebSphere adminstrative console.
ii.
From the administrative console, Navigate to Security > Authentication Mechanisms >
LTPA.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
375
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 5.1.x)
iii. Enter a password to create the <LTPA password>.
NOTE For password restrictions, see the WebSphere documentation. If you have
already configured Content Engine for LTPA, use the existing password in the
Application Engine configuration below.
iv. Enter a path for the Key File Name.
For example, C:\LTPA\<ltpa_key_name>.
v.
Click Generate Keys.
vi. Click Save, and then click Save changes to the Master Configuration.
vii. Navigate to Security > Authentication Mechanisms > LTPA.
viii. Click Export Keys.
ix. Copy the key file.
Copy the file from the location you specified above to a directory on the Application
Engine server. On Windows, for example, C:\LTPA\<ltpa_key_name>.
x. Navigate to Security > Global Security.
xi. From the Active Authentication Mechanism drop down list, select LTPA (Light weight
Third Party Authentication).
xii. From the Active User Registry drop down list, select LDAP.
xiii. Click Apply, and then click Save changes to the Master Configuration.
xiv. Stop and restart WebSphere.
b. On the Application Engine server,do the following:
i.
Log in to the WebSphere adminstrative console.
ii.
Navigate to Security > Authentication Mechanisms > LTPA.
iii. Enter a value for the timeout that is larger than the default.
For example, if the timeout value is set to 2 hours, the LTPA key expires and end users
will not be able to log in to Workplace after having been logged in for 2 hours.
iv. Enter the <LTPA password> you created for Content Engine above.
v.
Enter the path for the key file that you copied to the Application Engine server. For
example, C:\LTPA\<ltpa_key_name>.
vi. Click Import Keys.
vii. Navigate to Security > User Registries > LDAP.
viii. Configure the LDAP provider to exactly match the settings from the Content Engine
server.
•
Server User ID
•
Server User Password
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
376
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 5.1.x)
•
Type
•
Host
•
Port
•
Base distinguished name (DN)
•
Bind distinguished name (DN)
•
Bind password
ix. Click Apply.
x. Click Advanced LDAP Settings.
xi. Configure the settings here to exactly match the settings from the Content Engine
server. For example, Group Filter and Group ID Map must match the Content Engine
settings.
•
User filter
•
Group Filter
•
User ID map
•
Group member ID map
•
Certificate map mode
•
Certificate filter
xii. Navigate to Security > Global Security.
xiii. Select (select) Enabled flag.
xiv. Turn off (deselect) Enforce Java 2 Security.
NOTE IBM FileNet P8 platform utilizes LDAP-based security, and does not support
Java 2 security. Enforcing Java 2 security will cause unexpected behavior.
xv. From the Active Authentication Mechanism drop down list, select LTPA (Light weight
Third Party Authentication).
xvi. From the Active User Registry drop down list, select LDAP.
xvii.Click Apply, and then click Save changes to the Master Configuration.
6. Stop and restart WebSphere.
7. Set permissions for the user running the application server.
If the local user that will be running the application server is different from the user that
installed Application Engine, you must give the user read/write permissions on the following
(default) folders:
<WAS_HOME>/profiles/default/installedApps/<node_name>/app_engine_war.ear/
app_engine.war
<AE_install_path>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
377
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.0)
8. Continue with “To configure the server ports” on page 386.
To configure Application Engine (WebSphere 6.0)
1. Open the WebSphere administrative console.
2. Set JVM settings for JAAS login configuration, memory settings, and UTF-8 encoding.
a. Expand Servers.
b. Click Application Servers.
c. Click <server name>.
d. Under “Server Infrastructure”, select Java & Process Management.
e. Select Process Definition, and then select Java Virtual Machine.
f.
Set the JAAS login entry in the JVM generic argument field to one of the following (do not
enter the linebreaks):
-Djava.security.auth.login.config=<ae_install_path>\CE_API\config
\jaas.conf.WebSphere
CAUTION (Windows only) On WebSphere/Windows the path cannot contain a space. You
must use 8.3-notation for the install path information.
If <AE_install_path> is:
C:\Program Files\FileNet\AE
use:
C:\Progra~1\FileNet\AE
g. Set the Initial and Maximum Heap Size.
Refer to your application server vendor's recommendation for Initial and Maximum heap
size values. For IBM specific recommendations, see the IBM FileNet P8 Platform
Performance Tuning Guide. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
h. Click Apply.
i.
Click Custom Properties.
j.
Click New.
k. Verify that the Name field is set to:
client.encoding.override
l.
Verify that the Value field is set to:
UTF-8
m. Click Apply, click Save, and then click Save Changes to the Master Configuration.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
378
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.0)
3. (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.
Perform the following steps on both the Content Engine profile and the Application Engine
profile:
a. Expand Servers.
b. Click Application Servers.
c. Click <server name>.
d. Under “Server Infrastructure”, select Java & Process Management.
e. Select Process Definition, and then select Java Virtual Machine.
f.
Click Custom Properties.
g. Click New.
h. In the Name field, enter
com.ibm.websphere.orb.uniqueServerName
i.
In the Value field, enter
true
j.
Click Apply, click Save, and then click Save Changes to the Master Configuration.
k. Restart WebSphere.
4. Verify Application Integration.
a. From the Administrative Console, expand Environment. Click Virtual Hosts.
b. Click the default_host (or the host your application is deployed under).
c. Click MIME Types.
d. Verify that MIME type is set to application/octet-stream or use the following steps to set it.
i.
Click New.
ii.
In the MIME Type field, enter application/octet-stream.
iii. In the Extension(s) field, enter exe. Click OK.
iv. Click Apply, click Save, and then Save changes to the Master Configuration.
5. Configure Light weight Third Party Authentication (LTPA).
NOTE Skip this step if your Application Engine and Content Engine are located on the same
WebSphere application server profile.
a. On the Content Engine server, do the following:
NOTE If you are already using LTPA with your Content Engine application server, you only
need to export the existing keys per Step viii thru Step viii below.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
379
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.0)
i.
Log in to the Adminstrative Console.
ii.
Navigate to Security > Global Security.
iii. From the right side of the panel, select Authentication > Authentication Mechanisms >
LTPA.
iv. Enter a password to create the <LTPA password>.
NOTE For password restrictions, see the WebSphere documentation. If you have
already configured Content Engine for LTPA, use the existing password in the
Application Engine configuration below.
v.
Enter a path for the Key File Name. For example, C:\LTPA\<ltpa_key_name>.
vi. Click Generate Keys.
vii. Click Save, and then click Save changes to the Master Configuration.
viii. Navigate to Security > Global Security.
ix. From the right side of the panel, select Authentication > Authentication Mechanisms >
LTPA.
x. Click Export Keys.
xi. Copy the key file.
Copy the file from the location you specified above to a directory on the Application
Engine server. On Windows, for example, C:\LTPA\<ltpa_key_name>.
xii. Navigate to Security > Global Security.
xiii. From the Active Authentication Mechanism drop down list, select LTPA (Light weight
Third Party Authentication).
xiv. From the Active User Registry drop down list, select LDAP.
xv. Click Apply, and then click Save changes to the Master Configuration.
xvi. Stop and restart WebSphere.
b. On the Application Engine server, do the following:
i.
Log in to the Adminstrative Console.
ii.
Navigate to Security > Global Security.
iii. From the right side of the panel, select Authentication > Authentication Mechanisms >
LTPA.
iv. Enter a value for the timeout that is larger than the default.
For example, if the timeout value is set to 2 hours, the LTPA key expires and end users
will not be able to log in to Workplace after having been logged in for 2 hours.
v.
Enter the <LTPA password> you created for Content Engine above.
vi. Enter the path for the key file that you copied to the Application Engine server. For
example, C:\LTPA\<ltpa_key_name>.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
380
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.0)
vii. Click Import Keys.
viii. Navigate to Security > Global Security.
ix. From the right side of the panel, select LDAP User Registry.
x. Configure the LDAP provider to exactly match the corresponding settings on the
Content Engine application server.
•
Server User ID
•
Server User Password
•
Type
•
Host
•
Port
•
Base distinguished name (DN)
•
Bind distinguished name (DN)
•
Bind password
xi. Click Apply.
xii. Click Advanced Lightweight Directory Access Protocol (LDAP) user registry settings.
xiii. Configure the settings here to exactly match the corresponding settings from the
Content Engine application server.
•
User filter
•
Group Filter
•
User ID map
•
Group member ID map
•
Certificate map mode
•
Certificate filter
xiv. Navigate to Security > Global Security.
xv. Turn on (check) Enabled flag.
xvi. Turn off (uncheck) Enforce Java 2 Security.
NOTE The IBM FileNet P8 Platform utilizes LDAP-based security, and does not
support Java 2 security. Enabling Java 2 security will cause unexpected behavior.
xvii.From the Active Authentication Mechanism drop down list, select LTPA (Light weight
Third Party Authentication).
xviii.From the Active User Registry drop down list, select LDAP.
xix. Click Apply, and then click Save changes to the Master Configuration.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
381
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.1)
6. Set permissions for the user running the application server.
The user that will be running the application server must have read/write permissions on the
following (default) folders:
<WAS_HOME>/profiles/default/installedApps/<node_name>/app_engine_war.ear/
app_engine.war
<AE_install_path>
7. Continue with “To configure the server ports” on page 386.
To configure Application Engine (WebSphere 6.1)
1. Open the WebSphere administrative console.
2. Set JVM settings for JAAS login configuration, memory settings, and UTF-8 encoding.
a. Expand Servers.
b. Click Application Servers.
c. Click <server name>.
d. Under “Server Infrastructure”, select Java & Process Management.
e. Select Process Definition, and then select Java Virtual Machine.
f.
Set the JAAS login entry in the JVM generic argument field to one of the following (do not
enter the linebreaks):
-Djava.security.auth.login.config=<ae_install_path>\CE_API\config
\jaas.conf.WebSphere
CAUTION (Windows only) On WebSphere/Windows the path cannot contain a space. You
must use 8.3-notation for the install path information.
If <AE_install_path> is:
C:\Program Files\FileNet\AE
use:
C:\Progra~1\FileNet\AE
g. Set the Initial and Maximum Heap Size.
Refer to your application server vendor's recommendation for Initial and Maximum heap
size values. For IBM specific recommendations, see the IBM FileNet P8 Platform
Performance Tuning Guide. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
h. Click Apply.
i.
Click Custom Properties.
j.
Click New.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
382
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.1)
k. Verify that the Name field is set to:
client.encoding.override
l.
Verify that the Value field is set to:
UTF-8
m. Click Apply, click Save, and then click Save Changes to the Master Configuration.
3. (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.
Perform the following steps on both the Content Engine profile and the Application Engine
profile:
a. Expand Servers.
b. Click Application Servers.
c. Click <server name>.
d. Under “Server Infrastructure”, select Java & Process Management.
e. Select Process Definition, and then select Java Virtual Machine.
f.
Click Custom Properties.
g. Click New.
h. In the Name field, enter
com.ibm.websphere.orb.uniqueServerName
i.
In the Value field, enter
true
j.
Click Apply, click Save, and then click Save Changes to the Master Configuration.
k. Restart WebSphere.
4. Verify Application Integration.
a. From the Administrative Console, expand Environment. Click Virtual Hosts.
b. Click the default_host (or the host your application is deployed under).
c. Click MIME Types.
d. Verify that MIME type is set to application/octet-stream or use the following steps to set it.
i.
Click New.
ii.
In the MIME Type field, enter application/octet-stream.
iii. In the Extension(s) field, enter exe. Click OK.
iv. Click Apply, click Save, and then Save changes to the Master Configuration.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
383
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.1)
5. Configure Light weight Third Party Authentication (LTPA).
NOTE Skip this step if your Application Engine and Content Engine are located on the same
WebSphere application server profile.
a. On the Content Engine server, do the following:
NOTE If you are already using LTPA with your Content Engine application server, you only
need to export the existing keys per Step vi thru Step viii below.
i.
Log in to the Adminstrative Console.
ii.
Navigate to Security > Secure administration, applications, and infrastructure.
iii. From the right side of the panel, select Authentication Mechanisms and expiration.
iv. In the box titled "Cross-cell single sign-on, enter a password to create the <LTPA
password>.
NOTE For password restrictions, see the WebSphere documentation. If you have
already configured Content Engine for LTPA, use the existing password in the AE
configuration below.
v.
Enter a path for the Key File Name. For example, C:\LTPA\<ltpa_key_name>.
vi. Click Export Keys. Verify that the following message is displayed: The keys were
successfully exported to the file <file name>.
vii. Click OK, and then click Save changes to the Master Configuration.
viii. Copy the key file.
Copy the file from the location you specified above to a directory on the Application
Engine server. On Windows, for example, C:\LTPA\<ltpa_key_name>.
ix. Stop and restart WebSphere.
b. On the Application Engine server, do the following:
i.
Log in to the Adminstrative Console.
ii.
Navigate to Security > Secure administration, applications, and infrastructure.
iii. From the right side of the panel, select Authentication Mechanisms and expiration.
iv. Enter a value for the timeout that is larger than the default.
For example, if the timeout value is set to 2 hours, the LTPA key expires and end users
will not be able to log in to Workplace after having been logged in for 2 hours.
v.
In the box titled cross-cell single sign-on, enter the <LTPA password> you created for
Content Engine above. Confirm the password.
vi. Enter the path for the key file that you copied to the Application Engine server. For
example, C:\LTPA\<ltpa_key_name>.
vii. Click Import Keys. Verify that the following message is displayed:The keys were
successfully imported from the file <file name>.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
384
Task 29a: Configure Application Engine (WebSphere)
To configure Application Engine (WebSphere 6.1)
viii. Navigate to Security > Secure administration, applications, and infrastructure.
ix. Turn on (check) Enable Administrative Security flag.
x. Turn on (check) Enable application security flag.
xi. Turn off (uncheck) Java 2 Security.
NOTE The IBM FileNet P8 Platform utilizes LDAP-based security, and does not
support Java 2 security. Enabling Java 2 security will cause unexpected behavior.
xii. From the Active Authentication Mechanism drop down list, select LTPA (Light weight
Third Party Authentication).
xiii. From the bottom of the panel, in the box titled "available realm definitions," select
Standalone LDAP registry and click Configure.
xiv. Configure the LDAP provider to exactly match the corresponding settings on the
Content Engine application server.
•
Primary administrative user name
Select “Automatically generated server identity."
•
Type
•
Host
•
Port
•
Base distinguished name (DN)
•
Bind distinguished name (DN)
•
Bind password
xv. Click Apply.
xvi. Click Advanced Lightweight Directory Access Protocol (LDAP) user registry settings.
xvii.Configure the settings here to exactly match the corresponding settings from the
Content Engine application server.
•
User filter
•
Group Filter
•
User ID map
•
Group member ID map
•
Certificate map mode
•
Certificate filter
xviii.Save these settings
xix. Click Test 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
385
Task 29a: Configure Application Engine (WebSphere)
To configure the server ports
xx. Next to "Available realm definitions," make sure "Standalone LDAP registry" is still
selected, and click Set as current.
xxi. Click Save.
6. Set permissions for the user running the application server.
The user that will be running the application server must have read/write permissions on the
following (default) folders:
<WAS_HOME>/profiles/default/installedApps/<node_name>/app_engine_war.ear/
app_engine.war
<AE_install_path>
7. Continue with “To configure the server ports” on page 386.
To configure the server ports
This configuration is required for WebSphere 5.x and recommended for WebSphere 6.x.
1. Stop the WebSphere server.
2. Make a backup copy of serverindex.xml located in:
•
WebSphere 5.x
<WAS_HOME>\profiles\default\config\cells\<machine_name>Node01Cell\nodes\
<machine_name>Node01\
•
WebSphere 6.x
<WAS_HOME>\profiles\default\config\cells\<machine_name>Node01Cell\nodes\
<machine_name>Node01\
3. Edit serverindex.xml.
Locate the <specialEndpoints> section, and change the port numbers for the three SSL
listener addresses to “0” as shown below:
<specialEndpoints xmi:id="NamedEndPoint_1155689929072"
endPointName="SAS_SSL_SERVERAUTH_LISTENER_ADDRESS">
<endPoint xmi:id="EndPoint_1155689929072" host="host_name" port="0"/>
</specialEndpoints>
<specialEndpoints xmi:id="NamedEndPoint_1155689929073"
endPointName="CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS">
<endPoint xmi:id="EndPoint_1155689929073" host="host_name" port="0"/>
</specialEndpoints>
<specialEndpoints xmi:id="NamedEndPoint_1155689929074"
endPointName="CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS">
<endPoint xmi:id="EndPoint_1155689929074" host="host_name" port="0"/>
</specialEndpoints>
4. Save and close the serverindex.xml file.
5. Restart WebSphere.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
386
Task 29a: Configure Application Engine (WebSphere)
To configure the server ports
6. Continue with the following task:
•
If you are performing a fresh install:
Do Task 30 “Install Application Engine Software Updates” on page 398.
•
If you are performing an upgrade:
Do “Manually copy custom data.” on page 581.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
387
Task 29b: Configure Application Engine (WebLogic)
To edit web.xml for SSO (optional)
Task 29b: Configure Application Engine (WebLogic)
This topic covers the configuration of your Application Engine application (Workplace) on
WebLogic. Perform the following high-level steps in the order listed, using the referenced detailed
procedures for each step.
1. If you are using SSO, edit web.xml. See “To edit web.xml for SSO (optional)” on page 388.
2. Modify the application server startup script. See “To modify the application server startup script” on
page 389.
3. Configure Application Engine. See “To configure Application Engine (WebLogic 8.1.x)” on page 391
or “To configure Application Engine (WebLogic 9.2)” on page 393.
4. Modify config.xml to support passing user credentials to clients such as Application Integration
and WebDAV. See “To enable passing user credentials to client applications” on page 394.
To edit web.xml for SSO (optional)
NOTE Perform this procedure only if your site uses SSO with a proxy server. You must modify
web.xml to enable SSO.
1. Make a backup copy of web.xml.
<AE_install_path>/Workplace/WEB-INF/web.xml
2. Edit web.xml.
a. Set the parameter perimeterChallengeMode to true, as in:
<init-param>
<param-name>perimeterChallengeMode</param-name>
<param-value>true</param-value>
</init-param>
b. 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, then you must set the corresponding sso* parameter for that element in the URL
to the value for the SSO proxy host.
The default settings are (in bold):
<init-param>
<param-name>ssoProxyContextPath</param-name>
<param-value></param-value>
</init-param>
<init-param>
<param-name>ssoProxyHost</param-name>
<param-value></param-value>
</init-param>
<init-param>
<param-name>ssoProxyPort</param-name>
<param-value></param-value>
</init-param>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
388
Task 29b: Configure Application Engine (WebLogic)
To modify the application server startup script
<init-param>
<param-name>ssoProxySSLPort</param-name>
<param-value></param-value>
</init-param>
In general, the init parameters above should 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 deploy 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:
<param-name>ssoProxyContextPath</param-name>
<param-value>/fn/Workplace</param-value>
•
ssoProxyHost: Set the value to the SSO proxy host server name. Typically, this will be
a full domain-qualified hostname.
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:
<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
and/or used to access Workplace pages.
For example:
<param-name>ssoProxySSLPort</param-name>
ram-value>443</param-value>
3. Save your changes to web.xml and close the file.
To modify the application server startup script
1. Stop the WebLogic application server if running.
2. Make a backup copy of the application server startup script.
Backup startWebLogic.cmd for Windows or startWebLogic.sh for UNIX.
NOTE If you are not using a WebLogic domain, backup startWLS.cmd for Windows or
startWLS.sh for UNIX.
3. Edit the application server startup script.
a. Configure JAAS login.
Add one of the following right after the classpath entry for WebLogic.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
389
Task 29b: Configure Application Engine (WebLogic)
To modify the application server startup script
CAUTION The set jaas_login entry should be entered as a single line without line breaks.
•
Windows
@REM Jaas Login configuration setting
set jaas_login=%jaas_login% -Djava.security.auth.login.config=
”<AE_install_path>\CE_API\config\jaas.conf.WebLogic”
•
UNIX
# Jaas Login configuration setting
jaas_login=”${jaas_login} -Djava.security.auth.login.config=
”<AE_install_path>/CE_API/config/jaas.conf.WebLogic”
•
AIX
# Jaas Login configuration setting
jaas_login=”${jaas_login} -Djava.security.auth.login.config=
”<AE_install_path>/CE_API/config/jaas.conf.WebLogic”
jaas_login="${jaas_login} Dlogin.configuration.provider=com.ibm.security.auth.login.ConfigFile
b. Add %jaas_login% section as indicated in the examples below in bold.
•
WebLogic 8 - Windows - after the CLASSPATH settings
echo
echo
echo
echo
echo
echo
echo
echo
echo
echo
echo
.
CLASSPATH=%CLASSPATH%
.
PATH=%PATH%
.
***************************************************
* To start WebLogic Server, use a username and *
* password assigned to an admin-level user. For *
* server administration, use the WebLogic Server *
* console at http:\[hostname]:[port]\console *
***************************************************
%JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %jaas_login% Dweblogic.Name=%SERVER_NAME% -Dweblogic.management.username=%WLS_USER% Dweblogic.management.password=%WLS_PW% Dweblogic.ProductionModeEnabled=%PRODUCTION_MODE% Djava.security.policy="%WL_HOME%\server\lib\weblogic.policy" weblogic.Server
•
WebLogic 8 - UNIX - after the CLASSPATH settings
# JAAS login config file
JAAS_LOGIN="${JAAS_LOGIN} -Djava.security.auth.login.config=/opt/FileNet/AE/
CE_API/config/jaas.conf.weblogic"
# Call WebLogic Server
echo "."
echo "CLASSPATH=${CLASSPATH}"
echo "."
echo "PATH=${PATH}"
echo "."
echo "***************************************************"
echo "* To start WebLogic Server, use a username and
*"
echo "* password assigned to an admin-level user. For *"
echo "* server administration, use the WebLogic Server *"
echo "* console at http://[hostname]:[port]/console
*"
echo "***************************************************"
${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS} ${JAAS_LOGIN} Dweblogic.Name=${SERVER_NAME} -
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
390
Task 29b: Configure Application Engine (WebLogic)
To configure Application Engine (WebLogic 8.1.x)
Dweblogic.ProductionModeEnabled=${PRODUCTION_MODE} Djava.security.policy="${WL_HOME}/server/lib/weblogic.policy" weblogic.Server
•
WebLogic 9 - Windows - in the WLS_REDIRECT_LOG settings
If “%WLS_REDIRECT_LOG%”==””(
echo Starting WLS with line:
echo %JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %jaas_login%
-Dweblogic.Name=%SERVER_NAME% Djava.security.policy=%WL_HOME%\server\lib\weblogic.policy %PROXY_SETTINGS%
%SERVER_CLASS%
%JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %jaas_login% Dweblogic.Name=%SERVER_NAME% -Dweblogic.management.username=%WLS_USER% Dweblogic.management.password=%WLS_PW% Djava.security.policy=%WL_HOME%\server\lib\weblogic.policy %PROXY_SETTINGS%
%SERVER_CLASS%
) else (
echo Redirecting output from WLS window to %WLS_REDIRECT_LOG%
%JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %jaas_login% Dweblogic.Name=%SERVER_NAME% -Dweblogic.management.username=%WLS_USER% Dweblogic.management.password=%WLS_PW% Djava.security.policy=%WL_HOME%\server\lib\weblogic.policy %PROXY_SETTINGS%
%SERVER_CLASS% >”%WLS_REDIRECT_LOG%” 2>&1
)
•
WebLogic 9 - UNIX - in the WLS_REDIRECT_LOG settings
${JAVA_HOME}/bin/java ${JAVA_VM} -version
if [ "${WLS_REDIRECT_LOG}" = "" ] ; then
echo "Starting WLS with line:"
echo "${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS} Dweblogic.Name=${SERVER_
NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy
${PROXY_SETTINGS} ${SERVER_CLASS
}"
${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS}
${JAAS_LOGIN} -Dweblogic.Name=${S
ERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy
${PROXY_SETTINGS} ${SERVER_
CLASS}
else
echo "Redirecting output from WLS window to ${WLS_REDIRECT_LOG}"
${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS}
${JAAS_LOGIN} -Dweblogic.Name=${S
ERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy
${PROXY_SETTINGS} ${SERVER_
CLASS} >"${WLS_REDIRECT_LOG}" 2>&1
fi
4. Save and close the server startup script.
To configure Application Engine (WebLogic 8.1.x)
1. (If you selected Container-Managed Authentication during the installation) Enable trust between
WebLogic domains for the Content Engine domain and the Application Engine domain.
Do the following on both the Content Engine application server and the Application Engine
application server.
a. Log on to the WebLogic Administration Console.
b. Click <my_domain>.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
391
Task 29b: Configure Application Engine (WebLogic)
To configure Application Engine (WebLogic 8.1.x)
c. Click View Domain-Wide Security Settings.
d. Click the Advanced tab.
e. Uncheck (turn off) Enable Generated Credential.
f.
Enter a password for the domain in the Credential field. You must enter the same password
for both Content Engine and Application Engine.
g. Confirm the password by entering it in the Confirm Credential field.
h. Click Apply.
If you are enabling this feature in a managed server environment, you must stop the
Administration server and all the Managed Servers in both domains and then restart them.
If this step is not performed, servers that were not rebooted will not trust the servers that
were rebooted. Refer to your BEA documentation for more information.
2. (If you selected Container-Managed Authentication during the installation) Configure LDAP
settings on Application Engine to exactly match the Content Engine settings.
a. Refer to your Content Engine installation checklists and the WebLogic Administration
Console settings for Compatibility Security > Realms for Authentication Provider, users, and
groups on Content Engine.
Configure the LDAP provider to exactly match the settings from the Content Engine server.
•
Group Base DN:
•
User Name Attribute:
•
Port:
•
User Base DN:
•
Principal:
•
Credential:
•
Confirm Credential:
•
Host:
•
User From Name Filter:
•
Group From Name Filter:
b. Restart the application server.
3. Set permissions for the user running the application server.
NOTE On Windows, the following is only required for NTFS formatted partitions
If the user that will be running the application server is different from the user that installed
Application Engine, you must give the user read/write permissions on the folder where you
installed AE (<AE_install_path>), see “Specify Installation Location” on page 359.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
392
Task 29b: Configure Application Engine (WebLogic)
To configure Application Engine (WebLogic 9.2)
4. Continue with the following task:
•
If you are performing a fresh install:
Do Task 30 “Install Application Engine Software Updates” on page 398.
•
If you are performing an upgrade:
Do “Manually copy custom data.” on page 581.
To configure Application Engine (WebLogic 9.2)
1. (If you selected Container-Managed Authentication during the installation) Enable trust between
WebLogic domains for the Content Engine domain and the Application Engine domain.
Do the following on both the Content Engine application server and the Application Engine
application server.
a. Log on to the WebLogic Administration Console.
b. In the Change Center of the Administration Console, click Lock & Edit.
c. Click the name of the domain.
d. Click the Security tab.
e. Click General.
f.
Click Advanced.
g. Enter a password for the domain in the Credential field. You must enter the same password
for both the Content Engine domain and Application Engine domain.
h. Click Save.
i.
Click Activate Changes.
j.
Restart the server if needed.
k. Repeat this procedure in each domain for which you want to enable trust.
2. (If you selected Container-Managed Authentication during the installation) Configure LDAP
settings on Application Engine to exactly match the Content Engine settings.
a. Refer to your Content Engine installation checklists and the WebLogic Administration
Console settings for Compatibility Security > Realms for Authentication Provider, users, and
groups on Content Engine.
Configure the LDAP provider to exactly match the settings from the Content Engine server.
•
Group Base DN:
•
User Name Attribute:
•
Port:
•
User Base DN:
•
Principal:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
393
Task 29b: Configure Application Engine (WebLogic)
To enable passing user credentials to client applications
•
Credential:
•
Confirm Credential:
•
Host:
•
User From Name Filter:
•
Group From Name Filter:
b. Restart the application server.
3. Set permissions for the user running the application server.
If the user that will be running the application server is different from the user that installed
Application Engine, you must give the user read/write permissions on the folder where you
installed AE (<AE_install_path>), see “Specify Installation Location” on page 359.
4. Continue with “To enable passing user credentials to client applications” on page 394.
To enable passing user credentials to client applications
Perform this procedure to enable passing user credentials between Application Engine and its
client applications such as WebDAV and Application Integration.
CAUTION If you do not make this change to config.xml, then end users will be prompted to enter
their user name and password to complete any client operations, such as adding a document.
1. Stop the WebLogic server.
2. Make a backup copy of config.xml located in deployment directory.
For example:
WebLogic 8.x
<BEA_home>/bea/user_projects/domains/<domain_name>/config.xml
WebLogic 9.x
<BEA_home>/bea/user_projects/domains/<domain_name>/config/config.xml
3. Edit config.xml.
CAUTION The enforce-valid-basic-auth-credentials entry should be entered as a single line
without line breaks.
a. Locate the <security-configuration> section and add the following line to the end of the
section, just before the </security-configuration> tag:
<enforce-valid-basic-auth-credentials>false</enforce-valid-basic-authcredentials>
b. Save your changes to config.xml and close the file.
4. Restart WebLogic.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
394
Task 29b: Configure Application Engine (WebLogic)
To enable passing user credentials to client applications
5. Continue with the following task:
•
If you are performing a fresh install:
Do Task 30 “Install Application Engine Software Updates” on page 398.
•
If you are performing an upgrade:
Do “Manually copy custom data.” on page 581.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
395
Task 29c: Configure Application Engine (JBoss)
To modify the application server startup script
Task 29c: Configure Application Engine (JBoss)
This topic covers the configuration of your Application Engine application (Workplace) on JBoss.
Perform the following high-level steps in the order listed, using the referenced detailed procedures
for each step.
To modify the application server startup script
1. Stop the JBOSS application server if running.
2. Make a backup copy of the application server startup script.
Backup run.bat (Windows) or run.sh (UNIX).
3. Configure JAAS login.
a. Open the application server startup script for editing.
•
(UNIX) run.sh
•
(Windows) run.bat
b. Configure JAAS login.
Add one of the following right after the RESTART entry in the startup script.
CAUTION Enter the jaas_login entry (bold below) as a single line without line breaks.
•
Windows
:RESTART
"%JAVA%" %JAVA_OPTS% "-Djava.security.auth.login.config=C:\Program
Files\FileNet\AE\CE_API\config\jaas.conf.JBoss" "Djava.endorsed.dirs=%JBOSS_ENDORSED_DIRS%" -classpath "%JBOSS_CLASSPATH%"
org.jboss.Main %*
•
UNIX
:RESTART
"%JAVA%" %JAVA_OPTS% -Djava.security.auth.login.config=”/opt/FileNet/AE/
CE_API/config/jaas.conf.WSI” "-Djava.endorsed.dirs=%JBOSS_ENDORSED_DIRS%" classpath "%JBOSS_CLASSPATH%" org.jboss.Main %*
4. Save and close the server startup script.
5. Configure LDAP settings on Application Engine to exactly match the Content Engine settings.
a. On the Application Engine server, open login-config.xml, located in <JBoss_home>/server/
default/conf, for editing.
b. Set the <application-policy name="FileNet"> entry identical to the corresponding entry in the
login-config.xml file on the Content Engine server.
c. Restart the application server.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
396
Task 29c: Configure Application Engine (JBoss)
To modify the application server startup script
6. Set permissions for the user running the application server.
NOTE On Windows, the following is only required for NTFS formatted partitions
If the user that will be running the application server is different from the user that installed
Application Engine, you must give the user read/write permissions on the folder where you
installed Application Engine (<AE_install_path>), see “Specify Installation Location” on page 359.
7. Continue with the following task:
•
If you are performing a fresh install:
Do Task 30 “Install Application Engine Software Updates” on page 398.
•
If you are performing an upgrade:
Do “Manually copy custom data.” on page 581.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
397
Task 30: Install Application Engine Software Updates
To install the Application Engine software updates
Task 30: Install Application Engine Software Updates
Install any service packs, fix packs and/or interim fixes required for Application Engine.
To install the Application Engine software updates
1. To download the latest software updates, and to determine which of these updates may be
required for use with other components and expansion products, contact your support
representative.
2. Open the readmes for any subsequent fix packs or interim fixes (typically optional) and perform
the installation procedures provided.
3. Install the latest Content Engine and Process Engine client file updates. See Task 31 on page
399 and Task 32 on page 400.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
398
Task 31: Install the Latest Content Engine Client Files on Application Engine Servers
To install the Content Engine client files
Task 31: Install the Latest Content Engine Client Files
on Application Engine Servers
Install any Content Engine client file updates that are available.
To install the Content Engine client files
1. 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.
2. Open the readme for Content Engine 4.0.1 Service Pack or any later fix pack and perform the
installation procedures provided.
3. Continue with “Install the Latest Process Engine Client Files on Application Engine Servers” on
page 400.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
399
Task 32: Install the Latest Process Engine Client Files on Application Engine Servers
To install the Process Engine client files
Task 32: Install the Latest Process Engine Client Files
on Application Engine Servers
Install the Process Engine Client files for the 4.0.x release or fix pack version of Process Engine
you intend to run. These steps apply to WebSphere, WebLogic, and JBoss (except where noted).
Perform the following steps on all Application Engine servers.
To install the Process Engine client files
1. 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.
2. Log on to the server as a user who has permission to install software.
3. Back up the deployed web application directory.
4. Download and expand the appropriate TAR or ZIP file for Process Engine client installation to
the server and extract the contents to a local directory.
5. From Process Task Manager, stop the Component Manager(s) (if running), then exit the Process
Task Manager application.
6. (Windows only) From the Windows Services Console, stop the Process AE Services Manager
service.
7. If you wish to retain your existing configurations, copy the following configuration files from the
backup copy of your deployed application to the /WEB-INF folder in the installed directory on
your application server, overwriting the existing installed files.
The backup of these files is to ensure the files are still available in case there is any reason to
go back to the previous versions. When redeploying after installing the fix pack, any custom
settings will be added back to the deployed working directory.
From the /WEB-INF folder in the backed-up Workplace directory created in Step 3 on page 400
above, copy the following files to the <AE_install_path>/Workplace/WEB-INF/ directory:
WcmApiConfig.properties
web.xml
NOTE You must do the above file copy before you install the fix pack.
8. (WebSphere and WebLogic only) Stop and undeploy any instances of Application Engine.
9. (JBoss only) Run the shutdown command.
10. Manually delete the web application temporary directories associated with Application Engine.
11. Start the Process Engine client install process in one of the following ways:
•
For an interactive install, do the following:
i.
Access the IBM FileNet Process Engine client update software.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
400
Task 32: Install the Latest Process Engine Client Files on Application Engine Servers
To install the Process Engine client files
ii.
Launch the following install program, as appropriate for your operating system:
Windows
P8PEClientUpdater-<PE_version>-Win.exe
UNIX
P8PEClientUpdater-<PE_version>-<operating system>.bin
where:
<PE_version> is the version of Process Engine you intend to run, for example, 4.0.3.
<operating_system> is the UNIX type, for example, AIX.
iii. Continue with Step 12 on page 401 below.
•
For a silent install, do the following:
i.
Access the IBM FileNet Process Engine client update software package, and copy the
P8PEClient_silent_input.txt file to a local directory.
ii.
Follow the instructions in the silent input file to edit the file to reflect the appropriate
responses for your update.
iii. Run the Process Engine client files installer with the following arguments:
Windows
P8PEClientUpdater-<PE_version>-Win.exe -silent -options
<path>\<P8PEClient_silent_input.txt>
UNIX
P8PEClientUpdater-<PE_version>-<operating system>.bin -silent -options
<path>/<P8PEClient_silent_input.txt>
where:
<PE_version> is the version of Process Engine you intend to run, for example, 4.0.3.
<path> is directory path of the silent input file.
<operating_system> is the UNIX type, for example, AIX.
iv. Continue with Step 13 on page 402 below.
12. Complete the Setup screens as follows:
In this screen...
Perform this action...
Products to Update
Select Application Engine.
Stop Running Software
If prompted, stop all running software components.
Installation Summary
Validate that the information displayed is correct and that there
is enough space to complete the installation.
Software Components
Select the software components to automatically start after the
installation is complete.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
401
Task 32: Install the Latest Process Engine Client Files on Application Engine Servers
To install the Process Engine client files
13. Perform one of the following deployment tasks, depending on your application server type:
•
“Deploy Application Engine (WebSphere)” on page 403
•
“Deploy Application Engine (WebLogic)” on page 409
•
“Deploy Application Engine (JBoss)” on page 412
14. (Windows only) From the Windows Services Console, restart the Process AE Services Manager
service.
15. Restart Process Task Manager and Component Manager.
16. If necessary, restart Component Manager from Process Task Manager, and then exit the
Process Task Manager application.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
402
Task 33a: Deploy Application Engine (WebSphere)
To recreate the WAR or EAR file
Task 33a: Deploy Application Engine (WebSphere)
This topic covers the deployment and start of your Application Engine application (Workplace) on
WebSphere.
To recreate the WAR or EAR file
Any time that you make changes to files in the /Workplace directory, such as changes to web.xml
for container-managed authentication, SSO support, or any other edits, you must recreate the
WAR or EAR file and redeploy your changes.
NOTE Before recreating the EAR file, you must also recreate the WAR file.
•
If you will be deploying from a WAR file.
a. Verify that all modified /Workplace directory files have been saved.
b. Recreate the app_engine.war file by running create_app_engine_war.sh (UNIX) or
create_app_engine_war.exe (Windows) from the following location:
<AE_install_path>/deploy/
•
If you will be deploying from an EAR file.
a. Verify that a newly recreated app_engine.war file exists.
b. Recreate the app_engine.ear file by running create_app_engine_ear.sh (UNIX) or
create_app_engine_ear.exe (Windows) from the following location:
<AE_install_path>/deploy/
To deploy Application Engine (WebSphere 5.1.x)
1. Start the application server.
2. Log on to the WebSphere administrative console.
3. From the Administrative Console, expand Applications. Click Install New Application. The
“Preparing for the application installation” dialog box opens.
4. Select file to deploy.
•
(If the Administrative Console is running locally) Select Local Path and enter or browse to the
location of the app_engine.war or app_engine.ear file created by Setup (see below for the
default path). Do not enter the machine name.
•
(If the Administrative Console is remote) Select Server path and enter the fully-qualified
pathname to the app_engine.war or app_engine.ear file. Do not enter the machine name.
<AE_install_path>/deploy
5. If you are deploying from a WAR file, enter Workplace as the context root, and click Next to
proceed to deploying a new application.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
403
Task 33a: Deploy Application Engine (WebSphere)
To deploy Application Engine (WebSphere 6.0)
NOTE The context root is the name of the application you log in to using the web interface,
such as:
http://<ApplicationEngineServerName>:<port#>/<Context Root>.
6. From the “Generate Default Bindings” screen, leave the defaults, and click Next.
7. From the “Application Security Warning” screen, click Continue.
8. At “Install New Application”, Step 1, specify the application name.
Enter Workplace, or the name you chose to call the application, click Next.
9. At “Install New Application”, Step 2, specify the Virtual Host for the virtual host that you are
planning to use. Check Workplace and keep the default virtual host (default_host), click Next.
10. At “Install New Application”, Step 3, configure your application server, and then click Next.
11. At “Install New Application”, Step 4, verify your configuration and click Finish. Once the
configuration is saved, click Save to Master Configuration.
12. Configure the Classloader settings.
a. From the Administrative Console, expand Applications. Click Enterprise Applications, and
click your application (default Workplace).
b. From the Configuration tab, set Classloader Mode to PARENT_LAST.
c. Verify that the WAR Classloader Policy is set to Module.
NOTE Do this only for the specific web application. Do not change the similar settings for
the entire application server.
13. Configure the Web Module Classloader setting.
a. From the Administrative Console, expand Applications. Click Enterprise Applications, and
click your application (default Workplace). Under Related Items, click Web Modules. Click
app_engine.war.
b. From the Configuration tab, set Classloader Mode to PARENT_LAST.
NOTE Do this only for the specific web application. Do not change the similar settings for
the entire application server.
c. Click Apply, click Save, and then click Save changes to the Master Configuration.
14. Stop and restart the application server.
15. If this is an upgrade, before you bring up the Workplace login, continue with “Complete PostUpgrade Application Engine Configuration” on page 583.
To deploy Application Engine (WebSphere 6.0)
1. Start the application server.
2. Log on to the WebSphere administrative console.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
404
Task 33a: Deploy Application Engine (WebSphere)
To deploy Application Engine (WebSphere 6.0)
3. From the WebSphere administrative console, expand Applications. Click Install New
Application. The “Preparing for the application installation” dialog opens.
4. Select file to deploy.
•
(If the Administrative Console is running locally) Select Local Path and enter or browse to the
location of the app_engine.war or app_engine.ear file created by Setup (see below for the
default path). Do not enter the machine name.
•
(If the Administrative Console is remote) Select Server path and enter the fully-qualified
pathname to the app_engine.war or app_engine.ear file. Do not enter the machine name.
<AE_install_path>/deploy
5. If you are deploying a WAR file, enter the context root:
Enter Workplace and click Next to proceed to deploying a new application.
NOTE The context root is the name of the application you log in to using the web interface,
such as:
http://<ApplicationEngineServerName>:<port#>/<Context Root>.
6. On the “Preparing for the application installation” screen, leave the defaults, and click Next.
7. On the “Application Security Warning” screen, click Continue.
8. At “Install New Application”, Step 1, specify the application name.
Enter Workplace, or the name you chose to call the application, click Next.
9. At “Install New Application”, Step 2, Map modules to servers, specify the WebServer you are
planning to use. Check Workplace and click Next.
10. At “Install New Application”, Step 3, Map virtual hosts for Web Modules , check Workplace and
keep the default virtual host (default_host), click Next.
11. At “Install New Application”, Step 4, verify your configuration and click Finish. Once the
configuration is saved, click Save to Master Configuration.
12. Configure the Classloader settings.
a. From the Administrative Console, expand Applications. Click Enterprise Applications, and
click your application (default Workplace).
b. From the Configuration tab, set Classloader Mode to PARENT_LAST.
c. Verify that the WAR Classloader Policy is set to Module.
NOTE Do this only for the specific web application. Do not change the similar settings for
the entire application server.
d. Click Apply.
13. Configure the Web Module Classloader setting.
a. From the Administrative Console, expand Applications.
b. Click Enterprise Applications, and click your application (default Workplace).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
405
Task 33a: Deploy Application Engine (WebSphere)
To deploy Application Engine (WebSphere 6.1)
c. Under Related Items, click Web Modules. Click app_engine.war.
d. From the Configuration tab, set Classloader Mode to PARENT_LAST.
NOTE Do this only for the specific web application. There are similar settings for the entire
application server. Do not change these.
e. If you are using container-managed authentication, navigate to Enterprise Applications >
Workplace > Map security roles to users/groups, and verify that the Everyone? column is
checked for the "Everyone" role .
f.
Click Apply, click Save, and then click Save changes to the Master Configuration.
14. Stop and restart the application server.
15. If this is an upgrade, continue with the Upgrade Core Components Task 16 “Complete PostUpgrade Application Engine Configuration” on page 583. You will not return to this task.
16. Start the Enterprise Application.
a. From the Administrative Console, expand Applications.
b. Click Enterprise Application.
c. Check the box to the left of the Workplace application (or whatever you named it), and click
Start.
To deploy Application Engine (WebSphere 6.1)
1. Start the application server.
2. Log on to the WebSphere administrative console.
3. From the WebSphere administrative console, expand Applications. Click Install New
Application. The “Preparing for the application installation” dialog opens.
4. Select file to deploy.
a. Select Path
•
(If the Administrative Console is running locally) Select Local Path and enter or browse
to the location of the app_engine.war or app_engine.ear file created by Setup (see
below for the default path). Do not enter the machine name.
•
(If the Administrative Console is remote) Select Server path and enter the fullyqualified pathname to the app_engine.war or app_engine.ear file. Do not enter the
machine name.
<AE_install_path>/deploy
b. If you are deploying a WAR file, enter the context root:
Enter Workplace and click Next to proceed to deploying a new application.
NOTE The context root is the name of the application you log in to using the web interface,
such as:
http://<ApplicationEngineServerName>:<port#>/<Context Root>.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
406
Task 33a: Deploy Application Engine (WebSphere)
To deploy Application Engine (WebSphere 6.1)
5. Click Next.
6. At “Install New Application”, Step 1, specify the application name.
Enter Workplace, or the name you chose to call the application, click Next.
7. At “Install New Application”, Step 2, Map modules to servers, specify the WebServer you are
planning to use. Check Workplace and click Apply. Verify that the webserver you specify is
displayed to the right of Workplace. Click Next.
8. At “Install New Application”, Step 3, Map virtual hosts for Web Modules , check Workplace and
keep the default virtual host (default_host), click Next.
9. At “Install New Application”, Step 4, verify your configuration and click Finish. Once the
configuration is saved, click Save.
10. Configure the Classloader settings.
a. From the Administrative Console, expand Applications. Click Enterprise Applications, and
click your application (default Workplace).
b. From the Configuration tab, click Class loading and update detection.
c. Change Classloader order from "Classes loaded with parent class loader first" to "Classes
loaded with application class loader first."
NOTE Do this only for the specific web application. Do not change the similar settings for
the entire application server.
d. Change the polling interval to a number appropriate for your environment.
e. Click Apply.
11. Configure the Web Module Classloader setting.
a. From the Administrative Console, expand Applications.
b. Click Enterprise Applications, and click your application (default Workplace).
c. Under Modules, click Manage Modules. Click Workplace, or your application name.
d. Change Classloader order from "Classes loaded with parent class loader first" to "Classes
loaded with application class loader first."
NOTE Do this only for the specific web application. There are similar settings for the entire
application server. Do not change these.
e. If you are using container-managed authentication, navigate to Enterprise Applications >
Workplace > Map security roles to users/groups, and verify that the Everyone? column is
checked for the "Everyone" role .
f.
Click Apply, click Save, and then click Save changes to the Master Configuration.
12. Stop and restart the application server.
13. If this is an upgrade, continue with the Upgrade Core Components Task 16 “Complete PostUpgrade Application Engine Configuration” on page 583. You will not return to this task.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
407
Task 33a: Deploy Application Engine (WebSphere)
To deploy Application Engine (WebSphere 6.1)
14. Start the Enterprise Application.
a. From the Administrative Console, expand Applications.
b. Click Enterprise Application.
c. Check the box to the left of the Workplace application (or whatever you named it), and click
Start.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
408
Task 33b: Deploy Application Engine (WebLogic)
To recreate the WAR or EAR file
Task 33b: Deploy Application Engine (WebLogic)
This topic covers the deployment of your Application Engine application (Workplace) on
WebLogic.
To recreate the WAR or EAR file
Any time that you make changes to files in the /Workplace directory, such as changes to web.xml
for container-managed authentication, SSO support, or any other edits, you must recreate the
WAR or EAR file and redeploy your changes.
NOTE Before recreating the EAR file, you must also recreate the WAR file.
•
If you will be deploying from a WAR file.
a. Verify that all modified /Workplace directory files have been saved.
b. Recreate the app_engine.war file by running create_app_engine_war.sh (UNIX) or
create_app_engine_war.bat (Windows) from the following location:
<AE_install_path>/deploy/
•
If you will be deploying from an EAR file.
a. Verify that a newly recreated app_engine.war file exists.
b. Recreate the app_engine.ear file by running create_app_engine_ear.sh (UNIX) or
create_app_engine_ear.bat (Windows) from the following location:
<AE_install_path>/deploy/
To deploy as “Workplace” or custom name using a WAR file
Perform this step only if you are using a WAR file for deployment, and you want to use
“Workplace” or a custom name for the context root of the application. The context root is part of
the URI that end users type to access Workplace. By default, when you deploy from a WAR file,
the context root is the first part of the WAR filename.
Rename the app_engine.war file to reflect the name you want to use using the format <Application
Name>.war.
Example:
The default app_engine.war will generate the following context root:
http://<server_name>:<port#>/app_engine
Renaming the WAR file Workplace.war will generate the following context root:
http://<server_name>:<port#>/Workplace
CAUTION You must rename the WAR file every time you regenerate it. The
create_app_engine_war.sh/.bat script will by default create a file with the name app_engine.war.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
409
Task 33b: Deploy Application Engine (WebLogic)
To deploy Application Engine (WebLogic 8.1.x)
To deploy Application Engine (WebLogic 8.1.x)
1. Start the application server.
2. (For WAR file or exploded directory deployment only) Create a new Web Application for WAR file
or exploded directory deployment.
a. From the WebLogic Server Console, click <mydomain>, click Deployments, and then click
Web Application Module.
b. Click Deploy a new Application.
c. From the right pane of the WebLogic Administration Console, do one of the following:
•
To deploy from an exploded folder, browse to and select the radio button for the
Workplace folder in:
<AE_install_path>
•
To deploy from a WAR file, browse to and select the radio button for the WAR file you
want to deploy (Default: app_engine.war) in:
<AE_install_path>/deploy
d. Click Target Module to select Workplace.
e. Verify that the Name field has the value Workplace.
f.
Click Deploy.
NOTE To verify that the deployment was successful, expand Applications. The web
application Workplace will be listed.
3. (For EAR file depolyment only) Create a new Web Application for EAR file deployment.
a. From the WebLogic Server Console, click <mydomain>, click Deployments, and then click
Application.
b. Click Deploy a new Web Application Module.
c. From the right pane of the WebLogic Administration Console, browse to and select the radio
button for the app_engine.ear file in:
<AE_install_path>/deploy
d. Click Target Module to select Workplace.
e. Verify that the Name field has the value Workplace.
f.
Click Deploy.
NOTE To verify that the deployment was successful, expand Web Applications. The web
application Workplace will be listed.
4. (Upgrades only) If this is an upgrade, continue with Upgrade Core Components Task 16
“Complete Post-Upgrade Application Engine Configuration” on page 583. You will not return to this
task.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
410
Task 33b: Deploy Application Engine (WebLogic)
To deploy Application Engine (WebLogic 9.2)
5. Continue with “To start the web application” on page 411.
To deploy Application Engine (WebLogic 9.2)
1. Start the application server.
2. From the WebLogic Administration Console, navigate to the domain you created for the Application
Engine in “Configure an Application Server for Application Engine (WebLogic)” on page 152.
3. Click Deployments.
4. In the Change Center, click Lock & Edit.
5. From the right pane of the WebLogic Administration Console, do one of the following:
•
To deploy from an exploded folder, browse to and select the radio button for the Workplace folder
in:
<AE_install_path>
•
To deploy from a WAR or EAR file, browse to and select the radio button for the WAR file you want
to deploy (Default: app_engine.war or app_engine.ear) in:
<AE_install_path>/deploy
6. Click Next.
7. Accept the defaults for the deployment, except for the name for the deployment. Use
“Workplace” instead of “appengine”.
8. Click Finish.
9. Click Save, and then click Activate Changes.
NOTE To verify that the deployment was successful, expand Web Applications. The web
application Workplace will be listed.
10. If this is an upgrade, continue with the Upgrade Core Components Task 16 “Complete PostUpgrade Application Engine Configuration” on page 583. You will not return to this task.
11. Continue with “To start the web application” on page 411.
To start the web application
After Workplace is deployed, start the web application.
1. From the WebLogic Administration Console, navigate to <your_domain> > Deployments and select
the box next to Workplace.
2. Click Start, and then select Servicing all requests.
3. Click Yes to start the application.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
411
Task 33c: Deploy Application Engine (JBoss)
To recreate the WAR or EAR file
Task 33c: Deploy Application Engine (JBoss)
This topic covers the deployment and start of your Application Engine application (Workplace) on
JBoss.
To recreate the WAR or EAR file
Any time that you make changes to files in the /Workplace directory, such as changes to web.xml
for container-managed authentication, SSO support, or any other edits, you must recreate the
WAR or EAR file and redeploy your changes.
NOTE Before recreating the EAR file, you must also recreate the WAR file.
•
If you will be deploying from a WAR file.
a. Verify that all modified /Workplace directory files have been saved.
b. Recreate the app_engine.war file by running create_app_engine_war.sh (UNIX) or
create_app_engine_war.exe (Windows) from the following location:
<AE_install_path>/deploy/
•
If you will be deploying from an EAR file.
a. Verify that a newly recreated app_engine.war file exists.
b. Recreate the app_engine.ear file by running create_app_engine_ear.sh (UNIX) or
create_app_engine_ear.exe (Windows) from the following location:
<AE_install_path>/deploy/
To deploy as “Workplace” or custom name using a WAR file
Perform this step only if you are using a WAR file for deployment, and you want to use
“Workplace” or a custom name for the context root of the application. The context root is part of
the URI that end users type to access Workplace. By default, when you deploy from a WAR file,
the context root is the first part of the WAR filename.
Rename the app_engine.war file to reflect the name you want to use using the format <Application
Name>.war.
Example:
The default app_engine.war will generate the following context root:
http://<server_name>:<port#>/app_engine
Renaming the WAR file Workplace.war will generate the following context root:
http://<server_name>:<port#>/Workplace
CAUTION You must rename the WAR file every time you regenerate it. The
create_app_engine_war.sh/.exe script will by default create a file with the name app_engine.war.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
412
Task 33c: Deploy Application Engine (JBoss)
To deploy and start Application Engine
To deploy and start Application Engine
•
To deploy from exploded directory.
a. On the JBoss server, copy the /Workplace folder from:
<AE_install_path>
to:
<JBOSS_home>/server/default/deploy/
b.
Append the extension .war to the Workplace folder:
<JBOSS_home>/server/default/deploy/Workplace.war
•
To deploy from WAR file.
On the JBoss server, copy the app_engine.war file from:
<AE_install_path>/deploy
to:
<JBOSS_home>/server/default/deploy/
•
To deploy from EAR file.
On the JBoss server, copy the app_engine.ear file from:
<AE_install_path>/deploy
to:
<JBOSS_home>/server/default/deploy/
4. Set permissions for the user running the application server.
If the user that will be running the application server is different from the user that installed
AE, you must give the user read/write permissions on the following folders:
NOTE For Windows this is only required for NTFS formatted partitions:
<JBOSS_home>/server/default/deploy/app_engine.war/.ear
<AE_install_path>
5. Start or restart the JBoss application server.
6. Verify that the application deployed successfully.
Verify that the server.log file located in <JBOSS_home>/server/default/log lists deployment of
the WAR or EAR file you used.
7. If this is an upgrade, continue with the Upgrade Core Components Task 16 “Complete PostUpgrade Application Engine Configuration” on page 583. You will not return to this task.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
413
Configuration/Startup Tasks
To configure the IBM FileNet P8 Platform components
Configuration/Startup Tasks
To configure the IBM FileNet P8 Platform components
1. Configure Content Engine for content-based retrieval (CBR). Do Task 34 on page 415.
2. Set bootstrap preferences. Do Task 35 on page 421.
3. Initialize the isolated region. Do Task 36 on page 426.
4. Create a Process Engine connection point. Do Task 37 on page 427.
5. Configure the Process Engine connection point for Application Engine. Do Task 38 on page 428.
6. Set up Content Engine and client transport SSL security. Do Task 39 on page 430.
7. Set up Application Engine SSL security. Do Task 40 on page 434.
8. Perform additional configuration tasks. Do Task 41 on page 438.
9. Familiarize yourself with IBM FileNet P8 system startup and shutdown procedures. See the IBM
FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration > Shutdown and
Startup.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
414
Task 34: Configure Content Engine for Content-Based Retrieval
To create a collections directory
Task 34: Configure Content Engine for Content-Based
Retrieval
This task is for new installations only and is required if you have installed the Content Search
Engine. It covers how to use Enterprise Manager to configure an index area and enable the
Content-Based Retrieval (CBR) feature provided by the IBM FileNet P8 Content Search Engine.
This search engine is based on Autonomy K2.
If you are upgrading and have 3.5.x content-search indexes that you want to upgrade to 4.0.0 index
areas (now called K2 collections), do not complete this task. Instead, follow the upgrade procedure,
Task 3 Upgrade Content Engine Software on page 505.
NOTES
•
Before you complete the procedure in this topic, ensure the IBM FileNet P8 Content Search
Engine has been installed and configured on at least one server (In effect, this means you
have already installed and configured an Autonomy K2 Master Administration Server). For
details, see Task 11 Install and Configure Content Search Engine on page 174.
•
Numerous K2 security accounts are referenced within this procedure. For more information on
the accounts required, see “To create Content Search Engine accounts” on page 93 for details on
which accounts to designate and the permissions to assign.
•
Various server names and related ports assigned during the installation and configuration of
Autonomy K2 will be required during this procedure. If you do not have a record of the servers
created and the ports that have been assigned, log into the Autonomy K2 dashboard to obtain
the information necessary.
•
If you unimport the style set, the original files will be deleted from your system. In this
scenario, if you wish to re-import the style set, you will need to recover it from your installation
disk. In order to avoid this situation, you can either enter a unique name for the Style Set Alias
during the initial Content Search Engine (Autonomy K2) installation, or make a backup copy of
the original style set. If you entered a unique name for the style set during installation, ensure
you use that Style Set Alias name for this procedure.
To create a collections directory
For performance reasons, it is recommended that you create one collections directory for each
index area you create in IBM FileNet P8 Content Engine. Each collections directory you create
must be set to provide proper security access. The path to both the collections directory and
collections temp directory must be entered in the index area properties when you create them.
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 more
information on the accounts required, see “To create Content Search Engine accounts” on page 93 for
details on which accounts to assign and the permissions to add. For detailed information on
security, see the IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration
> FileNet P8 Security > Authorization > Security for integrated components and third-party products >
Autonomy K2 Server > Security for Autonomy K2 Server.
1. Create a directory on the Verity server on which you will store collections
(VerityIndexArea.RootDirectoryPath). This directory must be located on a disk that is local to the
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
415
Task 34: Configure Content Engine for Content-Based Retrieval
To create a collections directory
Verity server. Using a remote mounted disk accessed via the network (NFS, PCNFS, or CIFS)
will cause stability problems under load and corrupt collections. Set permissions to allow access
to the K2 Operating System User.
NOTE This path must be local to the index server that will be assigned to write collections.
2. Create a temp directory (VerityIndexArea.TempDirectoryPath) which will be used by the K2
Index Server and Content Engine Server during operations.
NOTE This path must be visible to both the Content Engine and the Autonomy K2 servers.
This means that if the K2 Administration Server and Content Engine are not installed on the
same machine, they both must be on a network mounted file system.
3. Provide read/write access to the collections directory for Autonomy K2 by entering the full path
to the location and record the temp collections path.
For upgrades of 3.5.x collections
Windows:
a. Open the following K2 configuration file in a text editor:
C:\Program Files\filenet\contentengine\verity\k2\common\verity.cfg
b. 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
c. Modify the next available alias settings by adding an entry for each 3.5.x collections path,
expressed as UNC, that you want to upgrade. For example, change alias7, mapping7, and
dirmode7 to the following:
alias7=path2
mapping7=\\<server_host_name>\<Collections_Directory>
dirmode7=wr
UNIX:
a. Open the following K2 configuration file in a text editor:
/opt/verity/k2/common/verity.cfg
b. Modify the next available alias settings by adding the collections path. For example, change
alias6, mapping6, and dirmode6 to the following:
alias6=path1
mapping6=/<Collections_Directory_Path>
dirmode6=wr
NOTE The Collections_Directory_Path must be a local path and not a mount point.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
416
Task 34: Configure Content Engine for Content-Based Retrieval
To Configure Content Engine for CBR
For new installations where you are not upgrading existing collections
Windows:
a. Open the following K2 configuration file in a text editor:
C:\Program Files\filenet\contentengine\verity\k2\common\verity.cfg
b. 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
UNIX:
a. Open the following K2 configuration file in a text editor:
/opt/verity/k2/common/verity.cfg
b. Modify the next available alias settings by adding the collections path. For example, change
alias6, mapping6, and dirmode6 to the following:
alias6=path1
mapping6=/<Collections_Directory_Path>
dirmode6=wr
NOTE The Collections_Directory_Path must be a local path and not a mount point.
4. Set file store access. Each file store that will be full text indexed must be accessible by the Verity
server that will perform the full text indexing. Permissions on the file store must be set the same
as the permissions on the collections directories, allowing both the Content Engine Operating
System User and the Verity Operating System User to access them. The names of the file store
directories must also be the same on each server that access it.
To Configure Content Engine for CBR
NOTE l
This procedure covers the minimum setup and configuration steps to get CBR configured and
running with Autonomy K2. For more detail on Content-Based Retrieval and Content Engine, see
the IBM FileNet P8 help topic Configure CBR found at FileNet P8 Administration > Content Engine
Administration > Content-based retrieval > How to... > Configure CBR.
NOTE Where machine name variables are required, IP addresses will not validate. In these
cases, you must enter the host name for the machine.
1. Launch Enterprise Manager and log in as the GCD Administrator.
2. Create a Verity Domain Configuration (VDC) for K2.
a. Right-click Enterprise Manager [domain] in the Enterprise Manager tree and select
Properties.
b. Click the Verity Domain Config. tab.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
417
Task 34: Configure Content Engine for Content-Based Retrieval
To Configure Content Engine for CBR
c. Enter the following K2 Master Administration Server access information:
•
Host Name - the name of the host of the K2 Master Administration Server.
•
Port - the K2 Master Administration Server port.
•
User Domain - the authentication domain in which your K2 services are installed.
•
User Group - K2 Security Group
•
Verity Username - K2 Security User
•
Password - the K2 Security User password.
d. Click Create Configuration to save your settings and create a Verity Domain Configuration
object.
3. Assign a K2 Broker Server:
a. Click the Verity Server tab.
b. From the Brokers AVAILABLE pane, select the broker and click Add to move the server to
the Brokers Selected pane.
c. Click OK.
NOTE You may assign multiple Broker Servers to a K2 Administration Server, primarily for
failover. If one Broker Server goes down, then K2 can switch to another. In this configuration,
you must ensure that all Search Servers required to access K2 Collections (index areas) are
attached to each Broker Server. Be aware that a given Content Engine server will neither call
multiple Broker Servers nor merge associated search results. See steps 3 and 4 of “To
configure Autonomy K2 for Content-Based Retrieval” on page 180 for instructions on how to create
Broker Servers and assign Search Servers.
4. Enter a CBR Locale.
NOTE If you click the Set to Default button, uni will be set as the CBR Locale. The uni locale is
slower than the language-specific locales. The uni locale handles all languages but does not
allow word-stemming. Therefore, a language-specific locale is recommended instead. Refer to
the K2 documentation for a listing of K2-specific locales. Naming of K2 locales is specific to
the K2 product and not the same as localization locales.
a. Right-click the Object Store and select Properties.
b. Click the Locale tab.
c. Enter a valid Autonomy K2 locale for CBR.
5. Create an index area, as follows:
a. Right-click the name of the object store to which you want to add an index area (K2
collection) and select New > Index Area.
b. Enter the following information.
–
Display Name: <Index_Area_Name>
–
Descriptive Text: <Description>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
418
Task 34: Configure Content Engine for Content-Based Retrieval
To enable additional K2 Index Servers and Search Servers
–
Site: Choose which site to associate with the index area.
–
Template Type: FileNet_FileSystem_PushAPI.
–
File system root directory for Verity Collections: Enter the full path to the collections
directory (verity.rootdirectory.path) for this index area (for example,
\\<myserver>\<Verity_Collections>).
–
File system temporary directory for Verity Collections: Enter the full path to the
temporary collections directory (verity.temporary.path) for this index area (for example,
\\<myserver>\<Verity_Collections_temp>).
c. Select <server_name>_search_server in the Verity Search Servers selection window.
d. Highlight <server_name>_index_server in the Verity Index Servers selection window.
e. Click Create Index Area.
f.
Click OK in the confirmation window.
6. Enable CBR for class definitions by activating the CBR Enable flag of the class you want
available for CBR, as follows:
a. Right-click the class you want to configure in the Enterprise Manager tree and click
Properties.
b.
Select CBR Enabled and click OK.
7. Enable CBR for the class properties you want available for CBR, as follows:
a. Right-click the class you want to configure 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.
To enable 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
419
Task 34: Configure Content Engine for Content-Based Retrieval
To enable additional K2 Index Servers and Search 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
420
Task 35: Set Application Engine Bootstrap Preferences
Bootstrap Preferences
Task 35: Set Application Engine Bootstrap Preferences
Bootstrap preferences are a category of site preferences. The first time you sign into Workplace
after Application Engine installation, the Bootstrap Preferences page opens.
Bootstrap Preferences
The following six bootstrap preference groups are available the first time you sign in:
•
Security Info (required for SSL only)
•
User Token Settings
•
Preference Settings (required)
•
Banner Image
•
Application Integration
•
Administrator Access Role
For more information, see the IBM FileNet P8 help topic User Help > Actions, preferences, and tools >
Site Preferences > Bootstrap preferences.
Enhanced Timezone Detection
In addition to these settings you can also set the useEnhancedTimeZoneDetection parameter to
accurately detect a client browser's time zone. 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 FileNet P8 Administration > Application
Engine Administration > Key configuration files and logs > bootstrap.properties.
NOTES
•
By successfully signing in to Workplace and saving the bootstrap preferences, you are
verifying the Application Engine’s basic functionality such as user authentication as well as
communication and storing of data in Content Engine.
•
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 the
IBM FileNet P8 help topic User Help > Actions, preferences, and tools > Site preferences.
•
After the initial bootstrap configuration, users with the Application Engine Administrators role
can change any of these preferences by signing into Workplace and navigating to Admin >
Site Preferences > Bootstrap.
•
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.
•
In a web farm/clustered environment, all Application Engines share site preferences by using
the same bootstrap.properties file. For more information, see the IBM FileNet P8 Platform
High Availability Technical Notice. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
421
Task 35: Set Application Engine Bootstrap Preferences
To set the bootstrap properties on first login
•
Bootstrap properties are stored in a separate file from other site preference. The default
location for this file, bootstrap.properties, is:
–
WebSphere
<WebSphere_home>/installed Apps/Workplace.ear/app_engine.war/WEB-INF
–
WebLogic
<AE_install_path>/Workplace/WEB-INF
•
(New installations only) To allow users to create workflows subscriptions, you must configure
the PWDesigner access role. For more information, see “(New installations only) To enable user
access to the Workflow Subscription Wizard” on page 425.
To set the bootstrap properties on first login
1. Sign in to Workplace:
a. On any computer, open a browser and type:
http://<ApplicationEngineServerName>:<port#>/Workplace
b. Enter a user name and password, and then click Sign in. The Bootstrap Preferences page
opens.
NOTE 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 User Help > Actions, preferences, and tools > 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 “Set Up Application Engine SSL Security” on page 434 for
instructions on setting up SSL security for one or more Application Engines.
CAUTION Once you’ve 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).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
422
Task 35: Set Application Engine Bootstrap Preferences
To set the bootstrap properties on first login
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.
NOTE The bootstrap preferences are saved in the bootstrap.properties file, and not in the site
preferences file.
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 is:
http://<DocServerName>:<port#>/ecm_help/
where <DocServerName> is the name of your Java application server where the
documentation is installed,
<port#> is the port number,
and <ecm_help> is the root directory of the documentation web site.
NOTE 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 “Enable Application Engine to Use ISRA” on page 468.
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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
423
Task 35: Set Application Engine Bootstrap Preferences
To add a single index for Application Name on the site preferences object store
Select No (default), if you do not want users to be prompted to add an email to an object store
each time the email is sent.
Select Yes, if you want users prompted to add an email to an object store when the email is
sent.
This preference setting only affects Outlook integration.
7. Add Application Engine Administrators.
Add the users and groups that will perform Application Engine administration tasks to the
Application Engine Administrators role.
NOTES
•
The user who initially signs 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
User Help > Actions, preferences, and tools > 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.
8. Click Apply to save your bootstrap settings.
To add a single index for Application Name on the site preferences object store
To properly index access roles and improve login performance on Application Engine, you must
create an index for Application Name on the object store that contains the Workplace site
preferences. Do this after you have successfully configured the bootstrap preferences.
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 preferences are stored. See “(Required) Specify
preference settings.” on page 423 above.
4. Expand Other Classes and then Custom Object.
5. Right click Access Role and select Properties.
6. Select the Property Definitions tab.
7. Select Application Name and click Edit.
8. On the General tab of the Application Name Properties, if the Indexed field shows 'not indexed',
click Set/Remove.
9. Select Set and then Single Indexed.
10. Click OK to set the index.
11. Click OK to apply the change and close the Application Name Properties window.
12. Click OK to close the Access Role Class Properties window.
NOTE If you are performing an upgrade, continue with Step 4 on page 584.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
424
Task 35: Set Application Engine Bootstrap Preferences
(New installations only) To enable user access to the Workflow Subscription Wizard
(New installations only) To enable 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. You can perform these steps in any order, and you must perform
both steps any time you need to add or remove users.
1. Assign users as members of the PWDesigner access role. See the IBM FileNet P8 help topic
User Help > Actions, preferences, and tools > Site preferences > Access Roles preferences.
2. Run the security script wizard,and load the workplacescript.xml file to add accounts to the
Workflow Designer role.
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 FileNet P8
Administration > Content Engine Administration > Content Engine Wizard Help > 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 FileNet P8 Administration > Content
Engine Administration > Managing Security > Security Script Wizard.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
425
Task 36: Create a Process Engine Isolated Region
To create a Process Engine isolated region
Task 36: Create a Process Engine Isolated Region
Process Engine communicates to its database using a connection point. Each connection point is
associated with an isolated region. In this task you will create an isolated region. In Task 37 on
page 427 you will define a connection point to this isolated region.
To create a Process Engine isolated region
1. Start Enterprise Manager by double-clicking the FileNet Enterprise Manager SnapIn 4.0 on the
desktop, or by navigating to Start > All Programs > FileNet P8 Platform > Enterprise Manager
SnapIn 4.0. Log on as a GCD administrator.
2. Connect to the FileNet P8 domain you created in “Install and Deploy Content Engine” on page 187.
3. Right-click PE Region ids > New PE Region ids.
4. Click Next on the Specify a Site screen to select a site named initial site.
5. Enter the DNS name for the Process Engine server.
6. Enter the region ID.
7. Modify the communication port if needed.
8. Click Next when done.
9. Enter the password for the isolated region. This password must match that entered in the
Process Engine Task Manager for the isolated region in “Configure Process Task Manager” on
page 352.
10. Click OK on the Confirmation Window.
11. Click Finish to finish create a new region for Process Engine.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
426
Task 37: Create a Process Engine Connection Point
To create a Process Engine connection point
Task 37: Create 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.
To create a Process Engine connection point
1. Start Enterprise Manager by double-clicking the FileNet Enterprise Manager SnapIn 4.0 on the
desktop, or by navigating to Start > All Programs > FileNet P8 Platform > Enterprise Manager
SnapIn 4.0. Log on as a GCD administrator.
2. Connect to the FileNet P8 domain you created in “Install and Deploy Content Engine” on page 187.
3. Right-click PE Connection Points > New PE Connection Points.
4. Enter a Process Engine Connection Point name and click Next.
5. Choose the region which is created in “Create a Process Engine Isolated Region” on page 426, and
click Next.
6. Click Finish to finish creating the Connection Point.
7. Click OK.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
427
Task 38: Configure the Process Engine Connection Point for Application Engine
To configure the connection point
Task 38: Configure the Process Engine Connection
Point for Application Engine
Before users can access tasks and work items from Workplace, you must configure the
Connection Point on the Application Engine. Make sure that you have already completed these
Tasks:
•
“Create a Process Engine Isolated Region” on page 426
•
“Create a Process Engine Connection Point” on page 427
To configure the connection point
1. Log onto Application Engine:
a. On any computer, open a browser and navigate to:
http://<ApplicationEngineServerName>:<port#>/Workplace
b. Sign in using 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 Conncetion Point from the drop down
list.
5. Click Apply.
6. Click Exit.
7. Initialize the isolated region.
a. Click Admin.
b. Click Process Configuration Console.
NOTE 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 enter
the following settings:
•
De-select (clear) the Internet Explorer option.
•
If you will be using Netscape 6.0, select the Netscape option.
c. Right-click the icon or name of the isolated region you want to initialize, and select Connect
from the context menu.
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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
428
Task 38: Configure the Process Engine Connection Point for Application Engine
To configure the connection point
8. In Workplace, click Tasks to confirm that Application Engine is communicating with Process
Engine.
9. Sign out of Workplace.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
429
Task 39: Set Up Content Engine and Client Transport SSL Security
Task 39: Set 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.
CAUTION IBM strongly recommends enabling 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 P8 4.0.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 may 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, but 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.
NOTES:
•
The Content Engine web service is used:
–
By all clients of the Content Engine 4.0 .NET API
–
By all clients of the Content Engine 4.0 COM Compatibility API (CCL)
–
By the Enterprise Manager tool
–
By the Content Engine 3.5.2 to 4.0.0 Upgrade tool
–
By the Process Engine, when making calls to the 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 CE 3.5 web service API, including
Altien Document Manager and the Sharepoint integration done by Vorsite.
•
Certain Java applications (written against the Content Engine 3.5.x Java API or the Content
Engine 4.0.0 Java API) may use the Content Engine web service transport, but typically they
would use EJB transport (IIOP or T3 protocol).
•
The IBM FileNet Application Engine server will use only the EJB transport to communicate
with the Content Engine in the P8 4.0.0 release.
•
The Process Engine web service is used by customer and third-party 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
430
Task 39: Set Up Content Engine and Client Transport SSL Security
To enable SSL for Content Engine
To enable SSL for Content Engine
NOTE In the steps below, a server certificate certificate will be added to the Directory Services
server (for authentication). In addition, the CA certificate will be added in two different locations
on the Content Engine server (the JDK path location is for authorization). Follow the steps closely
to ensure that the proper certificate is added to each of the three locations.
1. Obtain and install a server certificate and a CA certificate on the directory service. These
certificates are available from third-party 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
may 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, in Step a, or create a custom location, in
Step b.
a. To use the JDK default java key store, do the following:
i.
Determine the java version your application server uses and the JAVA_HOME location.
ii.
Use the keytool to import the CA certificate to the Java keystore at
%JAVA_HOME%\jre\lib\security\cacerts.
iii. To improve security, change the default password.
b. To use your own key store (rather than the JDK default key store), do the following:
i.
Add the following system parameters to the Java command line in your application
server’s startup script:
-Djavax.net.ssl.trustStore=<path_to_your_keystore_file>
-Djavax.net.ssl.trustStorePassword=<password_of_your_keystore>
ii.
Use the Java keytool to import the CA certificate to your own keystore.
5. Use Enterprise Manager to enable SSL for Content Engine and set the port number to match the
SSL port on the directory server, as described in “To enable SSL between Enterprise Manager and
the directory service” on page 432.
6. Obtain another server and CA certificate for the Content Engine.
7. Create a custom identity keystore on the Content Engine server, and add the server certificate
to the custom keystore.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
431
Task 39: Set Up Content Engine and Client Transport SSL Security
To enable SSL between Enterprise Manager and the directory service
8. 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.
•
WebLogic
Set up a custom identity keystore. In the left pane of the WebLogic Administration
Console, navigate to DomainName > Servers > ServerName. In the right pane, select
Keystores and SSL and specify the keystore information.
•
WebSphere
Configure an SSL repertoire. In the left pane of the WebSphere administrative console,
navigate to Security > SSL. In the right pane, select your Java TM Secure Socket Extension
(JSSE) repertoire and specify key and trust file names and passwords.
NOTE (WebLogic only) The name in your certificate must match the host name specified in
your WebLogic application server. If the name in the certificate is fully qualified (for example,
Host1.filenet.com), the same fully qualified host name must appear in the Host field
(WebLogic > Authentication Provider > Active Directory tab > Host field).
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
details:
Protocol
SSL
Port
App Server
Sample URL
HTTP
no
7001
WebLogic
<http://mycorp.com:7001/wsi/FNCEWS40DIME/>
HTTPS
yes
7002
WebLogic
<https://mycorp.com:7002/wsi/FNCEWS40DIME/>
T3 (IIOP)
no
7001
WebLogic
t3://mycorp.com:7001/FileNet/Engine
T3S (IIOP)
yes
7002
WebLogic
t3s://mycorp.com:7002/FileNet/Engine
HTTP
no
9080
WebSphere
<http://mycorp.com:9080/wsi/FNCEWS40DIME/>
HTTPS
yes
9403
WebSphere
<https://mycorp.com:9403/wsi/FNCEWS40DIME/>
IIOP
no
2809
WebSphere
iiop://mycorp.com:2809/FileNetEngine
IIOP
yes
9443
WebSphere
iiop://mycorp.com:9443/FileNetEngine
NOTE The port values in the table above are default values. If you change the port that your
application server listens on, you must also change the port number used by the Content
Engine client.
To enable SSL between Enterprise Manager and the directory service
1. Launch Enterprise Manager and log on as a GCD administrator.
2. In the tree view, right-click the root node and choose Properties.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
432
Task 39: Set Up Content Engine and Client Transport SSL Security
To enable SSL between Enterprise Manager and the directory service
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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
433
Task 40: Set Up Application Engine SSL Security
To set up full SSL support on a single Application Server
Task 40: Set Up Application Engine SSL Security
This topic describes how to configure an Application Engine to direct sign-ins through a Secure
Socket Layer (SSL) https connection. It assumes that Application Engine(s) have already been
installed.
IBM FileNet Application Engine supports the following methods of configuring an SSL
environment:
•
Full SSL support - A single Application Engine server, where all of the software is running
under SSL.
•
One server SSL redirect - One Application Engine server set up to redirect logon attempts on
the non-SSL port to the SSL port.
•
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.
To set up full SSL support on a single Application Server
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 one of the following URLs:
https://<Application_Engine_server_name>:<SSL port>/Workplace
The entire sign-in process will be handled by the SSL-enabled host.
For more information about SSL port numbers, see “IBM FileNet P8 Port Numbers” on page 667.
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
b. Sign in as a user with Application Engine Administrator access role privileges. For more
information, see the IBM FileNet P8 help topic User Help > Actions, preferences, and tools >
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.
For more information, see “Enter security info (required for SSL only).” on page 422.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
434
Task 40: Set Up Application Engine SSL Security
To set up SSL redirect on two Application Engine servers
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 User Help > Actions, preferences, and
tools > 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 into Workplace using the following URL:
http://<Application_Engine_server_name>:<non-SSL port>/Workplace
NOTE 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.
To set up SSL redirect on two Application Engine servers
1. Install Application Engine on both computers so that both Application Engines 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. See “Setup
WebLogic clusters” or “Setup WebSphere clones” in the IBM FileNet P8 Platform High
Availability Technical Notice for specific instructions. To download this guide from the IBM
support page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on
page 23.
CAUTION 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
User Help > Actions, preferences, and tools > 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.
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
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
435
Task 40: Set Up Application Engine SSL Security
To set up SSL redirect on two Application Engine servers
server. See “Make a note of the user token crypto key path.” on page 366 for information on the
default location for the UTCryptoKeyFile.properties file.
NOTE IBM recommends copying 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 User Help > Actions, preferences, and tools >
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.
For more information, see “Enter security info (required for SSL only).” on page 422.
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 User Help > Actions, preferences, and
tools > 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
NOTE 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
436
Task 40: Set Up Application Engine SSL Security
Additional procedure for WebSphere 5.1
Additional procedure for WebSphere 5.1
If you are using Workplace Application Integration to connect to port 80 on WebSphere, you need
to enable URL rewriting for SSL sign-in to work properly.
To enable URL rewriting
1. Open the WebSphere administrative console and select Applications > Enterprise Applications
from the left pane. Then select the Application Engine application (the default is
app_engine.war).
2. From Additional Properties, select Web Container.
3. Click Session Management and click Edit Properties.
4. Select Overwrite for Overwrite Session Management.
5. Select Enable URL rewriting for Session tracking mechanism.
6. Click OK, then Save, and Save again to save changes to the Master configuration.
7. Stop and restart the application server.
Using Java Applets in an SSL Environment
If you are using a Java applet in an SSL environment, you may experience an
SSLHandshakeException because the appropriate certificate does not exist on your computer.
Follow the instructions in the the IBM FileNet P8 help topic User Help > Using Workplace > Basics >
Use Java applets to resolve this issue.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
437
Task 41: Perform Additional Configuration Tasks
Task 41: Perform Additional Configuration Tasks
Once you have completed the Installation Tasks, your core IBM FileNet P8 system will be up and
running. Below is a list of additional configuration tasks you should complete (or at least review) to
prepare the system for general use. Except where noted, the links go to the IBM FileNet P8 Help,
and start from the Contents panel in:
<Documentation URL, in the form http://webserver:port#/ecm_help>/_start_here.htm
•
Configure Content Federation Services for Image Services Guidelines. Refer to the IBM
FileNet P8 Content Federation Services for Image Services Guidelines. To download this
guide from the IBM support page, see “Access IBM FileNet Documentation, Compatibility Matrices,
and Fix Packs” on page 23.
•
Configure Application Engine to set the file types you want to open in a browser window rather
than using the Image Viewer. Refer to FileNet P8 Administration > Application Engine
Administration > Key configuration files and logs > content_redir.properties file.
•
Set site preferences for the Workplace application. Refer to User Help > Actions, preferences,
and tools > Site preferences.
•
Design searches and/or search templates for Workplace users. Refer to User Help > Actions,
preferences, and tools > Tools > Search Designer > About Search Designer.
•
Design publishing templates for Workplace users. Refer to User Help > Actions, preferences, and
tools > Tools > Publishing Designer > About Publishing Designer.
•
Configure security for publishing. Refer to User Help > Actions, preferences, and tools > Tools >
Publishing Designer > Security > Specify publication document security.
•
Configure automatic workflow launch. Refer to FileNet P8 Administration > Content Engine
Administration > Events and subscriptions > Concepts: workflow subscriptions.
•
Create and configure the object stores that will contain business objects, folders, documents,
workflow definitions, searches, and other objects. Refer to FileNet P8 Administration > Content
Engine Administration > Object stores > How to... > Create object store.
•
Define document classes and folders and set security for each class. Refer to FileNet P8
Administration > Content Engine Administration > Classes > Concepts.
•
Review and, if necessary, edit the security of the network shared folders containing any file
stores created for the object store. Refer to FileNet P8 Administration > Content Engine
Administration > Content storage > File storage areas.
•
Configure Process Engine for automatic startup. Refer to FileNet P8 Administration > Enterprisewide Administration > Process Task Manager > Process Engine > Process Service > Start and stop
Process Service > Configure the Process Service for automatic startup (Windows).
•
Configure email notification. Refer to FileNet P8 Administration > Process Engine Administration >
Workflow administration tasks > Coordinating workflow design > Email notification.
•
Set Process Engine runtime options. Refer to User Help > Integrating workflow > Process
Configuration Console > VWServices > View or modify VWService properties > Set runtime options.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
438
Task 41: Perform Additional Configuration Tasks
•
Set the default date/time mask for the Process Service. Refer to Process Engine > Process Task
Manager > Process Service > Configuring Process Service > General properties.
•
Create content cache area. Refer to FileNet P8 Administration > Content Engine Administration >
Content storage > Content cache areas > How to... > Create content cache.
•
Create additional authentication realms. Refer to FileNet P8 Administration > Enterprise-wide
Administration > FileNet P8 Security > How to > Configure for multiple realms.
•
Define additional isolated regions. Refer to User Help > Integrating workflow > Process
Configuration Console > Isolated regions.
•
For each isolated region:
–
Define workflows. Refer to User Help > Integrating workflow > Process Designer.
–
Configure event logging options. Refer to User Help > Integrating workflow > Process
Configuration Console > Isolated regions > View or modify isolated region properties > Configure
event logging options.
–
Configure step processors. Refer to User Help > Integrating workflow > Process Configuration
Console > Isolated regions > View or modify isolated region properties >Configure custom step
processors.
–
Define and configure work queues. Refer to User Help > Integrating workflow > Process
Configuration Console > Queues > Configuring work queues.
–
Define and configure component queues. Refer to User Help > Integrating workflow > Process
Configuration Console > Queues > Configuring component queues.
–
Define and configure workflow rosters. Refer to User Help > Integrating workflow > Process
Configuration Console > Queues > Rosters.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
439
Optional Installation Tasks
To install optional IBM FileNet P8 components
Optional Installation Tasks
To install optional IBM FileNet P8 components
NOTE You can install the additional or optional IBM FileNet P8 components listed below in any
order.
•
Install and configure IBM FileNet Publishing components. Do Task 42 on page 441.
•
Enable Process Engine Component Integrator. Do Task 43 on page 442.
•
Install Enterprise Manager on a dedicated computer. Do Task 44 on page 445.
•
Set up remote Content Engine file storage areas. Do Task 45 on page 446.
•
Install Workplace Application Integration. Do Task 46 on page 447.
•
Install File Tracker. Do Task 47 on page 451.
•
Deploy Multiple Content Engine Instances. Do Task 48 on page 454.
•
Deploy Content Engine to Other Application Servers. Do Task 49 on page 455.
•
Deploy Multiple Application Engine Instances. Do Task 50 on page 461.
•
Install additional Content Search Engine administration servers. Do Task 51 on page 464.
•
Enable Application Engine to use ISRA. Do Task 52 on page 468.
•
Set up IBM FileNet System Manager. Do Task 53 on page 473.
•
Install interim fixes for optional components. Do Task 54 on page 474.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
440
Task 42: Install and Configure IBM FileNet Publishing
Task 42: Install and Configure IBM FileNet Publishing
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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
441
Task 43: Enable the Process Engine Component Integrator
To specify the user name and password for the Java adaptor (on an Application Engine server)
Task 43: Enable the Process Engine Component
Integrator
Via 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 described in this task.
As a post-installation task, you will also have to define workflows that incorporate Content Engine
(CE) 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 Steps > Component Steps >
General Properties > Using Content Engine (CE) operations in a workflow.
Once 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 Java object or
Java TM Messaging Service (JMS) messaging system. For further information, see the IBM FileNet
P8 help topic Developing Process Applications > Developing Work Performers / Component Integrator
Operations > Developing Component Integrator-Based Workflow Applications.
To specify the user name and password for the 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 “Configure Process Task Manager” on page 352), 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.
NOTE 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 enter the
following settings:
•
Clear the Internet Explorer option.
•
If you will be using Netscape 6.0, select the Netscape 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).
3. Select the Isolated Region icon that corresponds to the isolated region you initialized in “Create
a Process Engine Isolated Region” on page 426.
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 (PE) 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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
442
Task 43: Enable the Process Engine Component Integrator
To configure and start the Component Manager (on an Application Engine server)
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.
To configure and start the Component Manager (on an Application Engine server)
Execute Step 1 below if Application Engine is configured to use maximum strength encryption. The
JRE used to run the Process Task Manager that contains the Component Manager (which uses
JDK 1.4.x) must be updated with Unlimited Strength Jurisdiction Policy Files. Otherwise proceed
to Step 2 below.
1. Install unlimited strength JAR files.
NOTE Perform this step only if you are using JDK 1.4 or higher and have selected the Create
unlimited strength keys option in the Application Engine User Security and/or User Token
Security steps of the Application Engine Setup program. Failure to perform the step will cause
EncryptionException messages or other errors indicating that a Java Security API provider for
Blowfish is not available. The EncryptionException is caused by the wrong versions of (or
absence of) required JAR files that provide unlimited strength security policy files in a Sun
JDK 1.4 or higher environment.
For more information, see the IBM FileNet P8 help topic FileNet P8 Administration > Application
Engine Administration > Application Engine Security.
a. Obtain the JDK version-specific unlimited strength JAR files, as follows:
•
For the IBM JDK, obtain the IBM unlimited jurisdiction policy files from the IBM web
site (http://www.ibm.com/developerworks/java/jdk/security).
•
For the Sun JDK, obtain the Sun unlimited strength policy files from the Sun product
web site (http://java.sun.com/j2se/).
CAUTION Make sure you install JAR files specific to the JDK version you are using.
b. Install the files into the JRE's /jre/lib/security folder by replacing files with the same names.
c. Restart the application server.
2. Start Process Task Manager on the Application Engine server.
Launch the Process Task Manager by running one of the following command files from the
<AE_install_path>/FileNet/AE/Router directory, depending on your operating system:
UNIX
routercmd.sh
Windows
routercmd.bat
NOTE If the port number assigned to Component Manager conflicts with the port number
required by another application or service running on the Application Engine server, then
Process Task Manager will not start up as expected. See “IBM FileNet P8 Port Numbers” on
page 667 for details on how to resolve this condition.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
443
Task 43: Enable the Process Engine Component Integrator
To specify connection between Process Engine and Component Manager (on a Process Engine server)
3. Select Component Manager in the left pane (also referred to as the feature pane).
4. Right-click and select New to define a new connection point. You will be prompted to enter the
Content URI, Service Username, and Service Password to authenticate to the Content Engine
server.
5. Enter or modify the component properties as appropriate. For details, see the IBM FileNet P8
help topic FileNet P8 Administration > Enterprise-wide Administration > Process Task Manager >
Application Engine > Component Manager > Configure the Component Manager -> General.
NOTE 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.
6. Click Start on the toolbar.
To specify connection between Process Engine and Component Manager (on a Process Engine
server)
1. On the Process Engine server, start Process Task Manager as follows, depending on your
operating system:
Windows
Select Start > Programs > FileNet P8 Platform > Process Engine > Process Task Manager.
UNIX
Enter the following command on the command line:
vwtaskman
2. Select Process Engine in the left pane (also referred to as the feature pane).
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.
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 in
Step 3 of “To configure and start the Component Manager (on an Application Engine server)” on
page 443.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
444
Task 44: Install an Additional Instance of Enterprise Manager
To install an additional instance of Enterprise Manager,
Task 44: Install an Additional Instance of Enterprise
Manager
Do this task only if you want to install an instance of Enterprise Manager in addition to the one you
installed in “Install Enterprise Manager” on page 217.
CAUTION Do not install Enterprise Manager 4.0.x on any machine running the 3.5.x version, at
least until the Content Engine 4.0.x upgrade is complete. Otherwise, you will no longer be able to
run Enterprise Manager 3.5.x against any remaining 3.5.x object stores.
NOTE You can install Enterprise Manager only on a Windows machine, and only using the
Windows version of the Content Engine installation media.
To install an additional instance of Enterprise Manager,
1. If you have not already done so, install Microsoft .NET Framework 2.0 and Web Services
Enhancements (WSE) 3.0. Enterprise Manager on the Windows machine where you are going
to install Enterprise Manager.
2. Do a silent or interactive installation of Enterprise Manager as shown in “Install Enterprise
Manager” on page 217.
3. Go to “Install Content Engine Software Updates” on page 204 to install service packs, fix packs
and/or interim fixes required for Content Engine software.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
445
Task 45: Create Additional File Storage Areas
To create a file storage area
Task 45: Create Additional File Storage Areas
Do 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 FileNet P8 Administration >
Content Engine Administration > Content storage > Fixed storage areas.
Do the following procedures for each file storage area you want to create.
To create a file storage area
1. Prepare a location for the file storage area, as shown in “Prepare Storage Areas for Object Stores”
on page 95, and then continue at Step 2.
2. Start Enterprise Manager.
3. Select a FileNet P8 domain and log on as an administrator of the object store in which you will
create a file storage area.
4. Right-click the Storage Areas node and then choose New Storage Area.
5. When the Create a Storage Area wizard opens, click Next and complete the wizard screens as
shown in the IBM FileNet P8 help topic FileNet P8 Administration > Content Engine Administration >
Content Engine Wizard Help > Create a Storage Area.
Before storing content in the file storage area, do the following procedure to verify that it was
properly created.
To verify the file storage area
1. Log on to the machine where Content Engine Server is installed.
2. List the contents of <fsa1>, the directory you created or designated on the file server in one of
the following procedures:
•
(UNIX) “To configure a UNIX-based file server” on page 98
•
(Windows) “To configure a Windows-based file server for a Windows client using CIFS” on
page 98
•
(Windows) “To configure a Windows-based file server for a UNIX client using NFS” on page 99
3. Verify that <fsa1> contains an XML file, named fn_stakefile, and two subdirectories, content and
inbound.
NOTE On UNIX machines, the content and inbound subdirectories must remain in the same
file system.
4. Verify that <fsa1> has the ownership and access permissions you specified.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
446
Task 46: Install Application Integration
To install the Application Integration software interactively
Task 46: Install Application Integration
Install Application Integration if you want to integrate IBM FileNet Workplace with your Microsoft
Office applications and Outlook. Complete the following procedure on each machine that will use
Workplace Application Integration.
NOTE You cannot collocate Workplace Application Integration with clients running IDM Desktop
Application Integration.
Verify that the client machine meets the platform requirements documented in the IBM FileNet P8
Hardware and Software Requirements. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
To install the Application Integration software interactively
1. Log onto 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 do one of
the following:
•
Click Open to run the program from its current location.
•
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. Once 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:
•
Select the applications you want to integrate, and then click Next.
NOTE The Application Integration Toolkit Components option is required to use
Application Integration.
•
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.
NOTE You may 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
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
447
Task 46: Install Application Integration
To install the Application Integration software silently
server’s assigned port, application is the directory where you installed the IBM FileNet
Workplace application files.
Check Server uses secure connection (SSL) if you are running full SSL to encrypt all
communication with Workplace.
NOTE 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.
To install the Application Integration software silently
1. Log onto 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:
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.
Refer to 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"
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
448
Task 46: Install Application Integration
To verify your Workplace Application Integration installation
Command Line Values
Installs
ADDLOCAL=ALL
All Features
ADDLOCAL=ALL
REMOVE=OutlookIntegrationFeature
Office Only
ADDLOCAL=ALL
REMOVE=OfficeIntegrationFeature
Outlook Only
ADDLOCAL=ALL
REMOVE=OutlookIntegrationFeature,
OfficeIntegrationFeature
Core Only
Command Line Values
Settings
HOST=<host name>
Enter the name of the web server running
Workplace.
PORT=<port number>
Enter the web server’s assigned port number.
APPLICATION=<application name>
Enter the directory in which you installed the
Workplace application files.
SERVER_CONNECTION=1
Set Application Integration to use an https
connection
SERVER_CONNECTION=0
Set Application Integration to use http
connection. This is the default if this
parameter is not passed.
/L*v C:\temp\AppIntSetup.txt
Verbose installation log and specify log
location.
To verify your Workplace Application Integration installation
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 using any valid domain account. The available object stores in your environment are
displayed.
NOTE If you didn’t enter the Workplace Address information in Step 8 above, enter the server
name, port number and application name that defines the Workplace address. The server
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
449
Task 46: Install Application Integration
To uninstall or modify Workplace Application Integration
name is the name of the web server running Workplace, port number is the web server’s
assigned port, application is the directory where you installed the IBM FileNet 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
login.
4. Close all dialog boxes and close Microsoft Word.
To uninstall or modify Workplace Application Integration
1. From the Start menu, click Settings, and then click Control Panel.
2. Click Add/Remove Programs, and then click FileNet Workplace Application Integration 4.0.
3. Do one of the following:
•
Click Remove, and then click Yes to confirm you want to uninstall Workplace Application
Integration.
•
Click Change to access maintenance tasks, and then click Next. You can modify, repair, or remove
Application Integration using the maintenance tasks.
Do one of the following:
–
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 using this option. The Custom Setup dialog
box appears, where you highlight 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. Once the application is removed from your system, click
Finish to complete the process.
To silently uninstall Workplace Application Integration
1. Open a command prompt.
2. Enter the following command to uninstall Workplace Application Integration:
msiexec.exe /X{35907B7D-02E2-490C-8F3B-54C4E3729D90} /qn
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
450
Task 47: Install File Tracker
To install the File Tracker software interactively
Task 47: Install File Tracker
Install File Tracker if you want to use the Workplace file tracking feature without installing
Application Integration. Complete the following procedure on each machine that will use
Workplace File Tracker.
NOTES
•
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. For details about the
upgrade process, see “Upgrade Application Integration and File Tracker” on page 587.
Verify that the client machine meets the platform requirements documented in the IBM FileNet P8
Hardware and Software Requirements. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
To install the File Tracker software interactively
1. Log onto the client machine using an account that has Administrator privileges.
2. Log into Workplace.
3. Click Author, and then click General Tools.
4. Scroll down and click Download File Tracker and do one of the following:
•
Click Open to run the program from its current location.
•
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. Once 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.
7. 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.
•
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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
451
Task 47: Install File Tracker
To install the File Tracker software silently
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.
To install the File Tracker software silently
1. Log onto the client machine using an account that has Administrator privileges and log into
Workplace.
2. Click Author, and then click General Tools.
3. 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 where FileTracker.exe
resides.
5. Type the following at the command line:
FileTracker.exe /s /v"/qn <additional msi arguments included in string>
LICENSE_ACCEPTED=true"
NOTE 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"
Command Line Values
Settings
/L*v C:\temp\FileTrackerSetup.txt
Verbose installation log and specific log
location.
NOTE 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.
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.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
452
Task 47: Install File Tracker
To uninstall Workplace File Tracker
d. Click OK, and OK again to save changes.
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.
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
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
453
Task 48: Deploy Multiple Content Engine Instances
Task 48: Deploy Multiple Content Engine Instances
You can deploy multiple instances of Content Engine on a single application server. Moreover, the
instances do not need to all have the same database type or directory server.
To prepare for deploying a subsequent instance of Content Engine on an application server, you
will do only the applicable tasks in “Prerequisite Tasks” on page 50 and “Installation Tasks” on
page 156.
1. As needed, configure the directory server for your subsequent Content Engine instance.
2. Do the database task for your subsequent Content Engine instance.
For example, if the initial instance uses DB2 for its database, and a subsequent instance will
use MS SQL Server, do the prerequisite MS SQL Server task. Even if your Content Engine
instances will all use the same database type, you must create at least a GCD database/
tablespace for each instance.
3. For each Content Engine instance, set up a dedicated configuration on your particular
application server, as follows:
•
Create and configure a WebSphere profile, as shown in “Configure an Application Server for
Content Engine (WebSphere)” on page 134.
•
Create and configure a WebLogic domain, as shown in “Configure an Application Server for
Content Engine (WebLogic)” on page 138.
•
Set up and configure a JBoss server, as shown in “Configure an Application Server for
Content Engine (JBoss)” on page 146.
4. “Install and Deploy Content Engine” on page 187.
5. Do all subsequent Content Engine-related tasks in “Installation Tasks” on page 156.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
454
Task 49: Deploy Content Engine to Other Application Servers
Deploy Content Engine Into a Non-Managed Server Environment
Task 49: Deploy Content Engine to Other Application
Servers
After doing the first installation and deployment of Content Engine on an application server, you
can deploy Content Engine to additional application servers of the same type (for example, if the
first deployment of Content Engine is on a WebSphere server, each additional deployment of
Content Engine must be on a WebSphere server).
If you deployed Content
Engine to a server that ...
Continue at...
Does not function as an
administrative server for
your application server
environment,
“Deploy Content Engine Into a Non-Managed Server Environment” on
page 455 to deploy Content Engine to additional machines.
Does function as an
administrative server for
your application server
environment
“Deploy Content Engine Into a Managed Server Environment” on
page 457 to redeploy Content Engine to managed server instances
that will run Content Engine.
Deploy Content Engine Into a Non-Managed Server Environment
Use one of the following procedures to deploy Content Engine from one (source) application
server to another (destination) application server
To deploy Content Engine to another WebSphere server
1. Create a profile for Content Engine on the destination WebSphere server (see “Configure an
Application Server for Content Engine (WebSphere)” on page 134).
2. Copy the file Engine-ws.ear (the Content Engine EAR file) from the source WebSphere server to
to the destination WebSphere server, for example (on a UNIX machine) /opt/FileNet/
ContentEngine/lib/Engine-ws.ear.
3. Log on to the WebSphere administrative console on the destination WebSphere server.
4. Deploy Content Engine, as follows:
a. Navigate to Applications > Install New Application.
b. Click Local file system and browse to the file Engine-ws.ear file and click Next.
c. Accept defaults for all options except the following: provide options to perform the EJB
deploy
d. Accept defaults for most options except the following:
e. Provide options to perform the EJB Deploy: Change Database Type to the desired database
(e.g., ORACLE_v9).
f.
At the last page, click Finish and the application server will start the actual deployment.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
455
Task 49: Deploy Content Engine to Other Application Servers
To deploy Content Engine to another WebSphere server
g. Update the master configuration by selecting Save on the toolbar then click the Save button.
5. Assign FileNet configuration property values, as follows:
a. Navigate to Applications > Enterprise Applications > FileNetEngine.
b. Change the following configuration settings to the values shown and then click Apply:
•
Classloader Mode: PARENT_LAST
•
WAR Classloader Policy: Application
c. Click Apply.
6. (WebSphere 5.1.x and 6.0.x only) Assign values to the connection factory properties, as follows:
a. Navigate to Applications > FileNetEngine > Connector Modules > engine.rar > Resource
Adaptor.
b. Click J2C Connection Factories.
c. Click New.
d. Set the connection factory values, as follows:
•
Name: FileNetConnectionFactory
•
JNDI: FileNet/Local/ConnectionFactory
•
Authentication Preference: None
•
Component-managed Authentication Alias: <node name>/<J2C connection alias for
GCD DB user>
e. Click Apply.
7. (WebSphere 6.1 only) Assign values to the connection factory properties, as follows:
a. Navigate to Enterprise Applications > FileNetEngine > Manage Modules > engine.rar >
FileNetEngine.FileNet P8 Connector > J2C connection factories.
b. Click New.
c. Set the connection factory values, as follows:
•
Name: FileNetConnectionFactory
•
JNDI: FileNet/Local/ConnectionFactory
•
Container-managed authentication alias: None
•
Authentication Preference: None
•
Mapping-configuration alias: None
8. Assign values to the connection pool properties, as follows:
a. Click Connection Pool.
b. Set the connection pool values, as follows:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
456
Task 49: Deploy Content Engine to Other Application Servers
To deploy Content Engine to another WebLogic server
•
Connection Timeout: 1000
•
Max Connections: 100
•
Min Connections: 10
c. Click Apply.
9. Update the master configuration by selecting Save on the toolbar then click the Save button
10. Navigate to Applications > Enterprise Applications and verify that FileNet Engine is listed.
11. Click Start to verify that Content Engine Server starts.
12. (Optional) To access Centera fixed content devices from this server, continue at “Install Centera
Shared Libraries” on page 212.
To deploy Content Engine to another WebLogic server
1. Create a domain for Content Engine on the destination WebLogic server (see “Configure an
Application Server for Content Engine (WebLogic)” on page 138).
2. Locate the file Engine-wl.ear on the source WebLogic server.
3. Copy the file Engine-wl.ear to a directory in the domain you created in the destination WebLogic
server in Step 1.
4. Stop and start the destination WebLogic server.
5. (Optional) To access Centera fixed content devices from this server, continue at “Install
Centera Shared Libraries” on page 212.
To redeploy Content Engine to a managed JBoss server
JBoss does not have a centralized management server for administering multiple JBoss servers.
If you wish to create another Content Engine on JBoss, but do not want to leverage using a JBoss
farm (cluster) with a load balancer, just repeat the following tasks on another JBoss server:
•
“Install and Deploy Content Engine” on page 187
•
“Install Content Engine Software Updates” on page 204
•
“Complete Post-Install Content Engine Configuration” on page 212
When not using a load balancer, you must statically distribute your Content Engine clients (such
as Application Engine servers) between the multiple Content Engine servers on JBoss.
For details on how to leverage JBoss clusters (farms) using a load balancer, see the IBM
FileNetP8 High Availability Technical Notice. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Deploy Content Engine Into a Managed Server Environment
Use one of the following procedures to redeploy Content Engine from an administrative server to a
managed server instance.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
457
Task 49: Deploy Content Engine to Other Application Servers
To redeploy Content Engine to a managed WebSphere server
To redeploy Content Engine to a managed WebSphere server
1. Start the WebSphere administrative console (if it is not already running).
2. Undeploy the Content Engine using WebSphere administrative console on the deployment
manager node, as follows:
a. Navigate to Applications > Enterprise Applications, select the FileNet Engine application,
and click Uninstall.
b. Save your changes and synchronize the configuration with all nodes in the cell.
c. Restart the deployment manager instance, all node agents, and application server instances
in the cell which will host the Content Engine application. Wait until all instances have
restarted before continuing to next step.
3. (WebSphere 5.1.1 only) Deploy the Content Engine application to the managed nodes in the
application server configuration, as follows:
a. Navigate to Applications > Install New Application , select the file Engine-ws.ear, or type the
full path to the file, and then click OK.
By default, Engine-ws.ear has the following path:
•
(UNIX) <Content Engine Install Path>/FileNet/ContentEngine/lib
•
(Windows) <Content Engine Install Path>\FileNet\Content Engine\lib
b. Accept the defaults in the Preparing for the application installation/You can choose to
generate default bindings and mappings screen.
c. Accept the defaults in the screen Install New Application\Step 1:Provide options to perform
the installation.
d. On the screen Install New Application\Step 2:Provide options to perform the ejb deploy,
select the database type used in the configuration from the Deploy EJBs Option - Database
Type drop-down box, and then click Next.
Select the check box next to each of the modules listed, and then click Apply. The server
field for each module should now appear with the values selected in the Clusters and
Servers selection box. Click Next.
e. Accept the defaults in the screen Install New Application\Step 3:Provide JNDI Names for
Beans.
f.
Accept the defaults in the screen Install New Application\Step 4:Map EJB references to
beans screen.
g. Accept the defaults for the screen Install New Application\Step 5:Map virtual hosts for web
modules.
h. On the screen Install New Application\Step 6:Map modules to servers, select the server
names that will provide access to Content Engine from the Clusters and Servers selection
box.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
458
Task 49: Deploy Content Engine to Other Application Servers
To redeploy Content Engine to a managed WebSphere server
i.
4.
On the screen Install New Application\Step 7:Summary, review the summary and click
Finish.
(WebSphere 6.0.2 only) Deploy the Content Engine application to the managed nodes in the
application server configuration, as follows:
a.
Navigate to Applications > Install New Application, select the file Engine-ws.ear, or type the
full path to the file, and then click OK.
By default, Engine-ws.ear has the following path:
•
(UNIX) <Content Engine Install Path>/FileNet/ContentEngine/lib
•
(Windows) <Content Engine Install Path>\FileNet\Content Engine\lib
b. Accept the defaults in the screen Preparing for the application installation/Choose to
generate default bindings and mappings.
c. Accept the defaults in the screen Install New Application\Step 1:Select installation options.
d. On the screen Install New Application\Step 2:Map modules to servers," select the server
name, and any web servers that will provide access to Content Engine from the Clusters and
Servers selection box.
Select the check box next to each of the modules listed, and then click Apply. The server
field for each module should now show up with the values selected in the Clusters and
Servers selection box. Click Next.
e. On the screen Install New Application\Step 3:Provide options to perform the ejb deploy,
select the database type used in the configuration from the Deploy EJBs Option - Database
Type drop-down box, then click Next.
f.
Accept the defaults in the screen Install New Application\Step 4:Provide JNDI Names for
Beans.
g. Accept the defaults in the screen Install New Application\Step 5:Map JCA resource
references to resources.
h. Accept the defaults in the screen Install New Application\Step 6:Map EJB references to
beans.
i.
Accept the defaults in the screen Install New Application\Step 7:Map virtual hosts for web
modules.
j.
On the screen Install New Application\Step 8:Summary, review the summary and click
Finish.
5. Perform post-deployment tasks, as follows:
a. After the application has been loaded and configured in WebSphere, save the changes and
synchronize all nodes.
b. Continue at Step 5 on page 456.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
459
Task 49: Deploy Content Engine to Other Application Servers
To redeploy Content Engine to a managed WebLogic 8.1.x server
To redeploy Content Engine to a managed WebLogic 8.1.x server
1. If they aren’t already running, start all instances of WebLogic Server in the WebLogic domain,
including the administrative server.
2. From the WebLogic Server Administration Console, go to the Target & Deploy tab for each of
the connection pools and data sources created for the GCD database.
3. Select the check box next to the WebLogic instances that will be running Content Engine, clear
the check box next to the administration server name, and click Apply. This will redeploy Content
Engine to the managed servers (WebLogic instances) you selected.
4. Select Engine-wl from the WebLogic Administration Console.
5. Select the Targets tab for the application, and select the check boxes next to the WebLogic
instances that will be running Content Engine. Clear the check box for the administration server
name and click Apply.
6. Restart all administration server instances and managed nodes.
To redeploy Content Engine to a managed WebLogic 9.2.x server
1. If they aren’t already running, start all instances of WebLogic Server in the WebLogic domain,
including the administrative server.
2. From the WebLogic Server Administration Console, go to the Target tab for data sources created
for the GCD database and click Lock & Edit
3. Select the check box next to the WebLogic instances that will be running Content Engine and
clear the check box next to the administration server name. This will redeploy content Engine to
the managed servers (WebLogic instances) you selected.
4. Select Engine-wl from the WebLogic Administration Console.
5. Select the Targets tab for the application and select the check boxes next to the WebLogic
instances that will be running Content Engine. Clear the check box for the administration server
name.
6. Click Activate Changes.
7. Restart all administration server instances and managed nodes.
To redeploy Content Engine to a managed JBoss server
JBoss does not have a central management system, so there is no procedure for redeploying
Content Engine in a managed environment.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
460
Task 50: Deploy Multiple Application Engine Instances
To deploy a second instance of the Workplace application
Task 50: Deploy Multiple Application Engine Instances
This topic covers deployment of 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 may use different Site Preference settings and
may provide access to different object stores.
NOTES
•
The following procedure assumes that you have already installed Application Engine and
performed the following configuration tasks according to your application server type:
–
“Configure Application Engine (WebSphere)” on page 369
–
“Configure Application Engine (WebLogic)” on page 388
–
“Configure Application Engine (JBoss)” on page 396
•
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.
•
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
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
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
461
Task 50: Deploy Multiple Application Engine Instances
To deploy each additional Workplace instance as an EAR file
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 (in bold):
<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>
To deploy each additional Workplace instance as an EAR file
NOTE Perform the following steps for each custom Workplace instance you plan to deploy.
1. Modify the application.xml file located in the copied deploy directories:
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 (shown in bold, below).
<display-name>Workplace1</display-name>
<description>FileNet Application Engine</description>
<module>
<web>
<web-uri>app_engine.war</web-uri>
<context-root>Workplace1</context-root>
</web>
</module>
2. In the create_app_engine_war file, change the install_home path and the deploy directory to
match your custom names.
For example, you would make the following changes, shown in bold.
install_home=”/opt/FileNet/AE/Workplace1”
"${install_home}/../_AEjvm/bin/jar" -cf "${install_home}/../deploy1/app_engine.war"*
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
462
Task 50: Deploy Multiple Application Engine Instances
To deploy each additional Workplace instance as an EAR file
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, shown in bold.
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 provided
for your application server type:
•
“Deploy Application Engine (WebSphere)” on page 403
•
“Deploy Application Engine (WebLogic)” on page 409
•
“Deploy Application Engine (JBoss)” on page 412
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
463
Task 51: Install Additional Content Search Engine Servers
To install an Autonomy K2 Administration Server on Windows
Task 51: Install Additional Content Search Engine
Servers
This task describes how to install and configure additional Autonomy K2 Administrative Servers
for IBM FileNet P8 Content Search Engine, an optional component based on the Autonomy K2
product. This task is required for both new installations and upgrades. In effect, you will set up
Autonomy K2 Administration Servers required for any multi-server K2 configuration.
NOTE To install the Content Search Engine software silently, you can create your own script to
run the command-line steps presented in the procedures in this topic.
To install an Autonomy K2 Administration Server on Windows
1. Create the required accounts and groups and related permissions as specified in “To create
Content Search Engine accounts” on page 93.
2. Access the host machine and log on to the directory service as K2 Operating System User .
NOTE Ensure K2 Operating System User is an operating system administrator on the host
machine.
3. Insert the IBM FileNet Autonomy K2 installation CD and extract the contents of K2-win.zip to the
following location:
C:\Program Files\filenet\contentengine\verity
4. Set the Java_Home environment variable as follows:
a. Open the System control panel.
b. Click the Advanced tab.
c. Click Environment Variables.
d. Click New.
e. Set the variable information as follows:
Variable name: Java_Home
Variable value: <Java1.5.0xx_JDK_install_path>
5. Open C:\Program Files\filenet\contentengine\verity\config.vcnf in a text editor and make the
following modifications in the file:
•
Replace the instance of <myMode> with Local.
•
Replace all instances of <myLocalHostName> with the name of the machine on which you are
installing.
•
Replace all instances of <myMasterHostName> with the machine name that the K2 Master
Administration Server is installed on.
•
Replace all instances of <installDir> with C:\Program Files\filenet\contentengine\verity.
•
Replace the instance of <JavaHome> with the path to the installed Java 1.5.0_xx JDK.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
464
Task 51: Install Additional Content Search Engine Servers
To install an Autonomy K2 Administration Server on UNIX
6. Open a command line and change directory to C:\Program Files\filenet\contentengine\verity.
7. Enter the following at the command line and substitute the applicable value for each variable:
k2\_nti40\bin\vconfig -cfg "c:\program
files\filenet\contentengine\verity\config.vcnf" -dir "c:\program
files\filenet\contentengine\verity" -username "<K2 Security User>" -pwd "<password>"
-domain "<domain>" -verbose -log log.txt
The Autonomy K2 Administration Server service will be installed and running at the
completion of the vconfig command.
8. Set K2 Administration Server service to run as K2 Operating System User, as follows:
a. Access Component Services.
b. Stop the Verity K2 6.1.1 Administration Server service.
c. Change the logon settings and set the service to Log On as K2 Operating System User.
d. Start the Verity K2 6.1.1 Administration Server service.
9. See “Configure Content Engine for Content-Based Retrieval” on page 415 to configure this
Autonomy K2 installation.
To install an Autonomy K2 Administration Server on UNIX
NOTE For HP-UX installations, manually configure the kernel with following parameters:
Value
Setting
maxdsiz
1.9 Gbytes (0x7B033000)
maxfiles
2048 Kbytes
maxfiles_lim
2048 Kbytes
maxssiz
160 Mbytes (0xA000000)
max_thread_proc
1024
maxswapchunks
8192
maxtsiz
1 Gbyte (0x40000000)
maxuprc
512
maxusers
128
nkthread
1024
nproc
517
1. Create the required accounts and groups and related permissions as specified in “To create
Content Search Engine accounts” on page 93.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
465
Task 51: Install Additional Content Search Engine Servers
To install an Autonomy K2 Administration Server on UNIX
2. Insert the IBM FileNet Autonomy K2 installation CD and extract the contents of K2<platform>.tar.gz to /opt/verity using the following commands:
a. gzip -d <platform>.tar.gz
b. tar -xvf <plaftorm>.tar
NOTE If you install to a directory other than /opt/verity, you must create a soft link using the
following command:
ln –s <InstallPath> /opt/verity
3. Change directory to /opt/verity.
4. Edit /opt/verity/config.vcnf as follows:
•
Replace the instance of <myMode> with Master.
•
Replace all instances of <myLocalHostName> with the name of the machine on which you are
installing.
•
Replace all instances of <myMasterHostName> with the name of the machine on which you are
installing.
•
Replace the instance of <JavaHome> with the path to the installed Java 1.5.0_xx JDK.
5. Set the Java_home variable:
JAVA_HOME=/usr/java/jdk1.5.0_09_xx
export JAVA_HOME
NOTE Enter the Java_home variable in the .profile file to set this variable each time the
user logs in.
6. Append the following environment variables according to your platform:
(HP-UX)
•
PATH=$PATH:/opt/verity/k2/_hpux/bin
export PATH
•
SHLIB_PATH=$SHLIB_PATH:/opt/verity/k2/_hpux/bin
export SHLIB_PATH
(AIX)
•
PATH=$PATH:/opt/verity/k2/_rs6k43/bin
export PATH
•
LIBPATH=$LIBPATH:/opt/verity/k2/_rs6k43/bin
export LIBPATH
(Solaris)
•
PATH=$PATH:/opt/verity/k2/_ssol26/bin
export PATH
•
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/verity/k2/_ssol26/bin
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
466
Task 51: Install Additional Content Search Engine Servers
To configure Autonomy K2 Administration Servers from the K2 Dashboard
export LD_LIBRARY_PATH
(Linux)
•
PATH=$PATH:/opt/verity/k2/_ilnx21/bin
export PATH
•
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/verity/k2/_ilnx21/bin
export LD_LIBRARY_PATH
7. Change directory to /opt/verity/ and enter:
k2/<platform>/bin/vconfig -cfg "/opt/verity/config.vcnf" -dir "/opt/verity" verbose -log log.txt
Substitute one of the following for <platform>:
•
_ssol26 (Solaris 8.0, 9.0 or 10.0)
•
_hpux (HP-UX 11i with -AA compiler flag)
•
_rs6k43 (AIX 5.2 and 5.3)
•
_ilnx21 (Red Hat Advanced Server 3.0 and 4.0, SUSE 8 and 9)
The Autonomy K2 Administration Server service and Tomcat will be installed and running at
the completion of the vconfig command.
To configure Autonomy K2 Administration Servers from the K2 Dashboard
If you are adding Content Search Engine to an already functioning and updated IBM FileNet P8
Platform system, skip to Task 22 Install Content Search Engine Software Updates to apply any
available service packs, fix packs and/or interim fixes and then complete Task 34 Configure Content
Engine for Content-Based Retrieval. Otherwise, move on to Task 12 "Install and Deploy Content Engine"
on page 187.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
467
Task 52: Enable Application Engine to Use ISRA
ISRA SSL support
Task 52: Enable Application Engine to Use ISRA
Image Services Resource Adapter (ISRA) is a J2EE connector to the FileNet Image Services (IS)
libraries. Using ISRA, Workplace users can view IS documents and their associated annotations
in the FileNet P8 Image Viewer and, if they have the appropriate permissions, update the
annotations.
To enable Workplace users to view documents using ISRA, the following steps must be
completed:
•
Install the Application Engine.
•
Install FileNet ISRA.
For information on installing, configuring and deploying FileNet ISRA, refer to the Image
Services Resource Adapter documentation on the FileNet ISRA Installation CD.
TIP Use the Sample Application shipped with FileNet ISRA to confirm that the ISRA
installation was successful.
WARNING 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 install. Changing this variable can cause
conflicts when accessing documents.
•
•
Install the Application Engine ISRA Servlet.
–
Deploy the servlet on the same application server as FileNet ISRA.
–
You need not the servlet with the Application Engine.
–
Install and deploy ISRA before installing and deploying the ISRA Servlet.
Configure Workplace Site Preferences.
ISRA SSL support
The following table details supported SSL configurations for ISRA.
SSL Configuration
SSL Support
ISRA Servlet and AE Collocated. AE configured
for SSL logon redirect to a non-local host.
Supported
ISRA Servlet and AE Collocated. AE Configured
for SSL logon redirect to a local host.
Supported
ISRA Servlet and AE Collocated. AE, and ISRA
Servlet running under SSL.
Not Supported
ISRA Servlet remote from AE. AE configured for
SSL logon redirect to a non-local host.
Supported
ISRA Servlet remote from AE. AE configured for
SSL logon redirect to a local host.
Supported
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
468
Task 52: Enable Application Engine to Use ISRA
To install and deploy the Application Engine ISRA Servlet
SSL Configuration
SSL Support
ISRA Servlet remote from AE. AE running under
SSL, ISRA Servlet not running under SSL.
Supported
ISRA Servlet remote from AE. AE, and ISRA
Servlet running under SSL.
Not Supported
To install and deploy the Application Engine ISRA Servlet
The FileNet P8 Application Engine installation software contains the ISRA servlet installation
programs for the supported P8 AE operating systems.
1. Log on to the application server.
UNIX - logon as a user with write access to the /bin directory and read, write, execute access
to the directory where you plan to install ISRA Servlet.
Windows - logon as a member of the local Administrators group or as a user with equivalent
permissions.
2. Stop the application server if it is running.
3. Access the ISRA installation package, and start the Application Engine ISRA Servlet Setup
wizard:
UNIX - Execute <Platform>filenet_ae_israservlet_setup.bin.
Windows - Execute WINfilenet_ae_israservlet_setup.exe
4. Complete the Setup screens as follows:
In this screen...
Perform this action...
License Agreement
Review and accept the license agreement for FileNet P8
software.
Directory Name
For the Directory Name field, enter or browse to the location
where you want to install the ISRA Servlet, or accept the default
location:
•
UNIX - /opt
•
Windows - C:\Program Files\
UNIX
<AE_israservlet_install_path>/FileNet/
ApplicationEngineISRAServlet>
Windows
<AE_israservlet_install_path>\FileNet\ApplicationEngineI
SRAServlet>
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
469
Task 52: Enable Application Engine to Use ISRA
To install and deploy the Application Engine ISRA Servlet
In this screen...
Perform this action...
Create war File
Check this box if you use a WebSphere application server.
If the box is checked, the installation program will create the
ae_isra.war file and a script that can also generate the
ae_isra.war file.
User Token Security
Make a note of the user token crypto key path.
Ready to Install
Verify your selections, and click Next to install the ISRA Servlet.
Completing the Setup
Click Finish to complete the ISRA Servlet installation Wizard.
5. Check the file filenet_ApplicationEngineISRAServlet_install_log.txt, located in the
<AE_israservlet_install path>\FileNet directory, to see if any errors occurred during the
installation.
6. Install unlimited strength jar files.
Perform this step only if you selected the Create unlimited strength key option in the
Application Engine User Token Security step of the Application Engine installation and the
Application Engine ISRA Servlet is deployed on a different application server from the
Application Engine. Failure to perform the step causes an EncryptionException when you login
to the IS Server.
7. (WebSphere 5.x only) To allow users to save annotations through ISRA, copy the
<AE_israservlet_install_ path>\FileNet\jar\ISRA.jar file to the
<AE_install_path>\FileNet\AE\Workplace\WEB-INF\lib directory.
8. Start the application server.
9. Deploying the Application Engine ISRA Servlet is similar to deploying Workplace.
•
WebSphere:
Deploy <AE_israservlet_install_path>\FileNet\ApplicationEngineISRAServlet\ae_isra.war in
the same way you deployed the app_engine.war file for Workplace.
•
WebLogic:
Deploy <AE_israservlet_install_path>\FileNet\ApplicationEngineISRAServlet in the same
way you deployed <AE_install_path>\FileNet\AE\Workplace.
10. Stop and restart the application server.
11. Verify the Application Engine ISRA Servlet installation.
A diagnostic tool is available to verify that the ISRA Servlet is installed and deployed correctly.
a. Launch your browser.
b. Enter the URL for the Application Engine ISRA Servlet, for example,
http://<ApplicationEngineISRAServlet_servername>:<port>/
ApplicationEngineISRAServlet/ISRA
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
470
Task 52: Enable Application Engine to Use ISRA
To configure the Workplace site preferences
NOTE 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 installed and deployed 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
To configure the Workplace site preferences
The Application Engine setup installs a pre-configured external service called Image Service,
which includes the parameterized values necessary to access FileNet IS libraries from Workplace.
Enable the service by setting the Image Service value in Site Preferences to Show (the default is
Hide), as described in the following procedure.
To enable the pre-configured Image Service
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. Select External Services from the left options list.
4. Select Modify for the Image Service (under External Reference Services).
The External Reference Service Settings site preference page displays.
5. Under General Information, locate Show on Select File page and change the value to Show.
6. Click Accept.
7. Click Apply.
To set the ISRA Interface Servlet URL
1.
Select Bootstrap.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
471
Task 52: Enable Application Engine to Use ISRA
To log on to Image Services via LDAP
2. Under Preferences Settings, set the value of ISRA Interface Servlet URL. For example:
http://<servername>:<port>/ApplicationEngineISRAServlet/ISRA
NOTE 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.
3.
Click Apply.
4. Click Exit to exit Site Preferences.
To log on to Image Services via LDAP
To log on to the Image Services library using your LDAP account, configure ISRA and Image
Services for LDAP authentication. If the LDAP account with which you accessed Workplace is not
valid for the Image Services library, or if LDAP authentication is not configured, you will be
prompted to log on to the Image Services library.
For information on configuring LDAP authentication for ISRA, refer to the ISRA Installation and
Deployment Guide. For information on configuring LDAP authentication for Image Services, refer
to the Image Services System Tools Reference Manual.
To access IS library documents
For informations about accessing IS library documents, see User Help > Actions, preferences and
tools > Actions > Documents > Add a document (Workplace).
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
472
Task 53: Install and Configure IBM FileNet System Manager
Task 53: Install and Configure IBM FileNet System
Manager
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 FileNet Dashboard to perform related configuration
procedures to enable System Manager. Installing Dashboard is not necessary if you currently
have IBM FileNet System Monitor installed.
Refer to the following IBM FileNet P8 help topic FileNet P8 Documentation > FileNet P8 Administration
> Enterprise-wide Administration > System Manager for instructions on how to enable the associated
System Manager components.
Refer to the documentation provided with IBM FileNet Dashboard for instructions on how to use
Dashboard.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
473
Task 54: Install Software Updates for Optional Components
Task 54: Install Software Updates for Optional
Components
Install any service packs, fix packs and/or interim fixes required for the optional components. To
determine whether such additional software updates are needed, contact your service
representative.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
474
Upgrade Planning and Procedures
Upgrade Planning and Procedures
This upgrade section contains the following major topics:
•
“Plan the Upgrade” on page 476
•
“Upgrade Core Components” on page 495
•
“Upgrade Add-On Components” on page 585
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
475
Plan the Upgrade
Plan the Upgrade
This section includes the following topics:
•
“Upgrade Overview” on page 477.
•
“Upgrade Planning Considerations” on page 478.
•
“Upgrade Checklists” on page 487.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
476
Upgrade Overview
Upgrade Overview
The upgrades described in the guide assume that you will:
•
Retain your basic platform configuration from the previous release (except as noted above for
Content Engine).
•
Make no changes to existing user or group definitions during the upgrade (although you must
specify new administrative and program accounts, as noted in “Specify IBM FileNet P8 Accounts”
on page 72).
•
Apply only the necessary supported third-party software updates, service packs, fix packs and
patches, as noted in this guide and in the IBM FileNet P8 Hardware and Software
Requirements. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
Apply the required minimum level of IBM FileNet P8 Service Packs, fix packs, or interim fixes
to the currently installed software before you upgrade. IBM FileNet Service Packs, fix packs
and test fixes often include feature updates that are required to ensure a successful upgrade.
Therefore, before you begin your upgrade to IBM FileNet P8 Platform 4.0.x, you must have
applied the minimum level of Service Pack, fix pack, or test fix to your installed 3.5.x
components. For more details, see “Access IBM FileNet Documentation, Compatibility Matrices,
and Fix Packs” on page 23.
This guide generally does not address migrations to different operating systems, databases, or
directory services. However, because IBM FileNet P8 Platform 4.0 introduces UNIX support for
Content Engine server and the new Autonomy K2-based Content Search Engine software, you
can install these components on UNIX rather than Windows as part of the upgrade procedure. You
can then upgrade your 3.5.x metadata, file stores, and index stores, and thereafter physically
move the resulting file storage areas and index areas from their Windows locations to UNIX
locations.
CAUTION You must make these operating system changes at the time of 4.0 upgrade and before
you make the system available to general users. To migrate Content Engine and Content Search
Engine to UNIX at a later date, you must contact your IBM FileNet representative. Likewise, to
migrate other components or third-party software from one platform to another (for example,
migrating from an SQL Server database engine to Oracle), you must contact your IBM FileNet
representative.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
477
Upgrade Planning Considerations
General Requirements for all IBM FileNet P8 Systems
Upgrade Planning Considerations
This section lists details that will help you prepare your environment for the upgrade of a IBM
FileNet P8 system. In many cases, the items you see listed are links to more detailed information,
which will help you plan a system upgrade. Review this section thoroughly before you start to
upgrade IBM FileNet P8 components or required third-party software.
General Requirements for all IBM FileNet P8 Systems
•
Gather auxiliary documentation. Retrieve the following from the IBM Information Management
support page on www.ibm.com, or from your IBM FileNet P8 Help installation:
NOTE For general instructions on how to navigate to this and other IBM FileNet product
documentation on the IBM web site, see “Access IBM FileNet Documentation, Compatibility
Matrices, and Fix Packs” on page 23.
–
IBM FileNet P8 Hardware and Software Requirements. This document provides details for
all IBM FileNet P8 system components, as well as the minimum supported levels of thirdparty software components. The information throughout the IBM FileNet P8 Platform
Installation and Upgrade Guide assumes you have met all applicable requirements listed
in that document.
–
The IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration >
FileNet P8 Security > Users and groups. This help topic provides a complete list of the user
and group roles, accounts, and responsibilities required to install, configure, and maintain
a IBM FileNet P8 system.
–
IBM FileNet P8 Release Notes. This document provides details on new features, known
issues, and resolved problems. Please review the “What's New” topic for recent product
changes, particularly to Security features.
–
IBM FileNet P8 Platform Installing Non-English Environments Technical Notice. This
document will help you set up the product if your environment is not English-language
based.
–
IBM FileNet P8 Platform High Availability Technical Notice. This document provides details
on how to set up your IBM FileNet P8 system using clusters, farms, and other highavailability software and hardware.
–
The IBM FileNet P8 help topic FileNet P8 Administration > Enterprise-wide Administration >
Shutdown and Startup. This help topic describes how to shut down and restart IBM FileNet
P8 Platform components and some expansion products. Manual, command line, and some
sample batch file procedures are provided.
–
IBM FileNet P8 Platform Planning and Deployment Guide. This document provides
information on deploying a IBM FileNet P8 system from a staging environment into a full
production environment.
–
IBM FileNet P8 Platform Troubleshooting Guide. This document provides troubleshooting
information on all aspects of the product.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
478
Upgrade Planning Considerations
Functional Expansion Product Considerations
•
–
IBM FileNet P8 Platform 3.5.x Version Tools Technical Notice. This document provides
instructions on running component-specific tools to determine whether you are at the IBM
FileNet P8 software release, fix pack, and interim fix levels required to upgrade.
–
IBM FileNet P8 Platform 4.0.x Version Tools Technical Notice. This document provides
instructions on running component-specific tools to determine whether you are at the IBM
FileNet P8 4.0.x software release, fix pack, and interim fix levels required to upgrade in
your environment (for example, if you running expansion products that require a particular
level of IBM FileNet P8 Platform 4.0.x software).
–
IBM FileNet P8 Platform Performance Tuning Guide. This document provides performance
tuning information on all aspects of the product.
–
IBM FileNet Rendition Engine Installation and Upgrade Guide. This document provides
details and information on installing and upgrading Rendition Engine components.
It is best practice yo plan and test the upgrade on a designated test system first. Verify
the upgrade is successful by running functionality and stress tests. After successful
verification, perform the production upgrade.
Functional Expansion Product Considerations
eForms
If you have the IBM FileNet P8 eForms functional expansion product installed you must uninstall it
before upgrading Application Engine.
Records Manager
•
You must update the Records Manager (RM) data model on each file plan object store (FPOS)
before you attempt to upgrade associated Content Engine data. The Upgrader Tool will fail if
run on an FPOS unless it has been updated to the 4.0.0 data model. This limitation only
applies to FPOSs, you can update ROS object stores without first updating the data model.
For more information, see “Upgrade Content Engine Data” on page 523 and the IBM FileNet
Records Manager Installation and Upgrade Guide task “Prepare to Upgrade Object Stores.“
NOTES
•
–
To complete and confirm your IBM FileNet P8 Platform upgrade you must update at least
one object store. If your configuration contains only Records Manager object stores, you
must either update at least one of them or create a non-Records Manager object store
prior to upgrading and use that object store to confirm the upgrade.
–
If your site preferences reside on a Records Manager object store, you must update that
object store to complete the IBM FileNet P8 Platform upgrade. Alternatively, you can move
the site preferences to another object store before the upgrade.
Do not install Enterprise Manager 4.0.x on any machine running the 3.5.x version until the
Records Manager 4.0.0 upgrade is complete. This includes updating all Records Manager
object stores to version 4.0.0. Installing Enterprise Manager 4.0.x will cause unexpected
behavior with the Records Manager Data Upgrade Tool.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
479
Upgrade Planning Considerations
Third-party Software Considerations
Third-party Software Considerations
The 3.5.x and 4.0.0 versions of IBM FileNet P8 support common levels of third-party software.
Exceptions are listed in the IBM FileNet P8 Hardware and Software Requirements. To download
this guide from the IBM support page, see “Access IBM FileNet Documentation, Compatibility
Matrices, and Fix Packs” on page 23.
Fixed Content Devices
•
If you set up EMC Centera fixed content devices in version 3.5.x of IBM FileNet P8, make sure
they are using the version of the CentraStar™ operating system supported in version 4.0.0 of
IBM FileNet P8, as specified in the IBM FileNet Hardware and Software Requirements.
•
If you set up NetApp SnapLock fixed content devices in version 3.5.x of IBM FileNet P8, make
sure they are using the version of the Data ONTAP™ operating system supported in version
4.0.0 of IBM FileNet P8, as specified in the IBM FileNet Hardware and Software
Requirements.
NOTE To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Operating System Considerations
General
•
Upgrade to Windows 2003 before you begin the upgrade process to IBM FileNet P8 4.0.0.
See the IBM FileNet P8 Hardware and Software Requirements for details on any required
Window 2003 Service Packs and patches. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
NOTE IBM FileNet field personnel indicate that most customers prefer to do a fresh installation
of Windows 2003 rather than upgrading the Windows 2000 software. This will require you to
install Content Engine 4.0.0 on its own Windows 2003 server (separate from the 3.5.2 Content
Engine server).
•
Synchronize the time and date on all servers. System users will experience a variety of
problems if one or more servers are not synchronized with the rest of the system.
The Process Engine database server is considered the master time keeper; the UTC time of
that machine is considered the correct time. The server hosting the Process Engine API and
the server hosting Content Engine must have the UTC time set to match the UTC time on the
Process Engine database server, plus or minus 15 minutes.
–
To change the time on the machine hosting Process Engine, you must stop the server. In a
farmed Process Engine system, if you want to change the time of one of the servers in the
farm, you need to stop only that server.
–
To change the time in the machine hosting the Process Engine API, be sure it is not
connected to any Process Engine system. If the API is connected to a Process Engine
server, and you change the time, you will experience authentication errors, and you might
need to log on again.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
480
Upgrade Planning Considerations
Operating System Considerations
–
If your Content Engine server is being used with a Process Engine server, and you change
the time on the Content Engine server, you will experience authentication errors in
Process Engine and you might need to log on again.
Content Engine
Windows 2003
•
Ensure proper upgrade to Windows 2003 on your existing Content Engine 3.5.2 servers
prior to IBM FileNet P8 upgrade. If you do want to upgrade to Windows 2003 on your
Content Engine 3.5.2 servers and intend to run them for any length of time before you upgrade
to Content Engine 4.0.0, be sure to see the “Configure Content Engine and SQL Servers for
Windows 2003" in the IBM FileNet P8 Platform Installation and Upgrade Guide v 3.5.x for
important details and procedures. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
Ensure that you have the necessary Windows clients for Enterprise Manager 4.0.0.
Although Content Engine server now runs on UNIX as well as Windows, the Enterprise
Manager administrative client still runs on Windows only. For upgrade purposes, IBM
recommends you install Enterprise Manager 4.0.0 on a separate client from the 3.5.x version.
UNIX
•
If you intend to move to UNIX for Content Engine 4.0.0, consider the following:
–
You must install Content Engine server 4.0.0 on UNIX as an initial step in the upgrade
process. To migrate after you have completed the upgrade and begun using your system,
you will have to contact your IBM FileNet representative and arrange a Professional
Services engagement.
–
You must temporarily leave your existing 3.5.2 file stores (and associated index stores) on
Windows to upgrade them using the CE 3.5.2 to 4.0 Upgrader Tool. This means that if you
install Content Engine server on UNIX, you must have an NFS gateway in place (for
example, Windows R2 Gateway or Samba) to enable communication between the new
UNIX Content Engine server and Windows file storage areas and index areas.
Once they are upgraded, you can physically move the shared directories for the file
storage areas and index areas to UNIX, but you must be sure to establish comparable
security settings. For details on these settings, see the IBM FileNet P8 help topic FileNet
P8 Administration > Enterprise-wide Administration > FileNet P8 Security > Authorization >
Storage Area Security.
Process Engine
•
Reconcile the Process Engine user security information.
The Process Engine duplicates certain parts of the user security information in its own
database. Over time, the information in the directory service might be changed or updated.
When this happens, the information in the Process Engine’s environment records, whether
cached or permanent, can end up containing old, invalid information about the Process Engine
users and groups.
WARNING During the Process Engine upgrade it is critical that this user information is correct
and up to date. Before upgrading you must reconcile the cached and permanent user data
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
481
Upgrade Planning Considerations
Security Considerations
environment records on the Process Engine with the possibly more-up-to-date data in an
LDAP-based directory service.
For more information, see the IBM FileNet P8 help topic FileNet P8 Administration > Process
Engine Administration > Administrative tools > vwtool > Commands > environment.
•
If you are using the Process Analyzer expansion product, several steps must be taken on the
Process Analyzer, on the Process Engine database, and on Process Engine, before upgrading
Process Engine. See “Upgrade Process Engine (UNIX)” on page 550 and “Upgrade Process Engine
(Windows)” on page 556 for details.
UNIX
•
Ensure minimum /tmp size. The /tmp directory must have 510 MB free for use by Process
Engine Setup.
•
Allocate a minimum of 500 MB of additional disk space to the /fnsw disk volume. This
space is required for upgrades and is in addition to the minimum space requirements called for
in the IBM FileNet P8 Hardware and Software Requirements. To download this guide from the
IBM support page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs”
on page 23.
•
Expand the following raw partitions that are used for the SEC databases:
–
fn_sec_rl0: expand raw partition to 64MB
–
fn_sec_db0: expand raw partition to 64MB
Security Considerations
•
If you intend to migrate to a different directory service, do so prior to the 4.0.0 upgrade. If you
are expecting to migrate to a different directory service for use with IBM FileNet P8 Platform
4.0.0, you must do so before you begin the upgrade from 3.5.x. See the IBM FileNet P8
Platform 3.5.x Directory Service Migration Guide for complete information. To download this
guide from the IBM support page, see “Access IBM FileNet Documentation, Compatibility Matrices,
and Fix Packs” on page 23. Migrating to a different directory service provider is not supported
once you are running the 4.0.0 release but is likely to be provided in subsequent releases or
Service Packs. Contact your IBM FileNet representative if you intend to switch to IBM Tivoli
Directory Server, which is supported for IBM FileNet P8 4.0.0, but not for 3.5.x.
•
Be sure to understand updated user and group account requirements for release 4.0.0.
The 4.0.0 release requires you to designate or create several new accounts (for example, the
K2 Operating System User for Content Search Engine). For details, see “Specify IBM FileNet P8
Accounts” on page 72.
•
Determine whether you intend to use Secure Socket Layers (SSL). IBM recommends you
use SSL to strengthen security. Configuring SSL for 4.0.0 is noticeably different than for 3.5.x.
For example, Content Engine 4.0.0 now relies on its own application server to direct calls to
your chosen authentication provider. For configuration details, see “Set Up Content Engine and
Client Transport SSL Security” on page 430 and “Set Up Application Engine SSL Security” on
page 434.
•
Gather 3.5.x authentication information and plan 4.0 authentication.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
482
Upgrade Planning Considerations
Security Considerations
In the 3.5.x release, Content Engine authentication and authorization information are both
specified by configuring one or more authentication providers, using Active Directory, Novell
eDirectory, or Sun Java System Directory Server.
–
For Novell and Sun authentication providers, the root of the configured 3.5.x Directory
Service contains one or many children, or naming contexts, each of which are used
automatically by 3.5.x Content Engine as FileNet P8 authentication realms.
–
For Windows Active Directory, the 3.5.x Content Engine uses the Windows domain (also
known as deployment domain) it resides in and automatically gets all trusted domains,
siblings, parents, children within the domain's forest. By default, the deployment domain is
the default realm.
3.5.x authentication realms are viewable (but not editable) in Enterprise Manager's root
domain property sheet > Authentication Provider tab > DefaultRealm property. The names of
all realms for the current FileNet P8 domain appear as values in the drop-down list for this
property.
NOTE If you are using the 3.5.x Content Engine attributes DefaultRealm and
RestrictToDefaultRealm to modify 3.5.x authentication behavior, then you must carefully map
out which 3.5.x authentication realms are active and essential to your upgraded 4.0.x Content
Engine authentication scheme. The DefaultRealm and RestrictToDefaultRealm attributes are
not supported by Content Engine 4.0.x, because of the introduction of the application server,
which uses Java Authentication and Authorization Service (JAAS) for authentication.
By contrast, in Content Engine 4.0.x, configuring authentication and authorization are two
separate steps, both of which must be completed on the Content Engine 4.0.x server
environment before upgrading object stores from 3.5.x. Authentication is configured through
the application server’s administration console. Authorization is configured by creating one or
more Directory Configuration objects in Content Engine 4.0.x for the FileNet P8 domain. (Note
that 3.5.x authentication information is not carried forward by the CE 3.5.2 to 4.0 Upgrader
Tool.) Therefore, the following are prerequisites to upgrading a 3.5.x domain:
–
Install and configure one of the supported J2EE application servers, using the application
server's install tools.
–
Install a Content Engine 4.0.x server as an application into the J2EE application server,
using the Content Engine Setup program.
–
Configure the authentication environment, through the J2EE application server's
administration console. (If you want the Content Engine Setup program to create the initial
application server's authentication, as opposed to creating it yourself before installing the
Content Engine, make sure you select to install the component Application Server
Authentication Provider on the associated Content Engine Setup wizard screen.)
–
Create a Content Engine 4.0.x domain, using the Enterprise Manager’s Add Domain
Configuration wizard.
–
Create one or more Directory Configurations, using the Enterprise Manager’s Create a
Directory Configuration wizard. One Directory Configuration is required for each distinct
3.5.x authentication realm.
There are several cases that might exist for this last bullet. In all cases, Directory
Configurations must be created that preserve access to all users who have used the object
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
483
Upgrade Planning Considerations
Network Considerations
stores being upgraded. Access to all users’ SIDs and group information is necessary for
authorization to occur.
–
In the typical case, you will create one 4.0.x Directory Configuration object for each realm
used in 3.5.x, specifying the same directory server (LDAP) host and port information that
was used in Content Engine 3.5.x.
–
However, in some cases customers will choose to configure the Content Engine 4.0.x
server to obtain directory configuration information from a different directory server than
was used in Content Engine 3.5.x (for instance by using a replica of the 3.5.x directory
service which contains the same user or group information), or to expand the users of the
Content Engine 4.0.x domain being upgraded by adding additional realms. If this is the
case, then the set of 4.0.x Directory Configurations that must be created for the new 4.0.x
domain could differ from the set of realms that were configured in 3.5.x. Just make sure
that the 4.0.x Directory Configurations contain the same user and group principals, with
the exact same SIDs, as those used in Content Engine 3.5.x. Remember that users in the
newly added realms will have no authorization to access any Content Engine 4.0.x objects
until they are explicitly granted authorization, typically by using Enterprise Manager in
ways described in the 4.0.x Help for Content Engine Administration.
Network Considerations
•
Ensure availability of the required port numbers. For a composite list of port numbers
required for IBM FileNet P8 4.0.0, see “IBM FileNet P8 Port Numbers” on page 667.
Database Considerations
General
•
Update to the appropriate database patches before you upgrade IBM FileNet P8
components. For minimum patch requirements, see IBM FileNet P8 Hardware and Software
Requirements. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
Update database versions after you upgrade IBM FileNet P8 components. If you intend to
upgrade the version of the database, from Oracle 9i to 10g, from DB2 version 8 to 9, or from
SQL Server 2000 to 2005, complete the upgrade of all IBM FileNet P8 components and verify
a fully functional system before upgrading the database software.
•
Plan for upgrade implications regarding databases. If you are upgrading to version 4.0.x, you
will continue to use existing object store databases. However, you must create a new database
for the 4.0.x global configuration data (GCD), which the Content Engine Upgrader Tool
migrates from its 3.5.x file-based format (sysinit.dat).
•
Consider the following for Business Process Manager components (PE, PA, PS):
–
The Process Engine database upgrade automatically renames the existing VWLogxxx_yyy
tables to VWLogxxx_yyy_Archive and creates the new VWLogxxx_yyy table.
–
The Process Engine Log SeqNumber starts from 21000.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
484
Upgrade Planning Considerations
Application Server Considerations
–
Process Analyzer gets its data from the Process Engine database. The 3.5.x and 4.0.0
database schemas have changed both on Process Engine and Process Analyzer. The
3.5.x data from Process Engine must be transmitted to Process Analyzer 3.5.x before you
upgrade either of these components to 4.0.0. For details, see the 4.0.x IBM FileNet
Process Analyzer Installation and Upgrade Guide.
Oracle
•
Ensure you have applied appropriate Oracle patches to Oracle clients as well as
servers. Be sure that clients remote from Oracle database servers have patches that are
comparable to the database server. Oracle clients include any machines remote from the
Oracle database server where Content Engine, Process Engine, and Enterprise Manager
software is installed. You can download all the required Oracle database server patches from
the Oracle website and install them.
•
Consider increasing the number of Oracle sessions and a lowering the session timeout
settings. Upgrading a Content Engine object store can use a large number of database
sessions. The number of sessions required depends on the number of custom class
definitions in the object store being upgraded. If the maximum number of sessions is
exceeded during an object store upgrade, the upgrade will fail. To recover from such an
upgrade failure, you will have to increase the number of sessions, decrease the session
timeout settings, and then perform the following steps:
a. In the Content Engine Upgrader Tool, note the steps that completed successfully during the
object store upgrade, that is, those items that have green check marks next to them.
b. Shut down the Content Engine Upgrader Tool.
c. Shut down and then restart Oracle to release all database sessions and processes.
d. Restart the Content Engine Upgrader Tool.
e. Resume the object store upgrade and make sure to reset only the failed upgrade steps.
CAUTION To avoid a potential corruption of the object store, ensure that you have not
chosen to rerun any upgrade steps that were already completed in the initial run of the
Upgrader Tool.
•
Determine when to execute SQL scripts. An upgrade SQL script must be executed. This script
can be executed manually, before starting Process Engine Setup, or from Process Engine
Setup. See “Process Engine SQL Scripts” on page 671 details about the scripts, including
information on execution modes and associated security requirements.
Microsoft SQL Server
Create an ODBC data source. The 4.0.x version of Process Engine uses an ODBC data source
to connect to the database. The database administrator should create the data source before
trying to upgrade the Process Engine software. See “Upgrade Process Engine (Windows)” on
page 556 for details on creating the data source and testing the database connection.
Application Server Considerations
Determine whether the number of object stores to be upgraded will require you to run a 64-bit Java
Virtual Machine (JVM) on your Content Engine application servers. If the 3.5.x FileNet P8 domain
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
485
Upgrade Planning Considerations
Application Server Considerations
you are upgrading contains more than 50 object stores, it is a best practice to install Content
Engine on application servers running a 64-bit, rather than 32-bit, JVM. Otherwise, you might
experience significant Content Engine performance issues.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
486
Upgrade Checklists
IT Administrator
Upgrade Checklists
The following topics provide checklists of items that must be completed for a successful upgrade
of the P8 Platform. The lists are divided by user or role. Note that your organization might have
different administrator roles, and that some of the responsibilities of listed roles might vary.
You can print these lists and gather and record the relevant information about your existing
installation before you begin the upgrade. You can then record new information as you perform the
upgrade tasks. Where applicable, the list items indicate which role will need the information you
provide. IBM recommends coordinating communication among the various roles to facilitate an
easier installation process.
IT Administrator
This role administers hardware and operating systems for your environment, as well as helping
make decisions about machine usage and configurations such as clustering and farming. The
information confirmed and collected in this set of checklists should be provided to the upgrade
administrator for each component.
Before the Upgrade
ˆ Make sure the site has restorable backups of system and data for all IBM FileNet P8
components. In case of an emergency, you might need to back out of the upgrade. For details
on what to back up for IBM FileNet P8 components, see the IBM FileNet P8 help topic
Enterprise-wide Administration > Backup and Restore.
ˆ In some cases it might be necessary for IBM FileNet Engineering and Support personnel to
access the system for support. To facilitate such access, we request that you implement a
reliable remote access method.
ˆ If high availability is configured (clusters, farms, etc.), be sure to see the IBM FileNet P8
Platform High Availability Technical Notice. To download this guide from the IBM support page,
see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
ˆ If you have more than 50 object stores in a single 3.5.x FileNet P8 domain, see the Notes
section in “Upgrade Content Engine Software” on page 505 for a recommended upgrade
approach.
Content Engine
ˆ The upgrade process for Content Engine includes a new installation of the 4.0.0 version. Refer
to the items for Content Engine in the “Installation Checklists” on page 39.
ˆ Record the following information about the K2 Master Administration Server.
K2 Master Administration Server host name:
K2 Master Administration Server port:
StyleSetAlias path (FileNet_FileSystem_PushAPI):
K2 Server names:
K2 Index server names:
K2 Broker server names:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
487
Upgrade Checklists
IT Administrator
ˆ For each object stores you plan to upgrade, record the following:
Local JNDI name:
Global JNDI name:
ˆ Specify the Content Engine Operating System user:
Process Engine
ˆ (HP-UX only) Collect kernel parameter information before you upgrade the Process Engine
software.
Before you upgrade, run the kmtune utility to collect current kernel parameter information and
save the output. After the upgrade, use the HPjconfig utility to collect information on required
patches and recommended kernel parameters. The HPjconfig utility's recommendations for
the kernel parameters are based on analysis of historical data on the server. See the HP
website for configuration details
ˆ (All UNIX platforms) Expand the raw partitions for the SEC databases to a minimum of 64MB :
fn_sec_rl0
fn_sec_db0
ˆ (All UNIX platforms) Save the following files for the fnsw (or alias) and root users:
.Xdefaults
.Xresources
.dbxinit
.dtprofile
.env
.login
.mwmrc
.xinitrc
.profile
.cshrc
Application Engine
ˆ Provide the following administrative credentials for installation on the Application Engine
server:
Windows (local administrator):
UNIX (root)
NOTE The root user must have read/write/execute access to both the /bin directory and the
Content Engine installation directory.
ˆ (Optional) Provide a local machine administrative account to run Application Engine. This user
must have read and write privileges to machine resources:
Windows:
UNIX:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
488
Upgrade Checklists
Security Administrator
ˆ (WebLogic) Determine the recommended MaxPermSize value for MEM_ARGS:
MaxPermSize:
Security Administrator
This role administers authentication, users and groups, passwords, encryption, and general
network access considerations for the upgrade and eventual use of the IBM FileNet P8 Platform
software. The information confirmed and collected in the following checklist items should be
provided to the upgrade administrator for each component, as well as to the FileNet P8
administrators (for example, the GCD administrator).
General
ˆ Note the user name and password for a FileNet P8 GCD administrator:
GCD Administrator:
Password:
Content Engine
ˆ The upgrade process for Content Engine includes a new installation of the 4.0.0 software.
Refer to the items for Content Engine in the “Installation Checklists” on page 39.
ˆ Ensure that you have the necessary local and Content Engine administrative user accounts
and passwords to run upgrade-related programs. You will need these various levels of
administrative operating system access to run Content Engine Setup and the CE 3.5.2 to 4.0
Upgrader Tool against the Content Engine servers and Windows Enterprise Manager
administrative clients. For details on accounts and privileges, see “Upgrade Content Engine
Software” on page 505 and “Specify IBM FileNet P8 Accounts” on page 72.
ˆ Supply the following K2 user and group information for the Content Search Engine:
K2 Security User Group:
K2 Security User:
K2 Security User password:
K2 Operating System User:
K2 Operating System User password:
(Windows) Domain name on which K2 services run:
ˆ (Windows) Verify directory permissions on file storage areas for the following users:
User performing the upgrade:
User running the application server:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
489
Upgrade Checklists
Database Administrator
Application Engine
ˆ Specify the users and groups to add to the Application Engine Administrators access role:
Users or groups
ˆ Specify the users and groups who will be allowed to create subscriptions to add to the
PWDesigner access role.
NOTE These accounts are not specifically required to complete an install, but required to
create subscriptions later in Workplace, and can also be added later:
Users or groups
ˆ For SSO, specify the following:
SSO proxy host URL:
SSO proxy host server name:
HTTP port on the SSO proxy host:
HTTPS port on the SSO proxy host:
ˆ For SSL, specify the following:
SSL Host name and port number:
Java Server HTTP port:
Database Administrator
This role oversees database creation and administration. The decisions, task confirmations, and
information gathered in the following checklist items should be provided to the upgrade
administrator for each component.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
490
Upgrade Checklists
Upgrade Administrator
General
ˆ Note the following general database information:
Database instance name:
NLS character set:
Content Engine
ˆ The upgrade process for Content Engine includes a new installation of the 4.0.0 version. Refer
to the items for Content Engine in the “Installation Checklists” on page 39.
ˆ Note the following database information for each existing object store:
Database user name:
Database user password:
Database type:
Database class:
Database URL:
Process Engine
ˆ Determine when to execute Oracle SQL scripts.
An upgrade SQL script must be executed. This script can be executed manually, before
starting Process Engine Setup, or executed from Process Engine Setup. See “Process Engine
SQL Scripts” on page 671 for information on execution modes and associated security
requirements as well as details about the script.
ˆ Install SQL Server Client.
SQL Server Client software is required on the Process Engine server to execute a number of
upgrade SQL scripts if the database is a remote SQL Server. These scripts are not a part of
Process Engine Setup but are executed as a part of the procedures in “Complete Post-Upgrade
Process Engine Configuration” on page 563. The SQL Server Client software can be removed
from the Process Engine server after the Process Engine database has been successfully
upgraded to the 4.0.x release.
ˆ Create the ODBC data source:
Data source name:
Upgrade Administrator
This role will perform upgrade tasks for your IBM FileNet P8 Platform software. This role might
also perform initial configuration, setup, and startup tasks that would subsequently fall under the
role of the FileNet P8 Administrator.
Before the Upgrade
ˆ Be sure to read the “What’s New” and “Known Issues” topics in the IBM FileNet P8 Platform
Release Notes. To download this guide from the IBM support page, see “Access IBM FileNet
Documentation, Compatibility Matrices, and Fix Packs” on page 23. New features might be
interesting for your implementation of IBM FileNet P8 Platform, and known issues might
impact the upgrade procedures.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
491
Upgrade Checklists
Upgrade Administrator
ˆ Before you begin the upgrade, make sure no users or processes are accessing the IBM
FileNet P8 system.
ˆ Before you begin the upgrade, disable tasks such as:
–
Scheduled automated backups
–
Cron jobs
–
Virus scanning
Environment Considerations
ˆ Determine the existing IBM FileNet P8 Platform documentation URL. If you have an existing
application server in place with a IBM FileNet P8 Documentation web site established, you
can determine its URL by checking the Documentation server site preference in Workplace.
Documentation Server URL:
NOTE You can now install and deploy the IBM FileNet P8 Documentation on the Content
Engine application server, as well as on the Application Engine or any other supported
application server.
Content Engine
ˆ Review the list of users and permissions required to perform the Content Engine upgrade. See
the overview of “Upgrade Content Engine Software” on page 505.
ˆ The upgrade process for Content Engine includes a new installation of the 4.0.0 version. Refer
to the items for Content Engine in the “Installation Checklists” on page 39.
ˆ Note the GCD (sysinit file) location on the master GCD server. The GCD master is typically
your initially installed Content Engine server.
ˆ If you are going to upgrade content-search indexes (Verity collections), provide the UNC path
to the collections directory for each collection you plan to upgrade:
UNC path to collections directory:
ˆ After the install of the 4.0.0 Content Engine software is complete, provide the URL for the
component manager on Content Engine:
CE Component Manager URL:
ˆ After the install of the 4.0.0 Content Engine software is complete, provide the download and
upload URLs for Content Engine (server name and port number for your Content Engine
server for downloading and uploading document content):
CE download URL:
CE upload URL:
ˆ After the install of the 4.0.0 Content Engine software is complete, provide the Content Engine
client software URL, which includes the server name and port number for your Content Engine
server on which the Application Engine Web Connectivity (Java) module resides:
CE client software URL:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
492
Upgrade Checklists
Upgrade Administrator
Process Engine
ˆ Note the User Base and Group Base specified in the LDAP Connection tab in the Process
Engine Task Manager. This information can be useful for troubleshooting during the upgrade
process.
User Base:
Group Base:
Application Engine
ˆ Gather the J2EE application server administrator's credentials or have that user available
during the upgrade.
User name:
Password:
ˆ Determine which components and installation option you used to install Application Engine
3.5.x.
When you upgrade Application Engine, you must install the same components as are currently
installed. If you installed Application Engine 3.5.x using a Typical install, perform a Typical
install; if you used a Custom install, perform a Custom install using the same selection of
components.
In particular, do NOT run a Typical upgrade if you initially ran a Custom installation (for
example, to install the Java API). If you do this, your Custom software component choices will
not be updated as expected.
To find out which Application Engine 3.5.x components are currently installed, look for the
following folders:
–
Process and Content Java APIs (only)
<AE_install_path>/FileNet/lib2
<AE_install_path>/FileNet/Router
–
Workplace web applications and Process and Content Java APIs
<AE_install_path>/FileNet/lib2
<AE_install_path>/FileNet/Router
<AE_install_path>/FileNet/Workplace
–
Workplace Toolkit Source Code (for custom application development)
<AE_install_path>/FileNet/Workplace/source
ˆ Record the current Component Manager configuration data.
Existing Component Manager configuration data is not retained during the Application Engine
upgrade. If you did not modify the default Application Engine 3.5.x configuration for the
Component Manager, it is not necessary to record and re-enter the Component Manager
configuration data; it will be set to the Application Engine 4.0.x default values during the
upgrade.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
493
Upgrade Checklists
Upgrade Administrator
To view the current configuration data, start the Process Task Manager on Application Engine.
Click Component Manager and note the values displayed on the General and Required
Libraries tabs.
ˆ Verify that at least one object store exists and is available for upgrading. See “Create Object
Stores” on page 286.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
494
Upgrade Core Components
To upgrade the core IBM FileNet P8 Platform components
Upgrade Core Components
To upgrade the core IBM FileNet P8 Platform components
CAUTION You must upgrade the core components as described in the topics listed below before
upgrading the optional add-on components as described in “Upgrade Add-On Components” on
page 585.
1. Review IBM FileNet P8 Platform requirements and other planning considerations. See “General
Requirements for all IBM FileNet P8 Systems” on page 478.
2. Upgrade the IBM FileNet P8 Platform documentation. Do Task 1 on page 496.
3. Ensure that you are running the minimum required release of IBM FileNet P8 Platform software
and service packs for doing an upgrade. Do Task 2 on page 504.
4. Upgrade Content Engine. Do Task 3 on page 505.
5. Install Content Engine software updates. Do Task 4 on page 515.
6. Install Process Enging Client file updates on Content Engine servers. Do Task 5 on page 516.
7. Redeploy Content Engine. Do Task 6 on page 519.
8. Upgrade Content Engine data. Do Task 7 on page 523.
9. Install Content Search Engine software updates. Do Task 8 on page 537.
10. Complete the post-upgrade Content Engine configuration. Do Task 9 on page 538.
11. Complete the pre-upgrade Process Engine configuration. Do Task 10 on page 542
12. Upgrade Process Engine. Depending on your server platform, do one of the following:
•
Task 11a on page 550 (UNIX).
•
Task 11b on page 556 (Windows 2000).
13. Install Process Engine software updates. Do Task 12 on page 561.
14. Install the latest Content Engine client files on Process Engine servers. Do Task 13 on page 562.
15. Complete the post-upgrade Process Engine configuration. Do Task 14 on page 563.
16. Upgrade Application Engine. Do Task 15 on page 577.
17. Complete the post upgrade Application Engine configuration. Do Task 16 on page 583.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
495
Task 1: Upgrade IBM FileNet P8 Documentation
Overview
Task 1: Upgrade IBM FileNet P8 Documentation
Overview
There are two methods available for updating to an IBM FileNet P8 4.0.x Documentation
installation:
–
“Refresh IBM FileNet P8 4.0.0 Documentation Without Uninstalling” on page 497
Use this option if you have IBM FileNet P8 3.5.x documentation installed without any
expansion product help.
–
“Update IBM FileNet P8 4.0.0 Documentation by Uninstalling and Reinstalling” on page 499
Use this option if you have IBM FileNet P8 3.5.x documentation installed with expansion
product help included (for example: Process Analyzer, Process Simulator, IBM FileNet P8
eForms, Content Federation Services for Image Services, or IBM FileNet P8 Portlets).
NOTES
•
•
With the IBM FileNet P8 4.0.0 release, the documentation can be located on the Content
Engine server. If you wish to install the 4.0.0 documentation on the Content Engine server, or
install on a new application server, you will not need to perform an upgrade. Instead, use the
install instructions in the following topics, depending on your application server type:
•
“Install IBM FileNet P8 Platform Documentation (WebSphere)” on page 158
•
“Install IBM FileNet P8 Platform Documentation (WebLogic)” on page 163
•
“Install IBM FileNet P8 Platform Documentation (JBoss)” on page 169
The refresh procedure assumes the following:
–
You wish to replace the 3.5.x documentation at the existing location with updated files.
–
You are familiar with your application server’s procedures for reinstalling or redeploying
web site applications.
•
Before installing any IBM FileNet P8 documentation, review the IBM FileNet P8 Hardware and
Software Requirements for the required software versions, Service Packs, and Hot Fix Packs
for third-party software. To download this guide from the IBM support page, see “Access IBM
FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
•
Although some versions of BEA WebLogic support deployment of WAR-file-based web
applications, you cannot deploy ecm_help.war on this application server platform. You must
instead use the fully expanded IBM FileNet P8 documentation directory (ecm_help) structure.
Otherwise, the searches within the IBM FileNet P8 documentation will not work and you will
receive null pointer errors.
•
In environments where Windows NTFS is used, there is a 256 character limit on file and folder
names (folder depth). When trying to delete an existing IBM FileNet P8 documentation web
site, you may encounter access denied errors. See Microsoft Knowledge Base article http://
support.microsoft.com/?kbid=320081 for more information.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
496
Task 1: Upgrade IBM FileNet P8 Documentation
Refresh IBM FileNet P8 4.0.0 Documentation Without Uninstalling
•
If your IBM FileNet P8 documentation server is a Windows server, verify that Microsoft
Windows Internet Information Services (IIS Admin Service, Simple Mail Transport Protocol
(SMTP), and World Wide Web Publishing Service) are stopped and set to manual.
•
Before installing the latest IBM FileNet P8 documentation, be sure to back up your existing
IBM FileNet P8 documentation web site according to your site and application server
procedures. This precaution will allow you to restore the IBM FileNet P8 documentation web
site quickly if for any reason you have to back out of or delay your IBM FileNet P8 software
upgrade.
•
If you install any IBM FileNet P8 expansion product(s) as part of your upgrade (for example,
Process Analyzer, Process Simulator, IBM FileNet P8 eForms, Content Federation Services
for Image Services, or IBM FileNet P8 Portlets), be aware that:
–
You must copy the associated help for all expansion products onto the IBM FileNet P8
documentation server.
–
You must update the index for the help Search feature as documented below. This action
ensures that searches return all expected results. If you add help for other expansion
products later, you must re-run the procedure below for updating the help Search index.
You must also update the help Search index if you update the installed IBM FileNet-based
help that you have customized or translated as part of your own application development.
•
Any time you update the documentation search index, a backup of the files in the existing
Index\core directory will be automatically copied to the Index\IndexOld subdirectory. You can
reapply these backed-up files to the core subdirectory (after first removing the new files
created there) if you need to return to your previous indexed state.
•
Depending on your operating system (Windows or UNIX) and application server version
(WebSphere or WebLogic), some screens will be slightly different than those documented in
the procedures listed below.
Refresh IBM FileNet P8 4.0.0 Documentation Without Uninstalling
You can refresh an existing IBM FileNet 3.5.x (or earlier 4.0.0) P8 documentation installation by
simply copying the newer documentation files over the existing files, and then reindexing for
Search.
Use this option if you have IBM FileNet P8 3.5.x documentation installed without any expansion
product help.
NOTES
•
If you have FileNet P8 3.5.x documentation installed with expansion product help included,
use the procedure “Update IBM FileNet P8 4.0.0 Documentation by Uninstalling and Reinstalling” on
page 499.
•
This refresh procedure requires that you copy the expanded ecm_help directory from the IBM
FileNet P8 Documentation package over the existing documentation. This stipulation applies
to all application servers, even those, such as WebSphere, that required a WAR file for initial
deployment of the existing 3.5.x documentation.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
497
Task 1: Upgrade IBM FileNet P8 Documentation
To refresh the IBM FileNet P8 documentation without first uninstalling
To refresh the IBM FileNet P8 documentation without first uninstalling
1. Stop the application server (or IBM FileNet P8 documentation site) on which the existing
documentation is deployed so that no processes can access the documentation.
2. This step removes the Search index, which you must recreate later for the newer set of
documentation files. On the IBM FileNet P8 documentation application server, locate the
deployed IBM FileNet P8 documentation directory, and back up (or move to a safe location) the
files located in:
UNIX:<deployment_path>/ecm_help/search/index/core
Windows:<deployment_path>\ecm_help\search\index\core
3. Access the 4.0.x IBM FileNet P8 Platform Documentation package.
4. Copy the expanded ecm_help directory from the package over the deployed ecm_help directory.
a. (UNIX) When copying expansion product documentation, use a cp copy command from a
terminal to copy the ecm_help directory structure from the associated Documentation
package over the ecm_help directory installed on the existing IBM FileNet P8 documentation
server.
cp -r <mount_location> <target_destination>
WARNING Care should be taken when copying folders in UNIX. Dragging-and-dropping of
folders replaces any existing folder(s) of the same name. Also note that your switch ( -r)
requirements may be different from the example shown. Contact your system administrator
if you have questions about proper syntax.
b. (Windows) Use a copy command from a command prompt or drag-and-drop the files to the
destination.
c. (Content Federation Services for Image Services) Copy the cfs_guide.pdf file from the
Documentation directory on the software package into the ecm_help/cfs_help directory on
the IBM FileNet P8 documentation server.
NOTE Repeat this step for each of your expansion products. You can copy more than one
expansion product documentation set to the documentation application server before
continuing (for example, Process Analyzer, Process Simulator, IBM FileNet P8 eForms,
Content Federation Services for Image Services, or IBM FileNet P8 Portlets) so you end up
with one ecm_help directory containing multiple sets of expansion product files added to it.
5. Continue as follows:
•
If you have added expansion product documentation, you will need to update the search index. Go
on to the procedure in the following topic, “Update Help Search Index” on page 502.
•
If you have no further documentation to install, and you did not install any expansion products,
then go on to the procedure in the topic “Deploy and Verify IBM FileNet P8 Documentation Web
Site” on page 503.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
498
Task 1: Upgrade IBM FileNet P8 Documentation
Update IBM FileNet P8 4.0.0 Documentation by Uninstalling and Reinstalling
Update IBM FileNet P8 4.0.0 Documentation by Uninstalling and
Reinstalling
Use this option if you have IBM FileNet P8 3.5.x documentation installed with expansion product
help included (for example: Process Analyzer, Process Simulator, IBM FileNet P8 eForms,
Content Federation Services for Image Services, or IBM FileNet P8 Portlets).
Use the following procedures to completely remove an existing IBM FileNet P8 documentation site
from the application server before updating the site.
To update the IBM FileNet P8 documentation on WebLogic application servers
To update a Weblogic 8.x installation
1. Verify the WebLogic application server is running, and then start the WebLogic Administration
Console.
2. From the WebLogic Administration Console, stop the existing documentation site.
3. Delete the existing IBM FileNet P8 documentation site.
4. Delete any IBM FileNet P8 documentation files, leaving the ecm_help directory in place.
5. Access the IBM FileNet P8 Platform Documentation package.
6. Copy the ecm_help folder structure from the package to the location of the original IBM FileNet
P8 documentation as follows:
•
(UNIX) When copying expansion product documentation, use a cp copy command from a terminal
to copy the ecm_help directory structure from the associated Documentation package over the
ecm_help directory installed on the existing IBM FileNet P8 documentation server.
cp -r <mount_location> <target_destination>
CAUTION Take care when copying folders in UNIX. Dragging-and-dropping folders
replaces any existing folder(s) of the same name. Also note that your switch ( -r)
requirements can be different from the example shown. Contact your system administrator
if you have questions about proper syntax.
•
(Windows) Use a copy command from a command prompt or drag-and-drop the files to the
destination.
7. From the WebLogic Administration Console, click <mydomain> > Deployments > Web
Application Modules.
8. Select the existing Web Application site and click the Deploy tab.
9. Click Start.
10. Continue as follows:
•
If you have added expansion product documentation, you will need to update the search index. Go
on to the procedure in the following topic, “Update Help Search Index” on page 502.
•
If you have no further documentation to install, then go on to the procedure in the topic “Deploy
and Verify IBM FileNet P8 Documentation Web Site” on page 503.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
499
Task 1: Upgrade IBM FileNet P8 Documentation
To update the IBM FileNet P8 documentation on WebSphere application servers
To update a Weblogic 9.x installation
1. Verify the WebLogic 9.x application server is running, and then start the WebLogic
Administration Console.
2. From the WebLogic Administration Console, click Deployments and then select the IBM FileNet
P8 documentation web site.
3. Click the Lock and Edit button.
4. Select the IBM FileNet P8 Documentation and stop the existing documentation site. If prompted,
click Yes to stop the site.
5. From the install location, delete any IBM FileNet P8 documentation files, leaving the ecm_help
directory in place.
6. Access the IBM FileNet P8 Platform Documentation package.
7. Copy the ecm_help folder structure from the package to the location of the original IBM FileNet
P8 documentation as follows:
•
(UNIX) When copying expansion product documentation, use a cp copy command from a terminal
to copy the ecm_help directory structure from the associated Documentation package over the
ecm_help directory installed on the existing IBM FileNet P8 documentation server.
cp -r <mount_location> <target_destination>
CAUTION Take care when copying folders in UNIX. Dragging-and-dropping folders
replaces any existing folder(s) of the same name. Also note that your switch ( -r)
requirements can be different from the example shown. Contact your system administrator
if you have questions about proper syntax.
•
(Windows) Use a copy command from a command prompt or drag-and-drop the files to the
destination.
8. From the WebLogic Administration Console, click Deployments.
9. Select the existing Web Application site and click the Deploy Tab.
10. Click Start and then click Servicing all requests.
11. Continue as follows:
•
If you have added expansion product documentation, you will need to update the search
index. Go on to the procedure in the following topic, “Update Help Search Index” on page 502.
•
If you have no further documentation to install, then go on to the procedure in the topic
“Deploy and Verify IBM FileNet P8 Documentation Web Site” on page 503
To update the IBM FileNet P8 documentation on WebSphere application servers
1. Verify the WebSphere 5.x application server is running, and then start the WebSphere
administrative console.
2. Expand Applications > Enterprise Applications.
3. Select the IBM FileNet P8 Documentation site.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
500
Task 1: Upgrade IBM FileNet P8 Documentation
To update the IBM FileNet P8 documentation on JBoss application servers
4. Stop the existing documentation site.
5. From the initial install location, delete the IBM FileNet P8 documentation installed files, leaving
the ecm_help directory in place.
6. Access the IBM FileNet P8 Platform Documentation package.
7. Copy the \ecm_help\ folder structure from the package to the location of the original IBM FileNet
P8 documentation as follows:
•
(UNIX) When copying expansion product documentation, use a cp copy command from a terminal
to copy the ecm_help directory structure from the associated Documentation package over the
ecm_help directory installed on the existing IBM FileNet P8 documentation server.
cp -r <mount_location> <target_destination>
CAUTION Take care when copying folders in UNIX. Dragging-and-dropping folders
replaces any existing folder(s) of the same name. Also note that your switch ( -r)
requirements can be different from the example shown. Contact your system administrator
if you have questions about proper syntax.
•
(Windows) Use a copy command from a command prompt or drag-and-drop the files to the
destination.
8. Expand Applications > Enterprise Applications.
9. Select the IBM FileNet P8 Documentation site.
10. Start the existing documentation site.
11. Continue as follows:
•
If you have added expansion products you will need to update the search index add on
documentation for expansion products, go on to the procedure in the following topic, “Update Help
Search Index” on page 502.
•
If you have no further documentation to install, then go on to the procedure in the topic “Deploy
and Verify IBM FileNet P8 Documentation Web Site” on page 503.
To update the IBM FileNet P8 documentation on JBoss application servers
1. Shut down the application server.
2. Remove the entire existing IBM FileNet P8 Platform documentation application directory.
3. Remove the temporary working directory for the IBM FileNet P8 Platform documentation from
the <JBoss_home>\work\MainEngine\localhost directory.
4. Access the IBM FileNet P8 Platform Documentation package.
5. Copy the ecm_help directory from the package to the existing location on the application server
from which you just removed the old version of the directory.
6. Continue as follows:
•
If you have added expansion products you will need to update the search index. Go on to the
procedure in the following topic, “Update Help Search Index” on page 502.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
501
Task 1: Upgrade IBM FileNet P8 Documentation
Update Help Search Index
•
If you have no further documentation to install, then go on to the procedure in the topic “Deploy
and Verify IBM FileNet P8 Documentation Web Site” on page 503.
Update Help Search Index
Perform this procedure to update the Search index after you have installed all the IBM FileNet P8
Platform and expansion product documentation on a supported application server.
To update the help Search index
NOTE Perform this procedure only if you refreshed the core documentation, or you have installed
expansion product (or customized application) help onto your IBM FileNet P8 documentation
application server. Otherwise, skip to “Deploy and Verify IBM FileNet P8 Documentation Web Site” on
page 503.
1. Make sure that the server on which the documentation is deployed is stopped, and that no
processes are accessing the documentation.
2. If you have previously deployed IBM FileNet P8 documentation as a web application, undeploy
that web application using the procedure for your application server.
3. Make sure you have copied the help for all your various expansion products to a designated
application server location containing the IBM FileNet P8 help. Otherwise, you will have to
repeat this procedure if you add new help later.
4. Open a command prompt or terminal on the application server.
5. From the command line, navigate to the search subdirectory under your ecm_help root directory.
6. Using a text editor, open the search-indexing script file that is appropriate to your application
server operating system:
(UNIX) indexFiles.sh
(Windows) indexFiles.bat
7. If necessary, set the JAVA_HOME variable in the script file with the path to your JRE installation.
The default examples are:
(UNIX) JAVA_HOME="/usr/java/j2sdk1.4.1_02"
(Windows) SET JAVA_HOME=c:\j2sdk1.4.2
NOTE Your JDK reference may be different; use your installed version location if different than
the example.
8. Save your changes and close the text editor.
9. If you intend to run the search indexer on a UNIX application server, ensure that you add
execute permissions (chmod 755) to the indexFiles.sh file.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
502
Task 1: Upgrade IBM FileNet P8 Documentation
Deploy and Verify IBM FileNet P8 Documentation Web Site
10. Run the updated search-indexing script file.
By default, the script backs up the existing index files to indexOld, and then re-indexes all the
help files starting from the root ecm_help directory.
NOTE As you run the search-indexing script, you may notice periodic Parse Abort errors. You
can ignore these error conditions, as they are benign and do not adversely affect the overall
indexing process.
11. Go on to the procedure in the next topic “Deploy and Verify IBM FileNet P8 Documentation Web
Site” on page 503.
Deploy and Verify IBM FileNet P8 Documentation Web Site
Perform this procedure after you have installed (and, if necessary, reindexed) the IBM FileNet P8
documentation on a supported application server.
To deploy and verify the IBM FileNet P8 documentation web site
1. Deploy or install the copied IBM FileNet P8 documentation as a web-site application. Use the
appropriate instructions provided with your application server.
2. Verify that the application server and the new IBM FileNet P8 documentation web site are
running, as follows:
a. From your web browser, access the following URL. The documentation's Help Directory
should open.
http://<docserver>:<port#>/<contextRoot>/
where:
docserver is the name of the Java web server.
port# is the port number.
contextRoot is the value of the Map to URL field that you specified when you deployed
the IBM FileNet P8 documentation application. If you specified /ecm_help, then the
contextRoot is ecm_help.
NOTE You can use multi-part root folders (e.g., /docs/ecm_help) if your application
server supports them.
b. Click the Search link on the Help Directory toolbar. The documentation Search page should
open.
c. Select one of the Search query result links. The associated help page should open.
NOTE When it is time to configure the online help location for the various IBM FileNet P8
components, either while running Setup programs or later via site preferences settings, use
the URL in the example in Step a above.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
503
Task 2: Verify Current Release Level
To verify your IBM FileNet P8 system is ready for upgrade
Task 2: Verify Current Release Level
Before you begin your IBM FileNet P8 Platform upgrade, you must first verify that your current
system is running the software release and component fix pack levels supported for upgrade.
See the section “Plan the Upgrade” on page 476 for a list of upgrade paths, planning considerations,
and pre-upgrade information and tasks that you must take into account, even before performing
the task presented below.
To verify your IBM FileNet P8 system is ready for upgrade
1. Run the IBM FileNet P8 Platform 3.5.x Version Tools. See the IBM FileNet P8 Platform 3.5.x
Version Tools Technical Notice. These tools will identify what release and fix pack level of IBM
FileNet P8 software you are currently running. To download this guide from the IBM support
page, see “Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
2. Ensure that all your users have closed their sessions and no longer have access to the system.
NOTE You may choose to shut down all your IBM FileNet P8 Platform components as part of
this step. However, be aware that some components (e.g., Content Engine) must be running to
begin the actual upgrade process, so the associated setup programs will restart the software
as needed.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
504
Task 3: Upgrade Content Engine Software
To create the database for the GCD
Task 3: Upgrade Content Engine Software
Upgrading Content Engine software from version 3.5.x to 4.0.0 involves the following major steps
(shown later in this task topic) to be done in the order shown:
1. Prepare Content Engine for upgrade.
a. Create a database for the Global Configuration Data (GCD).
b. Create or designate user accounts required for upgrading Content Engine.
c. Gather information about all your 3.5.x authentication realms.
d. If you have not already done so, install and configure the application server on the host
machine on which Content Engine 4.0.0 is to be deployed.
e. Verify that all in-progress event actions have finished.
f.
Verify that all publishing requests have been completed.
g. Delete custom subclasses of the PublishRequest object.
h. Verify that all pending content transactions, indexing requests, and fixed-content migration
requests have completed.
i.
If you use the full-text search feature (CBR) in 3.5.x, you must install and configure ContentSearch Engine (Autonomy K2).
j.
Stop and disable all Content Engine 3.5.x services.
k. Back up the databases used by Content Engine.
2. Install and deploy Content Engine 4.0.0 on an application server.
3. If your existing FileNet P8 domain includes a SnapLock fixed content device and version 4.0.0 of
Content Engine will be on a UNIX platform, prepare the device for upgrade.
To create the database for the GCD
Do the upgrade-applicable configuration procedures listed in one of the following tasks,
depending on your database type, to create the GCD:
•
“Verify that DB2 Server Is Installed for IBM FileNet P8” on page 114
•
“Verify that Microsoft SQL Server Is Installed for IBM FileNet P8” on page 101
•
“Verify that Oracle Server Is Installed for IBM FileNet P8” on page 106
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
505
Task 3: Upgrade Content Engine Software
To create or designate user accounts required for upgrade
To create or designate user accounts required for upgrade
Create or designate the following accounts, which are required to complete a Content Engine
upgrade. Note that you may have to make some additional configurations to your existing security
accounts. See “Specify IBM FileNet P8 Accounts” on page 72 for further account-related details.
User Account
Description
Content Engine Upgrader Tool User
The Windows operating system user who runs
Upgrader Tool needs the following permissions:
P8 4.0 GCD Administrator
P8 4.0 Content Engine Operating System
User
•
Read access to the Content Engine 3.5.x
directory (default location is C:\Program
Files\FileNet\Content Engine).
•
Read access to the 3.5.x version of sysinit.dat.
•
Read/write access to the root directories for the
file storage areas
To do upgrades, at least one P8 4.0 GCD
administrator must:
•
Be an object store administrator for all object
stores to be upgraded. Use P8 3.5.x FileNet
Enterprise Manager to ensure that this user
has Full Control to each P8 3.5.2 object store.
•
Have Full Control for the P8 3.5.x and P8 4.0.x
domains.
The operating system user that the P8 4.0 Content
Engine software runs as. This user must also have
read/write access to the root directories for the P8
3.5.x file stores.
If version 3.5.x file stores are on a SnapLock fixed
content device, then this user must also have read/
write access to the device.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
506
Task 3: Upgrade Content Engine Software
To create or designate user accounts required for upgrade
User Account
Description
Database User - SQL Server
For each object store you are going to upgrade,
grant the associated 3.5.x database user at least
the following additional roles and access
permissions:
SQL Server roles
•
System Administrators
•
Security Administrators
•
Database Creators
Database access (for GCD and object stores)
•
public
•
db_owner
Add to the SQL Server master database and grant
these roles:
Database User - Oracle
Database User - DB2
•
public
•
SqlDBCXAUser (so the SQL Server user can
participate in distributed transactions with the
JDBC driver)
For each object store you are going to upgrade,
grant the associated 3.5.x tablespace user at least
the following additional roles and access
permissions:
•
CREATE SESSION
•
CREATE TABLE
•
CREATE SEQUENCE
An operating system user on the database server
with the following DB2 database permissions. In
the case of a remote database, no equivalent users
are needed on the Content Engine server.
•
Connect to the database
•
Create tables in the tablespace (CREATETAB)
•
Use the tablespace (USE OF) for User and
User Temp tablespaces
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
507
Task 3: Upgrade Content Engine Software
To gather 3.5.x P8 domain authentication information
User Account
Description
K2 Security User
When upgrading full-text indexes (Verity
collections), Upgrader Tool interacts with the
Autonomy K2 server software, and requires a K2
user name and password.
K2 Operating System User
The Autonomy (Verity) K2 software runs as this
operating system user.
•
This user must also have read/write access to
the root directories for the P8 3.5.x file stores.
To gather 3.5.x P8 domain authentication information
Note down the type, Host name and Port of your 3.5.x authentication provider, and have the
information available while installing your new Content Engine 4.0.0 system. For more
information, see “Gather 3.5.x authentication information and plan 4.0 authentication.” on page 482.
To install and configure an application server for Content Engine Server
1. Install one of the following IBM FileNet P8-supported application servers on the machine that
will host version 4.0.0 of Content Engine Server:
•
WebSphere Application Server
•
WebLogic Server
•
JBoss Application Server
2. Configure the application server according to one of the following topics:
•
“Configure an Application Server for Content Engine (WebSphere)” on page 134
•
“Configure an Application Server for Content Engine (WebLogic)” on page 138
•
“Configure an Application Server for Content Engine (JBoss)” on page 146
To verify that all in-progress event actions have finished
Verify that all in-progress event actions have been processed by launching Enterprise Manager
and doing the following for each object store:
1. In the list view, under the object store icon, right-click the Search Results folder, and choose
New Search.
2. In the Content Engine Query Builder dialog box, choose QueueItem from the Select From Table
list.
3. Retain all default settings and click OK. (Click Yes at the prompt for a WHERE clause.)
4. If any event items remain in the queue, you will see them in the Query Status dialog box. If no
event items appear, then all events have been processed.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
508
Task 3: Upgrade Content Engine Software
To verify that publishing requests have been completed
If any event items do remain in the queue, you will see them in the Query Status dialog box. To
remove unwanted items, set up the same search again; but this time select the Delete check
box in the Action tab of the Search dialog box, before clicking OK. Click OK again to confirm
the deletion.
To verify that publishing requests have been completed
1. Start Enterprise Manager.
2. In each object store to be upgraded, do the following:
a. Expand the Publishing folder and click Queue and choose View > All requests.
b. Verify that the queue (right pane) of publishing requests is empty. If the queue is not empty,
do the following:
i.
Wait until all publish requests in the In Queue state or In Work state are processed.
ii.
If any publish requests are in the In Error state, contact your publishing administrator for
the appropriate action to take (such as retrying after correcting the error or just deleting
the item).
3. In the list view, under the object store icon, right-click the Search Results folder, and choose
New Search.
4. In the Content Engine Query Builder dialog box, choose PublishRequest from the Select From
Table list.
5. Retain all default settings and click OK, and then click Yes at the prompt for a WHERE clause.
6. Manually delete any publishing requests displayed in the Query Status window.
To delete custom subclasses of the PublishRequest object
Before Upgrader Tool can upgrade an object store, you must delete any custom subclasses of the
PublishRequest class, along with any instances of such subclasses, as shown in the following
steps:
1. Start version 3.5.x of Enterprise Manager.
Do Step 2 and Step 3 for each object store.
2. In the left pane of Enterprise Manager, open an object store, and navigate to Other Classes >
Publish Request.
3. In the right pane, delete any custom subclasses of Publish Request and any instances of such
subclasses.
4. Exit from Enterprise Manager.
To verify that all in-progress Content Engine transactions involving content files have finished
Before upgrading Content Engine, you must verify that all pending content transactions, indexing
requests, and fixed-content migration requests have completed. You can do this by running the
Content Resource Manager utility, RMU.exe, as shown in the following steps:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
509
Task 3: Upgrade Content Engine Software
To install and configure Content-Search Engine (Autonomy K2)
CAUTION All transactions and requests must have completed before you upgrade Content
Engine; otherwise the upgrade will fail.
1. On each machine where Content Engine 3.5.x is installed, do the following:
a. Start File Store Service if it is not already running.
b. Stop Object Store Service and Content Cache Service.
2. On a machine where Content Engine 3.5.x is installed, start RMU.exe, located (by default) at
C:\Program Files\FileNet\Content Engine.
3. In the Content Resource Manager Utility window, do the following:
a. Navigate to Statistics > Transactions and note the values of Total prepared <phase 1>, Total
committed, and Total aborted.
b. Navigate to Statistics > Can't Do Queue and note the value of Current items in the can't do
queue.
c. Add the values of Total committed and the Total aborted. If the sum equals the value of Total
prepared <phase 1>, and the value of Current items in the can't do queue is zero, then all
content transactions have completed.
d. Navigate to Indexing Service > Index Control. If the value of Current index queue files is
zero, then all pending indexing requests have completed.
e. Navigate to Fixed Content > Migration Queuing. If the value of Current number in queue is
zero, then all fixed-content migration requests have completed.
4. If all activity checked in Step 3 has completed, then stop File Store Service on each machine
where Content Engine 3.5.x is installed, and continue at “To stop and disable all Content-Enginerelated services on all servers in the FileNet P8 domain” on page 510; otherwise, do the following:
a. Exit from the Content Resource Manager utility.
b. Wait a few minutes, and then return to Step 1.
To install and configure Content-Search Engine (Autonomy K2)
If you use the full-text search feature (CBR) in 3.5.x, you must install and configure ContentSearch Engine (Autonomy K2) so that your existing content-search indexes (Verity collections)
can be upgraded as part of “Upgrade Content Engine Data” on page 523. To install and configure
Content-Search Engine, complete Installation task “Install and Configure Content Search Engine” on
page 174.
To stop and disable all Content-Engine-related services on all servers in the FileNet P8 domain
1. On each machine where version 3.5.x of Content Engine Server software is installed, log on with
local administrator permissions.
2. Stop and disable the following services:
•
Apache2
•
Content Engine Content Cache Service
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
510
Task 3: Upgrade Content Engine Software
To verify the directory permissions on file stores
•
Content Engine File Store Service
•
Content Engine Object Store Service
•
FileNet Publishing HTML Plug-in Service
•
FileNet Publishing PDF Plug-in Service
•
Process Services Manager
•
Wasp Server for Java
3. Right-click the Apache services monitor in the Windows system tray and click Exit.
To verify the directory permissions on file stores
If the application server on which Content Engine Server 4.0.0 is to be deployed is running on
Windows, then give the following users write permission to the root directory where a 3.5.x file
store is located. (This procedure is necessary to allow conversion to a 4.0.0 file storage area
during upgrade.)
•
The user running the Upgrader Tool
•
The user running the application server (for WebSphere on Windows, this user is a service
log-on account)
To back up the database
Use your existing database backup solution to back up the Content Engine 3.5.x object store
databases.
To upgrade Content Engine
1. Continue at “Install and Deploy Content Engine” on page 187 to run Content Engine Setup to install
version 4.0.0 Content Engine Server. On a Windows machine, Content Engine Setup
automatically installs Enterprise Manager.
CAUTION Do not install Enterprise Manager on any machine running the 3.5.x version—at
least until after the upgrade of Content Engine to version 4.0.0 is complete. Otherwise, you
will no longer be able to run the 3.5.x version of FileNet Enterprise Manager against any
remaining 3.5.x object stores.
2.
If you have NetApp fixed content devices, continue at “To prepare NetApp SnapLock Volumes for
the upgrade” on page 511; otherwise, go to “Install Content Engine Software Updates” on page 515.
To prepare NetApp SnapLock Volumes for the upgrade
If each of the following conditions apply, you must do this procedure; otherwise continue at “Install
Content Engine Software Updates” on page 515:
•
Version 4.0.0 of Content Engine is on a UNIX platform.
•
Your existing FileNet P8 domain includes a SnapLock fixed content device.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
511
Task 3: Upgrade Content Engine Software
To prepare NetApp SnapLock Volumes for the upgrade
Do this procedure for each of your NetApp filers (network-attached appliances for data storage) to
allow access to your fixed content via NFS instead of, or in addition to, CIFS.
1. Check prerequisites
a. Check the IBM FileNet P8 Hardware and Software Requirements to verify your NetApp filers
use the version of the Data ONTAP operating system that is supported in version 4.0.0 of
IBM FileNet P8. To download this guide from the IBM support page, see “Access IBM
FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
For information on accessing and configuring your NetApp filers, consult the following
Data ONTAP manuals:
•
System Administration Guide
•
Software Setup Guide
•
File Access and Protocols Management Guide
b. Make sure you are licensed to use NFS to access your NetApp filers.
2. Set the security style of a NetApp storage volume to enable support for NFS clients
Each qtree (virtual subvolume of a storage volume) has exactly one of the security styles
(scheme for setting security on files and directories in the qtree) shown in the following table:
Security Style
Description
UNIX
UNIX file permission attributes. Only NFS clients can create files and
directories in a UNIX qtree.
NTFS
Windows access control lists. Only CIFS clients can create files and
directories in an NTFS qtree.
Mixed
Both UNIX and NTFS security styles. Only one security style at a time is
allowed. The current style is that of the last client to modify it.
Since all pre-4.0.0 versions of IBM FileNet P8 support only CIFS, all NetApp storage volumes
used by Content Engine Server use NTFS security style, which you must change to UNIX or
Mixed. Specify the Mixed style for qtrees that must service requests for both NFS and CIFS
clients during the upgrade process; otherwise, specify UNIX style.
For each qtree, do the following steps to specify the security style:
a. Access the Data ONTAP administrative console (see the ONTAP System Administration
Guide for information on administrative access methods).
b. Run the qtree command as in the following example, which sets the UNIX security style on
the qtree /vol/vol1/sa1 of NetApp filer NAFiler the security style to UNIX:
telnet NAFiler
qtree security /vol/vol1/sa1 unix
After the qtree command executes, all files created by Content Engine Server on a UNIX
platform will have UNIX security attributes.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
512
Task 3: Upgrade Content Engine Software
To prepare NetApp SnapLock Volumes for the upgrade
513
3. Map UNIX users and groups to Window equivalents
Because version 3.5.x of Content Engine Server support CIFS, rather than NFS, all existing
files on a NetApp volume have NTFS security attributes; and the users and groups with
access rights to these files are defined by Windows.
To allow version 3.5.x files to remain accessible, you must create a mapping between the new
UNIX account for version 4.0.0 of Content Engine Server and the old Windows account for
version 3.5.x.
Each NetApp filer has its own configuration file, /etc/usermap.cfg, to map between Windows
user names and equivalent UNIX user names. A UNIX user attempting to access a file having
NTFS security attributes uses usermap.cfg to determine if a mapping exists between the UNIX
account and an equivalent Windows account. If the mapping exists, the access checks on the
target file will use the Windows account.
Each usermap.cfg entry has the following format:
[IP_qualifier:] Windows_name [direction] [IP_qualifier:] UNIX_name
The meaning of each element in the entry is shown in the following table:
Element
Meaning
IP_qualifier
Qualifies the name according to the source address of the requester
Windows_name
The name of the Window user or group in domain name format (for example,
DomainName\UserName). The Windows name must be in the Windows
domain that the NetApp filer is configured to use when authenticating
Windows users.
UNIX_name
The name of a UNIX user or group. The name must be defined in the file or
directory service that the NetApp filer uses to authenticate UNIX users. In
many cases this will be the local /etc/passwd (for users) or /etc/group (for
groups).
If it is a group, it may be necessary to also define it in an NIS repository or
an LDAP directory server, depending on how the filer is configured.
In either case the UID (UNIX user ID) must be identical to the UID of the user
under which the Content Engine Server is executing.
Direction
The direction of the mapping, either <= or =>.
<=: Maps UNIX_name to Windows_name
=>: Maps Windows_name to UNIX_name
For example, the following steps define a mapping on a NetApp filer between FNCE_OS_User
(the Windows user account under which version 3.5.x of Content Engine Server executes) and
FNCE_UNIX_User (the UNIX user account under which version 4.0.0 of Content Engine
Server executes).
a. Log on to the machine where version 3.5.x of the Content Engine is installed.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
Task 3: Upgrade Content Engine Software
To prepare NetApp SnapLock Volumes for the upgrade
b. Connect to the root volume on the target NetApp filer using the Administrator account.
By default, the NetApp filer root volume is accessible from a Windows client as a CIFS
share named C$), as in the following example (where NAFiler is the host name of the
target NetApp filer at your site.
C\> net use n: \\NAFiler\C$ /user:NAFiler1\Administrator
c. Edit /etc/usermap.cfg by adding the following stanza:
CEDomain\FNCE_OS_User => FNCE_UNIX_User
d. Edit /etc/passwd by adding the following stanza:
FNCE_UNIX_User:CEServers:205:7100::/home/FNCE_UNIX_User:
4. Continue at “Install Content Engine Software Updates” on page 515.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
514
Task 4: Install Content Engine Software Updates
To install the Content Engine software updates
Task 4: Install Content Engine Software Updates
Install any service packs, fix packs and/or interim fixes required for Content Engine.
To install the Content Engine software updates
1. To download the latest software update, and to determine whether additional interim fixes are
needed, contact your service representative.
2. Open the readmes for the following software updates and perform the installation procedures
provided:
a. P8CE-4.0.0-002 Service Pack (or later)
b. Any subsequent interim fixes (typically optional)
3. Continue at “Upgrade Content Engine Data” on page 523.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
515
Task 5: Install the Latest Process Engine Client Files on Content Engine Servers
To install the Process Engine Client files
Task 5: Install the Latest Process Engine Client Files
on Content Engine Servers
Install the Process Engine Client files for the 4.0.x release or fix pack version of Process Engine
you intend to run. Perform the following steps on all Content Engine servers. These steps apply to
WebSphere, WebLogic, and JBoss (except where noted).
To install the Process Engine Client files
1. To download the latest software updates, and to determine which of these updates may be
required for use with other components and expansion products, contact your service
representative.
2. Log on to the Content Engine server as a user who has permission to install software.
3.
Verify that there is a current backup.
4. Download and expand the appropriate tar or zip file to the Content Engine server and extract the
contents to a local directory.
5. (WebSphere only) Make a note of the max and min connection settings from the
FileNetConnectionFactory.
You will need to reset these when you redeploy Content Engine. For details, see Step c in the
task “Redeploy Content Engine” on page 519.
6. Close all instances of Enterprise Manager (EM) and any other Content Engine client
applications, such as Application Engine. From the application server administrative console,
stop and un-deploy Content Engine.
•
WebSphere: Stop and un-deploy the FileNet Content Engine Application (Engine-ws.ear).
•
WebLogic: Stop and un-deploy the FileNet Content Engine Application (Engine-wl.ear).
•
JBoss: Execute the shutdown command.
7. (WebLogic only) Manually delete the following application server cache directories, substituting
your domain name and machine name in place of mydomain and myserver, respectively:
WebLogic 8.1.x UNIX:
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/tmp/_WL_user\Engine-wl
/opt/ bea/user_projects/domains/mydomain/servers/.wlnotdelete
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/cache/
EJBCompilerCache
WebLogic 8.1.x Windows:
C:\bea\user_projects\domains\FNCEDomain\myserver\.wlnotdelete\EJBCompilerCache
C:\bea\user_projects\domains\FNCEDomain\myserver\.wlnotdelete
WebLogic 9.2.x UNIX:
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
516
Task 5: Install the Latest Process Engine Client Files on Content Engine Servers
To install the Process Engine Client files
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/tmp/_WL_user\Engine-wl
/opt/ bea/user_projects/domains/mydomain/servers/.wlnotdelete
/opt/bea/user_projects/domains/mydomain/servers/AdminServer/cache/
EJBCompilerCache
WebLogic 9.2.x Windows:
C:\bea\user_projects\domains\mydomain\servers\AdminServer\tmp\_WL_user\Engine-wl
C:\bea\user_projects\domains\mydomain\servers\.wlnotdelete
C:\bea\user_projects\domains\mydomain\servers\AdminServer\cache\EJBCompilerCache
8. Start the Process Engine client install process.
–
To install the Process Engine client interactively:
i.
Access the IBM FileNet Process Engine client update software.
ii.
Launch the appropriate install program, where <PE_version> is the version of Process
Engine you intend to run, for example, 4.0.3.
•
Windows:
P8PEClientUpdater-<PE_version>-Win.exe
•
UNIX:
P8PEClientUpdater-<PE_version>-<operating system>.bin
iii. Continue with Step 9 on page 518 below.
–
To install the Process Engine client silently:
i.
Access the IBM FileNet Process Engine client update software package, and copy the
P8PEClient_silent_input.txt file to a local directory.
ii.
Follow the instructions in the silent input file to edit the file to reflect the appropriate
responses for your update.
iii. Run the PE Client installer with the following arguments, where <PE_version> is the
version of Process Engine you intend to run, for example, 4.0.3:
Windows:
P8PEClientUpdater-<PE_version>-Win.exe -silent -options
<path>\<P8PEClient_silent_input.txt>
UNIX:
P8PEClientUpdater-<PE_version>-<operating system>.bin -silent -options
<path>/<P8PEClient_silent_input.txt>
iv. Continue with Step 10 on page 518 below.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
517
Task 5: Install the Latest Process Engine Client Files on Content Engine Servers
To install the Process Engine Client files
9. Complete the Setup screens as follows:
In this screen...
Perform this action...
Products to Update
Select Content Engine.
Depending on the
version of Content
Engine detected by the
installer, you will see one
of the following:
Select Content
Engine EAR File to
Update
Select the appropriate EAR file. In most cases, this will be the
deployed EAR file.
Select Content
Engine Server to
Update
Choose a Content Engine Server instance from the drop-down
list.
or
Stop Running Software
If prompted, stop all running software components
Installation Summary
Validate that the information displayed is correct and that there
is enough space to complete the installation.
Software Components
Select the software components to automatically start after the
installation is complete.
10. Redeploy the Content Engine application, using the instructions in Task 6 “Redeploy Content
Engine” on page 519.
IBM FILENET P8 PLATFORM INSTALLATION AND UPGRADE GUIDE
518
Task 6: Redeploy Content Engine
To redeploy Content Engine on WebSphere 5.1.x and 6.0.x
Task 6: Redeploy Content Engine
The procedures in this topic explain how to redeploy Content Engine on a standalone server. For
Content Engine in a managed server environment, see the procedures in “Deploy Multiple Content
Engine Instances” on page 454. For Content Engine in a clustered environment, see the IBM FileNet
P8 High Availability Technical Notice. To download this guide from the IBM support page, see
“Access IBM FileNet Documentation, Compatibility Matrices, and Fix Packs” on page 23.
Perform the redeployment procedure appropriate for your Content Engine application server type:
•
“To redeploy Content Engine on WebSphere 5.1.x and 6.0.x” on page 519
•
“To redeploy Content Engine on WebSphere 6.1.x” on page 520
•
“To redeploy Content Engine on WebLogic” on page 522
•
“To redeploy Content Engine on JBoss” on page 522
To redeploy Content Engine on WebSphere 5.1.x and 6.0.x
1. From the WebSphere administrative console, go to Applications > Install New Application.
2. From the EAR/WAR/JAR module page, in the local or remote file system:
a. Navigate to the new Engine-ws.ear file.
b. Click Next.
c. Accept the defaults. When you see the "Provide options to perform the EJB Deploy" step,
change the "Database Type" to the current GCD database type (for example,
MSSQLSERVER_2000).
3. Save the changes to the master configuration.
4. Create a new J2C connection factory.
a. Go to Applications> Enterprise Applications> FileNetEngine> Connector Modules>
engine.ear> Resource Adapter> J2C Connection Factories.
b. If a connection factory already exists, click the factory name, and modify the properties as
follows. If a connection factory does not exist, click New to create a new J2C connection factory:
Name: FileNetConnectionFactory
JNDI name: FileNet/Local/ConnectionFac