Plan and Prepare Your Environment For FileNet P8
Plan and Prepare Your Environment For FileNet P8
Version 5.2.1
IBM
GC19-3955-04
FileNet P8
Version 5.2.1
IBM
GC19-3955-04
Note
Before using this information and the product it supports, read the information in Notices on page 185.
This edition applies to version 5.2.1 of IBM FileNet Content Manager (product number 5724-R81), version 5.2.1 of
IBM Case Foundation (product number 5724-R76), and to all subsequent releases and modifications until otherwise
indicated in new editions.
Copyright IBM Corporation 2001, 2016.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
ibm.com and related resources . . . . vii Choosing a standby index area activation
Contacting IBM . . . . . . . . . . . . . vii policy for IBM Content Search Services . . 28
Configuring AIX, HPUX, HPUXi, Linux, Linux
Planning and preparing for FileNet P8 on System z, or Solaris . . . . . . . . 28
Configuring AIX, HPUX, HPUXi, Linux,
installation . . . . . . . . . . . . . 1 Linux on System z, or Solaris for FileNet
Planning the installation . . . . . . . . . . 1 P8 servers (all components) . . . . . . 29
FileNet P8 Platform sample architecture . . . . 1 Configuring Content Platform Engine
Installation scenarios. . . . . . . . . . . 2 servers (AIX, HPUX, HPUXi, Linux, Linux
Overview of installation types . . . . . . 3 on System z, or Solaris) . . . . . . . 29
Single server scenario . . . . . . . . . 6 Configuring IBM Content Search Services
Standard distributed scenario . . . . . . . 7 servers (AIX, Linux, Linux on System z,
Content Platform Engine distributed Solaris) . . . . . . . . . . . . . 30
installation scenario . . . . . . . . . 7 Configuring Application Engine (Solaris) 32
IBM Content Search Services distributed Configuring Application Engine or
installation scenario . . . . . . . . . 8 Workplace XT servers (Linux) . . . . . 33
Application Engine distributed installation Configuring Microsoft Windows . . . . . 33
scenario . . . . . . . . . . . . . 9 Configuring Windows for FileNet P8
Multiple domain scenario. . . . . . . . 10 servers . . . . . . . . . . . . . 33
Definition of installation roles . . . . . . . 11 Configuring Windows for .NET and COM
Using the installation and upgrade worksheet . . 13 compatibility clients . . . . . . . . 33
Running the Customize Worksheet macro . . 13 Configuring Windows for Content Platform
Autofiltering and sorting the Worksheet . . . 14 Engine on Active Directory . . . . . . 34
Performing the required installation preparation Adding inbound rules to the Windows
tasks. . . . . . . . . . . . . . . . . 15 2008 firewall . . . . . . . . . . . 34
IT administrator installation tasks . . . . . . 15 Configuring the network . . . . . . . . 34
Creating Content Platform Engine operating Prerequisites to configuring your network 34
system accounts . . . . . . . . . . . 16 Synchronizing machine clocks . . . . . 35
Creating the Content Platform Engine Creating a local or shared directory for the
application server installation administrator 17 shared configuration files (Application
Creating the Content Platform Engine Engine or Workplace XT) . . . . . . . 35
application server installation group . . . 18 Storage area options for object stores . . . . 35
Creating Content Platform Engine installer Advantages of advanced storage areas . . . 36
account . . . . . . . . . . . . . 19 Replication models for advanced storage areas 37
Creating Content Platform Engine Preparing advanced storage areas . . . . . 39
operating system user account . . . . . 19 Preparing file servers for file storage areas . . 40
Creating Configuration Manager user . . 20 Configuring file servers for file storage
Creating the Content Platform Engine user areas . . . . . . . . . . . . . 40
account for DB2 for Linux, UNIX and Configuring account settings on file servers 41
Windows . . . . . . . . . . . . 21 Configuring the remote access protocol on
Creating the Content Platform Engine user the client machine . . . . . . . . . 43
account for DB2 for z/OS . . . . . . 21 Using IBM Support data collection tools . . . 44
Creating the Content Platform Engine Security administrator installation tasks . . . . 45
instance accounts for DB2 for z/OS . . . 22 Security planning considerations . . . . . 45
Creating Application Engine or Workplace XT Configuring directory server. . . . . . . 48
accounts . . . . . . . . . . . . . 22 Configuring Windows Active Directory . . 49
Creating the Application Engine or Configuring Active Directory Lightweight
Workplace XT installer account . . . . . 23 Directory Services (AD LDS). . . . . . 49
Creating the Application Engine or Configuring Oracle Directory Server
Workplace XT deployment account . . . 25 Enterprise Edition . . . . . . . . . 50
Preparing for IBM Content Search Services . . 25 Configuring Novell eDirectory . . . . . 51
Creating IBM Content Search Services Configuring Oracle Internet Directory . . 51
accounts . . . . . . . . . . . . 26 Configuring IBM Tivoli Directory Server. . 52
Choosing a load balancing method for IBM Configuring IBM virtual member manager 52
Content Search Services servers. . . . . 27 Configuring CA Directory . . . . . . 57
Contents v
Application Engine and Workplace XT ports . . . 176 Content Services for FileNet Image Services ports 182
Process Simulator ports . . . . . . . . . . 176
Content Search Services ports . . . . . . . . 177 Notices . . . . . . . . . . . . . . 185
Rendition Engine and Content Platform Engine Trademarks . . . . . . . . . . . . . . 187
ports for LIQUENT . . . . . . . . . . . 178 Privacy policy considerations . . . . . . . . 188
Database ports . . . . . . . . . . . . . 180
IBM System Dashboard for Enterprise Content
Index . . . . . . . . . . . . . . . 191
Management ports . . . . . . . . . . . 181
From ibm.com, click Support & downloads and select the type of support that you
need. From the Support Portal, you can search for product information, download
fixes, open service requests, and access other tools and resources.
You can view the product documentation online in IBM Knowledge Center or in
an Eclipse-based information center that you can install when you install the
product. By default, the information center runs in a web server mode that other
web browsers can access. You can also run it locally on your workstation.
Use the following links to view the IBM Knowledge Center online product
documentation that is appropriate for your configuration. For IBM FileNet P8
documentation, see http://www.ibm.com/support/knowledgecenter/
SSNW2F_5.2.1/. For IBM Content Foundation, see http://www.ibm.com/support/
knowledgecenter/SSGLW6_5.2.1/.
PDF publications
See the PDF publications that are available for your product at the following links:
Product Website
IBM FileNet P8 Platform http://www.ibm.com/support/
publication library docview.wss?uid=swg27042122
IBM Content Foundation http://www.ibm.com/support/
publication library docview.wss?uid=swg27042128
Contacting IBM
For general inquiries, call 800-IBM-4YOU (800-426-4968). To contact IBM
customer service in the United States or Canada, call 1-800-IBM-SERV
(1-800-426-7378).
Contacting IBM
For general inquiries, call 800-IBM-4YOU (800-426-4968). To contact IBM customer
service in the United States or Canada, call 1-800-IBM-SERV (1-800-426-7378).
For more information about how to contact IBM, including TTY service, see the
Contact IBM website at http://www.ibm.com/contact/us/.
The following graphic shows just one of many possible configurations of a FileNet
P8 Platform installation.
Ethernet
Database Directory
Process Rendition
servers server
Simulator Engine
IBM
Content
External Search
client Services
workstation File storage servers,
fixed content devices,
advanced storage servers
Tools Third-party products Windows only
installed with
Content
Platform Engine
Installation scenarios
Depending on how you plan to use your FileNet P8 system, you might make
different choices in how you install the components. You can review the possible
FileNet P8 environment scenarios to help you plan your installation process.
Overview of installation types on page 3
Before putting your FileNet P8 system into production, it is often a good idea
to install it several times, with each installation fulfilling a different purpose.
Single server scenario on page 6
You can install FileNet P8 by using the Composite Platform Installation Tool.
This tool installs all the middleware products and all the FileNet P8
components on a single server in one installation session.
Standard distributed scenario on page 7
In a typical distributed installation scenario, you install the FileNet P8 platform
components on a system of networked servers. You can install some
components as stand-alone applications, or install multiple instances of a single
component.
During your planning phase, you decide which of the installation scenarios, such
as the single server, the standard distributed, or the high availability scenario,
would be best to use for the following types of installations:
v Proof of concept
v Development
v Test
v Preproduction
v Disaster recovery
v Production
Proof of concept system
A proof of concept system can be used to demonstrate basic functionality,
such as document management and simple workflow, to a prospective
customer, a development partner, or a set of users.
This system might be a single-server configuration of just the core FileNet
P8 components you want to demonstrate. Or it could be the core
components plus one or more expansion products that are important to
your intended development activities or your audience.
The Composite Platform Installation Tool (CPIT) provides a quick way to
create a proof of concept system on one server. It automatically configures
the underlying required software and applies a baseline set of default
FileNet P8 configuration settings. However, make sure that you are aware
of the following factors:
v It does not install IBM Content Search Services or configure other
add-ons or expansion products.
v It uses WebSphere Application Server, DB2 for Linux, UNIX and
Windows, and Tivoli Directory Server only. This is the only
configuration installed and configured by the Composite Platform
Installation Tool.
v After a Composite Platform Installation Tool installation, consider
upgrading the components to the latest supported fix pack levels. You
can also add more products to the installation or interface with
components and products that are installed on other computers.
v It installs onto one server only.
v The Installation and Upgrade Worksheet is not needed when you use
the Composite Platform Installation Tool.
Before you install a proof of concept system, make the following decisions:
v Decide whether using the Composite Platform Installation Tool is
sufficient to achieve your proof of concept, or whether you need a more
complex system, with multiple servers and essential add-ons, or with
different components. In this case, you would probably follow the
standard distributed scenario.
The result is a FileNet P8 system most typically used for the following tasks:
v Developing and demonstrating proofs of concept
v Previewing technology
v Demonstrating and understanding content and process management
functionality
v Configuring a basic content and process management solution
If you plan to run a single server installation by using the Composite Platform
Installation Tool, you do not need to do most of the preparation tasks that you
must perform for any of the other installation scenarios. Also, you do not need to
fill out the Installation and Upgrade Worksheet. The Composite Platform
Installation Tool provides all the values needed for a fully functional FileNet P8
system.
You can choose to collocate some FileNet P8 platform components. For details on
collocation decisions, see the IBM FileNet P8 system requirements.
If you plan to use related add-on products with your FileNet P8 platform
environment, review the installation documentation for the add-ons before you
install and configure FileNet P8.
You can install or deploy multiple instances of Content Platform Engine on a single
web application server.
Using multiple instances of Content Platform Engine means that you can provide a
different repository of content for different areas within an organization. For
example, you could create an instance for use by a Research and Development
group, and create a separate instance for use by a Human Resources group.
Content Platform Engine distributed installation scenario
In a typical distributed installation scenario, you install the FileNet P8 Platform
components on a system of networked servers. You can install some
components as stand-alone applications, or install multiple instances of a single
component.
IBM Content Search Services distributed installation scenario on page 8
In a typical distributed installation scenario you can install IBM Content Search
Services. You can also install IBM Content Search Services to run with
supported custom applications that use IBM FileNet P8 Platform development
tools to operate.
Application Engine distributed installation scenario on page 9
You can install Application Engine as a stand-alone application. You can also
install multiple instances of Application Engine.
Managed deployment
Non-managed deployment
| In a typical distributed installation scenario you can install IBM Content Search
| Services. You can also install IBM Content Search Services to run with supported
| custom applications that use IBM FileNet P8 Platform development tools to
| operate.
Single instance single server deployment
When you deploy a single instance of IBM Content Search Services on a
single server, you must configure your IBM Content Search Services server
for mixed mode (indexing and searching).
Multiple instance single server deployment
You can deploy multiple instances of IBM Content Search Services on a
single server for load balancing and performance. You can configure each
instance of IBM Content Search Services for mixed mode (indexing and
searching) or dedicated mode (indexing or searching) to maximize your
processing requirements.
Multiple instance multiple server deployment
You can deploy multiple instances of IBM Content Search Services on
8 Planning for FileNet P8
multiple servers in a farm configuration for load balancing, performance
and high availability. For high availability, you need to ensure that there
are multiple instances running with mixed mode (indexing and searching)
on multiple servers. For dedicated mode (indexing or searching), you need
to ensure that you have a pair of instances for each mode.
You can install Application Engine as a stand-alone application. You can also install
multiple instances of Application Engine.
Stand-alone deployment
Multi-instance deployment
If you want to deploy multiple Application Engine instances, install and deploy
Application Engine on separate servers.
Each Application Engine instance is isolated from the others, and there is no
exchange of information between the instances. For example, you can dedicate a
Application Engine instance for use by a certain group. This creates a distinct
Workplace interface for the group, and you can configure permissions, settings,
and functions accordingly. For another group, you might want to configure a
separate instance of the Workplace application with different settings. Each
instance has its own user and site preferences. All instances provide an interface to
the Content Platform Engine object stores.
Managed deployment
When you deploy Application Engine with WebSphere Application Server Network
Deployment in a managed mode, you must install and configure Application
Engine on all managed cluster nodes (using the administrative console for the
deployment manager) that are assigned to Application Engine.
Non-managed deployment
Cloud service providers can host services for multiple customers by using the
multiple domain installation scenario. In this scenario, the service provider runs a
master FileNet P8 domain and one or more tenant domains within the same set of
Content Platform Engine servers, thereby reducing the overhead of deploying
separate application server instances of Content Platform Engine for each customer.
Tenants are isolated from each other and operate independently of other tenants.
For example, a tenant object store cannot be accessed from the master domain or
from the other tenant domains.
Each tenant has a single database connection. The tenant GCD database, and all
object stores and isolated regions, use this shared database connection. The service
provider designates what database each tenant uses. A tenant can be configured to
use the same database as either the master domain or another tenant, but the
recommended configuration is for each tenant to use a separate database.
Also note that, in the multiple domain model, there is no mechanism to partition
processing resources (such as memory, CPU cycles, threads, and database
connections) so as to prevent one tenant from using a disproportionate amount of
resources. Because of this, multiple domain configurations are primarily suited for
more narrow applications where the solution does not expose the full capabilities
of the Content Engine and Process Engine APIs. For most customers with a need to
support multiple business units, hosting multiple virtualized P8 domains on
shared hardware is the preferred approach. This approach does provide the ability
to limit the resources used by any tenant, and is therefore more appropriate for
most customers who want to share hardware resources across multiple
applications.
Installation administrator
v Runs FileNet P8 installation programs during initial setup.
v Runs Configuration Manager during initial setup, followed by starting IBM
Administration Console for Content Platform Engine.
v Runs FileNet P8 upgrade programs during upgrades.
v Abbreviated as IA. Responsible for coordinating the information described in
this worksheet. The information itself will require the input from the other roles.
Database administrator
v Creates, configures, maintains database installations and database or table
spaces.
v Responsible for creating database accounts needed by FileNet P8.
v For purposes of this documentation, the database administrator is expected to
have responsibilities regarding the JDBC data sources.
v Abbreviated as DBA. Responsible for providing the information in the rows in
the Installation and Upgrade Worksheet with a value of DBA in the Role column.
FileNet P8 administrator
v This role designation refers to the administrator or administrators who perform
regular maintenance of Content Platform Engine.
v The administrator who logs on to IBM Administration Console for Content
Platform Engine by using the gcd_admin account or an object_store_admin account
is considered a FileNet P8 administrator.
v Abbreviated as P8A. Responsible for providing the information in the rows of
the Installation and Upgrade Worksheet with a value of P8A in the Role column.
Related concepts:
Using the installation and upgrade worksheet on page 13
The Installation and Upgrade Worksheet is a Microsoft Excel spreadsheet
(p8_worksheet.xls). The worksheet describes the properties and parameters
required to complete FileNet P8 installation, upgrade, and configuration programs,
and provides a way to record the values you assign to these properties and
parameters.
IT administrator installation tasks on page 15
The Information Technology administrator must prepare the network and
operating systems, and carry out certain security configurations to prepare your
environment for FileNet P8.
Security administrator installation tasks on page 45
The Security administrator must prepare the security environment for the FileNet
P8 platform, including planning the security environment, configuring the
directory server, and creating accounts.
Database administrator installation tasks on page 70
The database administrator must prepare the databases that are required for
FileNet P8, which includes gathering information about data sources, creating
databases and database accounts.
Important: For support of the full range of built-in filter and macro features, use
Microsoft Excel to view the Installation and Upgrade Worksheet file. You can use
other spreadsheet programs to view the file; however, filter and macro support can
AutoFiltering is a quick way to display only those rows that meet a certain
criterion.
To use AutoFilter:
1. Make sure AutoFiltering is enabled. (Select the entire row with the column
headers, then click Data > Filter > Autofilter.) AutoFilter arrows will appear to
the right of the column labels.
2. Click the AutoFilter arrow in the Installation or Configuration Program
column header and select the program you are interested in (for example, CPE
installer).
3. For a custom AutoFilter, click the AutoFilter arrow in any column header,
select Custom, and use the dialog box to define a filter that will show rows
that meet your criteria.
4. To turn off AutoFiltering in a column, click the column AutoFilter arrow and
select (All).
5. To reorder rows alphabetically, do a Sort:
a. Click anywhere in a column, for example, Column A Role.
Some tasks require input that results from other preparation tasks performed by
other administrator roles. While performing the tasks, record results in the
Installation and Upgrade Worksheet. See the Using the installation and upgrade
worksheet on page 13 topic for details.
To prepare the IBM FileNet P8 environment, perform the tasks assigned to the
following roles.
IT administrator installation tasks
The Information Technology administrator must prepare the network and
operating systems, and carry out certain security configurations to prepare your
environment for FileNet P8.
Security administrator installation tasks on page 45
The Security administrator must prepare the security environment for the
FileNet P8 platform, including planning the security environment, configuring
the directory server, and creating accounts.
Database administrator installation tasks on page 70
The database administrator must prepare the databases that are required for
FileNet P8, which includes gathering information about data sources, creating
databases and database accounts.
Application Server administrator installation tasks on page 95
The Application Server Administrator must prepare the application servers for
FileNet P8, including planning deployment, creating administrative accounts,
and configuring JDBC drivers for Content Platform Engine.
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the worksheet file (p8_worksheet.xls), perform the following actions to quickly
see only the properties assigned to a particular role:
Click the AutoFilter drop-down arrow in the Role column header and select
ITA.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Creating the Content Platform Engine application server installation
administrator
An operating system account you used to install the Content Platform Engine
application server.
Creating the Content Platform Engine application server installation group on
page 18
An operating system group account to which several Content Platform Engine
accounts must belong.
Creating Content Platform Engine installer account on page 19
An operating system account you use to install Content Platform Engine.
Creating Content Platform Engine operating system user account on page 19
The account you use to create and configure the shared root directory of a file
storage area or content cache area.
Creating Configuration Manager user on page 20
An operating system account you use to run Configuration Manager.
Creating the Content Platform Engine user account for DB2 for Linux, UNIX
and Windows on page 21
An operating system account on the database server that Content Platform
Engine uses to access DB2 for Linux, UNIX and Windows.
Creating the Content Platform Engine user account for DB2 for z/OS on page
21
An operating system user account that Content Platform Engine uses to connect
to DB2 for z/OS databases containing the GCD and object stores.
Creating the Content Platform Engine instance accounts for DB2 for z/OS on
page 22
Operating system and database user and group accounts that Content Platform
Engine uses to connect to DB2 for z/OS.
An operating system account you used to install the Content Platform Engine
application server.
1. Create the following operating system account:
Content Platform Engine application server installation administrator
Unique identifier
cpe_appserver_install_user
Description
The cpe_appserver_install_user account is needed during the
installation process to perform the following tasks:
v Create and configure the application server/domain/profile
for Content Platform Engine.
v Start or stop the application server instance when needed.
If you are prompted for credentials (which might happen if
WebSphere Global security is enabled or if WebLogic is in
Planning and preparing for FileNet P8 installation 17
Production Mode), pass in the credentials of the
appserver_admin or appserver_console_user. See those entries for
more information.
v Modify the application server files or directories as needed
for deploying Content Platform Engine using the
Configuration Manager tool.
v Provide create, read and write permissions for directories on
devices or drives that are used for external Content Platform
Engine file storage.
cpe_appserver_install_user must belong to the
cpe_appserver_install_group.
The account you use to create and configure the shared root directory of a file
storage area or content cache area.
1. Create the following operating system account:
Content Platform Engine operating system user
Unique identifier
cpe_os_user
Creating the Content Platform Engine user account for DB2 for Linux, UNIX and
Windows:
An operating system account on the database server that Content Platform Engine
uses to access DB2 for Linux, UNIX and Windows.
1. Create the following operating system account:
Creating the Content Platform Engine user account for DB2 for z/OS:
An operating system user account that Content Platform Engine uses to connect to
DB2 for z/OS databases containing the GCD and object stores.
1. Create the following operating system account:
Content Platform Engine database user (DB2 for z/OS)
Unique identifier
cpedbuser
Description
Creating the Content Platform Engine instance accounts for DB2 for z/OS:
Operating system and database user and group accounts that Content Platform
Engine uses to connect to DB2 for z/OS.
1. Create the following operating system account:
Instance owner and instance owner primary group (DB2 for z/OS)
Unique identifiers
cpe_db_db2_ instanceowner and cpe_db_db2_group
Description
Operating system user and group that must exist on the
database server. The cpe_db_db2_ instanceowner will create
databases and set a number of configuration parameters.
Minimum required permissions
The DBA grants these accounts permissions for Content
Platform Engine access to DB2 for z/OS.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Create the following users and groups. All IBM FileNet Workplace accounts, as
well as accounts for other client applications and expansion products that use
Content Platform Engine or Application Engine, must have passwords.
An operating system account that you use to run the installation program for
Application Engine or Workplace XT.
1. Create the following operating system account:
Application Engine or Workplace XT installer account (Windows)
Unique identifier
ae_install_user or wpxt_install_user
Description
The operating system account you will use to log on to a
Windows machine and launch the Application Engine or
Workplace XT installation program.
Minimum required permissions
This account must be a Windows Local administrator or a user
with equivalent permissions.
If the P8TASKMAN_HOME environment variable exists, you
must grant read and write permission to the ../Common
Files/taskmaninstances.xml file. The default location for
Common Files for Windows: C:\Program Files\IBM\FileNet\
Common Files.
The installer account (ae_install_user or wpxt_install_user) must
be granted read/write/execute permission to these directories
and files:
Installation paths (ae_install_path or wpxt_install_path)
Grant ae_install_user read and write permission to the
ae_install_path.
Grant wpxt_install_user read and write permission to the
wpxt_install_path.
WebSphere Application Server
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\server\bin/startWLS.sh or start
WLS.cmd
Oracle\Middleware\user_projects\domains\
domain_name/config/config.xml
JBoss JBOSS_HOME/bin/run.sh or run.bat
If you are installing IBM Content Search Services, you must create new IBM
Content Search Services accounts.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Creating the IBM Content Search Services operating system account
The operating system account that you use to start and stop the IBM Content
Search Services software.
Creating the IBM Content Search Services installer account on page 27
An operating system account you use to install IBM Content Search Services.
The operating system account that you use to start and stop the IBM Content
Search Services software.
1. Use your operating system tools to create the following operating system
account on the IBM Content Search Services server:
IBM Content Search Services operating system account
Unique identifier
css_os_user
Description
Use this account to run the IBM Content Search Services
startup and shutdown commands.
Minimum required permissions
This account must be an operating system user with rights to
An operating system account you use to install IBM Content Search Services.
1. Use your operating system tools to create the following operating system
account:
IBM Content Search Services installer account
Unique identifier
css_install_user
Description
Run the IBM Content Search Services installation program
using this account.
Minimum required permissions
On Windows, this account must be a Windows Local
administrator or a user with equivalent permissions.
Read/write/execute permission to the css_install_path.
Choosing a load balancing method for IBM Content Search Services servers:
An affinity group is a group of one or more servers that are dedicated to one or
more index areas. A server that is a member of an affinity group can serve only
index areas that are assigned to that affinity group and that belong to the same site
as the server. A server that is not a member of an affinity group can serve only
index areas that do not belong to an affinity group and belong to the same site as
the server.
With an affinity group, the administrator can limit the load balancing for an index
area to the servers that are members of the group. These servers do the indexing
and searching of full-text indexes. All servers in the group must have equal access
to the root directory of the index area. The affinity group should include servers
that can do indexing and searching.
The affinity group improves performance because you can index your data on a
disk that is local to IBM Content Search Services. The downside is that Content
Planning and preparing for FileNet P8 installation 27
Platform Engine cannot provide failover. If the local disk that hosts the index area
fails, all indexing and search requests to that index area fail.
To avoid the possibility of a single point of failure for an affinity group, do not
store full-text index data on local (non-shared) disks. Instead, store your index data
on shared disks with data redundancy, as described in IBM Content Search
Services distributed installation scenario on page 8.
If you must use local disks, be sure to implement data redundancy by using a high
availability strategy for failover of the IBM Content Search Services server and the
disks, provided by Veritas, Microsoft Cluster Server, or IBM PowerHA.
Choosing a standby index area activation policy for IBM Content Search
Services:
The administrator also uses the priority to decide on the storage that is allocated to
the index area and to create a backup policy. By default, the priority of each index
area is zero, the highest priority.
To configure AIX, HPUX, HPUXi, Linux, Linux on System z, or Solaris for FileNet
P8 servers:
1. Ensure hosts file contents. On each FileNet P8 server that does not use DNS
(Domain Name Service) or NIS (Network Information Service), 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.
2. Ensure minimum required disk space and temp space for installation. See IBM
FileNet P8 system requirements.
3. Determine port requirements. Consult with the application server, database,
and FileNet P8 administrators to determine port requirements for all the
servers in your installation environment.
4. If you intend to install FileNet P8 components interactively, ensure that each
FileNet P8 server running on AIX, HPUX, HPUXi, Linux, Linux on System z, or
Solaris uses the X Window system. If you are going to install components from
a remote machine, verify that the remote machine has an X Window terminal
emulator. If you will use a Windows client to connect to the AIX, HPUX,
HPUXi, Linux, Linux on System z, or Solaris server to install, either set the
DISPLAY environment variable to the null (blank) value, or start X Window on
the server before you begin the silent installation or uninstallation procedure.
5. For Red Hat Linux 5.x or higher, change the security setting before installation.
Red Hat Enterprise Linux versions 5.x or higher have a security feature that
can cause errors during installation. For details on resolving the issue before
you install, see System requirements: Hardware and software requirements for
IBM FileNet P8. Search for the term SELinux.
Configuring Content Platform Engine servers (AIX, HPUX, HPUXi, Linux, Linux
on System z, or Solaris):
The fsize parameter controls the maximum file size; the nofiles parameter
controls the maximum number of open files per process.
To ensure that the values of fsize and nofiles are set to their unlimited value:
1. Run the following command to check the value of the fsize parameter:
ulimit -f
3. Run the following command to check the value of the nofiles parameter:
ulimit -n
5. Log out of the current session. If you changed the value of fsize or nofiles,
log back in for the changes to take effect.
Configuring IBM Content Search Services servers (AIX, Linux, Linux on System
z, Solaris):
Before you start the IBM Content Search Services installation on AIX, Linux,
Solaris, or Linux on System z, you must ensure that certain ulimit settings are set
to their unlimited value.
The IBM Content Search Services installation startup script checks the ulimit value
of the fsize and nofiles parameters. The fsize parameter controls the maximum
file size; the nofiles parameter controls the maximum number of open files per
process. If the values are not set to unlimited, the startup script attempts to change
them to unlimited. If the startup script cannot change the value to unlimited, a
warning is generated.
The ulimit value for the rss parameter (which controls the maximum resident set
size) and for the maximum size of virtual memory must also be set to unlimited.
(The installation startup script does not check these values.)
3. Run the following command to check the value of the nofiles parameter:
ulimit -n
5. Run the following command to check the value of the rss parameter:
ulimit -m
7. Run the following command to check the value for the maximum size of
virtual memory:
ulimit -v
The value for the maximum size of virtual memory is unlimited if it is one of
the following values, depending on your operating system:
Table 9. Unlimited value
Operating system Unlimited value
AIX and Solaris -1
Linux and Linux on System z 65536
9. Log out of the current session. If you changed any of the ulimit values, log
back in for the changes to take effect.
When Solaris starts up, it takes the first several ports, called anon ports, to use for
its communication daemons.
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
FileNet P8 use.
The Solaris platform provides several different tools, such as the netstat command,
to determine if a port is in use.
1. Determine the current tcp_smallest_anon_port setting. From the command line,
enter the following command: ndd -get /dev/tcp tcp_smallest_anon_port
2. Enable port 32777. If the port returned in the step above is less than 32778, you
must enable port 32777. 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
To configure Windows for FileNet P8 servers, ensure the minimum disk and
temporary space and determine the port requirements.
Microsoft .NET Framework is a prerequisite for installing .NET API Clients and
COM Compatibility clients. Some clients might also require the installation of
Microsoft Web Services Enhancements (WSE).
If Windows Active Directory is your directory service, set the primary DNS server
IP address on your Content Platform Engine machine to the IP address of the
machine where DNS is installed.
Configure inbound rules in the Windows 2008 firewall to allow the following ports
access.
FileNet P8 processes require that you synchronize the clocks on all of the machines
that are running FileNet P8 servers and FileNet P8 clients.
1. Make sure that the machine clocks on all FileNet P8 servers, including Content
Platform Engine, Application Engine, as well as all database servers and those
of FileNet P8 client applications including Workplace XT, Rendition Engine,
IBM Case Manager, and so on, are synchronized. Errors that might arise if they
are not synchronized include those of authentication, cooperative locking,
communication between servers, and others.
| 2. You can run a clock synchronization utility to synchronize all of the clocks on
| your Java virtual machines with a reliable time source. If the clocks get out of
| sync by 60 seconds or more, you can configure a scheduler in the clock
| synchronization utility to periodically synchronize the time of the clocks.
You can create a local or shared directory for the shared configuration files in
highly available environments.
Remember: At a minimum, the user running the install and the Application
Engine/Workplace XT processes needs write access to this directory.
Do not use one of the cluster servers for the file location as this creates a single
point of failure. The bootstrap.properties file could, theoretically, be placed on a
local Windows share or local NFS export directory from any of the systems in the
Application Engine/Workplace XT cluster (that is, shared out from the default file
location from the first installation). However, if the local system holding the file
would go down, other Application Engine/Workplace XT instances will be unable
to find the bootstrap.properties file and will return error messages.
An object store can have up to four types of storage areas, and multiple instances
of each type, for the content of documents and business objects. The name of each
storage area in an object store must be unique.
advanced storage area
An advanced storage area supports these underlying advanced storage
devices: OpenStack cloud storage and file system storage. One or more
advanced storage devices can be associated with an advanced storage area.
An advanced storage area supports native content replication for disaster
recovery and online backups solutions. In addition, an advanced storage
area leverages the Content Platform Engine sweep service to perform
queue processing for replication, content deletion, and abandoned content
backout.
An advanced storage area can coexist with other storage areas: database,
file system, or fixed content. Data can be moved between an advanced
Advanced storage areas have two main advantages over other storage areas: They
support content replication over storage devices, and they offer storage on
OpenStack-based cloud objects. Advanced storage areas also offer direct content
upload. That is, content uploaded by a client application to an advanced storage
area goes directly to a storage device without needing to be written to temporary
storage.
The core features that advanced storage areas support are as follows:
Support for Content Platform Engine content replication
Content Platform Engine can replicate content to more than one type of
storage device and to multiple instances of the same type. Mounting of file
system replicas between sites is not required. If Content Platform Engine
determines that it has connectivity to a cross-site replica, it reads or writes
to the replica directly. The advanced storage area implements a
connectivity detection scheme, caching the results, and using this
information when reading or writing to a replica.
If server communication is configured for a site, then server
communication is the favored route to content in a different site. If direct
connectivity between sites is not available, then server communication
must be configured to allow content to be accessed across sites.
Direct connectivity for a file system storage device means that the file
system is mounted across the WAN between sites to every Content
Platform Engine server. If server communication is not configured, then
direct connectivity is required.
Support for direct use of cloud object storage
Content Platform Engine can transfer content to a cloud object, and
without needing to use temporary disk storage.
Support for direct upload of content
The following table summarizes the differences between advanced storage areas
and other storage areas in terms of their support of core features:
Table 11. Core feature support by advanced storage areas and other types of storage areas
Supported by advanced storage Supported by other types of storage
Core feature areas? areas?
File storage yes yes
Database storage no yes
OpenStack-based cloud storage yes no
Fixed content storage no yes
Replication yes no
Direct content upload yes no
Replica repair yes no
Content Platform
Engine
Object Object
Object Storage store Storage store Storage
store device database device database device
database replica replica replica replica replica
Content Platform
Engine
Object Object
Object Storage store Storage store Storage
store device database device database device
database replica replica replica replica replica
Remote site
The remote site replication model extends the high availability/disaster
recovery model by adding support for replication to and from a replica on
a remote site. Content is synchronously written to the local site (Content
Platform Engine 1 and 2) and asynchronously written to the remote site
(Content Platform Engine 3A and 4A).
The following figure illustrates content being ingested in Content Platform
Engine 1:
Grid storage
The grid storage model uses cloud storage. The cloud content stores are
not tied to any of specific Content Platform Engine site. Content is
uploaded to any of the Content Platform Engine instances. Content is
synchronously written to two of the three cloud content stores, and
asynchronously written to the third store.
The following figure illustrates content being written to the cloud stores:
Site 1 Site 2 Site 3
After your storage plan is in place, create one or more advanced storage devices to
connect to the advanced storage area. You can use OpenStack cloud storage and
file system storage as advanced storage devices. You must create the advanced
storage devices before you can create an advanced storage area for an object store.
You must 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.
See IBM FileNet P8 system requirements for currently supported operating systems
for file servers.
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.
The supported remote file access protocols between Content Platform Engine and a
file server are Common Internet File System (CIFS), Network File System (NFS),
and Distributed File System (DFS). DFS is supported if you are using it to manage
a file storage area; however, the replication feature of DFS is not supported.
The communication method between the Content Platform Engine computer and
the file server depends on the operating systems that are running on the two
computers. To upgrade a file store, you must use some type of CIFS, NFS, or DFS
gateway.
You can use an iSCSI device as a Windows CIFS share with Content Platform
Engine servers as follows:
v You can mount an iSCSI device on one computer and then share that drive to
another computer as a Windows CIFS share.
v You cannot mount an iSCSI device on multiple computers where the Content
Platform Engine servers on the different computers can access the same storage
area on the iSCSI device.
Install a UPS power supply backup system on each file server to enable graceful
shutdown. Loss or corruption of data occurs if a file server does not shut down
gracefully.
The following table shows the operating system user and group on the machine
where Content Platform Engine is to be deployed that are involved in securing file
storage areas. The user and group 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 Platform Engine Server uses.
The user and group account variables in this table are placeholders for the actual
account names that you designate.
Table 12. User and group account names
Users and Groups Role
Content Platform Engine operating system The user under which Content Platform
user (cpe_os_user) Engine server runs (typically, the user that
starts Content Platform Engine server).
Content Platform Engine operating system The group that contains:
group (cpe_os_group) v Content Platform Engine operating system
user
Configuring a file server based on AIX, HPUX, HPUXi, Linux, Linux on System z, or
Solaris:
You need to create a directory and specify permissions for the Content Platform
Engine operating system user before you can create a storage area.
To configure a file server based on AIX, HPUX, HPUXi, Linux, Linux on System z,
or Solaris:
1. Log on to the 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 for the first storage area where content will be
stored (as in, fsa1). For example:
$ mkdir /opt/filenet/file_stores/fsa1
3. Set the Content Platform Engine operating system user as the owner of fsa1
and give group access permission to the Content Platform Engine operating
system group. For example:
chown cpe_os_user:cpe_os_group fsa1
Tip: The UID (user ID) for cpe_os_user and the GID (group ID) for cpe_os_group
on the file server must match the UID and GID for the same user and group on
the machine where Content Platform Engine and Content Search Engine are
running. This will normally be true if all machines use the same directory
service, but they might be different.
4. Change the permissions on fsa1 so that cpe_os_user and cpe_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.
You must configure security permissions on the directories where file storage areas
are going to be located.
Configuring a Windows-based file server for an AIX, HPUX, HPUXi, Linux, Linux on
System z, or Solaris client using NFS:
Tip:
v Windows Services for NFS is an optional Windows component.
v As part of configuring Windows Services for NFS, you must set up a
mapping of Windows users and groups to the AIX, HPUX, HPUXi, Linux,
Linux on System z, or Solaris users and groups. When setting up the
mapping for cpe_os_user and cpe_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 Platform Engine Server is installed.
When configuring the remote file access protocol (NFS or CIFS), the client machine
is the one where Content Platform Engine Server or IBM Content Search Services
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
local file system of the client machine.
where filesrv is the host name of the file server where the exported NFS file
system is located.
In this example, all Content Platform 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.
v To configure Windows-based Content Platform Engine Server to communicate
with a Windows file server via CIFS:
1. If both Content Platform 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 Platform Engine Server.
IBM Support data collection tools automate the gathering and sending of
appropriate diagnostic data to IBM Support for investigation and resolution of
installation, upgrade, or runtime problems in IBM FileNet P8 products. Typically
you would run an IBM Support data collection tool after installing or upgrading
the product, or when the IBM FileNet P8 system is in production.
To use an IBM Support data collection tool, your IBM FileNet P8 product must be
supported by the tool and must have Internet access to the IBM Support back-end
servers where the collected data is analyzed. If your product does not meet these
requirements, IBM Support can assist you in determining the most effective
manual method to collect and deliver the diagnostic data for analysis.
Two IBM Support Assistant data collection tools are available, at the IBM Support
Assistant Data Collectors website:
v IBM Support Assistant Data Collector is a web-based tool that can be used at
any time; there is nothing to install.
v IBM Support Assistant Lite Data Collector must be installed on the servers
where you installed or upgraded your IBM FileNet P8 products before it can be
used. By installing the tool before your IBM FileNet P8 system goes into
production, you avoid the possibility of not being able to install it after a
runtime problem occurs.
To determine which IBM Support data collection tool supports your IBM FileNet
P8 product:
1. Browse to the IBM Support Assistant Data Collectors website.
2. Find an IBM Support data collection tool that supports your product:
v To determine whether IBM Support Assistant Data Collector supports your
product, complete the following substeps:
a. Click the Data Collectors tab on the IBM Support Assistant Data
Collectors home page, and then click Launch.
Review all rows assigned to the Security administrator (SA) in the Installation and
Upgrade Worksheet. While you complete the following preparation tasks, provide
values for the rows that are appropriate to your installation.
With the Data > Filter > AutoFilter command enabled, as it is by default in the
worksheet file (p8_worksheet.xls), perform the following actions to quickly see
only the properties assigned to a particular Role:
v Click the AutoFilter drop-down arrow in the Role column header and select
SA.
v Further filter the result set by clicking the AutoFilter drop-down arrow in any
of the other columns and selecting a value or clear a filter by selecting All.
Security planning considerations
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.
Configuring directory server on page 48
The Security administrator must perform certain configurations on the directory
server that will provide the authentication repository for your FileNet P8
system.
Creating the application server administrative console user (WebSphere) on
page 57
An LDAP account to which you have granted the WebSphere Application
Server administrative role.
Creating Content Platform Engine directory server accounts on page 58
Content Platform Engine requires several directory server accounts that must be
provided during installation.
Creating Application Engine or Workplace XT directory server accounts on
page 70
Directory server accounts are needed to administer Application Engine or
Workplace XT.
You can configure Microsoft Windows Active Directory to be the directory service
for FileNet P8.
In a multi-domain Active Directory environment, a logon will fail for any account
whose user name and password in a parent/child domain does not match those in
a child/parent domain.
If you have an Active Directory failover configuration, you can configure FileNet
P8 to follow this failover sequence whenever Content Engine attempts to authorize
an already authenticated user. You can do this during Content Engine installation
while running the Create a Directory Configuration wizard, or at any time after.
Server Side Sorting (SSS) must be enabled. This is because FileNet P8 components
call on Content Platform Engine to perform searches using a sorted paging
mechanism. Note that SSS is normally enabled by default but is sometimes
disabled due to concerns with performance.
DNS forwarders provide external DNS lookup functionality. If you are working in
an "isolated" network, a DNS forwarder is not required. However, if you want to
access the Internet or other network resources, then a DNS forwarder pointing to a
DNS server that serves the external resources (for example, the Internet) is
required.
You can configure Active Directory Lightweight Directory Services (AD LDS) to be
the directory service for FileNet P8.
Server Side Sorting (SSS) must be enabled. This is because FileNet P8 components
call on Content Platform Engine to perform searches using a sorted paging
mechanism. Note that SSS is normally enabled by default but is sometimes
disabled due to concerns with performance.
You can configure Oracle Directory Server Enterprise Edition to be the directory
service for FileNet P8.
If there are more than 2,000 users in the Directory Server, you must increase the
resource limits to correctly display users in 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 FileNet P8 users.
Server Side Sorting (SSS) must be enabled. This is because FileNet P8 components
call on Content Platform Engine to perform searches using a sorted paging
mechanism. Note that SSS is normally enabled by default but is sometimes
disabled due to concerns with performance.
Setting the resource limits for the entire Oracle Directory Server Enterprise
Edition (v 5.2)
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.
Setting the resource limits for individual FileNet P8 users (Oracle Directory
Server Enterprise Edition) on page 51
Set resource limits any time you add IBM FileNet P8 users to your configured
Oracle Directory Server Enterprise Edition.
Setting the resource limits for the entire Oracle Directory Server Enterprise Edition (v
5.2):
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.
Setting the resource limits for individual FileNet P8 users (Oracle Directory Server
Enterprise Edition):
Set resource limits any time you add IBM FileNet P8 users to your configured
Oracle Directory Server Enterprise Edition.
You can configure Novell eDirectory to be the directory service for FileNet P8.
You can configure Oracle Internet Directory to be the directory service for FileNet
P8.
You can configure IBM Tivoli Directory Server to be the directory service for
FileNet P8.
Server Side Sorting (SSS) must be enabled. This is because FileNet P8 components
call on Content Platform Engine to perform searches using a sorted paging
mechanism. Note that SSS is normally enabled by default but is sometimes
disabled due to concerns with performance.
If your system requires continuous availability and a high degree of reliability, you
should configure failover for authorization.
You can configure IBM virtual member manager to be the directory service for
FileNet P8.
VMM Provider
VMM
VMM API
Adapter SPI
Not all virtual member manager repositories support server-side sorting. To keep
the behavior the same across repositories, VMM Provider does not retrieve the
entire search result set; it retrieves only the first N principals from virtual member
manager repositories for Principal Search. The value of N is defined by the page
size of findUsers() or findGroups() method in the Content Platform Engine Realm
class. VMM Provider returns only the first page of search result for Principal
Search.
Configuring a virtual member manager LDAP repository
You can configure IBM virtual member manager to use an approved LDAP
repository to be the directory service for FileNet P8.
Configuring a virtual member manager file repository on page 55
You can configure IBM virtual member manager to use a file-based repository
to be the directory service for FileNet P8.
Configuring a virtual member manager custom repository on page 56
You can configure IBM virtual member manager to use a custom repository to
be the directory service for FileNet P8.
You can configure IBM virtual member manager to use an approved LDAP
repository to be the directory service for FileNet P8.
You must provide and configure one or more LDAP repositories that are certified
for use by WebSphere Application Server.
This task describes the values that you must provide when you configure Content
Platform Engine using Configuration Manager.
You can configure IBM virtual member manager to use a file-based repository to
be the directory service for FileNet P8.
This task describes the values that you should provide while you carry out steps
that are described elsewhere. It is assumed that you already have a file-based
repository that is populated with the user and group accounts that are required by
your application.
You can configure IBM virtual member manager to use a custom repository to be
the directory service for FileNet P8.
For Custom user repositories, you must provide an adapter which implements the
com.ibm.wsspi.wim.Repository interface. While IBM will support these custom
configurations, you must be prepared to work with the vendor who provided the
custom adapter implementation, as well as the underlying user repository. IBM
Support cannot take responsibility for issues that require changes to either the
adapter or the underlying user repository.
This task describes the values you should provide while you carry out steps that
are described elsewhere. It is assumed that you have already provided a custom
repository populated with the user and group accounts required by your
application.
Configuring CA Directory:
You can configure CA Directory to be the directory service for FileNet P8.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
An account that Content Platform Engine uses to establish a connection with the
application server, access the application server's JNDI tree, look up the data
sources for accessing the GCD, and start up Content Platform Engine background
tasks.
1. Create the following LDAP account:
Content Platform Engine bootstrap account
Unique identifier
cpe_bootstrap_admin
Description
The cpe_bootstrap_admin, also known as the Content Platform
Engine system user, is an account that is stored in the
CEMPBoot.properties file that is archived in the Content
Platform Engine EAR file. You enter the bootstrap account's
credentials while running the Configuration Manager's
Configure Bootstrap Properties task. Any deployments of the
EAR file for the same FileNet P8 domain must use the same
credentials for the bootstrap account.
Content Platform Engine uses this account to authenticate to
the application server and access the data sources named in the
Planning and preparing for FileNet P8 installation 59
GCDConnection property. Content Platform Engine will not be
able to start if this user is not able to authenticate.
In keeping with the principle of granting to an account only
those permissions necessary to accomplish its purpose, do not
use the cpe_bootstrap_admin account to serve in the role of
gcd_admin. This can happen if you log in as cpe_bootstrap_admin
the first time you start IBM Administration Console for Content
Platform Engine following initial installation. Doing this places
cpe_bootstrap_admin on the security tab of the FileNet P8
domain object with Full Control access rights. The result is that
the cpe_bootstrap_admin is functioning as the gcd_admin. This is
not a recommended configuration. If it is your configuration,
consider using IBM Administration Console for Content
Platform Engine to add a new gcd_admin account to the security
of the FileNet P8 domain object, making sure to grant Full
Control to the P8 domain, and then removing the
cpe_bootstrap_admin from the security tab of the P8 domain.
To make sure it is not misused or locked out by accident, do
not use cpe_bootstrap_admin as an all-purpose account. For
example, if a user tried to log on to some other application
using the cpe_bootstrap_admin account and provided the wrong
password several times, thereby exceeding the number of
allowable login failures, this account could be locked out of the
directory server, depending on your local policies. This would
mean that Content Platform Engine would not start.
If possible, exempt cpe_bootstrap_admin from policies requiring
periodic password change.
If you change your system's login parameters so that the
cpe_bootstrap_admin credentials are no longer valid, the result
would be that Content Platform Engine will not be able to start.
For example, if you modified the User Short Name Attribute
or User Search Filter, in the application server's authentication
provider and in the IBM Administration Console for Content
Platform Engine P8 Domain Properties > Modify Directory
Configuration > User property sheet, from samAccountName to
distinguishedName, you would also need to use the
Configuration Manager bootstrap task to make the same change
in the Content Platform Engine EAR file.
A directory service account that has Full Control access to the Content Platform
Engine domain object.
1. Create the following directory server account:
GCD administrator
Unique identifier
gcd_admin
Description
The gcd_admin is able to create, modify, and delete Content
Platform Engine domain resources.
The gcd_admin account must reside in the directory service
realm specified in Configuration Manager's Configure LDAP
task.
A GCD administrator can grant Full Control rights to
additional users and groups, thereby making them GCD
administrators as well. Being a GCD administrator does not
automatically make you an object_store_admin, which is assigned
on the object store's own property sheet.
Log on to IBM Administration Console for Content Platform
Engine as gcd_admin in order to:
v Create the GCD by launching the Configure New Domain
Permissions wizard the first time you start IBM
Administration Console for Content Platform Engine to
establish the FileNet P8 domain.
v Carry out administrative tasks for the FileNet P8 domain.
Minimum required permissions
Use IBM Administration Console for Content Platform Engine
to grant Full Control access to the Content Platform Engine
domain object.
A directory service account that has Full Control access to a Content Platform
Engine object store.
1. Create the following directory server account:
Object Store administrator and group
Unique identifier
object_store_admin or object_store_admin_group
Description
A directory service account that can administer an object store
by having Full Control access to it. You can also grant Full
Control to an object store to group accounts, thereby making all
members of the group object store administrators.
Each time a gcd_admin runs the Object Store Wizard, you are
asked to specify the users and groups who should have
administrative access to the object store. Each object store could
therefore have a different set of object store administrators.
Conversely, if you want the same groups to administer all
object stores in the FileNet P8 domain, you must add them
while creating each new object store using the Object Store
Wizard. By default, the GCD administrator creating the object
store also becomes an object store administrator, but you can
remove it if your security design requires dedicated accounts
for each object store and GCD.
Object store administrative rights do not include the ability to
add, move, or remove object stores, fixed content devices,
content cache areas, or any of the other FileNet P8 domain
resources. These permissions are granted only to GCD
administrators.
An object store administrator is not also a GCD administrator
unless also specifically granted those permissions. This means
that an object store administrator who is not also a GCD
administrator would have to request that a GCD administrator
create a new domain resource like an object store. Once these
objects are created by the GCD administrator, however, the
object store administrator can populate the object store with
new classes and folders, store content in the file storage area,
assign markings, and so on.
The list of object store administrators is available for viewing
and modifying in the IBM Administration Console for Content
Platform Engine Object Store > Properties > Security property
page. You can add or remove users or groups from this list at
any time later on.
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Directory service (bind) user account (Active Directory)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
v Acts as the bind user specified by the application server to
search through realms to authenticate a user when the user
logs in to a Content Platform Engine client.
v Acts as the user specified in the GCD that searches users and
groups to authorize access to a specific FileNet P8 object after
a user has been authenticated.
Provide the fully qualified distinguished name of
cpe_service_user as the LDAPBindDN while running
Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard. Available for viewing and modifying in
the Administration Console for Content Platform Engine
Directory configuration tab.
The Directory Service User cannot be accessed using referrals.
Minimum required permissions
Use Active Directory tools to grant cpe_service_user at least the
following minimum rights to all entries (including user and
group entries) in each security realm that is configured for your
FileNet P8 domain:
v Read access rights (specifically the Read All Properties
permission) to the forest-wide configuration directory
partition and the domain directory partition in each desired
domain in the Active Directory forest. Because Authenticated
Users by default is a member of the Pre-Windows 2000
Compatible Access group which has these permissions, you
will need to assign the permissions to cpe_service_user only if
the default is modified or Authenticated Users access rights
are restricted.
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Directory service (bind) user account (Active Directory Lightweight Directory
Service) (AD LDS, formerly known as ADAM)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
v Acts as the bind user specified by the application server to
search through realms to authenticate a user when the user
logs in to a Content Platform Engine client.
v Acts as the user specified in the GCD that searches users and
groups to authorize access to a specific FileNet P8 object after
a user has been authenticated.
Provide the fully qualified distinguished name of
cpe_service_user as the LDAPBindDN while running
Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard. Available for viewing and modifying in
the Administration Console for Content Platform Engine
Directory configuration tab.
The Directory Service User cannot be accessed using referrals.
Minimum required permissions
An AD LDS user account that Content Platform Engine uses to
connect to a single Microsoft AD LDS partition. To configure
this, perform the following steps:
a. Start ADAM ADSI Edit under Start > All Programs >
ADAM.
b. Connect to the partition. Expand partition in left-hand pane
and click the CN=Roles node.) Be sure you have selected
the CN=Roles container in the partition not under the
CN=Configuration.)
c. In the right-hand pane right-click the CN=Readers group
and select Properties.
d. In the Attributes list double-click the member attribute.
e. Click Add ADAM Account.
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Directory service (bind) user account (Oracle Directory Server Enterprise
Edition)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
v Acts as the bind user specified by the application server to
search through realms to authenticate a user when the user
logs in to a Content Platform Engine client.
v Acts as the user specified in the GCD that searches users and
groups to authorize access to a specific FileNet P8 object after
a user has been authenticated.
Provide the fully qualified distinguished name of
cpe_service_user as the LDAPBindDN while running
Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard. Available for viewing and modifying in
the Administration Console for Content Platform Engine
Directory configuration tab.
The Directory Service User cannot be accessed using referrals.
Minimum required permissions
Use your directory server's tools to grant cpe_service_user at
least the following minimum rights to all entries (including
user and group entries) in each security realm that is
configured for your FileNet P8 domain: Read, Search, Compare.
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Planning and preparing for FileNet P8 installation 65
Directory service (bind) user account (Novell eDirectory)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
v Acts as the bind user specified by the application server to
search through realms to authenticate a user when the user
logs in to a Content Platform Engine client.
v Acts as the user specified in the GCD that searches users and
groups to authorize access to a specific FileNet P8 object after
a user has been authenticated.
Provide the fully qualified distinguished name of
cpe_service_user as the LDAPBindDN while running
Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard. Available for viewing and modifying in
the Administration Console for Content Platform Engine
Directory configuration tab.
The Directory Service User cannot be accessed using referrals.
Minimum required permissions
Use your directory server's tools to grant cpe_service_user at
least the following minimum rights to all entries (including
user and group entries) in each security realm that is
configured for your FileNet P8 domain: Read and Compare.
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Directory service (bind) user account (IBM Tivoli)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Directory service (bind) user account (Oracle Internet Directory)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
v Acts as the bind user specified by the application server to
search through realms to authenticate a user when the user
logs in to a Content Platform Engine client.
v Acts as the user specified in the GCD that searches users and
groups to authorize access to a specific FileNet P8 object after
a user has been authenticated.
Provide the fully qualified distinguished name of
cpe_service_user as the LDAPBindDN while running
Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard. Available for viewing and modifying in
the Administration Console for Content Platform Engine
Directory configuration tab.
A directory service account that Content Platform Engine uses to connect to the
directory server.
1. Create the following directory server account:
Directory service (bind) user account (CA Directory)
Unique identifier
cpe_service_user
Description
Provide the fully qualified distinguished name of
cpe_service_user as the directory service bind user name while
running Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard.
cpe_service_user performs the following roles:
v Acts as the bind user specified by the application server to
search through realms to authenticate a user when the user
logs in to a Content Platform Engine client.
v Acts as the user specified in the GCD that searches users and
groups to authorize access to a specific FileNet P8 object after
a user has been authenticated.
Provide the fully qualified distinguished name of
cpe_service_user as the LDAPBindDN while running
Configuration Manager and also when you run the
Administration Console for Content Platform Engine Directory
Configuration Wizard. Available for viewing and modifying in
the Administration Console for Content Platform Engine
Directory configuration tab.
The Directory Service User cannot be accessed using referrals.
Minimum required permissions
Use your directory server's tools to grant cpe_service_user at
least the following minimum rights to all entries (including
user and group entries) in each security realm that is
configured for your FileNet P8 domain: Read, Search, Compare.
A directory server user account that is used by workflow to create isolated regions.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Create the following users and groups. 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.
Creating the Application Engine or Workplace XT administrator account
Review all rows that are assigned to the database administrator (DBA) in the
Installation and Upgrade Worksheet. While you complete the following preparation
tasks, provide values for the rows that are appropriate to your installation. (Your
organization might have different roles, and some of the responsibilities of listed
roles vary from the roles that are assigned by default in this documentation.)
70 Planning for FileNet P8
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the worksheet file (p8_worksheet.xls), complete the following actions to quickly
see only the properties assigned to a particular Role:
v Click the AutoFilter drop-down arrow in the Role column header and select
DBA.
v Further filter the result set by clicking the AutoFilter drop-down arrow in any of
the other columns and selecting a value or clear a filter by selecting (All).
As an alternative, you can use the Customize Worksheet filtering macro, which is
in the Instruction tab on the Installation and Upgrade Worksheet.
If you plan to tune the performance of your databases, review the information in
Tuning FileNet P8 databases before you begin.
Creating Content Platform Engine database accounts
Use your database tools to create new or designate existing database accounts
for Content Platform Engine.
Preparing Microsoft SQL Server on page 75
Plan the SQL Server installation and configuration, install the software, and
configure database components for FileNet P8 components after reviewing the
requirements.
Preparing Oracle server on page 81
Plan the Oracle installation and configuration, install the software, and
configure database components for FileNet P8 components after reviewing the
requirements.
Preparing DB2 for z/OS servers on page 87
Plan the DB2 for z/OS installation and configuration, install the software, and
configure database components.
Preparing the DB2 for Linux, UNIX and Windows server on page 89
Plan and prepare your IBM DB2 for Linux, UNIX and Windows server for
FileNet P8 installation.
Create the following users and groups. After the IT Administrator creates operating
system users and groups for DB2 databases, you must grant database permissions
to those accounts.
Creating a Content Platform Engine database user for DB2 for Linux, UNIX
and Windows
An operating system account on the database server that Content Platform
Engine uses to access DB2 for Linux, UNIX and Windows databases containing
the GCD and object stores.
Creating a database user for DB2 for z/OS on page 73
A database account that Content Platform Engine uses to access DB2 for z/OS.
This account is initially created as an operating system account.
Creating a Content Platform Engine database user for Oracle on page 74
A database user account that Content Platform Engine uses to connect to Oracle
databases containing the GCD and object stores.
Creating a Content Platform Engine database user for SQL Server on page 75
A database user account that Content Platform Engine uses to connect to SQL
Server databases containing the GCD and object stores.
Creating a Content Platform Engine database user for DB2 for Linux, UNIX and
Windows:
An operating system account on the database server that Content Platform Engine
uses to access DB2 for Linux, UNIX and Windows databases containing the GCD
and object stores.
1. Create the following database user account after the database instance has been
created:
A database account that Content Platform Engine uses to access DB2 for z/OS.
This account is initially created as an operating system account.
1. Make sure you have already created the operating system account cpedbuser for
DB2 for z/OS. This procedure grants database permissions to that operating
system account.
2. Use your database tools to grant the following permissions to the
already-created cpedbuser:
Content Platform Engine database user (DB2 for z/OS)
Unique identifier
cpedbuser
Description
The cpedbuser must have DBADM authority of the DB2 instance
that will be used by the workflow system software.
DB2 for z/OS does not allow underscores in account names.
In a farmed or cluster configuration, each workflow system
must be configured to use the same database user name.
Minimum required permissions
Grant the following database permissions to this user:
v GRANT DBADM ON DATABASE cpe_databasename TO
cpedbuser
v GRANT USE OF STOGROUP storagegroupname TO cpedbuser
v GRANT USE OF BUFFERPOOL buffer_pool_name TO
cpedbuser
v GRANT EXECUTE ON PACKAGE NULLID.* TO cpedbuser
v GRANT SELECT ON SYSIBM.SYSINDEXES TO cpedbuser
A database user account that Content Platform Engine uses to connect to Oracle
databases containing the GCD and object stores.
1. Create the following database account after creating the database instance:
Content Platform Engine database user (Oracle)
Unique identifier
cpe_db_user
Description
The owner account that Content Platform Engine uses to access
Oracle. Use one account for the object store and one for the
GCD.
In order to share database connections in Oracle, you must
grant additional privileges to cpe_db_user . See the topic Sharing
database connections in Oracle.
Minimum required permissions
Grant each cpe_db_user at least the following permissions:
v CREATE SESSION
v CREATE TABLE
v CREATE VIEW
v CREATE SEQUENCE
v Alter user set QUOTA UNLIMITED on all table spaces used
by db user
v SELECT on pending_trans$
v SELECT on dba_2pc_pending
v SELECT on dba_pending_transactions
v SELECT on DUAL
v SELECT on product_component_version
v SELECT on USER_INDEXES
v EXECUTE on dbms_xa
A database user account that Content Platform Engine uses to connect to SQL
Server databases containing the GCD and object stores.
1. Create the following database account after the SQL Server instance is created:
Content Platform Engine database user (SQL Server)
Unique identifier
cpe_db_user
Description
The database accounts that Content Platform Engine uses to
access SQL Server. You can use the same account for the GCD
and object store databases. Or you can use one (for example,
cpe_db_user1 ) for the GCD database and one for the object
stores (for example, cpe_db_user2 .
cpe_db_user must be a SQL Server account. It does not have to
be an account in the configured directory service.
Minimum required permissions
Use your database tools to grant each cpe_db_user at least the
following database access permissions:
v db_datawriter
v db_datareader
v db_ddladmin
v public
Add these accounts to SQL Server's master database and grant
the public role to each. When you perform the procedure
described in the section on Configuring the JDBC distributed
transaction components, these accounts will also be granted the
SqlJDBCXAUser role.
When you decide about whether to share a database for multiple components,
consider the following factors:
v Database backup/recovery requirements allow for the data in a single database
to be backed up and recovered together.
v Database security allows for collocation of data.
v Sharing of a database might allow for more efficient usage of database resources
like database connections.
For SQL Server database requirements for Rendition Engine, see the IBM FileNet
Rendition Engine Installation and Upgrade Guide.
To prepare your databases before installing FileNet P8, you must install the SQL
Server software and configure the database components for your installation.
Installing and configuring Microsoft SQL Server
Install and configure SQL Server software and create one or more instances.
Creating a Microsoft SQL Server database for the Content Platform Engine
GCD on page 77
Create a database for the Content Platform Engine global configuration
database (GCD) on Microsoft SQL Server.
Creating a Microsoft SQL Server database for an object store on page 78
Create a Microsoft SQL Server database for an object store.
Enabling XA transactions on page 80
Configure the Windows server to enable XA transactions.
Reducing deadlock errors in Microsoft SQL Server on page 81
High Microsoft SQL Server concurrency causes transaction deadlock errors
because writers block access, by readers, to database resources. You can reduce
the likelihood of deadlock by setting the READ_COMMITTED_SNAPSHOT ON option
for your database.
Install and configure SQL Server software and create one or more instances.
Important: Select your SQL Server collation setting carefully. If you want to
switch from case-sensitive to case-insensitive collation after significant user
activity, switching collation settings after installation can be difficult and
time-consuming. If you have a case-sensitive database and you want to perform
a case-insensitive search (programmatically or otherwise), you might encounter
serious performance degradation on SQL Server because the database cannot
use column, or property, indexes in these cases.
5. See IBM FileNet P8 system requirements for required operating system and
database patch sets and service packs. Verify that the required service pack is
installed before proceeding.
6. Record the values for the database server name and database port number in
your customized Installation and Upgrade Worksheet.
Creating a Microsoft SQL Server database for the Content Platform Engine GCD:
Create a database for the Content Platform Engine global configuration database
(GCD) on Microsoft SQL Server.
Do not share the database that is used for the GCD with object stores or IBM
Content Navigator configuration data.
1. Create the database with a minimum size of 100 MB. In Microsoft SQL Server,
the PRIMARY file group holds the database system objects. Create an extra file
group and designate it as the default file group to hold the FileNet P8 tables.
| Important: The user who runs the command must be the only user who is
| connected to the database when this command is run. For more information,
| see the Microsoft SQL Server documentation that was provided with your
| database.
| If you want to add a workflow system to an object store that does not already
| have one, the workflow system can use the file groups that are used by the object
| store. Alternatively, you can create new file groups for the workflow system,
| according to the rules on file group names and minimum sizes that are
| documented here.
1. Use your Database tools to create a database for an object store. In Microsoft
SQL Server, the PRIMARY file group holds the database system objects. Create
an extra file group and designate it as the default file group to hold the FileNet
P8 tables.
Table 13. File group names and minimum sizes
File group Name Minimum Size (MB) Description
data 400 The default name of the data
file group that is used
byContent Platform Engine.
| Important: The user who runs the command must be the only user who is
| connected to the database when this command is run. For more information,
| see the Microsoft SQL Server documentation that was provided with your
| database.
3.
Record the values for the database name, the database port number, and the
file group names in your customized Installation and Upgrade Worksheet. To
Enabling XA transactions:
Perform these steps on every Microsoft SQL Server that will contain a Content
Platform Engine database.
1. Download the Microsoft SQL Server JDBC Driver that is referenced in IBM
FileNet P8 system requirements for Content Platform Engine SQL Server
databases.
Tip: Installation procedures for JDBC settings can vary by release. See the
Microsoft website for full details.
2. Copy the sqljdbc_xa.dll from the JDBC installation directory to the binn
folder of the instance, although a pre-2.0 version of the driver also functions
correctly from the tools\binn folder. For the 32-bit version of Microsoft SQL
Server , use the sqljdbc_xa.dll file in the x86 folder. For the 64-bit version of
Microsoft SQL Server, use the sqljdbc_xa.dll file in the x64 folder.
3. Log on as the sa administrator or as a user with equivalent permissions and
execute the database script xa_install.sql on the master database on every SQL
Server instance that will participate in distributed transactions.
High Microsoft SQL Server concurrency causes transaction deadlock errors because
writers block access, by readers, to database resources. You can reduce the
likelihood of deadlock by setting the READ_COMMITTED_SNAPSHOT ON option for your
database.
When you make the decision about whether to share a database for multiple
components, consider the following factors:
v Database backup/recovery requirements should allow for the data that resides
in a single database to be backed up and recovered together.
v Database security should allow for collocation of data.
v Sharing of a database might allow for more efficient usage of database resources
like database connections.
For an Oracle database to be used by Rendition Engine, see the IBM FileNet
Rendition Engine Installation and Upgrade Guide.
Make sure the machine hosting the database satisfies all preinstallation
requirements specified in the Oracle installation documentation.
Refer toIBM FileNet P8 system requirements for required operating system and
database patch sets, and service packs. The Oracle patches are available at the
Oracle website. The Oracle patch installation procedure might be less complicated
if you do it before you create any databases.
Plan to use locally managed table spaces. For performance reasons, IBM
recommends that you create locally managed, rather than dictionary managed,
table spaces. (The table spaces you create via Oracle Database assistant (dbca) are
locally managed by default.)
There are no requirements to install Oracle client software on the Content Platform
Engine if the database is remote.
To prepare your database before installing FileNet P8, you must install the Oracle
software and configure the database components for your installation.
Installing an Oracle database engine and creating databases on page 83
Install the Oracle software and configure the database server. Create one or
more databases, depending on whether one or more FileNet P8 components
will share the database.
Creating an Oracle table space for the Content Platform Engine GCD on page
84
Create a table space for the Content Platform Engine global configuration
database on Oracle.
Creating Oracle table spaces for a Content Platform Engine object store on
page 84
Create Oracle table spaces for a Content Platform Engine object store.
Configuring automatic transaction recovery on page 86
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.
Install the Oracle software and configure the database server. Create one or more
databases, depending on whether one or more FileNet P8 components will share
the database.
The following procedure shows the minimal choices (specific to the needs of
Content Platform Engine) for installing a database engine. Consult Oracle
installation documentation for complete preinstallation requirements and
instructions.
Record the values for the Database server name, Database name, and the
Database port number in your customized Installation and Upgrade Worksheet.
To find these properties, set the Autofilter for Column E Installation or
Configuration Program for CM: Configure GCD JDBC Data Sources. Then set
the Autofilter for Column D ISV Component Vendor to Oracle. In addition, set
the Database server name, Database name, and the Database port number for
the CM: Configure Object Store JDBC Data Sources.
Create a table space for the Content Platform Engine global configuration database
on Oracle.
At least two Oracle table spaces must be created for the Content Platform Engine.
One table space is needed for the global configuration database user and one for a
single object store user. Do not share the database user for the GCD with the object
store database user or with the IBM Content Navigator.
1. Create a user (cpe_db_user), password, and default table space in the Oracle
database for the global configuration database (GCD). See Creating Content
Platform Engine database accounts for information about the user and required
permissions.
2. Table space names must contain only alphanumeric and underscore characters.
Names must start with an alphabetic character and must be at most 30
characters long. For performance reasons, specify locally managed, instead of
dictionary managed, table spaces. (The table spaces you create with Oracle
Enterprise Manager are locally managed by default.)
The following table shows the recommended minimum sizes of the permanent
and temporary table spaces for the GCD. (The table space names shown in the
table are arbitrary.)
Table 14. Recommended table sizes for the GCD table spaces
Table space Name Table space Type Minimum Size Description
gcd Permanent 100 MB Permanent table
space for the GCD
tempgcd Temporary 2 GB Temporary table
space for the GCD
3.
Record the values for the Database user name, the Database password, and the
table space names in your customized Installation and Upgrade Worksheet. To
find these properties, set the Autofilter for Column E Installation or
Configuration Program for CM: Configure GCD JDBC Data Sources. Then set
the Autofilter for Column D ISV Component Vendor to Oracle.
Creating Oracle table spaces for a Content Platform Engine object store:
Create Oracle table spaces for a Content Platform Engine object store.
Use your database tools to create table spaces for an object store. Do not share the
database user for the GCD with the object store database user.
| If you want to add a workflow system to an object store that does not already
| have one, the workflow system can use the table spaces that are used by the object
| store. Alternatively, you can create new table spaces for the workflow system,
| according to the rules on table space types and minimum sizes that are
| documented here.
1. Create a user (cpe_db_user), password, and default table space in the Oracle
database for an object store that Content Platform Engine will access. See
Creating Content Platform Engine database accounts for information about the
user and required permissions.
3.
Record the values for the Database user name, the Database password, and the
table space names in your customized Installation and Upgrade Worksheet. To
find these properties, set the Autofilter for Column E Installation or
Configuration Program for CM: Configure Object Store JDBC Data Sources
(object store 1). Then set the Autofilter for Column D ISV Component Vendor
to Oracle . If your customized worksheet shows more than one object store,
create and provide values for all of them.
When you make the decision about whether to share a database for multiple
components, consider the following factors:
v Database backup/recovery requirements should allow for the data that resides
in a single database to be backed up and recovered together.
v Database security should allow for collocation of data.
v Sharing of a database might allow for more efficient usage of database resources
like database connections.
v Because schema names have global visibility within a DB2 for z/OS server,
make sure to use a separate schema name for every object store that is created
on your server. This is necessary even when the schemas reside in different
databases within a shared DB2 for z/OS server.
The database must be remote.
The DB2 for z/OS database must be remote from Content Platform Engine.
Use System Managed Storage (SMS).
Configure system managed storage for Content Platform Engine databases.
Use UTF-8 collation
Use UTF-8 collation settings by configuring CCSID UNICODE.
Add SDSNLOD2 into the LNKLST.
The SDSNLOD2 library must be added into the LNKLST.
Use TCP/IP as the default protocol.
Set TCP/IP as the default network protocol.
Determine the maximum size of the content elements your users store.
Determine the maximum size of the content elements your users store. The
size 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
Verifying that DB2 for z/OS server is installed for FileNet P8:
Plan the DB2 for z/OS installation and configuration. Some rules apply to sharing
of instances and databases.
Record the values for the following settings as you work through the database
installation. This information must be entered during subsequent installation and
configuration of Content Platform Engine. Be aware that DB2 for z/OS allows only
alphanumeric characters.
v DB2 Server name. Record both the TCP/IP address and the fully qualified
domain name.
v Content Platform Engine dedicated database names
v DB2 instance name
v DB2 instance port numbers
v User IDs and passwords for Content Platform Engine DB2 users (operating
system users who have been granted permissions on the database)
Creating and updating the DB2 for z/OS databases for Content Platform
Engine on page 89
At least two DB2 for z/OS databases are required to install Content Platform
Engine.
Installing the DB2 for z/OS license and modifying the classpath for Content
Platform Engine on page 89
Install the DB2 for z/OS license file on the Content Platform Engine server and
add it to the classpath.
At least two DB2 for z/OS databases are required to install Content Platform
Engine.
| If you want to add a workflow system to an object store that does not already
| have one, the workflow system can use the database that is used by the object
| store. Alternatively, you can create a new database for the workflow system,
| according to the rules on page size that are documented here.
1. Use your database tools to create two DB2 for z/OS databases: one for the
Content Platform Engine GCD, one for a single Content Platform Engine object
store. All must have 32 KB page sizes.
2. Record the values for the Content Platform Engine GCD database in your
customized Installation and Upgrade Worksheet. To find these properties, set
the Autofilter for Column E Installation or Configuration Program for CM:
Configure GCD JDBC Data Sources. Then set the Autofilter for Column D ISV
Component Vendor to DB2 for z/OS.
3. Record the values for the Content Platform Engine object store database in
your customized Installation and Upgrade Worksheet. To find these properties,
set the Autofilter for Column E Installation or Configuration Program for
CM: Configure Object Store JDBC Data Sources (object store 1). The Autofilter
for Column D ISV Component Vendor should still be set to DB2 for z/OS. If
it is not, then set it to that value.
Installing the DB2 for z/OS license and modifying the classpath for Content Platform
Engine:
Install the DB2 for z/OS license file on the Content Platform Engine server and
add it to the classpath.
Install the license jar in the same location as the JDBC driver jar
(db2jcc_license_cisuz.jar).
Determine whether IBM DB2 for Linux, UNIX and Windows database components
will be dedicated to individual FileNet P8 components or shared and review other
IBM DB2 for Linux, UNIX and Windows database requirements.
When you make the decision about whether to share a database for multiple
components, consider the following factors:
v Database backup/recovery requirements should allow for the data that resides
in a single database to be backed up and recovered together.
v Database security should allow for collocation of data.
v Sharing of a database might allow for more efficient usage of database resources
like database connections.
DB2 for Linux, UNIX and Windows version 9.7 is required for workflow system
data to support GB18030 character sets.
IBM FileNet P8 does not support partitioned DB2 databases or databases created
with the RESTRICTIVE clause (or, from the Control Center, with Restrict access to
system catalogs selected in the Create Database Wizard).
Plan to use automatic storage for table spaces. For performance reasons, IBM
recommends that you create table spaces using automatic storage, rather than
database managed or system managed table spaces.
Determine the maximum size of the content elements your users store. The size
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, use only file storage areas. Otherwise, users
can encounter memory-related errors when retrieving or indexing the large
content.
Important: 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.
To prepare your DB2 for Linux, UNIX and Windows databases before installing
FileNet P8, you must install the DB2 for Linux, UNIX and Windows software and
configure the database components for your installation.
Installing DB2 for Linux, UNIX and Windows and creating DB2 instances
Create DB2 for Linux, UNIX and Windows instances for Content Platform
Engine.
Creating the DB2 database and table space for the Content Platform Engine
GCD on page 92
Create a database and table space for the Content Platform Engine global
configuration database on DB2 for Linux, UNIX and Windows.
Creating the DB2 database and table spaces for a Content Platform Engine
object store on page 92
Create a database and table spaces for a Content Platform Engine object store
on DB2 for Linux, UNIX and Windows. Each additional object store will require
an additional table space and a unique table space user.
Installing DB2 for Linux, UNIX and Windows and creating DB2 instances:
Create DB2 for Linux, UNIX and Windows instances for Content Platform Engine.
To install DB2 for Linux, UNIX and Windows and create DB2 instances:
1. Install the IBM DB2 for Linux, UNIX and Windows software. Make note of the
TCP/IP port number assigned to the instance or instances. 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.
2. Refer to the IBM FileNet P8 system requirements for required operating-system
and database patch sets, and service packs.
3. Set TCP/IP as the default protocol.
4. Set or verify the following parameter settings by entering the following
command in the DB2 command-line processor:
DB2 for Linux, UNIX and Windows version 9.7
db2set DB2_WORKLOAD=FILENET_CM
db2set DB2_MINIMIZE_LISTPREFETCH=ON
db2set DB2_OPTPROFILE=ON
DB2 for Linux, UNIX and Windows version 9.7 Fix Pack 8 or later:
db2set DB2_WORKLOAD=FILENET_CM
DB2 for Linux, UNIX and Windows version 9.8
db2set DB2_WORKLOAD=FILENET_CM
db2set DB2_MINIMIZE_LISTPREFETCH=ON
db2set DB2_OPTPROFILE=ON
DB2 for Linux, UNIX and Windows version 10.1
db2set DB2_WORKLOAD=FILENET_CM
db2set DB2_MINIMIZE_LISTPREFETCH=ON
db2set DB2_OPTPROFILE=ON
DB2 for Linux, UNIX and Windows version 10.1 Fix Pack 2 or later:
db2set DB2_WORKLOAD=FILENET_CM
Set CUR_COMMIT=ON
| DB2 for Linux, UNIX and Windows version 10.5 or later:
where
v db_name is the name of your object store database
v user_name is the user ID used to access the object store database
v password is the password for the user ID used to to access the object store
database
Issue the following command:
db2 update db cfg using cur_commit ON
| 6. After making these changes, stop and restart the database using db2stop and
| db2start.
Creating the DB2 database and table space for the Content Platform Engine GCD:
Create a database and table space for the Content Platform Engine global
configuration database on DB2 for Linux, UNIX and Windows.
v Do not share the database used for the GCD with object stores or IBM Content
Navigator configuration data.
v The database name needs to be unique and from 1 to 8 characters long. The
table space name must be at most 18 characters long.
v Drop the default user [regular] table space - USERSPACE1 after creating the
database.
v Update the following configuration parameter. Set the value, minimally, to the
value indicated here:
APPLHEAPSZ 2560
1. Create the table space for the GCD. The following table shows the
recommended minimum size for the table space for the GCD.
2.
Record the values for the Database user name and the Database password in
your customized Installation and Upgrade Worksheet. To find these properties,
set the Autofilter for Column E Installation or Configuration Program for CM:
Configure GCD JDBC Data Sources. Then set the Autofilter for Column D
ISV Component Vendor to Oracle.
Creating the DB2 database and table spaces for a Content Platform Engine object store:
Create a database and table spaces for a Content Platform Engine object store on
DB2 for Linux, UNIX and Windows. Each additional object store will require an
additional table space and a unique table space user.
| If you want to add a workflow system to an object store that does not already
| have one, the workflow system can use the table spaces that are used by the object
| store. Alternatively, you can create new table spaces for the workflow system,
| according to the rules on table space types and minimum sizes that are
| documented here.
If you are creating a table space for a new object store on an existing system,
define the new table space with the same table space type and storage method
used for existing object store table spaces.
The following table shows the recommended table space names, types, and
minimum sizes:
Table 16. Recommended table space names, types, and minimum sizes
Minimum Size Minimum Page
table spaces (MB) Size (KB) Description
data_ts 768 32 (required) This is the
default name of
Configure as LARGE type and the data table
automatic storage. space used by
Content Platform
Engine.
Content Platform Engine, IBM FileNet Workplace XT, and Application Engine are
Java EE application server-based applications. You must install these applications
in a homogeneous Java EE environment in which all of your application servers
and their version numbers are identical.
Even if you have your own customized application, it is a best practice to install
one of these applications for testing and support purposes. The applications must
use Enterprise Java Bean (EJB) transport.
If the application server where you are deploying Content Platform Engine is
running on most 64-bit JVMs, it is a best practice to create no more than 150 object
stores. However, if sufficient system and database resources are available, IBM
WebSphere Application Server 7.0 or higher with the 64-bit IBM JVM and
WebSphere Compressed Reference Technology supports up to 500 object stores.
Although you might need to host Content Platform Engine and other applications
on the same machine, it is preferable to host Content Platform Engine on its own
machine or logical partition. If an architecture requires Content Platform Engine
and a non-P8 Java EE application to be on the same machine, be sure to
thoroughly test the configuration in your integration environment before deploying
them into production.
Review all rows assigned to the Application Server Administrator (ASA) in the
Installation and Upgrade Worksheet. While you complete the following preparation
tasks, provide values for the rows that are appropriate to your installation.
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the worksheet file (p8_worksheet.xls), perform the following actions to quickly see
only the properties that are assigned to a particular Role:
v Click the AutoFilter drop-down arrow in the Role column header and select
ASA.
v Further filter the result set by clicking the AutoFilter drop-down arrow in any of
the other columns and selecting a value or clear a filter by selecting (All).
Creating application server accounts on page 97
Create new or designate existing application server accounts.
Configuring WebSphere for Content Platform Engine on page 99
You must prepare IBM WebSphere Application Server before you install
Content Platform Engine. You must create a WebSphere profile for the Content
Platform Engine application and set the environment variables for the database
connection.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Creating the application server administrator
An application server administrator used while configuring Content Platform
Engine.
Important: You must use Configuration Manager, rather than a manual method, to
create the data sources that Content Platform Engine uses to connect to a database.
A data source that you create manually (by interacting directly with an application
server interface) can include, by default, many unnecessary and potentially
harmful custom properties. Also, for some combinations of database type and
application server type, Configuration Manager adds some special custom
properties to the data source it creates, which you might fail to include if you
create the data source manually. Without these added custom properties, runtime
errors can occur when Content Platform Engine tries to connect to a database.
1. Creating the WebSphere profile for Content Platform Engine on page 100
You must create an IBM WebSphere Application Server profile for Content
Platform Engine if you do not already have a profile.
You must create an IBM WebSphere Application Server profile for Content
Platform Engine if you do not already have a profile.
Option Description
AIX /usr/IBM/WebSphere/AppServer/bin/
manageprofiles.sh
HPUX, HPUXi, Linux, Linux for System z, /opt/IBM/WebSphere/AppServer/bin/
Solaris manageprofiles.sh
Windows C:\Program Files\IBM\WebSphere\AppServer\
bin\manageprofiles.bat
2.
Option Description
AIX /usr/IBM/WebSphere/AppServer/profiles/
profile_name/logs
HPUX, HPUXi, Linux, Linux for System z, /opt/IBM/WebSphere/AppServer/profiles/
Solaris profile_name/logs
Windows C:\Program Files\IBM\WebSphere\AppServer\
profiles\profile_name\logs
You must specify the IBM WebSphere Application Server environment variables so
that Content Platform Engine can access its databases.
See IBM FileNet P8 system requirements for information on the JDBC driver file for
the database type that you need for the global configuration database (GCD) or for
an object store or Case Analyzer store you create later. The version of the JDBC
driver file must match the version of the JDK on the system where WebSphere
Application Server is installed.
If you are using IBM WebSphere Application Server federated repositories for
LDAP authentication, you must ensure that the name you entered for the
WebSphere Application Server primary administrative user name is unique across
all realms.
Configuration Manager must be run by an operating system account that has been
granted certain directory permissions.
1. Set permissions for the Configuration Manager user (config_mgr_user) on the
WebSphere Application Server profile directory and all its subdirectories where
Content Platform Engine will be deployed:
Option Description
AIX, HPUX, HPUXi, Linux, Solaris Read, write, and execute permissions
Windows Read & Execute, and Write permission
2. Set write permission for the Configuration Manager user on the WebSphere lib
directory, for example /opt/IBM/WebSphere/AppServer/lib.
You can configure the load-balancer or proxy server to manage user requests over
multiple application servers.
If you use a load-balancer or proxy server in this configuration you must use the
virtual name when performing installation steps that require a server name for a
Content Platform Engine server, with the exception of IBM Administration Console
for Content Platform Engine and other administrative applications.
You need to compare the default parameter values for database failover and
determine whether to retain them.
The following table shows the default values that Configuration Manager assigns
to the database failover parameters.
Table 19. Retries for new connections
Parameter Value
Number of retries for new connections 100
Retry interval for new connections 3 seconds
Retry interval for existing connections 0 seconds
To determine whether to let Configuration Manager set these values, you need to
compare these default values with the values that are optimized for your database
cluster. If you enableConfiguration Manager to assign default values, you can still
change them before you deploy Content Platform Engine.
Before you install and deploy Content Platform Engine on a WebLogic Server
machine, you must create a WebLogic Server domain and install JDBC drivers.
(The drivers must be installed on the WebLogic Server machine whether your
database is collocated or not).
Important: You must use Configuration Manager, rather than a manual method, to
create the data sources that Content Platform Engine uses to connect to a database.
A data source that you create manually (by interacting directly with an application
server interface) can include, by default, many unnecessary and potentially
harmful custom properties. Also, for some combinations of database type and
application server type, Configuration Manager adds some special custom
properties to the data source it creates, which you might fail to include if you
create the data source manually. Without these added custom properties, runtime
errors can occur when Content Platform Engine tries to connect to a database.
Ensure that JBoss Application Server is installed on the machine where you intend
to deploy Content Platform Engine.
Note: JBoss Application Server clusters do not use a separate administrative server,
and configuration changes are implemented on each cluster node separately in a
highly available environment.
Important: You must use Configuration Manager, rather than a manual method, to
create the data sources that Content Platform Engine uses to connect to a database.
A data source that you create manually (by interacting directly with an application
server interface) can include, by default, many unnecessary and potentially
harmful custom properties. Also, for some combinations of database type and
application server type, Configuration Manager adds some special custom
properties to the data source it creates, which you might fail to include if you
create the data source manually. Without these added custom properties, runtime
errors can occur when Content Platform Engine tries to connect to a database.
Configuring JBoss Application Server for Content Platform Engine
JBoss Application Server requires some configurations before you install
Content Platform Engine.
Strengthening Content Platform Engine server security under JBoss
Application Server on page 111
In FileNet P8 environments the Content Platform Engine server assumes that a
user's short name passed to it by means of an IIOP request from Application
Engine, Workplace XT, or an associated custom application has been properly
authenticated and can be trusted.
Configuring JBoss Application Server clusters on page 111
JBoss Application Server servers can be grouped together into a cluster for
performance or to provide high availability. This guide provides only minimal
instructions for setting up a JBoss Application Server cluster.
JBoss Application Server requires some configurations before you install Content
Platform Engine.
Note: JBoss Application Server clusters do not use a separate administrative server,
and configuration changes are implemented on each cluster node separately in a
highly available environment.
Important: You must use Configuration Manager, rather than a manual method, to
create the data sources that Content Platform Engine uses to connect to a database.
A data source that you create manually (by interacting directly with an application
server interface) can include, by default, many unnecessary and potentially
harmful custom properties. Also, for some combinations of database type and
application server type, Configuration Manager adds some special custom
properties to the data source it creates, which you might fail to include if you
create the data source manually. Without these added custom properties, runtime
errors can occur when Content Platform Engine tries to connect to a database.
Option Description
Standard deployment jboss_install_dir/server
Cluster deployment (required for high jboss_install_dir/all
availability)
2. Create a new configuration file set by copying the configuration file set to a
new directory. For JBoss Application Server 5.0.0 and higher, the configuration
file set is the standard subdirectory. For JBoss Application Server versions less
than 5.0.0, the configuration file set is the default directory.
Option Description
Standard deployment Copy the configuration file set to a new
directory within the /server directory. For
example, copy the files to
jboss_install_dir/server/server1.
Cluster deployment Copy the configuration file set to a new
directory within the /all directory. For
example, copy the files to
jboss_install_dir/all/server1.
Option Description
AIX, HPUX, Linux, Solaris, and JBoss 5.0 ./run.sh -c server1 -b 0.0.0.0
and 5.1
Windows and JBoss 5.0 run.bat -c server1 -b 0.0.0.0
Windows and JBoss 5.1 run.conf.bat -c server -b 0.0.0.0
WebSphere Application Server and Oracle WebLogic Suite have mechanisms such
as Lightweight Third-Party Authentication (LTPA) keys to secure IIOP
communications, which establishes this sort of trust relationship between Java
Virtual Machines (JVMs). However, because JBoss Application Server has no such
feature to prevent unauthenticated access, a security risk is exposed between the
Content Platform Engine JVM and the calling application's JVM.
JBoss Application Server servers can be grouped together into a cluster for
performance or to provide high availability. This guide provides only minimal
instructions for setting up a JBoss Application Server cluster.
| To effectively run load balancing tasks, all instances of the Content Platform
| Engine must reside in a single JBoss cluster. EJB load balancing cannot span
| multiple JBoss clusters.
For each Application Engine node, uniquely name the cluster something other than
default.
Update the JBoss startup file on both Application Engine cluster nodes from:
JBOSSSH=${JBOSSSH:-"$JBOSS_HOME/bin/run.sh -c $JBOSS_CONF -b $JBOSS_HOST"}
to
JBOSSSH=${JBOSSSH:-"$JBOSS_HOME/bin/run.sh -c $JBOSS_CONF -b $JBOSS_HOST"}
-Djboss.partition.name=JBossP8AE
Configure the application server on each node with the following modification:
| Review the information that is provided in Planning for your web application
| server to prepare for the IBM WebSphere Application Server configuration.
| Review the information that is provided in Planning for your web application
| server to prepare for the Oracle WebLogic Server configuration.
| For instructions on configuring WebLogic Server for IBM Content Navigator, see
| the topics in Preparing Oracle WebLogic Server for IBM Content Navigator
| components.
Depending on your application server type, run one of the following commands to
start or stop an application server instance:
Table 21. How to start or stop an application server instance
Command to start an Command to stop an
Application server type application server instance application server instance
WebSphere Application startServer stopServer
Server
JBoss Application Server run stop
Oracle WebLogic Server startWebLogic stopWebLogic
Identify the Base URL for the load balancer or proxy server When installing any
components that request the URL of a deployed Workplace or Workplace XT
instance in a highly available configuration, you must use the URL that directs
users to your load-balancing or proxy device.
The simplest way to access documentation is by using the IBM FileNet P8 online
documentation at http://www.ibm.com/support/knowledgecenter/SSNW2F_5.2.1.
However, if this is not possible, for example because your application is in an
environment where internet access is not available, you can install documentation
on a local application server and deploy the help as a web application. The
following table compares the options.
Table 22. Comparing IBM Knowledge Center online documentation and the local information
center
Online documentation Local information center
Requires internet access Yes No
Requires local application No Yes
server
Supports mixed versions of No Yes
IBM FileNet P8 components
Is customizable No Yes
If you install the information center locally, you can use an application server that
is uniquely dedicated for that purpose, or you can use one that is prepared for
Content Platform Engine, Application Engine, or Workplace XT.
To determine the value for the base documentation URL for your documentation:
1. Determine the base documentation URL as follows, depending on which
documentation option you have chosen to use:
Option Description
Online documentation in IBM Knowledge http://www.ibm.com/support/
Center knowledgecenter/SSNW2F_5.2.1/
2.
Option Description
Workplace XT Append com.ibm.p8.xt.user.doc/ to the
initial portion of the base documentation
URL. For example, the base documentation
URL for Workplace XT would be
http://www.ibm.com/support/
knowledgecenter/SSNW2F_5.2.1/
com.ibm.p8.xt.user.doc/.
Workplace Append com.ibm.p8.doc/ to the initial
portion of the base documentation URL. For
example, the base documentation URL for
Workplace would be http://www.ibm.com/
support/knowledgecenter/SSNW2F_5.2.1/
com.ibm.p8.doc/.
All other components Enter only the initial portion of the base
documentation URL, for example,
http://www.ibm.com/support/
knowledgecenter/SSNW2F_5.2.1/.
In version 5.2, the Content Engine, Process Engine, and Case Analyzer were
combined and now run as a single deployed application. This is the Content
Platform Engine. This content and workflow management software runs on every
application server instance where it is deployed. It is recommended that you
contact your IBM representative to review capacity planning and load balancing
before you upgrade.
All data in the existing global configuration database, object stores, and workflow
system are automatically upgraded when you deploy the upgraded Content
Platform Engine EAR file.
Upgrade scenarios
Upgrade planning depends on the details of your existing installation. The
starting version and platform choices all influence the upgrade path of your
existing components.
Upgrade planning considerations on page 124
Review all upgrade planning information related to requirements for upgrading
an FileNet P8 system and expansion products, as well as other vendor products
associated with the FileNet P8.
Definition of upgrade roles on page 127
Your organization may have different roles, and some of the responsibilities of
listed roles will vary from those assigned by default.
Using the installation and upgrade worksheet on page 128
The Installation and Upgrade Worksheet is a Microsoft Excel spreadsheet
(p8_worksheet.xls). The worksheet describes the properties and parameters
required to complete FileNet P8 installation, upgrade, and configuration
programs, and provides a way to record the values you assign to these
properties and parameters.
Upgrade scenarios
Upgrade planning depends on the details of your existing installation. The starting
version and platform choices all influence the upgrade path of your existing
components.
(For upgrades from versions 4.5.1, 5.0.0 and 5.1.0) Content Engine, Process Engine,
and the following associated components must be upgraded together:
v Application Engine and depending on which version of Application Engine you
are upgrading from, the upgrade could be only the installation of a fix pack.
v IBM FileNet Workplace XT
v IBM Content Search Services
v Rendition Engine
v IBM FileNet Content Federation Services
v Case Analyzer and IBM FileNet Process Simulator can be upgraded at the same
time if you need full access to all case and simulation data after the upgrade.
However, you could upgrade these components later, such as the following
weekend. All backlogged data will be processed after those upgrades are
complete. See the Case Analyzer and IBM FileNet Process Simulator
documentation for information on upgrading those components.
(For upgrades from versions 5.2.0) Content Platform Engine and the following
associated components must be upgraded together:
v Application Engine client files
v IBM FileNet Workplace XT client files
v IBM Content Navigator client files
v IBM Content Search Services
v Rendition Engine
v IBM FileNet Content Federation Services
v Case Analyzer and IBM FileNet Process Simulator can be upgraded at the same
time if you need full access to all case and simulation data after the upgrade.
However, you could upgrade these components later, such as the following
weekend. All backlogged data will be processed after those upgrades are
complete. See the Case Analyzer and IBM FileNet Process Simulator
documentation for information on upgrading those components.
See the FileNet P8 Fix Pack Compatibility Matrices for a list of product-component
versions from which you can start an upgrade. .
Upgrade on an existing server instance
You can complete an upgrade on an existing server instance.
Upgrade with migration to a new server instance on page 122
An upgrade can be accomplished while also migrating from one server instance
to another. The new server instance could be on new hardware, or could be on
existing hardware. Making such a change is often part of the motivation for
doing the upgrade and it is important to have a well-understood process.
(For upgrades from 5.2.0) This upgrade scenario assumes you are upgrading
Content Platform Engine on the application server where it is currently deployed
and making configuration changes to that deployment.
| A server that was formerly a Process Engine server could also be used to install
| Content Platform Engine and Case Analyzer. This requires an installation of the
| same application server software that is installed on the other Content Platform
| Engine servers. Handle the configuration of this server like an upgrade with
| migration to a new server instance. Then add the new server as another node in
| the Content Platform Engine application server cluster.
Upgrading large FileNet P8 systems involves significant work. The upgrade can be
particularly challenging if you are changing the underlying platform of major
system components, such as Content Platform Engine. Using this approach, you
might install and configure a new server instance, such as for the application
server or database server. The initial installation and configuration work can be
done without impacting the production system.
At a high level, complete the upgrade migration procedures by using the following
steps. Some steps are repeated for each major FileNet P8 component:
v Determine a time when you can run the upgrade, which must be done when
nobody is altering the production system data. The copy of the production data
(replica) must reflect the production system. Otherwise the upgrade is not on
current data.
| v Set up a second system that contains a copy of production data. With this
| approach, you can revert to the original system if you encounter problems
| during the upgrade. You can also do some of the initial installation and
| configuration without impact to the production system. This second system lets
| you move to different server instances, replacing or updating hardware for
| application servers or database servers. Try to reuse as many of the
| configuration settings as possible from the original system on the second system
| to reduce any configuration issues that might arise in the upgrade.
v On the second system, run all upgrade tasks that might alter data in a
production system.
v Typically, the file stores are also relocated to the new platform. If you do not
relocate your file stores, you must take extra steps to ensure that the file stores
can be accessed from the new system.
v Conduct various validation tests that use the production applications on the
upgraded replica system.
You can practice the upgrade of your production environment by using either of
these two methods:
v Upgrade the lower environments first by running practice upgrades in the
following order:
Upgrade the development environment
Upgrade the various test environments
Upgrade the production environment
This method tests the process and validate that your applications are functioning
correctly at each environment level before you move production to the next
level.
v Practice the upgrade of the production environment by using the new
production environment.
Early in the project cycle, copy the existing production databases and file
storage areas into the new environment
Each time that you practice the upgrade, you apply only the updates that
were made to the data since the last practice run.
This method reduces the time that is needed to complete the final upgrade in
the required maintenance window. All of the required FileNet P8 and custom
application software is already installed in the new environment. You run only
incremental changes to the replicas of databases and file storage areas.
Apply the required minimum level FileNet P8 software updates for the release you
are currently running before you upgrade.
Applying a fix pack for one component might require fix packs for other
components. Prior to applying any fix pack, review the FileNet P8 Fix Pack
Compatibility Matrices to ensure compatibility between all installed components.
FileNet P8 eForms:
For more information, see the appropriate topics for upgrading in the IBM FileNet
P8 eForms Installation and Upgrade Guide.
IBM FileNet Content Federation Services must be at the same version level as
Content Platform Engine.
If IBM FileNet Content Federation Services is not at the same version level as
Content Platform Engine, shut it down and upgrade it to the same version level
after Content Engine has been upgraded.
For more information, see readme file that accompanied the latest IBM FileNet
Content Federation Services fix pack.
Depending upon which version of the records management product you are using,
there are tasks you must perform before you upgrade your Content Platform
Engine software. You must use different upgrade tools depending on the version of
records management software you are running.
For specifics on how to upgrade the underlying vendor software, see the
appropriate vendor documentation. Complete these vendor software upgrades
before you begin the upgrade but as part of the entire upgrade process.
Any new databases into which you migrate data must be populated by using the
database vendors appropriate database tools, such as backup and restore tools or
export and import tools. Perform database migration tasks only after you shut
down existing Content Platform Engine software and back up the databases. These
shutdown and backup actions help to ensure that all data that was in production is
moved to the new upgraded system.
Upgrading Process Engine 4.5.1, 5.0.0, or 5.1.0 requires the following steps, which
are explained in the upgrade instructions:
v Install the Content Platform Engine and IBM Case Foundation 5.2.1 software on
an existing Content Engine application server or on a new application server.
v Define data sources for any Process Engine database that is not already shared
with an object store.
v Deploy the combined Content Platform Engine on the application server.
v Run the pre-upgrade wizard to gather configuration information for Process
Engine. Upon completion of the wizard, the upgrade of the Process Engine
database and isolated regions starts.
After the upgrade, the Process Engine is no longer a separate component. There is
a single deployment of both the Process Engine and Content Engine components in
the new Content Platform Engine. Each existing Process Engine database becomes
| To move a legacy workflow system to the 5.2 style collocation model, you use the
| Region Move tool that is provided under Tools in the installation package. For
| detailed information on how to run the Region Move tool, see
| http://www-01.ibm.com/support/docview.wss?uid=swg27036552.
There are no longer any dependencies on the IBM FileNet Image Services software
and no IBM FileNet Image Services software is installed. You can remove the older
versions of Process Engine and IBM FileNet Image Services after successfully
installing the Content Platform Engine software and upgrading the database.
The tasks in this guide as well as the rows in the Installation and Upgrade
Worksheet are organized by administrative roles, listed below.
| Installation administrator
| v Runs the FileNet P8 component installers and upgrade programs.
| v Runs the FileNet Configuration Manager tool, followed by launching IBM
| Administration Console for Content Platform Engine.
| v Abbreviated as IA. Responsible for coordinating the information described in
| this worksheet. The information itself will require the input from the other roles.
For tasks assigned to the ITA, see IT administrator upgrade tasks on page 131.
Security administrator
v Responsible for configuring the directory servers required by FileNet P8
components.
v Creates and maintains directory server user and group accounts.
v Abbreviated as SA. Responsible for providing the information in the rows in the
Installation and Upgrade Worksheet with a value of SA in the Role column.
For tasks assigned to the SA, see Security administrator upgrade tasks on page
141.
For tasks assigned to the DBA, see Database administrator upgrade tasks on
page 143.
For tasks assigned to the ASA, see Application Server administrator upgrade
tasks on page 151.
FileNet P8 administrator
v This role designation actually refers to the administrator or administrators who
perform regular maintenance of Content Platform Engine and any client
applications.
v The administrator who logs on to IBM Administration Console for Content
Platform Engine using the gcd_admin account or an object_store_admin account is
considered an FileNet P8 administrator.
v Abbreviated as P8A. Responsible for providing the information in the rows of
the Installation and Upgrade Worksheet with a value of P8A in the Role column.
For tasks assigned to the P8A, see FileNet P8 administrator upgrade tasks on
page 154.
Important: For support of the full range of built-in filter and macro features, use
Microsoft Excel to view the Installation and Upgrade Worksheet file. You can use
other spreadsheet programs to view the file; however, filter and macro support can
vary. For example, in Calc from OpenOffice.Org, the column filters work as
expected, but the Customize Worksheet button does not.
AutoFiltering is a quick way to display only those rows that meet a certain
criterion.
To use AutoFilter:
1. Make sure AutoFiltering is enabled. (Select the entire row with the column
headers, then click Data > Filter > Autofilter.) AutoFilter arrows will appear to
the right of the column labels.
2. Click the AutoFilter arrow in the Installation or Configuration Program
column header and select the program you are interested in (for example, CPE
installer).
3. For a custom AutoFilter, click the AutoFilter arrow in any column header,
select Custom, and use the dialog box to define a filter that will show rows
that meet your criteria.
4. To turn off AutoFiltering in a column, click the column AutoFilter arrow and
select (All).
5. To reorder rows alphabetically, do a Sort:
a. Click anywhere in a column, for example, Column A Role.
The only possible values in the Role column are ASA, SA, DBA, ITA, and
P8A. Sorting on Role therefore groups the rows by this attribute, in
alphabetic order. Several other columns also have a limited number of
possible values which means they can be usefully sorted.
b. Click the Sort Ascending icon in the Excel toolbar, or use the Data > Sort
menu command. The rows sort on Role.
Sorting the Worksheet reassigns row numbers. If you refer to rows by
number, be aware that row numbers change if you change the sort order.
To prepare the FileNet P8 environment, complete the tasks assigned to each role.
Some tasks require input that results from other preparation tasks performed by
other administrator roles. For information about assigning and defining these roles,
see Definition of upgrade roles on page 127.
While performing the tasks, record the results in the Installation and Upgrade
Worksheet where indicated.
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the shipping worksheet file (p8_worksheet.xls), perform the following actions to
quickly see only the properties assigned to a particular role:
Click the AutoFilter drop-down arrow in the Role column header and select
ITA.
Further filter the result set by clicking the AutoFilter drop-down arrow in
any of the other columns and selecting a value or clear a filter by selecting
All.
v Configure the operating systems to prepare for component upgrade.
Creating operating system accounts for upgrades on page 132
Operating system accounts are required during the upgrade process.
Configuring AIX, HPUX, HPUXi, Linux, Linux on System z, and Solaris on
page 136
Prepare your AIX, HPUX, HPUXi, Linux, Linux on System z, or Solaris-based
server for FileNet P8.
Configuring Microsoft Windows on page 138
Verify that the following Windows server configuration changes have been
made in preparation for upgrading FileNet P8 software.
Configuring operating system elements on page 140
Configure the network to prepare for your FileNet P8 upgrade. You must
ensure proper network communications and access rights.
Using IBM Support data collection tools on page 140
The IBM Support data collection tools can help you troubleshoot problems with
your installed IBM FileNet P8 products by collecting and analyzing
problem-related diagnostic data.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Creating the Content Platform Engine installer account
An operating system account you use to install Content Platform Engine.
Creating the Process Engine upgrade account (upgrades from versions 4.5.1,
5.0.0, 5.1.0) on page 133
An operating system account you use to run the Process Engine upgrade
wizard.
Creating Configuration Manager user on page 134
An operating system account you use to run Configuration Manager.
Creating the Content Platform Engine application server installation account
on page 135
Create a new or designate an existing application server account to be used
while upgrading Content Platform Engine.
Creating the Content Platform Engine application server installation group on
page 135
An operating system group account to which several Content Platform Engine
accounts must belong.
If you are upgrading on the same machine where Content Platform Engine (or
Content Engine) was previously installed, use the same installer account that you
originally used to install that software. The installation program requires this to
detect that it is an upgrade and to use the same installation path.
If you are upgrading on a new machine, where Content Platform Engine has never
been installed, create the cpe_install_user as explained here.
Creating the Process Engine upgrade account (upgrades from versions 4.5.1, 5.0.0,
5.1.0):
An operating system account you use to run the Process Engine upgrade wizard.
1. Create the following operating system account:
Process Engine upgrade user account
Unique identifier
pe_upgrade_user
Description
v A directory server user account that has Full Control access
rights to the FileNet P8 domain, and has also been granted
rights through its membership in the
workflow_system_admin_group.
v Content Platform Engine permissions can be granted by a
gcd_admin who uses IBM Administration Console for Content
If you are upgrading on the same machine where Content Platform Engine (or
Content Engine) was previously installed, use the same Configuration Manager
user account that you originally used during installation. The program requires
this to detect that it is an upgrade and to use the same installation values.
If you are upgrading on a new machine, where Content Platform Engine (or
Content Engine) has never been installed, create config_mgr_user, as explained here.
1. Create the following operating system account:
Configuration Manager user
Unique identifier
config_mgr_user
Description
An operating system account you will use to run Configuration
Manager.
Minimum required permissions
config_mgr_user must belong to the cpe_appserver_install_group.
(Windows only) Using Active Directory tools, add
config_mgr_user to either the Power Users group or the Local
Administrators group.
At several points in the installation process you will be
instructed to grant additional permissions to config_mgr_user,
including the following permissions:
v Execute permission to the Configuration Manager executable
file, configmgr.exe (Windows) or configmgr.sh (AIX, HPUX,
HPUXi, Linux, Linux for System z, Solaris).
v Read and write permission to the directory where
Configuration Manager will create the configuration XML
files. For example:
the directory you specify using the optional -path
parameter when you run Configuration Manager.
the default directory, ce_install_path/tools/configure/
profiles, if you do not specify a path parameter.
Create this account if it does not already exist. The upgrade instructions tell you
when to use it. In earlier releases, this account was identified as
ce_appserver_install_user.
1. Create the following operating system account:
Content Platform Engine application server installation administrator
Unique identifier
cpe_appserver_install_user
Description
The cpe_appserver_install_user account is needed during the
installation process to perform the following tasks:
v Create and configure the application server for Content
Platform Engine.
v Start or stop the application server when needed.
v Modify the application server files or directories as needed
for deploying Content Platform Engine using the
Configuration Manager tool.
v Provide create, read and write permissions for directories on
devices or drives that are used for external Content Platform
Engine file storage.
cpe_appserver_install_user must belong to the
cpe_appserver_install_group.
Minimum required permissions
Use your local machine's administrative tools to grant
cpe_appserver_install_user at least the following permissions:
v For Windows, cpe_appserver_install_user must be a member of
the Local Administrators Group.
v For UNIX, cpe_appserver_install_user must have read, write,
and execute permissions to the Content Platform Engine
installation directory.
Create this account if it does not already exist. The upgrade instructions tell you
when to use it. In earlier releases, this account was identified as
ce_appserver_install_group.
1. Create the following operating system account:
To ensure hosts file contents, the /etc/hosts file must have the Internet Protocol
(IP) address of the servers to be used.
1. Ensure hosts file contents. On each AIX, HPUX, HPUXi, Linux, Linux on
System z, or Solaris-based FileNet P8 server that does not use DNS (Domain
Name Service) or NIS (Network Information Service), the /etc/hosts file must
contain the name and IP address of all servers it will communicate with,
including the remote database server, if applicable.
2. Consult with the application server, database, and FileNet P8 administrators to
determine port requirements for all the servers in your environment. For
details, see Appendix B, FileNet P8 ports, on page 171.
Configuring Content Platform Engine servers (AIX, HPUX, HPUXi, Linux, Linux
on System z, and Solaris):
| The system checks for the default file-creation permissions for the user who will
| upgrade Content Platform Engine.
Content Platform Engine running on an AIX, HPUX, HPUXi, Linux, Linux on
System z, or Solaris-based application server
Use the umask utility program to set the default file-creation permissions
mask for the Java Virtual Machine (JVM) instance that hosts Content
Platform Engine so that the owner (the user running JVM) and the
members of the owners group have read/write/execute access
permissions, and all others have no access:
umask u=rwx,g=rwx,o=
This mask setting ensures that the access permissions on files and
directories created by Content Platform Engine are identical to those you
must specify when creating file storage areas on AIX, HPUX, HPUXi,
Linux, Linux on System z, or Solaris file servers.
Tip: This umask setting is required for the user (cpe_install_user) who runs
the Content Platform Engine installer program, but does not need to be in
the .profile file of the user.
Upgrades of the Content Platform Engine (or Content Engine) software are
normally done by the same user who originally installed the software. If this is
account cannot be used for some reason, designate a new account and assign
certain directory permissions to it.
If the old cpe_install_user account, the one you used to install Content Platform
Engine (or Content Engine) is not available, use the following procedure to assign
the necessary directory permissions to a new and different cpe_install_user user
account which you will use to upgrade Content Platform Engine:
1. Make sure you know the old cpe_install_user account. If you do not know, log
on to the application server as any user and run the ls -l command from a
shell prompt to determine the ownership of the Content Platform Engine (or
Content Engine) installation directory and the files it contains. The default
installation directory is one of the following locations:
Make sure your Windows servers comply with the requirements for the upgraded
version of FileNet P8.
v See the IBM FileNet P8 system requirements for details on required Windows
Service Packs and patches.
v Consult with the application server, database, and FileNet P8 administrators to
determine port requirements for all the servers in your installation environment.
For details, see Appendix B, FileNet P8 ports, on page 171.
Microsoft .NET Framework is a prerequisite for installing .NET API Clients and
COM Compatibility clients. Some clients might also require the installation of
Microsoft Web Services Enhancements (WSE).
If you are using Windows Active Directory for your directory service, set the
primary DNS.
If Windows Active Directory is your directory service, set the primary DNS server
IP address on your Content Platform Engine application server to the IP address of
the machine where DNS is installed.
Configure inbound rules in the Windows firewall to allow the following ports
access.
Ensure that your TCP/IP settings are configured so that your servers and clients
can communicate with one another.
FileNet P8 processes require that you synchronize the clocks on all of the machines
that are running FileNet P8 servers and FileNet P8 clients.
1. Make sure that the machine clocks on all FileNet P8 servers, including Content
Platform Engine, Application Engine, as well as all database servers and those
of FileNet P8 client applications including Workplace XT, Rendition Engine,
IBM Case Manager, and so on, are synchronized. Errors that might arise if they
are not synchronized include those of authentication, cooperative locking,
communication between servers, and others.
| 2. You can run a clock synchronization utility to synchronize all of the clocks on
| your Java virtual machines with a reliable time source. If the clocks get out of
| sync by 60 seconds or more, you can configure a scheduler in the clock
| synchronization utility to periodically synchronize the time of the clocks.
IBM Support data collection tools automate the gathering and sending of
appropriate diagnostic data to IBM Support for investigation and resolution of
installation, upgrade, or runtime problems in IBM FileNet P8 products. Typically
you would run an IBM Support data collection tool after installing or upgrading
the product, or when the IBM FileNet P8 system is in production.
To use an IBM Support data collection tool, your IBM FileNet P8 product must be
supported by the tool and must have Internet access to the IBM Support back-end
servers where the collected data is analyzed. If your product does not meet these
Two IBM Support Assistant data collection tools are available, at the IBM Support
Assistant Data Collectors website:
v IBM Support Assistant Data Collector is a web-based tool that can be used at
any time; there is nothing to install.
v IBM Support Assistant Lite Data Collector must be installed on the servers
where you installed or upgraded your IBM FileNet P8 products before it can be
used. By installing the tool before your IBM FileNet P8 system goes into
production, you avoid the possibility of not being able to install it after a
runtime problem occurs.
To determine which IBM Support data collection tool supports your IBM FileNet
P8 product:
1. Browse to the IBM Support Assistant Data Collectors website.
2. Find an IBM Support data collection tool that supports your product:
v To determine whether IBM Support Assistant Data Collector supports your
product, complete the following substeps:
a. Click the Data Collectors tab on the IBM Support Assistant Data
Collectors home page, and then click Launch.
b. Expand the I need to collect data for drop-down list. If your product is
listed, then you can use IBM Support Assistant Data Collector.
v To determine whether IBM Support Assistant Lite Data Collector supports
your product, complete the following substeps:
a. Click the Data Collectors tab on the IBM Support Assistant Data
Collectors home page.
b. Choose Enterprise Content Management in the Select a brand to begin
the download process drop-down list.
c. Expand the Select a product to access the download page drop-down
list. If your product is listed, then you can use IBM Support Assistant Lite
Data Collector.
3. Follow the instructions on the web page for the tool that supports your product
to use the tool directly or to install it, as needed.
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the worksheet file (p8_worksheet.xls), perform the following actions to quickly
see only the properties assigned to a particular role:
Click the AutoFilter drop-down arrow in the Role column header and select
SA.
Further filter the result set by clicking the AutoFilter drop-down arrow in
any of the other columns and selecting a value or clear a filter by selecting
All.
If you see a reference to an account that you do not understand, search the
documentation for that reference.
Creating the application server administrative console user (WebSphere
Application Server)
An LDAP account to which you have granted the WebSphere Application
Server administrative role.
An LDAP account to which you have granted the WebSphere Application Server
administrative role.
Create this account if it does not already exist. The upgrade instructions tell you
when to use it.
1. Create the following directory service account:
WebSphere administrative console user
Unique identifier
appserver_console_user
Description
The appserver_console_user account is an LDAP account to which
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the worksheet file (p8_worksheet.xls), perform the following actions to quickly
see only the properties assigned to a particular role:
Click the AutoFilter drop-down arrow in the Role column header and select
DBA.
Further filter the result set by clicking the AutoFilter drop-down arrow in
any of the other columns and selecting a value or clear a filter by selecting
All.
v Upgrade your database to a version that is supported by FileNet P8 prior to
upgrading the FileNet P8 software. See FileNet P8 Hardware and Software
Requirements for version information.
Database administrator planning
To prepare for an upgrade, review database requirements and complete other
planning tasks.
Planning the IBM Content Search Services upgrade on page 151
Empty the IBM Content Search Services index request table before you upgrade
Content Platform Engine.
Rather than upgrading your existing database, it is a best practice to create a new
database instance on a version of the database that is supported by the new
FileNet P8 components. Import data for, or restore backups of, your existing
Content Platform Engine (or your Content Engine and Process Engine) data into
the new database. Then retarget your JDBC Content Engine data sources to the
new database. This approach allows you to leave the existing production system in
place while you do the prerequisite steps for the new database.
Before upgrading FileNet P8 to version 5.2.1, Process Engine isolated regions that
are used in an IBM Case Manager configuration must be located in the
corresponding Content Engine object store database or table space.
For version 5.0 and 5.1 FileNet P8 systems, new installations configured with IBM
Case Manager were required to have common Oracle or DB2 for Linux, UNIX and
Windows table spaces for the Process Engine isolated region and Content Engine
object store. For Microsoft SQL Server, new installations configured with IBM Case
Manager were required to have a common database for the Content Engine object
store and the Process Engine isolated region. For systems that were upgraded to
version 5.0 or 5.1, where IBM Case Manager was then added, there was no
requirement for Process Engine and Content Engine databases to be common.
Important: For version 5.0 or 5.1 systems not in compliance with the common
database or table space requirement, you must move any Process Engine isolated
regions into the appropriate Content Engine object stores before you upgrade. A
tool has been provided on the Content Platform Engine installation media for that
purpose. See the techdoc documenting the tool for moving isolated regions.
Starting with the 5.2 version of FileNet P8, the Content Engine and Process Engine
are deployed together as a single application server instance. In addition, the
database is handled as a single entity. New workflow systems and isolated regions
are created in object stores, and all database connections require data sources.
Existing Process Engine systems become legacy workflow systems and the
databases are separate from any new workflow systems.
As a part of the upgrade you will create data sources for any existing Process
Engine databases. If you are upgrading from version 5.0 of Process Engine and had
multiple virtual servers, each virtual server had a unique database and each of
those databases will require a data source and those data sources will also be
targeted to the new database. Upgrade the Content Engine, Process Engine, and
Case Analyzer software and complete all upgrade procedures before you allow
users to access information in the new database.
To upgrade the Process Engine database, identify the existing database user name
and password. In versions of Process Engine older than 5.0, the default was the
f_sw user. Record this database user name and password in the Installation and
Upgrade Worksheet as the pe_db_user and password.
Planning for DB2 for Linux, UNIX and Windows database upgrades:
Review upgrade requirements for DB2 for Linux, UNIX and Windows databases.
For minimum version and fix pack requirements, see IBM FileNet P8 system
requirements.
Databases that are used for Content Platform Engine must be configured with a
minimum of 32 KB page sizes and a UTF-8 code page. Versions of Process Engine
before version 5.0 supported smaller page sizes. Older versions of Process Engine
also supported additional code pages. Use the procedures in the techdoc How to
determine if your Process Engine DB2 database has the correct tablespace pagesize and/or
code page for upgrading to Process Engine 5.0 (Techdoc 7020392) to determine whether
page size or code page changes are required before you upgrade to version 5.2.1.
To install DB2 for Linux, UNIX and Windows and create DB2 instances:
1. Set or verify the following instance and database settings. Settings and values
vary depending on database versions.
DB2 for Linux, UNIX and Windows versions 9.7, 9.8, 10.1:
db2set DB2_WORKLOAD=FILENET_CM
db2set DB2_MINIMIZE_LISTPREFETCH=ON
db2set DB2_OPTPROFILE=ON
DB2 for Linux, UNIX and Windows version 10.1 Fix Pack 2 or later:
db2set DB2_WORKLOAD=FILENET_CM
2. Connect to your object store databases by entering the following command:
db2 connect to db_name user user_name using password
where
v db_name is the name of your object store database
v user_name is the user ID used to access the object store database
v password is the password for the user ID used to to access the object store
database
Issue the following command:
DB2 for Linux, UNIX and Windows 10.5 (or later) supports an extended row size
by default. This means that you can create properties without exceeding the record
length limit for the page size, because column allocation sizes are no longer
counted against the limit during column creation. If an updated or inserted value
causes the sum of the bytes across all columns to exceed the physical record length
limit of the page size, DB2 for Linux, UNIX and Windows stores a descriptor (24
bytes) in the column. The descriptor points to an off-row location. For databases
that you upgraded to DB2 for Linux, UNIX and Windows 10.5 (or later) from a
release prior to DB2 for Linux, UNIX and Windows 10.5, issue this command to
enable extended row size support:
UPDATE DATABASE CONFIGURATION FOR dbName USING EXTENDED_ROW_SZ ENABLE
When you add a new property to a class, Content Platform Engine determines
whether extended row size is enabled for the DB2 for Linux, UNIX and Windows
10.5 (or later) database. Making this determination requires having the SELECT
privilege (granted by default) on a view:
SELECT ON SYSIBMADM.DBCFG
If extended row size is enabled for a DB2 for Linux, UNIX and Windows database,
even if table overflow is enabled on an object store, Content Platform Engine does
not overflow tables when you add a property to a class. That is, all columns are
added to the original table.
If extended row size is not enabled for a DB2 for Linux, UNIX and Windows
database, or if you revoked the view permission, rows are limited to 32 KB (at
column allocation time), and Content Platform Engine overflows tables if overflow
is enabled on an object store.
If your system has existing overflow tables and you upgraded to DB2 for Linux,
UNIX and Windows 10.5 (or later), and you enabled extended-row-size support,
DB2 for Linux, UNIX and Windows adds new columns to the original table, not
the overflow table. Content Platform Engine associates new properties with the
overflow table only if it determines that a property can reuse an existing column
that is no longer used.
Planning for Process Engine DB2 for Linux, UNIX and Windows database
upgrades (upgrades from versions 4.5.1, 5.0.0, 5.1.0)
For versions 4.5.1, 5.0.0, and 5.1.0, there are some additional requirements for
upgrading Process Engine.
Planning for Process Engine DB2 for Linux, UNIX and Windows database upgrades
(upgrades from versions 4.5.1, 5.0.0, 5.1.0):
For versions 4.5.1, 5.0.0, and 5.1.0, there are some additional requirements for
upgrading Process Engine.
The recommended upgrade scenario is to make a test copy of the Process Engine
database. Ensure the copy of the database is at least DB2 Version 9.7 for Linux,
Process Engine string fields are modified for all Process Engine user tables by
increasing the length by an expansion factor. This expansion value is to allow for
the additional space requirements for character-based string fields. String fields are
modified by increasing the length by the defined factor.
Record the value to indicate your choice to expand string fields by a size
factor in your customized Installation and Upgrade Worksheet. Set the value
between three and six. To find this property, filter on peupgrade and search the
worksheet for instances of the Database Column Size Factor parameter.
| After the upgrade, use the pedbconvert tool to make the following changes:
| v Enable date fields exceeding the 2038 date.
| v Support of character strings:
| Enable support for GB18030 characters. GB18030 character support also
| requires DB2 Version 9.7 for Linux, UNIX and Windows or higher.
| Enable properly truncated strings with multi-byte characters, where a partial
| character is not left at the end of a string.
| Number of bytes (expansion factor) for character sets no longer required.
| Provide better performance when using indexes that have one or more string
| keys.
| Use of the pedbconvert tool is recommended for workflow systems that support
| multi-byte characters in an international global environment. Customers who do
| not have multi-byte systems should also run the pedbconvert tool, but it can be
| run after the upgrade. See techdoc 7036559 for information. The technote is
| applicable to all upgrades from 4.5.1 and also to 5.0 systems that have upgraded
| previously from earlier releases but have not run the 5.0 advanced upgrade tool,
| techdoc 7019393.
For minimum version and fix pack requirements, see IBM FileNet P8 system
requirements. No additional actions are required to prepare the DB2 for z/OS
database for a FileNet P8 upgrade.
For information on support for DB2 for z/OS in earlier releases of FileNet P8, see
the techdoc DB2 for zOS is supported with Content Manager 5.2.0 starting in 5.2.0 FP2
(Techdoc 7038918).
Any Oracle database users must have the following permission for the upgrade:
SELECT on USER_INDEXES
Planning for Content Platform Engine (or Content Engine) Oracle database
upgrades
If you have set the oracle.jdbc.V8Compatible flag to true for your Content
Platform Engine (or Content Engine) database, as documented in the Enabling
Oracle Data Index Use in the FileNet Content Engine technical notice (see
http://www.ibm.com/support/docview.wss?uid=swg21397282), you need to set
the flag to false. The flag is not supported in Oracle 11g and is not needed in
version 5.2.1 Content Platform Engine databases.
For object stores upgraded from version 4.5.1, as part of the auto-upgrade of
Oracle-based Content Engine data, table columns defined by the DATE property
are automatically converted to the TIMESTAMP property, even if there is an index
on the DATE property. However, auto-upgrade will not be able to perform this
conversion on function-based indexes, such as the descending (DESC) keyword,
that involve the DATE property. Because it is not feasible to resolve this conversion
failure within the auto-upgrade framework, plan to manually convert DATE
columns with function-based indexes to TIMESTAMP columns by dropping these
indexes, altering the property and recreating the index. Upgrade procedures direct
you to complete this procedure after the auto-upgrade finishes.
The following database changes are automatically made for system and user data
during the database upgrade:
v Process Engine date and time fields are changed from 32-bit to 64-bit to enable
date fields exceeding the 2038 date.
v Process Engine string fields are converted from byte-based to character-based
strings.
For minimum version and fix pack requirements, see IBM FileNet P8 system
requirements.
Planning for Process Engine SQL Server database upgrades (upgrades from
version 5.0.0) on page 149
For version 5.0.0, plan the Process Engine SQL Server database upgrade. Plan
carefully to determine whether there are prerequisites for doing the Process
Engine upgrade.
Planning for Process Engine SQL Server database upgrades (upgrades from version
5.0.0):
For version 5.0.0, plan the Process Engine SQL Server database upgrade. Plan
carefully to determine whether there are prerequisites for doing the Process Engine
upgrade.
The recommended upgrade scenario is to make a test copy of the Process Engine
database. Complete the upgrade on that copy. Doing the upgrade with a database
copy also lets you to determine how long the upgrades take.
Process Engine string fields are modified for all Process Engine user tables by
increasing the length by an expansion factor. This expansion value is to allow for
the additional space requirements for character-based string fields. String fields are
modified by increasing the length by the defined factor.
Record the value to indicate your choice to expand string fields by a size
factor in your customized Installation and Upgrade Worksheet. Set the value
between three and six. To find this property, filter on peupgrade and search the
worksheet for instances of the Database Column Size Factor parameter.
| After the upgrade, use the pedconvert tool to make the following changes:
| v Enable date fields that exceed the 2038 date.
| v Support of character strings:
| Enable support for GB18030 characters by using nvarchar instead of varchar
| in the Process Engine database schema.
| Enable properly truncated strings with multi-byte characters, where a partial
| character is not left at the end of a string.
| Provides better performance when it uses indexes that have one or more
| string keys.
| Number of bytes (expansion factor) for character sets no longer required.
Enabling XA transactions:
Perform these steps on every Microsoft SQL Server that will contain a Content
Platform Engine database.
1. Download the Microsoft SQL Server JDBC Driver that is referenced in the IBM
FileNet P8 system requirements document for Content Platform Engine SQL
Server databases.
Tip: Installation procedures for JDBC settings can vary by release. See the
Microsoft website for full details.
2. Copy the sqljdbc_xa.dll from the JDBC installation directory to the binn
folder of the instance, although a pre-2.0 version of the driver also functions
correctly from the tools\binn folder. For the 32-bit version of Microsoft SQL
Server , use the sqljdbc_xa.dll file in the x86 folder. For the 64-bit version of
Microsoft SQL Server, use the sqljdbc_xa.dll file in the x64 folder.
3. Log on as the sa administrator or as a user with equivalent permissions and
execute the database script xa_install.sql on the master database on every SQL
Server instance that will participate in distributed transactions.
High Microsoft SQL Server concurrency causes transaction deadlock errors because
writers block access, by readers, to database resources. You can reduce the
likelihood of deadlock by setting the READ_COMMITTED_SNAPSHOT ON option for your
database.
For systems configured with IBM Content Search Services, plan to flush as many
index requests as possible before starting the upgrade. Part of the automatic
upgrade of the Content Platform Engine (or Content Engine) database includes a
change to the index request table. If there are more than 500,000 records in that
table when the automatic upgrade runs, a new required index will not be created.
A message will be logged and the database administrator must manually build the
new index before upgrading the IBM Content Search Services software. This index
must exist before the Content Platform Engine and IBM Content Search Services
software is used for production.
Create this account if it does not already exist. The upgrade instructions tell you
when to use it.
1. Create the following application server account:
Application server administrator
Unique identifier
appserver_admin
Description
WebSphere Application Server
In Configuration Manager, when you run the Set
Properties for WebSphere Application Server task, enter
the credentials of the appserver_admin account in the
field labeled Application server administrator user
name. Configuration Manager uses the appserver_admin
account to run configuration tasks.
WebSphere administrative security is enabled
You have two options for creating the
appserver_admin user account. You can use the
local file-based account usually defined while
creating the WebSphere profile. Or, you can use
WebSphere tools to grant administrative rights
to an LDAP account and optionally remove the
file-based account created earlier.
The appserver_admin user account must have
WebSphere administrator permissions
throughout the Content Platform Engine
Depending on your application server type, run one of the following commands to
start or stop an application server instance:
Table 25. How to start or stop an application server instance
Command to start an Command to stop an
Application server type application server instance application server instance
WebSphere Application startServer stopServer
Server
JBoss Application Server run stop
To determine the order of upgrading Content Platform Engine and the application
server on which it is deployed:
1. Consult the IBM FileNet P8 system requirements documentation for both the
existing version of software and the new version. Determine if a version of
your application server is supported by both your existing version of Content
Platform Engine (or Content Engine) and the new version of Content Platform
Engine.
2. Upgrade your application server and Content Platform Engine (or Content
Engine) according to the criteria in the following table:
Option Description
If you deployed your current version of 1. Upgrade the Content Platform Engine
Content Platform Engine (or Content software. It is not necessary to upgrade
Engine) on an application server version your application server.
that is supported by the new version of
2. (optional) Upgrade the application server
Content Platform Engine
to a newer version that is supported by
the new version of Content Platform
Engine
If you deployed your current version of 1. Upgrade to an application server version
Content Platform Engine (or Content that both the current version of Content
Engine) on an application server version Platform Engine (or Content Engine) and
that is not supported by the new version of the new version of Content Platform
Content Platform Engine Engine support.
2. Upgrade Content Platform Engine to the
new version.
If you deployed your current version of 1. Perform a migration upgrade by creating
Content Platform Engine (or Content a new instance of the application server
Engine) on an application server version using a version that is supported by the
that is not supported by the new Content new Content Platform Engine.
Platform Engine and an application server
2. Upgrade Content Platform Engine
version that is supported by both your
working through the topics on
existing Content Platform Engine (or
configuring Content Platform Engine into
Content Engine) and the new Content
a new application server instance using
Platform Engine version does not exist
an existing Configuration Manager
profile.
Tip: With the Data > Filter > AutoFilter command enabled, as it is by default in
the worksheet file (p8_worksheet.xls), perform the following actions to quickly see
only the properties assigned to a particular role:
v Click the AutoFilter drop-down arrow in the Role column header and select
P8A.
v Further filter the result set by clicking the AutoFilter drop-down arrow in any
of the other columns and selecting a value or clear a filter by selecting All.
Enabling the Asynchronous Processing dispatcher
You must enable the Asynchronous Processing dispatcher to ensure that the
object stores progress to a completed or ready state as part of an upgrade.
Preparing Process Engine for upgrade (upgrades from versions 4.5.1, 5.0.0,
5.1.0) on page 156
Repair any inconsistencies between Process Engine queues and rosters in the
Process Engine database, reconcile user security information and prepare Case
Analyzer data for upgrade.
Collecting settings for peupgrade wizard (upgrades from versions 4.5.1, 5.0.0,
5.1.0) on page 156
Collect the values for all settings in the peupgrade wizard. The values are
needed for Process Engine upgrades from versions 4.5.1, 5.0.0, and 5.1.0.
Collecting configuration information for Process Engine DbExecute
connections (upgrades from 4.5.1) on page 159
DbExecute connection information must be provided to the peupgrade tool for
Process Engine upgrades from Version 4.5.1. Collect the current configuration
information for all of your existing DbExecute aliases before you upgrade.
Saving Component Manager custom settings for CE_Operations (upgrades
from V5.1 or earlier) on page 160
Save Component Manager custom settings for CE_Operations in each isolated
region before you upgrade. You need to restore the settings after the upgrade is
complete.
For each object store to be upgraded, you must enable the Asynchronous
Processing dispatcher on at least one Content Platform Engine (or Content Engine)
server in the site where the object store is located.
During the upgrade of Process Engine, you run peupgrade. After you provide
information to the program, you run it to upgrade the Process Engine database.
The values can be provided to peupgrade in a wizard or in a property file that is
an input file to the program. The information that you must gather varies
depending on whether you are upgrading from Version 5.0 or 5.1, or from Version
The following table shows the information that is required and where to collect it
on the source Process Engine system. Several values are not on the source system
but are needed for the upgrade. For each property name, record the value in your
Installation and Upgrade worksheet. Property names in this table reflect the name
in the peupgrade wizard user interface.
Table 26. peupgrade upgrade values
4.5.1 property name and 5.0 or 5.1 property name
Property name location and location Comments
Server DNS name Server or load balancer Server or load balancer
name in FileNet Enterprise name in FileNet Enterprise
Manager, Isolated Region Manager, Isolated Region
properties. properties.
Naming service port Process Engine Naming service port in the The default value is 32776.
Communication Port (IOR Process Task Manager on On V5.0, every virtual
port) in the Process Task the Process Engine server. server has a different port.
Manager on the Process In Enterprise Manager, this
Engine server. In Enterprise port is called the
Manager, this port is called Communication Port.
the Communication Port.
Operating system character From the command line, From the command line, This property is the
set (AIX, HPUX, HPUXi, enter locale charmap enter locale charmap character set on the original
Linux, Linux on System Z, server.
Solaris)
Option Description
AIX, HPUX, HPUXi, Solaris /fnsw/local/sd
Windows \fnsw_loc\sd
2. Each connection has a file associated with the following naming scheme
.alias.bin
| Before you upgrade FileNet P8 from version 5.1 or earlier, you must make note of
| the logon and password for the adapter. If you extended the CE_Operations queue
| with exposed fields or database indexes, you must also save these custom settings
| before you upgrade. You must manually restore these settings and values after the
| upgrades of the Content Platform Engine software and the Process Engine
| database are complete.
| You can use Administration Console for Content Platform Engine if it is available
| or the Process Configuration Console in Workplace or Workplace XT to save the
| CE_Operations settings. The console that you select is used to configure the queue,
| but that does not imply that the component queue runs in Content Platform
| Engine or Workplace.
| Tip: Use the XML file extension for the file name.
| c. Choose the export type Export selected components and select the
| CE_Operations queue from the Component Queues. Then click Next.
| d. On the Summary page, confirm that the export contains only the
| CE_Operations queue, and then click Finish to complete the export.
| e. Repeat the preceding substeps for the other isolated regions.
| 3. Save the adapter settings for the CE_Operations queue in each isolated region:
| a. Go in Process Configuration Console for an isolated region to the isolated
| region node > Component Queues > CE_Operations.
| b. Right-click the CE_Operations node and choose Properties to view its
| properties.
By default, Content Platform Engine uses Oracle Outside In Search Export for text
extraction on PDF documents. For right-to-left language PDF documents, you can
optionally use Apache PDFBox technology for text extraction. To use PDFBox, you
set a JVM property on Content Platform Engine. For more information, see the
topics in Administering FileNet P8 > Administering Content Platform Engine.
For information on how IBM Content Search Services extracts text from documents
that are sent to it by IBM Content Collector, see Administering FileNet P8 >
Administering Content Platform Engine > Retrieving documents > Finding
objects with content-based retrieval > Making object text searchable > Indexable
document types and text extraction.
IT administrator
Depending on the operating system, the IT administrator installs either a
localized version of the operating system, or the operating system language
pack.
Security administrator on page 165
The FileNet P8 security administrator installation role includes configuring and
maintaining directory servers.
Database administrator on page 166
The FileNet P8 database administrator installation role includes configuring
database installations and table spaces, and creating database accounts.
Application Server administrator on page 167
To support Unicode UTF-8 characters, all FileNet P8 domain application servers
must be properly configured and must have all fix packs installed.
FileNet P8 administrator on page 168
The FileNet P8 administrator configures Process Task Manager for Application
Engine and Workplace XT.
Limitations on installing in a non-English environment on page 168
There are certain limitations on installing FileNet P8 in non-English
environments.
IT administrator
Depending on the operating system, the IT administrator installs either a localized
version of the operating system, or the operating system language pack.
Operating system considerations on page 164
In addition to any operating system platforms, the IT administrator must
consider the FileNet P8 components that will be installed in a non-English
environment.
Microsoft Windows on page 165
Use the localized Microsoft Windows version when available. If the localized
version is not available, use the English version with the appropriate regional
setting.
Remember: The Application Engine and Workplace XT setting must match the
Content Platform Engine setting. Otherwise, workflows can experience unexpected
problems such as errors related to the way characters display.
When you run the installation program for IBM Content Search Services, you
specify a configuration data directory and an installation directory. If any
component of either of these directory names contains non-English characters, the
installation program appears to complete normally; but the program creates an
installation directory whose name contains random characters instead of the name
that you specified.
This installation failure occurs whether you install the first instance or an
additional instance of IBM Content Search Services. To prevent the failure, use only
English characters in the name of each component of the configuration data
directory and the installation directory.
Use the Regional Options Control Panel to change the regional setting. For more
information, see the Windows help system.
If you intend to install IBM Content Search Services to a path that contains
non-English characters, ensure that your version of Windows supports the locale of
the non-English characters. If the native Windows command shell displays the
non-English characters correctly, the locale is supported.
Attention: The IBM Content Search Services temporary directory cannot contain
non-English characters. If you install to a non-English path, change the location of
the temporary directory to a path that contains English characters only. Use the
command-line configuration tool (configTool) to set the tempDirPath parameter.
Configure your X-session manager application to use the fonts for your operating
system. See your X-session manager application administration guide for details
about adding fonts or accessing them on the server. Make sure to add a locale for
the language that is used and also to add the UTF-8 locale. Set the server locale to
the UTF-8 locale.
For information about right-to-left languages, see the Oracle support document
Enabling Outside In Technology for Bidirectional Arabic and Hebrew Text.
Security administrator
The FileNet P8 security administrator installation role includes configuring and
maintaining directory servers.
Extended characters and user names
Note the following considerations for localized FileNet P8 accounts.
Database administrator
The FileNet P8 database administrator installation role includes configuring
database installations and table spaces, and creating database accounts.
Installing Microsoft SQL Server
During installation, the Microsoft SQL Server installer program detects the
Windows regional setting and sets the Microsoft SQL Server language setting
accordingly. Use the regional setting selected by the installation program
throughout the entire Microsoft SQL Server installation.
Installing Oracle server
Create the database using the AL32UTF8 database character set.
Installing the DB2 for Linux, UNIX and Windows server
Use the UTF-8 codeset for the DB2 for Linux, UNIX and Windows database
server.
| Installing the DB2 for z/OS server on page 167
When you install the DB2 for z/OS database server in a non-English
environment, use UTF-8 collation settings by configuring CCSID UNICODE.
Microsoft does not recommend changing the selected regional setting unless you
have to match the regional setting to the collation of another instance of Microsoft
SQL Server or to the Windows regional setting of another computer. Localized
versions of Microsoft SQL Server are available in French, German, Spanish, Italian,
Japanese, Korean, and Simplified and Traditional Chinese.
The collation settings must match the language settings on the system. Searching
for other languages that do not match the database collation setting will result in
invalid search and sort results.
The collation settings must match the language settings on the system. Searching
for other languages that do not match the database collation setting will result in
invalid search and sort results.
Set the regular character set to AL32UTF8. It is not required to set the national
character set (NLS_NCHAR_CHARACTERSET) to a specific value. You can take
the default. The national character set applies to the data types NCHAR /
NVARCHAR2 / NCLOB which the Content Platform Engine does not use.
| The collation settings must match the language settings on the system. Searching
| for other languages that do not match the database collation setting will result in
| invalid search and sort results.
FileNet P8 administrator
The FileNet P8 administrator configures Process Task Manager for Application
Engine and Workplace XT.
Configuring Process Task Manager for Application Engine and Workplace XT
In AIX, HPUX, HPUXi, Linux, Linux on System z, or Solaris environments,
verify that the LC_TIME and LC_MESSAGES environment variables are set to
C before you run Process Task Manager in Application Engine or Workplace
XT. Failure to set these variables can result in an error in a non-English locale.
IBM Case Manager requires language support on the Content Platform Engine
server to support authored language solution templates.
Important: Case Manager Builder displays unreadable characters in Step Editor for
double-byte (east Asian) characters. To resolve the problem, install the correct
language pack on the Case Manager Builder Server.
In IBM FileNet Image Services, navigate to fn_edit > System Attributes > Client
Character Set, enter MS932, and restart the IBM FileNet Image Services service. This
configuration setting ensures that Japanese characters in property values are
synchronized in both directions between IBM FileNet Image Services and Content
Platform Engine.
Rendition Engine
Rendition Engine supports only English and Japanese operating system languages.
You can install and run Rendition Engine on any language version of Windows,
provided that you set the Windows Region/Language configuration to either
English or Japanese.
With one exception, IBM FileNet Rendition Engine supports only the English
versions of authoring applications. The exception is that Rendition Engine supports
the Japanese versions of Microsoft Office, Microsoft Project, and Microsoft Visio.
For more information, see Microsoft Windows operating system help for further
information about adding additional language support.
The following conditions apply to the ports that are used by the FileNet P8
components:
v The port numbers are default values, but can be changed to other unique port
numbers.
v The default port number and communication protocol must be open on the
target server.
v Replies and responses to the requestor are made unless specified otherwise.
v No long-lived connections are established between FileNet P8 components
unless specified for the port. The connection is closed after the initiator opens a
connection with the recipient and the recipient responds.
Content Platform Engine ports on page 172
The Content Platform Engine ports information is presented in multiple tables
that list the port names, port numbers, communication protocols, and
descriptions.
Application Engine and Workplace XT ports on page 176
The Application Engine and Workplace XT servers ports table lists the port
names, port numbers, communication protocols, and description for its use.
Process Simulator ports on page 176
The Process Simulator ports information, which is segmented into multiple
tables, lists the port names, port numbers, communication protocols, and
description for its use.
Content Search Services ports on page 177
The Content Search Services ports information, which is segmented into
multiple tables, lists the port names, port numbers, communication protocols,
and description for its use.
Rendition Engine and Content Platform Engine ports for LIQUENT on page
178
The following tables list the Rendition Engine and Content Platform Engine
ports information for LIQUENT.
Database ports on page 180
The database ports information, which is segmented into multiple tables, lists
the port names, port numbers, communication protocols, and description for its
use.
IBM System Dashboard for Enterprise Content Management ports on page
181
The IBM System Dashboard for Enterprise Content Management ports
information, which is segmented into multiple tables, lists the port names, port
numbers , communication protocols, and description for it use.
Content Services for FileNet Image Services ports on page 182
The following tables list the port numbers used by IBM FileNet Content
Services for FileNet Image Services.
Communication on this port is one-way, from the Content Platform Engine server
to the email server.
Process Task Manager / This port is on the Application Engine server for Process Task Manager to
Component Manager version 1 communicate with the Component Managers.
communications port
Component Manager Event Port The port is on the Application Engine server, configured through the Process Task
Manager. This port number must match the port used for the Component Manager
Event Port on the Application Engine.
Communication on this port is one-way from the Content Platform Engine server
to the Component Manager.
Rules Listener The port is on the Content Platform Engine server.
The port is set for the workflow system. The port number is the internal port
number, which is the field name for this in the Administration Console for Content
Platform Engine. In a cluster configuration, this port needs to be set in
Administration Console for Content Platform Engine and it needs to be opened in
the firewall.
Table 42. Rendition Engine and Content Platform Engine ports for LIQUENT - continued
Reply or
Response to Long lived
Port name requestor? sessions? Load Balancer? Supports SSL?
LIQUENT input port Yes No No No
LIQUENT notify port Yes No No No
LIQUENT event port Yes No No No
LIQUENT admin port Yes No No No
LIQUENT file transfer port Yes No No No
LIQUENT job queue port Yes No No No
Table 43. Rendition Engine and Content Platform Engine ports for LIQUENTcontinued
Port name Notes
LIQUENT input port The port allows for distributed processing of jobs on the Rendition Engine servers
when there are more than one Rendition Engine server. A Rendition Engine server
or Rendition Engine client (Content Platform Engine Publishing server) on which a
job is submitted makes the load balancing decision on where to run the job. If the
job is sent to another Rendition Engine server for execution then it uses the other
Rendition Engine server's input port to do so.
The above port numbers are the default values set by the Rendition Engine
installer for the COM Repository in the LIQUENT Vista domain, which represents
the Rendition Engine server itself. When a Content Platform Engine Publishing
server is configured to point to the Rendition Engine server, one must create a
"Java Repository" in the LIQUENT Vista domain that represents the Content
Platform Engine Publishing server as a Java client to the Rendition Engine server,
and this repository will also have the same default port number values.
The database port number is not specified directly by the Rendition Engine
servers LIQUENT software, but it is specified for the Rendition Engine client in
the Content Platform Engine Publishing server's Rendition Engine Connection
object (for the JDBC connection from the Rendition Engine client module to the
Rendition Engine database server).
Table 48. IBM System Dashboard for Enterprise Content Management portscontinued
Reply or
Response to Long lived
Port name requestor? sessions? Load Balancer? Supports SSL?
Listener (first) Yes Yes No No
Listener (subsequent) Yes Yes No No
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
The client examples cited are presented for illustrative purposes only. Actual
performance results may vary depending on specific configurations and operating
conditions.
The performance data and client examples cited are presented for illustrative
purposes only. Actual performance results may vary depending on specific
configurations and operating conditions.
This information is for planning purposes only. The information herein is subject to
change before the products described become available.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at http://www.ibm.com/legal/copytrade.shtml
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States,
and/or other countries.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Other company, product, and service names may be trademarks or service marks
of others.
Permissions for the use of these publications are granted subject to the following
terms and conditions.
Applicability
http://www.ibm.com/legal/us/en/copytrade.shtml
Personal use
Notices 187
You may reproduce these publications for your personal, noncommercial use
provided that all proprietary notices are preserved. You may not distribute, display
or make derivative work of these publications, or any portion thereof, without the
express consent of IBM.
Commercial use
You may reproduce, distribute and display these publications solely within your
enterprise provided that all proprietary notices are preserved. You may not make
derivative works of these publications, or reproduce, distribute or display these
publications or any portion thereof outside your enterprise, without the express
consent of IBM.
Rights
IBM reserves the right to withdraw the permissions granted herein whenever, in its
discretion, the use of the publications is detrimental to its interest or, as
determined by IBM, the above instructions are not being properly followed.
You may not download, export or re-export this information except in full
compliance with all applicable laws and regulations, including all United States
export laws and regulations.
This Software Offering does not use cookies or other technologies to collect
personally identifiable information.
If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.
For more information about the use of various technologies, including cookies, for
these purposes, See IBMs Privacy Policy at http://www.ibm.com/privacy and
IBMs Online Privacy Statement at http://www.ibm.com/privacy/details the
Notices 189
190 Planning for FileNet P8
Index
Special characters authentication (continued)
Windows Active Directory 49
Content Platform Engine application
server installation group 135
.NET Windows AD LDS 49 Content Platform Engine installation
configuring Windows 33, 139 account 19
Content Platform Engine operating
Index 193
194 Planning for FileNet P8
IBM
GC19-3955-04