FileNet P8

Version 5.2.1

Plan and Prepare Your Environment for

FileNet P8 for installation on Microsoft
Windows with IBM DB2, IBM
WebSphere Application Server, and
IBM Tivoli Directory Server

IBM

GC19-3917-04
FileNet P8
Version 5.2.1

Plan and Prepare Your Environment for

FileNet P8 for installation on Microsoft
Windows with IBM DB2, IBM
WebSphere Application Server, and
IBM Tivoli Directory Server

IBM

GC19-3917-04
 Note
Before using this information and the product it supports, read the information in “Notices” on page 87.

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. . . . . v Configuring Windows for .NET and COM
Contacting IBM . . . . . . . . . . . . . v compatibility clients . . . . . . . . 26
Adding inbound rules to the Windows
Planning and preparing for FileNet P8 2008 firewall . . . . . . . . . . . 26
Configuring the network . . . . . . . . 27
installation . . . . . . . . . . . . . 1 Prerequisites to configuring your network 27
Planning the installation . . . . . . . . . . 1 Synchronizing machine clocks . . . . . 27
FileNet P8 Platform sample architecture . . . . 1 Creating a local or shared directory for the
Installation scenarios. . . . . . . . . . . 2 shared configuration files (Application
Overview of installation types . . . . . . 3 Engine or Workplace XT) . . . . . . . 28
Single server scenario . . . . . . . . . 6 Storage area options for object stores . . . . 28
Standard distributed scenario . . . . . . . 7 Advantages of advanced storage areas . . . 29
Content Platform Engine distributed Replication models for advanced storage areas 30
installation scenario . . . . . . . . . 7 Preparing advanced storage areas . . . . . 32
IBM Content Search Services distributed Preparing file servers for file storage areas . . 32
installation scenario . . . . . . . . . 8 Configuring file servers for file storage
Application Engine distributed installation areas . . . . . . . . . . . . . 33
scenario . . . . . . . . . . . . . 8 Configuring account settings on file servers 34
Multiple domain scenario . . . . . . . . 9 Configuring the remote access protocol on
Definition of installation roles . . . . . . . 11 the client machine . . . . . . . . . 35
Using the installation and upgrade worksheet . . 12 Using IBM Support data collection tools . . . 35
Running the Customize Worksheet macro . . 13 Security administrator installation tasks . . . . 36
Autofiltering and sorting the Worksheet . . . 14 Security planning considerations . . . . . 37
Performing the required installation preparation Configuring directory server. . . . . . . 40
tasks. . . . . . . . . . . . . . . . . 14 Configuring IBM Tivoli Directory Server. . 40
IT administrator installation tasks . . . . . . 15 Creating the application server administrative
Creating Content Platform Engine operating console user (WebSphere). . . . . . . . 40
system accounts . . . . . . . . . . . 16 Creating Content Platform Engine directory
Creating the Content Platform Engine server accounts . . . . . . . . . . . 41
application server installation administrator 17 Creating Content Platform Engine
Creating the Content Platform Engine bootstrap account . . . . . . . . . 41
application server installation group . . . 17 Creating the GCD administrator . . . . 43
Creating Content Platform Engine installer Creating the object store administrator . . 44
account . . . . . . . . . . . . . 18 Creating directory service user (IBM Tivoli
Creating Content Platform Engine Directory Server) . . . . . . . . . 45
operating system user account . . . . . 18 Creating the workflow system
Creating Configuration Manager user . . 19 administrator . . . . . . . . . . . 45
Creating the Content Platform Engine user Creating workflow system groups . . . . 46
account for DB2 for Linux, UNIX and Creating Application Engine or Workplace XT
Windows . . . . . . . . . . . . 20 directory server accounts . . . . . . . . 47
Creating Application Engine or Workplace XT Creating the Application Engine or
accounts . . . . . . . . . . . . . 20 Workplace XT administrator account . . . 47
Creating the Application Engine or Database administrator installation tasks . . . 47
Workplace XT installer account . . . . . 21 Creating Content Platform Engine database
Creating the Application Engine or accounts . . . . . . . . . . . . . 48
Workplace XT deployment account . . . 22 Creating a Content Platform Engine
Preparing for IBM Content Search Services . . 23 database user for DB2 for Linux, UNIX and
Creating IBM Content Search Services Windows . . . . . . . . . . . . 49
accounts . . . . . . . . . . . . 23 Preparing the DB2 for Linux, UNIX and
Choosing a load balancing method for IBM Windows server . . . . . . . . . . . 50
Content Search Services servers. . . . . 24 DB2 for Linux, UNIX and Windows
Choosing a standby index area activation database planning . . . . . . . . . 50
policy for IBM Content Search Services . . 25 Verifying that DB2 for Linux, UNIX and
Configuring Microsoft Windows . . . . . 26 Windows is installed for FileNet P8 . . . 51
Configuring Windows for FileNet P8 Application Server administrator installation
servers . . . . . . . . . . . . . 26 tasks. . . . . . . . . . . . . . . . 55

© Copyright IBM Corp. 2001, 2016 iii

 Creating application server accounts . . . . 57 Appendix A. Preparing non-English
Creating the application server environments for installing FileNet P8 . 69
administrator . . . . . . . . . . . 57 IT administrator . . . . . . . . . . . . . 69
Configuring WebSphere for Content Platform Operating system considerations . . . . . . 70
Engine . . . . . . . . . . . . . . 58 Microsoft Windows . . . . . . . . . . . 70
Creating the WebSphere profile for Content Security administrator . . . . . . . . . . . 71
Platform Engine . . . . . . . . . . 59 Extended characters and user names . . . . . 71
Specifying the WebSphere environment Database administrator . . . . . . . . . . 71
variables . . . . . . . . . . . . 60 Installing the DB2 for Linux, UNIX and Windows
Setting the primary administrative user server . . . . . . . . . . . . . . . 71
name . . . . . . . . . . . . . 62 Application Server administrator . . . . . . . 71
Setting host aliases for deployment on | Configuring character encoding on WebSphere
multiple servers . . . . . . . . . . 62 | Application Server . . . . . . . . . . . 71
Setting permissions for the Configuration FileNet P8 administrator . . . . . . . . . . 72
Manager user. . . . . . . . . . . 62 Limitations on installing in a non-English
Configuring the load-balancer or proxy environment . . . . . . . . . . . . . . 72
server . . . . . . . . . . . . . 62
Preparing for database failover support . . 63
Configuring application servers (high
Appendix B. FileNet P8 ports . . . . . 75
availability environments) . . . . . . . 63 Content Platform Engine ports . . . . . . . . 76
| Configuring WebSphere Application Server for Application Engine and Workplace XT ports . . . 79
| IBM Content Navigator . . . . . . . . 63 Process Simulator ports . . . . . . . . . . 79
Configuring WebSphere Application Server for Content Search Services ports . . . . . . . . 80
Application Engine or Workplace XT . . . . 63 Rendition Engine and Content Platform Engine
Starting or stopping an application server ports for LIQUENT . . . . . . . . . . . . 81
instance . . . . . . . . . . . . . 64 Database ports . . . . . . . . . . . . . 83
Resolving the names of existing data sources 64 IBM System Dashboard for Enterprise Content
Application Engine/Workplace XT in a highly Management ports . . . . . . . . . . . . 84
available environment . . . . . . . . . 65 Content Services for FileNet Image Services ports . 85
Configuring the application server for
Application Engine/Workplace XT in a Notices . . . . . . . . . . . . . . 87
highly available environment . . . . . 65 Trademarks . . . . . . . . . . . . . . 89
Configuring load-balancer or proxy server 65 Privacy policy considerations . . . . . . . . 90
Planning for Workplace/Workplace XT
shared settings . . . . . . . . . . 66 Index . . . . . . . . . . . . . . . 93
Accessing the documentation . . . . . . 67

iv Planning for FileNet P8

ibm.com and related resources
Product support and documentation are available from ibm.com®.

Support and assistance

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.

IBM® Knowledge Center

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/.

© Copyright IBM Corp. 2001, 2016 v

vi Planning for FileNet P8
Planning and preparing for FileNet P8 installation
To prepare to install FileNet P8, you must review the planning information before
you begin. You must also complete the prerequisite tasks assigned to the various
roles.
“Planning the installation”
You must review the installation planning information before your FileNet P8
installation so that you know what kind of deployments are supported,
understand how the tasks in the installation tasks are organized by role, and
know how to use the Installation and Upgrade Worksheet.
“Performing the required installation preparation tasks” on page 14
To efficiently carry out the required installation preparation tasks, you must
assign your staff to carry out the tasks that are organized by administrative
role.

Planning the installation

You must review the installation planning information before your FileNet P8
installation so that you know what kind of deployments are supported, understand
how the tasks in the installation tasks are organized by role, and know how to use
the Installation and Upgrade Worksheet.
“FileNet P8 Platform sample architecture”
You can distribute FileNet P8 Platform components and expansion products
across a variety of machines.
“Installation scenarios” on page 2
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.
“Definition of installation roles” on page 11
The installation tasks and the rows in the Installation and Upgrade Worksheet
are organized by administrative roles. Your organization might have different
roles, and some of the responsibilities of listed roles will vary from those
assigned by default in this documentation.
“Using the installation and upgrade worksheet” on page 12
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.

FileNet P8 Platform sample architecture

You can distribute FileNet P8 Platform components and expansion products across
a variety of machines.

The following graphic shows just one of many possible configurations of a FileNet
P8 Platform installation.

© Copyright IBM Corp. 2001, 2016 1

 Platform Additional
components components
Application server-based

Content Platform IBM FileNet IBM

Engine Collaboration Enterprise IBM FileNet
Services Records Case
Analyzer
Workplace XT
IBM CMIS IBM
for FileNet IBM FileNet
Datacap Case
Content Manager IBM Application
Engine Monitor
Case
Manager (Workplace)
Documentation IBM FileNet
server Content Image
(if installed locally) Navigator Services

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

To understand this graphic, keep in mind the following details:

v Use this graphic for general informational purposes only. Consult documentation
and the system requirements for full information about collocation, prerequisites,
and supported platforms.
v If you are installing IBM Content Navigator, you can find its planning and
installation information at Planning, installing, and configuring IBM Content
Navigator.
v Installing documentation locally is not required if you link to the online version
of the documentation on www.ibm.com.
v For information about installing components on a single server, see “Single
server scenario” on page 6.
v The graphic does not show components in a high availability or clustered
configuration.
v Not all additional components are shown. Check with your service
representative for availability of other products.
Related concepts:
“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.

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.

2 Planning for FileNet P8

 “Multiple domain scenario” on page 9
In a multiple domain installation scenario, a master domain maintains a set of
self-contained tenant domains. Each tenant domain appears to its clients as a
separate independent domain.

Overview of installation types

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.

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.

Planning and preparing for FileNet P8 installation 3

 v Decide whether to keep your proof of concept system in place without
major modifications, at least during the early stages, in order to have a
working example of the original installation as a reference.
v Decide whether you intend to use the proof of concept system as a
development or test system.
Follow either the single server scenario or the standard distributed
installation scenario, including high availability elements if appropriate, to
install your proof of concept system.
Development system
A development system is used by software developers to design and
implement code for custom applications.
A development system should be only large enough to accommodate your
development team and to contain the components required by the system
under design. In some cases, more than one development system might be
required, for example, if developers are working on different subprojects
that could conflict or require unique capacity. The development system
might not need to be as carefully controlled as a test system. For example,
you could install products or debugging tools on a development system, or
make environmental changes that are not recommended for production or
intended for final documentation. This flexibility might not be advisable
for a test system that is meant to exercise the production configuration.
| It is acceptable to use the same authentication realm for the proof of
| concept system as for the development and test systems, though you might
| want some special accounts to use for just testing purposes. The benefit of
| using the same authentication realm is that these systems can use the same
| directory server (LDAP) accounts and authentication realms, which makes
| the subsequent development and test systems easier to configure.
Before you install a development system, make the following decisions:
v Decide whether to use an existing proof of concept system as the basis
for the development system.
v Decide whether to install one of the bundled FileNet P8 client
applications even if your customized solution will not use these
products. For example, you might want to compare your customized
application with the FileNet P8 clients.
v Decide which APIs are needed to code your custom application, and
then include the components that are required to implement those APIs.
v Decide whether you want to collocate FileNet P8 components on the
same server. Collocation is not a best practice in a production
environment but can be a good option for development systems,
especially if server resources are scarce and underlying system
performance is not a major concern. See the P8 Related Requirements
document for information on collocation.
v Decide what kind of content storage areas you want to configure. For
your development system, you might want to use a database storage
area, which is easier to configure than a file storage area that is based in
a file system.
| Unless your development system requirements can be met by using the
| single server scenario, follow the standard distributed installation scenario,
| including high availability elements if appropriate, to install your
| development system.

4 Planning for FileNet P8

 Test system
A test system is used to evaluate the quality of the applications during
development and to assess all subsequent changes to the code after the
product is released. A test system is also used to evaluate product
upgrades and fix packs before applying them to other systems, such as
production systems that are already rolled out across your enterprise.
An important usage of a test system is to make sure that you have the
correct versions of each software component. The owners of the test system
must therefore be careful to control all changes to it. Configure your test
system exactly as described in the installation documentation and by the
hardware and software requirements. Control, maintain, and track the
elements of your test system as carefully as possible so that testing
integrity can be assured. Typically, a test system is backed up so that it can
be returned to a known state without reinstalling all the software
components. In many cases, you can use the same authentication realm for
the test and development systems, unless you have security restrictions
within your organization.
| Before you install a test system, make the following decisions to be able to
| validate the functionality, usability and performance of the customer's
| applications.
| v Decide how large your test system must be to provide an adequate
| testing environment for activities such as code assessment, installation
| and upgrade testing, functional testing, and performance monitoring.
| v If your production system is expected to be a high availability
| environment, you might decide not to configure high availability on test
| systems but rather to use the preproduction system for testing under
| high availability conditions before installing the software into
| production.
| v Decide whether you want to collocate FileNet P8 components on the
| same server. Collocation is not a best practice in a production
| environment but can be a good option for test systems, especially if
| server resources are scarce and you must increase or maintain system
| performance.
Unless your test system's requirements can be met using the single server
scenario, follow the standard distributed installation scenario, including
high availability elements if appropriate, to install your test system.
Preproduction system
A preproduction system is used to try out changes before making those
changes on a production environment.
It should be as similar to the production system as you can reasonably
implement. Do not assume that a version change or some new code that
runs acceptably on the test system will run acceptably on a production
system; it must be tested first on a system that closely approximates the
production configuration. The greater the difference between the
preproduction system and the production environment, the greater your
risk when implementing new software. For example, if the production
system has a cluster of 20 servers, the preproduction system would need a
cluster of at least two servers, and ideally more. Final performance testing
is often done on the preproduction systems, so the closer it is to the
production system, the more reliable your performance test results will be.
As a best practice, all changes that are successfully tested on a test system
should first be implemented on the preproduction system before being
added to the production system.

Planning and preparing for FileNet P8 installation 5

 If a preproduction system includes IBM Content Search Services, it must
have access to at least some of the documents to be searched. This access
might be accomplished by providing a complete synchronized replica of
the data, or only a subset of the data.
Before you install a preproduction system, make the following decisions:
v Decide whether you need to install fixed content devices in your
preproduction system. Because of the difficulties implementing a fixed
content device or other very large storage devices, you might decide to
implement such devices only on the production system.
v Decide how large a data set you need to approximate the production
system stored content and workflow information for preproduction
functional testing.
Follow the standard distributed installation scenario, including high
availability elements if appropriate, to install your preproduction system.
Disaster recovery system
Because it is designed to provide business continuity after a natural or
human-induced disaster, a disaster recovery system is often geographically
remote from production. Such a system is not designed to be instantly
enabled to replace a production system that is no longer available, because
this is generally accomplished by implementing high availability and
failover features into the production environment itself.
Production system
A production system is the full-featured, fully tested live system that has
access to all content and workflows, on the full suite of platform hardware
and software, configured to access your entire set of users and groups, that
supports your application.
Follow the standard distributed installation scenario, including high
availability elements if appropriate, to install your production system.

Single server scenario

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.

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.

For details on collocating some FileNet P8 components, see Related Requirements,

available on the IBM FileNet P8 system requirements web page.

6 Planning for FileNet P8

Standard distributed 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.

In a standard distributed environment, you install FileNet P8 on a number of

servers, according to the way you plan to use your system. This configuration
model can vary from a simple system with one stand-alone component per server
to a complex system with multiple instances, virtual servers, and managed
deployments.

Most FileNet P8 platform components work with middleware applications such as

web application servers, databases, and directory service applications. This guide
provides additional considerations and preparation tasks by role for the
administrators of these middleware applications. For details on which types and
versions of these applications work together in a FileNet P8 platform environment,
see IBM FileNet P8 system requirements

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.

Creating multiple instances of FileNet P8 platform components

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 8
You can install Application Engine as a stand-alone application. You can also
install multiple instances of Application Engine.

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.

Planning and preparing for FileNet P8 installation 7

 Stand-alone deployment

| When you deploy Content Platform Engine as a stand-alone application, you

| configure a single application server. You must configure your Content Platform
| Engine instances and deploy those Content Platform Engine instances on a single
| server, by using a single directory for the component files.

Managed deployment

When you deploy Content Platform Engine in a WebSphere Application Server

managed environment, you can install and configure Content Platform Engine on
any managed node. Then, use the application server administration console to
deploy the bootstrapped Content Platform Engine EAR file to the servers on each
managed node or to a cluster.

Non-managed deployment

| When you deploy Content Platform Engine in a WebSphere Application Server or

| WebLogic Server non-managed environment, you install and configure Content
| Platform Engine on any Content Platform Engine server in the environment. After
| you configure the bootstrapped Content Platform Engine EAR file on this first
| server, you are directed to copy the bootstrapped EAR file to each of the other
| servers. Then, deploy the bootstrapped EAR file on all of the servers.

IBM Content Search Services distributed installation scenario:

| 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
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.

Application Engine distributed installation scenario:

You can install Application Engine as a stand-alone application. You can also install
multiple instances of Application Engine.

8 Planning for FileNet P8

Stand-alone deployment

When you deploy Application Engine as a stand-alone application, you configure a

single application server. You must configure your Application Engine instances
and deploy those Application Engine instances on a single server, using a single
directory for the configuration files.

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.

JBoss Application Server has no managed deployment capability.

Non-managed deployment

When you deploy Application Engine in a WebSphere Application Server or

WebLogic Server non-managed environment, or a JBoss Application Server
environment, you install, configure, and deploy Application Engine on every
server in the environment.

Multiple domain scenario

In a multiple domain installation scenario, a master domain maintains a set of
self-contained tenant domains. Each tenant domain appears to its clients as a
separate independent domain.

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.

The physical infrastructure and storage resources in this environment are

controlled by the master domain, which allows the service provider to configure
and manage the multi-tenant infrastructure. Examples include physical devices,
servers, and sites. Tenant domains expose a read-only copy of these objects. Other
tenant domain objects are controlled by the tenant. Examples include the directory

Planning and preparing for FileNet P8 installation 9

 configuration, add-ons, object stores, and isolated regions. Some of these objects are
initially set to the value in the master, but can then be modified by the tenant.
Tenant domain users cannot access or modify anything in the master domain or in
other tenant domains.

A master domain has a property that, when it is set, distinguishes it from a

stand-alone domain and allows it to have tenant domains.

| Important: Migration paths to or from a multi-domain configuration are not

| supported. You cannot migrate existing stand-alone domains into a multi-domain
| configuration or convert a multi-domain configuration into a stand-alone domain.

To access the master domain in a multi-domain configuration, client applications

would specify the same type of URL that would be used to access a normal
stand-alone domain. To access a tenant domain, a ?tenantId=<tenant_identifier>
parameter is appended to the server URL. This convention applies to both Content
Engine and Process Engine client applications.

Applying a patch or an upgrade to Content Platform Engine server software affects

all tenants simultaneously. In other words, you cannot patch or upgrade just a
single tenant.

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.

In cloud-based scenarios, the cloud provider defines the authentication scheme,

which typically is some type of federated identity management. The cloud
provider sets the AuthenticationRealmName property of each tenant domain;
Content Platform Engine then ensures that only users who have been authenticated
against the tenant's WebSphere realm can access resources within that tenant
domain. Each tenant could be configured to replicate its users and groups into a
cloud-based directory for use by the tenant domain for authorization purposes.

It is recommended to use email address as the UserNameAttribute for the

directory configuration in the master domain. Doing so avoids a conflict in which a
user in a tenant domain might have the same user name as a user in the master
domain; neither user would be able to log in.

In a multiple domain scenario, Content Platform Engine must use WebSphere

Application Server. Multiple domains are supported only for new installations and
not for upgrades. In addition, support for a multiple domain configuration is
currently limited to custom applications. At time of writing, IBM client applications
that use Content Platform Engine as their foundation (such as IBM Content
Navigator and IBM Case Manager) do not support a multiple domain
configuration. For custom applications, support for a multiple domain
configuration is limited to applications that use the Content Engine and Process
Engine Java APIs. Custom applications that were written using some other
interface (such as IBM CMIS or Process Engine REST Service) are not supported in
a multiple domain configuration.

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

10 Planning for FileNet P8

 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.

Definition of installation roles

The installation tasks and the rows in the Installation and Upgrade Worksheet are
organized by administrative roles. Your organization might have different roles,
and some of the responsibilities of listed roles will vary from those assigned by
default in this documentation.

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.

The role of IA is usually filled by an IBM FileNet Certified Professional (FCP).

Information technology administrator

v Responsible for the networking and operating systems settings required by
FileNet P8.
v Responsible for performing certain security configurations.
v Abbreviated as ITA. Responsible for providing the information in the rows in
the Installation and Upgrade Worksheet with a value of ITA in the Role column.

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.

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.

Application server administrator

v Responsible for providing the application servers required by FileNet P8.
v Responsible for application server administrative accounts.

Planning and preparing for FileNet P8 installation 11

 v Abbreviated as ASA. Responsible for providing the information in the rows in
the Installation and Upgrade Worksheet with a value of ASA 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”
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 36
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 47
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 55
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.

Using the installation and upgrade worksheet

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.

Administrators who are preparing the environment for installation or upgrade of

FileNet P8 components must use the worksheet during their preparation tasks to
record the appropriate values and provide them to the Installation Administrator
who runs the installation or upgrade programs.

Some of the features of the Installation and Upgrade Worksheet are:

v Instructions: describes the worksheet and includes a button that runs the
Customize Worksheet macro.
v The two highlighted columns, Property or Parameter and ENTER YOUR
VALUE HERE, provide the simplest view of the requirement. The others add
identifying information and help you sort and filter the rows usefully.

12 Planning for FileNet P8

v The Role column assigns each row to an administrator and uses the following
acronyms:
– IA: Installation Administrator
– ITA: Information Technology Administrator
– ASA: Application Server Administrator
– DBA: Database Administrator
– SA: Security Administrator
– P8A: FileNet P8 Administrator
v Property definitions are contained in the column titled Description.
v Some rows, though not all, contain a hyperlink in the IC help link column.
Click this hyperlink to run a query against the online documentation, which
opens with the Search Results pane showing the topics that contain the words in
the query phrase. Browse the search results until you have enough information
to be able to enter a value in the Worksheet row.
“Running the Customize Worksheet macro”
The Customize Worksheet macro lets you extract only those rows that describe
your environment.
“Autofiltering and sorting the Worksheet” on page 14
There are several ways to organize the Worksheet to make finding properties
and entering values easier.

Running the Customize Worksheet macro

The Customize Worksheet macro lets you extract only those rows that describe
your environment.

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.

To run the Customize Worksheet macro:

1. Open the Installation and Upgrade Worksheet (p8_worksheet.xls) and click the
Instructions worksheet (also called a tab).
2. Scroll down until you see the button representing the Customize Worksheet
macro. Click the button.
3. Select the components and options that describe the environment you are
preparing for FileNet P8.
v Installation or Upgrade
v FileNet P8 Components
v Application Server type
v Operating system
v Database type
v Directory Server type
v Number of object stores (adds new sets of rows for creating additional data
sources)
v Name of customized sheet
4. Click OK. The macro copies the rows that fulfill your selection criteria into a
new worksheet with the name you entered. Enter the values for your
environment into this new worksheet.

Planning and preparing for FileNet P8 installation 13

 5. Click the name of the new worksheet at the bottom of the Excel window. Add
your preparation values into this new worksheet.
6. Notice that the new worksheet has buttons at the top titled Show Installer
View and Show Full View, depending on its state. The Show Installer View
displays only those columns that you need while running installation or
configuration programs.

Autofiltering and sorting the Worksheet

There are several ways to organize the Worksheet to make finding properties and
entering values easier.

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.

Performing the required installation preparation tasks

To efficiently carry out the required installation preparation tasks, you must assign
your staff to carry out the tasks that are organized by administrative 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 12 topic for details.

To prepare the IBM FileNet P8 environment, perform the tasks assigned to the
following roles.
“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.

14 Planning for FileNet P8

 “Security administrator installation tasks” on page 36
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 47
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 55
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.

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.
v Review all rows assigned to the IT administrator (ITA) in the “Using the
installation and upgrade worksheet” on page 12. 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 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 If you are installing in a non-English environment, review Preparing
non-English environments for installing FileNet P8 before you begin your
preparation tasks.
“Creating Content Platform Engine operating system accounts” on page 16
You must create several operating system accounts.
“Creating Application Engine or Workplace XT accounts” on page 20
Several operating system accounts are needed to install and deploy Application
Engine or Workplace XT.
“Preparing for IBM Content Search Services” on page 23
If you are installing IBM Content Search Services, you must do some things to
get ready.
“Configuring Microsoft Windows” on page 26
Perform certain operating system procedures on all Windows-based servers
where you will install FileNet P8.
“Configuring the network” on page 27
You must perform certain configurations on the network before installing
FileNet P8 platform.
“Storage area options for object stores” on page 28
An object store has several options for storage areas. You need to determine the
appropriate types of storage areas for your requirements.

Planning and preparing for FileNet P8 installation 15

 “Advantages of advanced storage areas” on page 29
Advanced storage areas offer several advantages over other types of storage
areas.
“Replication models for advanced storage areas” on page 30
If you use advanced storage areas for your object stores, you need to choose a
replication model that best suits your storage requirements.
“Preparing advanced storage areas” on page 32
Before you create an advanced storage area, you need to complete the following
planning-related actions:
“Preparing file servers for file storage areas” on page 32
To prepare for file storage, you must configure file servers for file storage areas,
configure a remote access protocol, and prepare the file servers where file
storage areas are to be located.
“Using IBM Support data collection tools” on page 35
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.

Creating Content Platform Engine operating system accounts

You must create several operating system accounts.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

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” on page 17
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 17
An operating system group account to which several Content Platform Engine
accounts must belong.
“Creating Content Platform Engine installer account” on page 18
An operating system account you use to install Content Platform Engine.
“Creating Content Platform Engine operating system user account” on page 18
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 19
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 20
An operating system account on the database server that Content Platform
Engine uses to access DB2 for Linux, UNIX and Windows.

16 Planning for FileNet P8

Creating the Content Platform Engine application server installation
administrator:

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
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.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of
cpe_appserver_install_user.

Creating the Content Platform Engine application server installation group:

An operating system group account to which several Content Platform Engine

accounts must belong.
1. Create the following operating system account:
Content Platform Engine application server installation group
Unique identifier
cpe_appserver_install_group
Description
An operating system group account. You will be instructed to
grant certain permissions to this group during Content Platform
Engine installation and configuration.
The user accounts in cpe_appserver_install_group will perform the
following tasks:
v Give operating system privileges to the directories used for
Content Platform Engine installation and for the application
server's instance/domain/profile.

Planning and preparing for FileNet P8 installation 17

 v Configure and deploy the Content Platform Engine EAR files
which require access to the application server's
instance/domain/profile directories.
v Have permissions on devices/drives to read and write that
are designated for external Content Platform Engine file
storage.
Minimum required permissions
Use your local machine's administrative tools to add the
following accounts to this group:
v cpe_appserver_install_user
v cpe_install_user
v config_mgr_user

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of
cpe_appserver_install_group.

Creating Content Platform Engine installer account:

An operating system account you use to install Content Platform Engine.

1. If installing Content Platform Engine on Windows, create the following
operating system account:
Content Platform Engine installer account (Windows)
Unique identifier
cpe_install_user
Description
An operating system account used to run the Content Platform
Engine installation program.
Minimum required permissions
Use Windows administrative tools to add cpe_install_user to the
Local Administrators group and to the
cpe_appserver_install_group.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of cpe_install_user.

Creating Content Platform Engine operating system user account:

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
Description
An operating system account you must log on as to create and
configure the shared root directory of a file storage area or
content cache area.
The operating system user who logs on to the Content Platform
Engine server and starts the local application server process is

18 Planning for FileNet P8

 the account that must be used to secure the folders and files in
a file storage area. From a practical standpoint, the account that
is used to install the application server should be the same
account that is used to start the application server process. As
an administrator, you will always log in using the same
cpe_os_user account to secure the folders and files in the file
system that Content Platform Engine will use for a file storage
area.
Minimum required permissions
Windows
For Windows-based Content Platform Engine and file
storage areas, cpe_os_user must reside in the same
Windows domain or in trusted Windows domains as
the servers that host Content Platform Engine and the
file storage area.
For Windows-based file storage areas and using
WebSphere: you must set the WebSphere service to
logon as the cpe_os_user.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of cpe_os_user.

Creating Configuration Manager user:

An operating system account you use to run Configuration Manager.

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.

Planning and preparing for FileNet P8 installation 19

 2. Record this value in your customized Installation and Upgrade Worksheet.
To find this property, search the worksheet for instances of config_mgr_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:

Remember: The user name length is restricted to no more than eight

characters.
Content Platform Engine database user (DB2 for Linux, UNIX and Windows)
Unique identifier
cpe_db_user
Description
This user account is granted database permissions for Content
Platform Engine access to the DB2 database. Separate accounts
can be used for each object store, but are not required.
Additional database-specific permissions must be added by the
DBA.
Minimum required permissions
Access to the DB2 for Linux, UNIX and Windows GCD
database and each object store database.
See the DBA section for the database permissions required by
this account.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of cpe_db_user.

Creating Application Engine or Workplace XT accounts

Several operating system accounts are needed to install and deploy Application
Engine or Workplace XT.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

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.

20 Planning for FileNet P8

 “Creating the Application Engine or Workplace XT installer account”
An operating system account that you use to run the installation program for
Application Engine or Workplace XT.
“Creating the Application Engine or Workplace XT deployment account” on
page 22

Creating the Application Engine or Workplace XT installer account:

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
Installation paths (BPMClient_directory)
Grant ae_install_user read and write permission to the
BPMClient_directory.
Grant wpxt_install_user read and write permission to the
BPMClient_directory.
Default BPMClient directory (Windows):
c:\Program Files\IBM\FileNet\BPMClient

Planning and preparing for FileNet P8 installation 21

 Application Engine or Workplace XT installer account (AIX, HPUX, Linux,
Solaris)
Unique identifier
ae_install_user or wpxt_install_user
Description
The operating account you will use to log on to a AIX, HPUX,
Linux, or Solaris machine and launch the Application Engine or
Workplace XT installation program.
Minimum required 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: /opt/IBM/FileNet/CommonFiles.
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
Installation paths (BPMClient_directory)
Grant ae_install_user read and write permission to the
BPMClient_directory.
Grant wpxt_install_user read and write permission to the
BPMClient_directory.
Default BPMClient directory (AIX, HPUX, Linux,
Solaris):
/opt/IBM/FileNet/BPMClient

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of ae_install_user or
wpxt_install_user.

Creating the Application Engine or Workplace XT deployment account:

1. Create the following operating system account:
Application Engine or Workplace XT deployment account
Unique identifier
ae_deploy_user or wpxt_deploy_user
Description
This account will have permissions to deploy an application. It
can be the same as the Application Engine or Workplace XT
installer account.

22 Planning for FileNet P8

 Minimum required permissions
The deployment account (ae_deploy_user or wpxt_deploy_user)
must be granted read/write/execute permission to these
directories and files:
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

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of ae_deploy_user or
wpxt_deploy_user.

Preparing for IBM Content Search Services

If you are installing IBM Content Search Services, you must do some things to get
ready.

Important: It is a best practice for Content Platform Engine storage areas and IBM
Content Search Services full-text indexes to not share the same root directory, disk,
or volume. Otherwise, disk I/O contention will cause degraded performance.
“Creating IBM Content Search Services accounts”
If you are installing IBM Content Search Services, you must create new IBM
Content Search Services accounts.
“Choosing a load balancing method for IBM Content Search Services servers”
on page 24
To optimize indexing and search performance, you need to decide on a method
to balance the load among the IBM Content Search Services servers.
“Choosing a standby index area activation policy for IBM Content Search
Services” on page 25
To maintain a uniform distribution of input/output among the disks used for
searching and indexing, you need to keep a steady number of open index areas.

Creating IBM Content Search Services accounts:

If you are installing IBM Content Search Services, you must create new IBM
Content Search Services accounts.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

If you see a reference to an account that you do not understand, search the
documentation for that reference.

Planning and preparing for FileNet P8 installation 23

 “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”
An operating system account you use to install IBM Content Search Services.

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.
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
run the IBM Content Search Services startup and shutdown
commands. By default, the css_install_user can also run these
commands.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of css_os_user.

Creating the IBM Content Search Services installer account:

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.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of css_install_user.

Choosing a load balancing method for IBM Content Search Services servers:

To optimize indexing and search performance, you need to decide on a method to

balance the load among the IBM Content Search Services servers.

24 Planning for FileNet P8

By default Content Platform Engine uses a built-in load-balancing algorithm to
assign IBM Content Search Services servers to indexes according to the indexing
workload of the servers. The assignments are based on the number of index
servers and the resources that are available to each server. If you want to override
this built-in algorithm, you can use Administration Console for Content Platform
Engine to create affinity groups and manually dedicate IBM Content Search
Services servers to specific index areas.

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
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:

To maintain a uniform distribution of input/output among the disks used for

searching and indexing, you need to keep a steady number of open index areas.

To maintain a constant number of index areas in open state, Content Platform

Engine needs to open a standby index area as soon as any other index area
becomes full. If no standby index areas are available, then Content Platform Engine
logs a warning.

To implement this policy, the Content Platform Engine administrator needs to

create some standby index areas in advance and assign a priority to each one.
Content Platform Engine uses the priority to determine which standby index area
to open when another index area becomes full.

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.

Planning and preparing for FileNet P8 installation 25

 Configuring Microsoft Windows
Perform certain operating system procedures on all Windows-based servers where
you will install FileNet P8.
“Configuring Windows for FileNet P8 servers”
To configure Windows for FileNet P8 servers, ensure the minimum disk and
temporary space and determine the port requirements.
“Configuring Windows for .NET and COM compatibility clients”
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).
“Adding inbound rules to the Windows 2008 firewall”
Configure inbound rules in the Windows 2008 firewall to allow the following
ports access.

Configuring Windows for FileNet P8 servers:

To configure Windows for FileNet P8 servers, ensure the minimum disk and
temporary space and determine the port requirements.

To configure Windows for FileNet P8 servers:

v Ensure minimum required disk space and temporary space for installation. See
the IBM FileNet P8 system requirements web page.
v 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. Also see the FileNet P8 ports section of the
Planning and preparing for IBM FileNet P8 documentation.
v If you intend to deploy Content Platform Engine on a Windows Server 2008 host
that is configured with Simplified Chinese, the host must have an English name.

Configuring Windows for .NET and COM compatibility clients:

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).

To configure Windows for .NET and COM compatibility clients:

1. If you have client programs that use Windows Communication Foundation
(WCF) to access Content Platform Engine, ensure that .NET 3.x is installed.
WCF is embedded with .NET 3.x or later and requires an SSL secured network
connection to Content Platform Engine.
2. Backward compatibility is provided for client programs that use Web Services
Enhancements (WSE) to access Content Platform Engine. These clients require
the installation of .NET 2.x and WSE 3.0.

Adding inbound rules to the Windows 2008 firewall:

Configure inbound rules in the Windows 2008 firewall to allow the following ports
access.

Open all of the ports that are appropriate in your configuration.

Port Protocol Used for

32771 TCP RMI

26 Planning for FileNet P8

 Port Protocol Used for
32775 TCP This is the primary IBM System Dashboard for
Enterprise Content Management listener port.
Internal port number HTTP In a cluster configuration, set it to a non-zero
value in Administration Console for Content
Platform Engine and use that port number
here to open it in the Windows 2008 firewall.

Configuring the network

You must perform certain configurations on the network before installing FileNet
P8 platform.
“Prerequisites to configuring your network”
A small number of tasks are required to ensure proper network
communications before you install FileNet P8 platform. Perform the
prerequisite tasks in any order.
“Synchronizing machine clocks”
FileNet P8 processes require that you synchronize the clocks on all of the
machines that are running FileNet P8 servers and FileNet P8 clients.
“Creating a local or shared directory for the shared configuration files
(Application Engine or Workplace XT)” on page 28
You can create a local or shared directory for the shared configuration files in
highly available environments.

Prerequisites to configuring your network:

A small number of tasks are required to ensure proper network communications

before you install FileNet P8 platform. Perform the prerequisite tasks in any order.
v Ensure TCP/IP settings. Verify the TCP/IP settings on the UNIX and Windows
servers and IBM Administration Console for Content Platform Engine clients
that are configured for FileNet P8 enable the servers and clients to communicate
with one another.
v Ensure availability of required port numbers. Several port numbers are required
by the various FileNet P8 components.

Synchronizing machine clocks:

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.

Planning and preparing for FileNet P8 installation 27

 Creating a local or shared directory for the shared configuration files
(Application Engine or Workplace XT):

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.

Storage area options for object stores

An object store has several options for storage areas. You need to determine the
appropriate types of storage areas for your requirements.

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
storage area and other types of storage areas. And, like other storage areas,
advanced storage areas can be assigned to storage policies.
file storage area
A file storage area stores content in a file system. A file storage area is
usually not on the machine where Content Platform Engine is installed. A
file storage area cannot reside on a write-once-read-many (WORM) device.
fixed storage area
A fixed storage area resides on a large-capacity, (possibly) write-once, fixed
content device. A fixed storage area uses a file storage area directory
structure as a temporary staging area before migrating files to permanent
storage on the external device. Multiple fixed storage areas can share the
same fixed content device, or a fixed storage area can have its own fixed
content device.
database storage area
A database storage area stores content as binary large objects (BLOBs) in a
database.
Related concepts:

28 Planning for FileNet P8

 Storage area types

Advantages of advanced storage areas

Advanced storage areas offer several advantages over other types of storage areas.

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
Content flows directly from a client application as a single stream to the
storage device; the content is never written to temporary storage. Only a
single instance of Content Platform Engine is involved in the upload.
Support for replica repair
If a replica contains damaged (missing or incorrect) content, Content
Platform Engine can detect the damage and re-replicate the correct content
to the replica.

The following table summarizes the differences between advanced storage areas
and other storage areas in terms of their support of core features:
Table 1. 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

Planning and preparing for FileNet P8 installation 29

Table 1. Core feature support by advanced storage areas and other types of storage areas (continued)
Supported by advanced storage Supported by other types of storage
Core feature areas? areas?
Fixed content storage no yes
Replication yes no
Direct content upload yes no
Replica repair yes no

Replication models for advanced storage areas

If you use advanced storage areas for your object stores, you need to choose a
replication model that best suits your storage requirements.

Advanced storage areas are designed to be flexible enough to support a wide

variety of replication models, including the following common modes: traditional
high availability/disaster recovery, remote site, and grid storage. Configuring
replicas can sometimes be complex. By using Administration Console for Content
Platform Engine, an administrator can configure common and complex custom
replication models.
Traditional high availability/disaster recovery
The traditional high availability/disaster recovery replication model
consists of an active (main) data center, a passive bunker data center, and a
passive disaster recovery data center. The bunker data center and the
disaster recovery data center provide database redundancy for content.
They are passive in the sense that they are activated only during a failover.
The database and content are synchronously replicated from the active
data center to the bunker data center, and asynchronously replicated from
the active data center to the disaster recovery data center. Bunker data
centers and disaster recovery data centers differ only in how they receive
database and content (synchronously or asynchronously). If the main data
center fails, the bunker data center is started and takes on the role of the
main data center. Replication to the disaster recovery data center is
synchronous until the main data center is restored.
The following figure illustrates normal operation for this replication model:
Main data center Bunker data center Disaster recovery data center

Content Platform
Engine

Object Object
Object Storage store Storage store Storage
store device database device database device
database replica replica replica replica replica

Synchronous Content Platform Engine content replication Asynchronous

Database system replication

The following figure illustrates a failover:

30 Planning for FileNet P8

 Main data center Bunker data center Disaster recovery data center

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 Synchronous

content replication writes

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:

Content Content Content Content

Platform Platform Platform Platform
Engine Engine Engine Engine
1 2 3A 4A

Storage Storage Storage Storage

device device device device
replica replica replica replica

The following figure illustrates content being ingested in Content Platform

Engine 3:

Content Content Content Content

Platform Platform Platform Platform
Engine Engine Engine Engine
1 2 3A 4A

Storage Storage Storage Storage

device device device device
replica replica replica replica

Planning and preparing for FileNet P8 installation 31

 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

Content Platform Content Platform Content Platform

Engine Engine Engine

Cloud object storage Cloud object storage Cloud object storage

replica 1 replica 2 replica 3

Preparing advanced storage areas

Before you create an advanced storage area, you need to complete the following
planning-related actions:
v Create a storage plan that is based on your replication requirements. See
“Replication models for advanced storage areas” on page 30 for an overview of
supported replication models.
v Consider whether you require site-setting overrides for replication.
v Decide on key configuration settings for an advanced storage area. For storing
content, do you need compression, duplication suppression, or encryption? For
deleting content, which method of removal satisfies your security requirements?
v Consider your need to assign the advanced storage area to a storage policy. Do
you want to distribute content between storage areas, where the system
evaluates configured criteria to determine which area to store the content?

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.

Preparing file servers for file storage areas

To prepare for file storage, you must configure file servers for file storage areas,
configure a remote access protocol, and prepare the file servers where file storage
areas are to be located.
“Configuring file servers for file storage areas” on page 33
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.
“Configuring account settings on file servers” on page 34
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.

32 Planning for FileNet P8

 “Configuring the remote access protocol on the client machine” on page 35
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.

Configuring file servers for file storage areas:

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.

To configure file servers for file storage areas:

1. Create or designate an existing top-level directory on the file server where file
storage areas will reside.
2. Secure the directory so only Content Platform Engine Server can access it.
3. Expose the directory via the remote file access protocol that applies to the
operating system of the file server.
4. (Best practice) Under the top-level directory, create a subdirectory for each file
storage area you intend to create. If you decide to put a file storage area
directly within a top-level directory, rather than in a subdirectory, and you later
decide to create an additional file storage area on this file server, you will have
to create another top-level directory for it, because you will not be able to use
the previously created top-level directory.
“Remote file access protocols”
The supported remote file access protocols between Content 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.

Remote file access protocols:

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.

Planning and preparing for FileNet P8 installation 33

 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.

Configuring account settings on file servers:

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 2. 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 Windows-based file server for a Windows client using CIFS”

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” on page 35
To configure Windows Services for NFS, use the procedures in Microsoft
documentation.

Configuring a Windows-based file server for a Windows client using CIFS:

You must configure security permissions on the directories where file storage areas
are going to be located.

To configure a Windows-based file server:

1. Log on to the Windows file server as cpe_os_user.
2. Create (or designate) a directory fsa1 where content will be stored. For
example: C:\filenet\file_stores\fsa1
3. Navigate in Windows Explorer to fsa1, right-click the file icon, and choose
Properties.
4. In the Security tab, click Advanced.
5. In the Advanced Security Settings dialog box:
a. Grant Full Control to cpe_os_user and cpe_os_group, and select This Folder,
subfolders, and files from the Apply to drop-down list.
b. Remove all other users and groups in the Permission entries table.
c. Click OK.

34 Planning for FileNet P8

6. In the Sharing tab, perform the following tasks:
a. Click Share this folder and click Permissions.
b. Grant Full control to cpe_os_user and cpe_os_group.
c. Remove all other users and groups in the Permission entries table.
d. Click OK.

Configuring a Windows-based file server for an AIX, HPUX, HPUXi, Linux, Linux on
System z, or Solaris client using NFS:

To configure Windows Services for NFS, use the procedures in Microsoft

documentation.

To configure Windows Services for NFS:

1. Do all the steps in “Configuring a Windows-based file server for a Windows
client using CIFS” on page 34.
2. Use the procedures in Microsoft documentation to configure Windows Services
for NFS to expose fsa1.

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.

Configuring the remote access protocol on the client machine:

When configuring the remote file access protocol (NFS or CIFS), the client machine
is the one where Content 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.

To configure remote access protocol:

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.

Using IBM Support data collection tools

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.

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.

Planning and preparing for FileNet P8 installation 35

 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.
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.

Security administrator installation tasks

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.

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.

36 Planning for FileNet P8

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 40
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 40
An LDAP account to which you have granted the WebSphere Application
Server administrative role.
“Creating Content Platform Engine directory server accounts” on page 41
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 47
Directory server accounts are needed to administer Application Engine or
Workplace XT.

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.
Authentication and authorization are separate processes.
Authentication (logon security) is separate from authorization (object and
process security). You must configure your JAAS login on the Content
Platform Engine application server so that any user or group that can
successfully log on to FileNet P8 resources can also be authorized to work
within FileNet P8 interfaces, using the Content Platform Engine directory
service provider connection.
Configuration Manager captures configuration information to create your
application server authentication provider; or you can use an
authentication provider that already exists on the application server.
Immediately following the initial Content Platform Engine deployment,
you will use IBM Administration Console for Content Platform Engine to
configure the Content Platform Engine authorization by creating a
Directory Configuration.
Logins are done through JAAS.
FileNet P8 uses Java Authentication and Authorization Service (JAAS) for
authentication, which is a process that occurs between a Java EE client
application, a Java EE application server, and one or more JAAS login
modules. This process does not involve any FileNet P8 code.
FileNet P8 platform uses JAAS for authentication only, not for
authorization on stored objects. Also, it does not support Java Security
Manager.
Determine single sign-on (SSO) requirements.
Content Platform Engine ability to use JAAS-based authentication means
that if a single sign-on (SSO) provider writes a JAAS LoginModule for a
supported application server, then clients of FileNet P8 applications hosted

Planning and preparing for FileNet P8 installation 37

 in that application server can use that SSO solution. See Single Sign-On
Solutions for IBM FileNet P8 at ibm.com/redbooks for configuration
information.
Determine Kerberos applicability.
You can use Kerberos for SSO authentication between .NET applications or
other products that use it, provided you use Windows Active Directory as
the directory server.
Decide how many authentication realms you require.
At least one authentication realm is required, which you create during an
initial installation by running the Configuration Manager Configure LDAP
task. After making sure that the first realm is working properly, you can
configure additional realms, depending on your security model and
requirements.
Make sure that you have a directory service provider in place.
Directory services are provided by third-party directory servers. Refer to
the IBM FileNet P8 system requirements for the list of supported products.
Starting with version 5.2, Content Platform Engine supports heterogeneous
directory server configurations when running in an IBM virtual member
manager environment. (To use virtual member manager, Content Platform
Engine requires WebSphere Application Server version 7.0 or above.) For
all other directory environments, only homogenous LDAP server
combinations are supported, meaning that a single FileNet P8 domain can
be configured to use only one of the supported directory servers.
Understand the users and groups required for FileNet P8.
All general administrative users and groups needing access to FileNet
P8-based applications must reside in one of the supported directory
servers. The planning and preparation tasks provide instructions for
creating the administrative accounts required for installation and initial
configuration.
You can configure Content Platform Engine to use email or UPN for login
You can assign the directory server's email attribute or, for Active
Directory, the userPrincipalName (UPN) to be the user short name that is
used for login. Instructions in the IBM FileNet P8 Platform Installation and
Upgrade Guide provide a link to a procedure that explains how to do this.
(WebSphere only) Choose Stand-alone or Federated repository type.
There is an option in the Configuration Manager Configure LDAP task to
select whether the WebSphere Application Server repository type is
Stand-alone LDAP registry or Federated repositories. To have
Configuration Manager use your repository type setting, select the
Configuration Manager option Set as current active user registry.
If you choose Stand-alone LDAP registry
Configuration Manager changes the administrative console user
login to the account you enter as the Administrative console user
name. This account must reside in the Stand-alone LDAP registry
location. The existing administrative console user login, if any,
becomes invalid.
To have Configuration Manager replace an existing Stand-alone
LDAP registry configuration, you must enable the Configuration
Manager option Overwrite existing repository.
If you choose Federated repositories
By choosing the Federated repositories option in Configuration

38 Planning for FileNet P8

 Manager, you are adding a new LDAP realm to an existing
Federated LDAP repository. The administrative console user name
that you provide must be a unique user across all federated realms.
Avoid overlapping realm definitions
In the Configuration Manager task Configure LDAP, if you set the
WebSphere Application Server LDAP repository type option to
Federated repositories, do not enter repositories with overlapping
suffixes as they are not supported. For example, the following two
repositories with overlapping Base entry distinguished names are
not supported:
v dc=ibm,dc=com
v dc=filenet,dc=ibm,dc=com
This restriction especially applies to Active Directory parent and
child domains, since by definition parent/child domains in AD
have overlapping suffixes.
The repositories in the next example are supported, because they
are sibling repositories and do not overlap:
v dc=tivoli,dc=ibm,dc=com
v dc=filenet,dc=ibm,dc=com
Administrative security must be enabled
Configuration Manager does not change the state of WebSphere
administrative security. If it was on before running Configuration
Manager, then it stays on; if it was off before, then it stays off.
WebSphere Application Server security domains
Content Platform Engine supports WebSphere Application Server
security domains, a feature that is introduced in WebSphere
Application Server 7.0. Security domains allow administrators to
define multiple security configurations for use in a single cell or
application server. By default, all administrative and user
applications in WebSphere Application Server use the same global
security configuration. However, with security domains, you can
create additional security configurations if you want to specify
different security attributes for some or all of your user
applications. For example, you can define different settings (such
as a different user registry) for user applications than for
administrative applications. You can also define separate security
configurations for user applications that are deployed to different
servers and clusters.
To use security domains, you deploy Content Platform Engine in
the normal way, and then use your WebSphere Application Server
administrative console to create a security domain and to assign
Content Platform Engine to it. Content Platform Engine code then
automatically honors this domain setting. All Content Platform
Engine servers and clients must be in one of the available
WebSphere security domains. Also, the Content Platform Engine
bootstrap account (cpe_bootstrap_admin) must be present in both the
WebSphere Application Server global security configuration and
the security domain that applies to the Content Platform Engine; or
you can skip the bootstrap login at the server startup by setting the
JVM argument
-Dcom.filenet.engine.init.BGThreadsAsBootstrapId=false.

Planning and preparing for FileNet P8 installation 39

 Configuring directory server
The Security administrator must perform certain configurations on the directory
server that will provide the authentication repository for your FileNet P8 system.
“Configuring IBM Tivoli Directory Server”
You can configure IBM Tivoli Directory Server to be the directory service for
FileNet P8.

Configuring IBM Tivoli Directory Server:

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.

Creating the application server administrative console user

(WebSphere)
An LDAP account to which you have granted the WebSphere Application Server
administrative role.
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
you have granted the WebSphere Application Server
administrative role so that it can log in to the WebSphere
administrative console.
v If your WebSphere repository type is Stand-alone LDAP
registry, when you run the Configuration Manager Configure
LDAP task, enter the credentials of a valid LDAP user
account to be the appserver_console_user for the entry labeled
Administrative console user name. Configuration Manager
grants this account WebSphere administrative console
administrative rights. Alternatively, you can enter an LDAP
account that you have already configured as a console
administrator.
v If your WebSphere Application Server LDAP repository type
is Federated repositories, you can use the same user account
defined as your appserver_admin. However, if you specify a
user for the Administrative console user name that is
different from appserver_admin, it must be unique across all
federated realms including the WebSphere Application Server
local file-based repository.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of
appserver_console_user.

40 Planning for FileNet P8

Creating Content Platform Engine directory server accounts
Content Platform Engine requires several directory server accounts that must be
provided during installation.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

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:

“Creating Content Platform Engine bootstrap account”
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.
“Creating the GCD administrator” on page 43
A directory service account that has Full Control access to the Content Platform
Engine domain object.
“Creating the object store administrator” on page 44
A directory service account that has Full Control access to a Content Platform
Engine object store.
“Creating directory service user (IBM Tivoli Directory Server)” on page 45
A directory service account that Content Platform Engine uses to connect to the
directory server.
“Creating the workflow system administrator” on page 45
A directory server user account that is used by workflow to create isolated
regions.
“Creating workflow system groups” on page 46
Directory server groups whose members can manage workflows.

Creating Content Platform Engine bootstrap account:

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

Planning and preparing for FileNet P8 installation 41

 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
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.

Restriction: If you are deploying Content Platform Engine on

an application server with federated user repositories and with
multiple realms in your FileNet P8 domain, be sure that no two
realms contain the same short name for this user; otherwise,
this user will not be able to authenticate.

42 Planning for FileNet P8

 Minimum required permissions
The account must be a directory server account that resides in
the realm that has been configured for Content Platform Engine
authentication.
If you are using WebSphere Application Server security
domains, see “Security planning considerations” for additional
requirements for cpe_bootstrap_admin.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of cpe_bootstrap_admin.
Related tasks:
“Creating the GCD administrator”
A directory service account that has Full Control access to the Content Platform
Engine domain object.

Creating the GCD administrator:

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.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of gcd_admin.

Planning and preparing for FileNet P8 installation 43

 Creating the object store administrator:

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.

Tip: Keeping the number of accounts assigned as object store

administrators or object store users as small as possible will
improve performance and simplify administration. The best
way to do this is to use group accounts instead of large
numbers of individual users. Groups can have as many
members as you want and can contain other groups.

44 Planning for FileNet P8

 Minimum required permissions
Use IBM Administration Console for Content Platform Engine
to grant an object_store_admin or object_store_admin_group Full
Control access to one or more object stores.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of object_store_admin
and object_store_admin_group.

Creating directory service user (IBM Tivoli Directory Server):

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:
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.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of cpe_service_user.

Creating the workflow system administrator:

A directory server user account that is used by workflow to create isolated regions.

Planning and preparing for FileNet P8 installation 45

 The variable name for this account has been changed from earlier releases. It was
formerly referred to as the pe_region_admin, but the permissions are the same.
1. Create the following account:
Workflow system administrator
Unique identifier
workflow_system_admin
Description
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_admin_group. The
workflow_system_admin therefore has permissions equivalent to
the gcd_admin but should be used only for workflow purposes.
Content Platform Engine permissions can be granted by a
gcd_admin who uses IBM Administration Console for Content
Platform Engine to add the workflow_system_admin to the ACL
of the FileNet P8 domain and grant it Full Control.
Permissions are granted by using your directory server tools to
add the workflow_system_admin to the workflow_admin_group. The
workflow_admin_group permissions are configured while running
IBM Administration Console for Content Platform Engine.
Minimum required permissions
Full Control access rights on the FileNet P8 domain.
Membership in the workflow_admin_group.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of
workflow_system_admin.

Creating workflow system groups:

Directory server groups whose members can manage workflows.

1. Create the following directory server groups:
Workflow system administration group
Unique identifier
workflow_system_admin_group
Description
Members of this group are granted privileges for administering
the workflow system by the Administration Console for
Content Platform Engine.
Workflow system configuration group
Unique identifier
workflow_system_config_group
Description
Members of this group are granted privileges for configuring
the workflow system by the Administration Console for
Content Platform Engine.
2. Provide these group names while configuring database connection points in
Administration Console for Content Platform Engine.

46 Planning for FileNet P8

 3. Record this value in your customized Installation and Upgrade Worksheet.
To find these properties, search the worksheet for instances of
workflow_system_admin_group and workflow_system_config_group.

Creating Application Engine or Workplace XT directory server

accounts
Directory server accounts are needed to administer Application Engine or
Workplace XT.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

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”

Creating the Application Engine or Workplace XT administrator account:

1. Create the following directory server account:
Application Engine or Workplace XT administrator account
Unique identifier
ae_admin_user or wpxt_admin_user
Description
This account serves in the role of Application Engine or
Workplace XT administrator. You will specify this account as a
member of the Application Engine or Workplace XT
administrator role when you set bootstrap preferences. The
account must have a password.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of ae_admin_user or
wpxt_admin_user.

Database administrator installation tasks

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.

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.)
Planning and preparing for FileNet P8 installation 47
 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 are installing in a non-English environment, review the information and

procedures in Appendix A, “Preparing non-English environments for installing
FileNet P8,” on page 69 before you begin your preparation tasks.

If you are installing Content Platform Engine in a highly available environment, it

is important that you follow the high availability steps within the Content Platform
Engine installation tasks. If Content Platform Engine is not available due to a
system failure, the other components are affected as well.

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 the DB2 for Linux, UNIX and Windows server” on page 50
Plan and prepare your IBM DB2 for Linux, UNIX and Windows server for
FileNet P8 installation.

Creating Content Platform Engine database accounts

Use your database tools to create new or designate existing database accounts for
Content Platform Engine.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

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. 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” on page 49
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.

48 Planning for FileNet P8

 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:

Remember: The user name length is restricted to no more than eight

characters.
Content Platform Engine database user (DB2 for Linux, UNIX and Windows)
Unique identifier
cpe_db_user
Description
The IT administrator (ITA) creates this operating system
account, after which the database administrator (DBA) grants it
additional database permissions. Separate accounts can be used
for each object store, but are not required.
Do not create databases with the RESTRICTIVE option.
| Minimum required permissions
| Use your database tools to grant the following database
| permissions to this user account:
| v GRANT CONNECT ON DATABASE TO cpe_db_user
| v GRANT CREATETAB ON DATABASE TO cpe_db_user
| v GRANT USE OF TABLESPACE UserTablespace TO cpe_db_user
| v GRANT USE OF TABLESPACE UserTemporaryTablespace TO
| cpe_db_user
| v GRANT SELECT on SYSIBM.SYSVERSIONS TO cpe_db_user
| v GRANT SELECT on SYSCAT.DATATYPES TO cpe_db_user
| v GRANT SELECT on SYSCAT.INDEXES TO cpe_db_user
| v GRANT SELECT on SYSIBM.SYSDUMMY1 TO cpe_db_user
| v GRANT USAGE on workload
| SYSDEFAULTUSERWORKLOAD TO cpe_db_user
| v GRANT IMPLICIT_SCHEMA on DATABASE TO cpe_db_user
| For added security in a shared database environment, you can
| remove the Connect privilege from the Public group.
| Grant the following permissions if you want to use dedicated
| table spaces for Data, Index, and LOB.
| v GRANT USE OF TABLESPACE UserDataTablespace TO
| cpe_db_user
| v GRANT USE OF TABLESPACE UserIndexTablespace TO
| cpe_db_user
| v GRANT USE OF TABLESPACE UserLOBTablespace TO
| cpe_db_user
| v GRANT USE OF TABLESPACE UserTemporaryTablespace TO
| cpe_db_user

Planning and preparing for FileNet P8 installation 49

 2. Record this value in your customized Installation and Upgrade Worksheet.
To find this property, search the worksheet for instances of cpe_db_user.

Preparing the DB2 for Linux, UNIX and Windows server

Plan and prepare your IBM DB2 for Linux, UNIX and Windows server for FileNet
P8 installation.
“DB2 for Linux, UNIX and Windows database planning”
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.
“Verifying that DB2 for Linux, UNIX and Windows is installed for FileNet P8”
on page 51
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.

DB2 for Linux, UNIX and Windows database planning:

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.

In a shared configuration, multiple FileNet P8 components can store their data in a

single database. Most components allow for data to be collocated. However, the
best practice is to keep some in dedicated databases:
v The global configuration database: it is best practice to not share this database.
v Object stores and their workflow system data although those part of a single
application family can be collocated given the factors listed below. If you
configure object stores in separate databases, you have more flexibility and
control with security access, backup scheduling and execution, updates, and
scheduled outages.
v Rendition Engine data
v IBM Content Navigator configuration data: sharing the IBM Content Navigator
database with the global configuration database is not supported.

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).

50 Planning for FileNet P8

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.

Plan to use SERVER authentication.

Set the DB2 codeset to UTF-8.

Set the page size to 32 KB.

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.

Verifying that DB2 for Linux, UNIX and Windows is installed for FileNet P8:

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 52
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 53
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.

Planning and preparing for FileNet P8 installation 51

 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:
| db2set DB2_WORKLOAD=FILENET_CM
| Set CUR_COMMIT=ON
5. 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 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.

52 Planning for FileNet P8

 Minimum Page Size
Content Platform Engine table space Minimum Size (MB) (KB)
GCD_ts 256 32 (required)

Configure as LARGE type and

automatic storage.

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.
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

| 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:

Planning and preparing for FileNet P8 installation 53

 Table 3. 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.

Record this value

in your
customized
Installation and
Upgrade
Worksheet. To
find this property,
use the Autofilter
drop-down arrow
in Column F,
Property or
Parameter (in
user interface), to
select Data table
space name.
index_ts 512 32 (required) This is the
default name of
(optional) the optional
default index
Configure as LARGE type and table space used
automatic storage. by Content
Platform Engine.
If you do not
create an index
table space, the
data table space
will be used for
indexes.

Record this value

in your
customized
Installation and
Upgrade
Worksheet. To
find this property,
use the Autofilter
drop-down arrow
in Column F,
Property or
Parameter (in
user interface), to
select Index table
space name.

54 Planning for FileNet P8

 Table 3. Recommended table space names, types, and minimum sizes (continued)
Minimum Size Minimum Page
table spaces (MB) Size (KB) Description
lob_ts 512 32 (required) This is the
default name of
(optional ) the optional
default LOB table
Configure as LARGE type and space used by
automatic storage. Content Platform
Engine. If you do
not create a LOB
table space, the
data table space
will be used for
LOB data.

Record this value

in your
customized
Installation and
Upgrade
Worksheet. To
find this property,
use the Autofilter
drop-down arrow
in Column F,
Property or
Parameter (in
user interface), to
select LOB table
space name.
user temporary ts 80 32 (required) This is the
default user
temporary table
space, required
for Content
Platform Engine
use.
system temporary ts 80 32 (required) This is the
default system
temporary table
space, required
for Content
Platform Engine
use.

Application Server administrator installation tasks

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.

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.

Planning and preparing for FileNet P8 installation 55

 If a user application is required for your system and you have not built or
customized one using the FileNet P8 API toolkits, you can install one of the
following general user interfaces:
v Workplace XT
v Application Engine / Workplace
v IBM Content Navigator

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.

Content Platform Engine is a resource-intensive enterprise application. Running

Content Platform Engine and other Java EE applications on the same machine is
possible but not a best practice. Other Java EE applications will compete with
Content Platform Engine for the same CPU, memory, and disk I/O resources, and
increase the complexity of the installation and the risk of the deployment, because
configurations will not match what has been qualified by FileNet P8 Engineering.

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.

If you are installing in a non-English environment, review the considerations and

procedures in Appendix A, “Preparing non-English environments for installing
FileNet P8,” on page 69 before you begin your preparation tasks.

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 57
Create new or designate existing application server accounts.
“Configuring WebSphere for Content Platform Engine” on page 58
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.

56 Planning for FileNet P8

 “Configuring application servers (high availability environments)” on page 63
You must configure application servers for high availability.
“Configuring WebSphere Application Server for IBM Content Navigator” on
page 63
You must install WebSphere Application Server on the machine where you are
going to install and deploy IBM Content Navigator.
“Configuring WebSphere Application Server for Application Engine or
Workplace XT” on page 63
You must install WebSphere Application Server on the machine where you are
going to install and deploy Application Engine or Workplace XT.
“Starting or stopping an application server instance” on page 64
You need to be able to start or stop an application server instance when
working with Content Platform Engine.
“Resolving the names of existing data sources” on page 64
You must create data sources for the global configuration database and your
object store databases. Configuration Manager does not create a new data
source with the same name as that of an existing data source. If you want to
reuse a data source name, you must resolve data source naming conflicts before
using Configuration Manager to configure the JDBC data sources.
“Application Engine/Workplace XT in a highly available environment” on page
65
You can install and configure Application Engine/Workplace XT in a highly
available FileNet P8 environment to provide access to the FileNet P8 content on
the corresponding Application Engine/Workplace XT Web application.
“Accessing the documentation” on page 67
The base documentation URL identifies the server where the IBM FileNet P8
documentation is located. You must decide whether you want to access the
online documentation in IBM Knowledge Center or a locally installed
information center.

Creating application server accounts

Create new or designate existing application server accounts.

Accounts are referred to in documentation in the following ways:

v By a display name; for example, Database User Name. An account's display
name is how the FileNet P8 user interface, such as a setup program or dialog
box, refers to the account. Many accounts have both a display name and a
variable.
v By a variable designator; for example cpe_db_user, using lower-cased italics and
underscores. The variable is intended to show that you must designate your
own account to act in the role described by the variable. The variable is the
unique identifier for a particular account.

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.

Creating the application server administrator:

An application server administrator used while configuring Content Platform

Engine.
1. Create the following application server account:

Planning and preparing for FileNet P8 installation 57

 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
installation process. Afterwards, you can reduce
the account to a lesser role, such as
Configurator.
WebSphere administrative security is not enabled
If you decide not to enable WebSphere
administrative security during profile creation,
then no special credentials are required to log
in to the WebSphere administrative console.
You can enter any string into the Configuration
Manager field labeled Application server
administrator user name. However, remember
that to run Content Platform Engine,
WebSphere administrative security must be
enabled. When you do enable it and the
WebSphere administrative console requests an
account to use as the administrative user, enter
the appserver_admin.

2. Record this value in your customized Installation and Upgrade Worksheet.

To find this property, search the worksheet for instances of appserver_admin.

Configuring WebSphere for Content Platform Engine

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.

Content Platform Engine is an enterprise application running on a Java application

server and should be made highly available in a high availability environment. In
this configuration, an administrative server manages a number of application
server instances. Applications and configuration changes are implemented by using
an administrative server/interface and sent to each cluster node. In this type of

58 Planning for FileNet P8

configuration the application server software provides the components to build
and deploy the highly available enterprise application.

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”
You must create an IBM WebSphere Application Server profile for Content
Platform Engine if you do not already have a profile.
2. “Specifying the WebSphere environment variables” on page 60
You must specify the IBM WebSphere Application Server environment variables
so that Content Platform Engine can access its databases.
3. “Setting the primary administrative user name” on page 62
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.
4. “Setting host aliases for deployment on multiple servers” on page 62
If you are deploying Content Platform Engine to multiple IBM WebSphere
Application Server servers on the same WebSphere node, you must define the
host alias and port numbers.
5. “Setting permissions for the Configuration Manager user” on page 62
Configuration Manager must be run by an operating system account that has
been granted certain directory permissions.
6. “Configuring the load-balancer or proxy server” on page 62
You can configure the load-balancer or proxy server to manage user requests
over multiple application servers.
7. “Preparing for database failover support” on page 63
You need to compare the default parameter values for database failover and
determine whether to retain them.

Creating the WebSphere profile for Content Platform Engine:

You must create an IBM WebSphere Application Server profile for Content
Platform Engine if you do not already have a profile.

To create the WebSphere profile for Content Platform Engine:

1. Run the command script at one of the following (default) locations to create a
new profile.

Option Description
Windows C:\Program Files\IBM\WebSphere\AppServer\
bin\manageprofiles.bat

2.

Planning and preparing for FileNet P8 installation 59

 Record application server values in your customized Installation and Upgrade
Worksheet. To find these properties, use the Autofilter drop-down arrow in
Column E, Installation or Configuration Program, to select CM: Create New
Installation Profile. Then use the Autofilter drop-down arrow in Column D,
ISV Component Vendor, to select “WebSphere”.
3. Grant write permission to the group cpe_appserver_install_group (the user who
runs Configuration Manager belongs to this group) on the following files in the
logs directory of the WebSphere profile for Content Platform Engine:
v wsadmin.traceout
v wsadmin.valout
You can find these files in one of the following locations:

Option Description
Windows C:\Program Files\IBM\WebSphere\AppServer\
profiles\profile_name\logs

where profile_name is the name of the WebSphere profile (for example,

AppServer01).

Specifying the WebSphere environment variables:

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.

To specify the WebSphere environment variables:

1. Install JDBC drivers on each WebSphere Application Server node where you
will deploy Content Platform Engine.
a. Obtain the JDBC drivers for your database type.
DB2 Access the IBM website and find the version of the Redistributable
DB2 JDBC Driver that matches the version of the JDK on the system
where WebSphere Application Server is installed.
b. Extract and copy the JDBC driver file to the following suggested location:
Windows
C:\jars
Do not copy the file to ...WebSphere\AppServer\lib\ext.
2. Start the WebSphere Application Server administrative console and log on to
your Content Platform Engine profile as appserver_console_user, the
Administrator Console User and complete the following substeps to configure
the Content Platform Engine nodes or cluster (if applicable).
a. Navigate to Environment > WebSphere Variables.
b. Select Cell scope from the All scopes list.
c. Set the value of the variable to the JDBC driver path that you specified
when you installed the JDBC drivers on the IBM WebSphere Application
Server machine. (If the variable does not exist, create it and then set its
value.)

60 Planning for FileNet P8

 d. Select Node scope from the All scopes list. In a cluster configuration, select
Node scope for all the nodes in the Content Platform Engine cluster.
e. In the table of substitution variables, click the item name in the Name
column that corresponds to the JDBC environment variable for your
database type in the Database environment variables table below.
Table 4. Database environment variables
Database JDBC Environment Variable
DB2 (JDBC 4.0)
DB2_JCC_DRIVER_PATH

f. Set the value of the name_JDBC_DRIVER_PATH item to the JDBC driver

path you specified (/opt/jars or C:\jars).
g. Optional: Select Server scope from the All scopes list. This step is not
required unless you defined the JDBC_DRIVER_PATH variable at the server
scope level.
h. In the table of substitution variables, click the item name in the Name
column that corresponds to the JDBC environment variable for your
database type in the Database environment variables table.
i. Set the value of the name_JDBC_DRIVER_PATH item to the JDBC driver
path you specified (/opt/jars or C:\jars).
j. Save your changes to the master configuration.
3. Navigate to Servers > Application servers > server1 > Java and Process
Management > Process Definition > Java Virtual Machine, and set the initial
and maximum heap sizes, where server1 is the name of the server where you
will deploy Content Platform Engine.
a. Set the values for the initial and maximum heap sizes:
Table 5. Values for initial and maximum heap size
Parameter Value (in MB)
Initial Heap Size At least 512
Maximum Heap Size 1024 or a size consistent with available RAM
on the machine where WebSphere
Application Server is installed

b. Set the following JVM parameters:

v -Duser.language=en
v -Duser.region=US
v -Duser.country=US
c. Save your changes to the master configuration.
4. Optional: Increase the maximum transaction timeout to prevent administrative
processes from failing:
a. Navigate to the screen containing the Maximum transaction timeout
parameter:
v Click Servers > Server Types > WebSphere application servers > server1
> [Container Settings] Container Services > Transaction Service.
b. Click the Configuration tab, and set the Maximum transaction timeout
parameter value to at least 600 (seconds), and increase the Total transaction
lifetime timeout as well.

Planning and preparing for FileNet P8 installation 61

 Important: If the timeout value is not large enough, some administrative
processes (such as adding an expansion product) might fail.
c. Click Apply and then click Save.
5. Repeat this procedure as needed for any object store that uses a different
database type.

Setting the primary administrative user name:

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.

Setting host aliases for deployment on multiple servers:

If you are deploying Content Platform Engine to multiple IBM WebSphere

Application Server servers on the same WebSphere node, you must define the host
alias and port numbers.

To set the host alias:

1. Log in to the WebSphere administrative console.
2. Navigate to Environment > Virtual Hosts > default host > Host Aliases.
3. If you are using SSL, add an alias for the SSL port number, such as port 9081.
4. Add an alias for the non-SSL port number, such as port 9444.
5. Click Apply.

Setting permissions for the Configuration Manager user:

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
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.

Configuring the load-balancer or proxy server:

You can configure the load-balancer or proxy server to manage user requests over
multiple application servers.

Load-balancers and proxy-servers are typically used to direct users to different

instances throughout a highly available application server configuration. When one
server goes down the system automatically redirects the user to another running
server instance.

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.

62 Planning for FileNet P8

 Session affinity is required for Application Engine and Workplace XT only.

Preparing for database failover support:

You need to compare the default parameter values for database failover and
determine whether to retain them.

If you enable it to do so, Configuration Manager automatically assigns default

values to the database failover parameter values when it runs the tasks to
configure JDBC data sources for the global configuration database and object
stores.

The following table shows the default values that Configuration Manager assigns
to the database failover parameters.
Table 6. 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.

Configuring application servers (high availability environments)

You must configure application servers for high availability.

Configure the application server on each node with the following modification:
v WebSphere Application Server:
Follow the instructions for configuring WebSphere Application Server for
Content Platform Engine, but set the JDBC parameters for the nodes by using
the administrative console, not the individual servers.

| Configuring WebSphere Application Server for IBM Content

| Navigator
| You must install WebSphere Application Server on the machine where you are
| going to install and deploy IBM Content Navigator.

| Review the information that is provided in Planning for your web application
| server to prepare for the IBM WebSphere Application Server configuration.

| For instructions on configuring WebSphere Application Server for IBM Content

| Navigator, see the topics in Preparing WebSphere Application Server for IBM
| Content Navigator components.

Configuring WebSphere Application Server for Application

Engine or Workplace XT
You must install WebSphere Application Server on the machine where you are
going to install and deploy Application Engine or Workplace XT.

Application Engine or Workplace XT can be collocated with Content Platform

Engine as long as the server is appropriately sized. However, each instance of the

Planning and preparing for FileNet P8 installation 63

 Application Engine or Workplace XT and each instance of the Content Platform
Engine must run in its own JVM. For assistance in sizing your system, access the
IBM FileNet P8 Platform support site.

To configure WebSphere Application Server:

1. Verify that the application server is set to use JSESSIONID as the default cookie
name. To avoid forcing end users to log in individually to applets such as
Process Designer, Search Designer, and Process Simulator, configure the
application server to use JSESSIONID as cookie name, and not use
application-unique cookie names. Using JSESSIONID is typically the default
setting for the supported application servers. Both Application Engine and
Workplace XT use cookie names to pass session information between
Application Engine or Workplace XT and the client browser.
2. Determine the Initial and Maximum Heap Size. Refer to your application server
vendor's recommendation for Initial and Maximum heap size values. You will
use this information when you configure WebSphere Application Server after
you install Application Engine or Workplace XT.
3. When WebSphere is running as a service and a UNC path is specified in
web.xml for configuration, upload, and download directories, the account that is
specified to run the WebSphere service must have permissions to the share of
the UNC path.

Starting or stopping an application server instance

You need to be able to start or stop an application server instance when working
with Content Platform Engine.

To start or stop an application server instance:

Depending on your application server type, run one of the following commands to
start or stop an application server instance:
Table 7. 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

In a high availability environment, when instructed to start or stop an application

server instance, start or stop the nodes unless otherwise specified.

Resolving the names of existing data sources

You must create data sources for the global configuration database and your object
store databases. Configuration Manager does not create a new data source with the
same name as that of an existing data source. If you want to reuse a data source
name, you must resolve data source naming conflicts before using Configuration
Manager to configure the JDBC data sources.

Complete this procedure only if you already created data source names by using
your application server administration tools, and you want to use Configuration
Manager to create data sources with the same names.

To resolve the names of existing data sources:

1. Use your application server administration tools to determine if the data source
names that you selected already exist.

64 Planning for FileNet P8

2. If you have a duplicate data source name that you want to use, manually
delete the existing data source from your application server. See your
application server documentation for more information.

Application Engine/Workplace XT in a highly available

environment
You can install and configure Application Engine/Workplace XT in a highly
available FileNet P8 environment to provide access to the FileNet P8 content on
the corresponding Application Engine/Workplace XT Web application.

Complete these additional Application Server Administrator planning and

preparation tasks for Application Engine/Workplace XT in a highly available
environment.
“Configuring the application server for Application Engine/Workplace XT in a
highly available environment”
You can create clusters of supported application servers.
“Configuring load-balancer or proxy server”
Before installing and configuring Application Engine or Workplace XT in a
highly available environment, verify that your load balancer or proxy server
has been set up correctly.
“Planning for Workplace/Workplace XT shared settings” on page 66
You can store Workplace/Workplace XT settings in a shared configuration
directory for high availability environments. This directory can reside on a
shared device as needed.

Configuring the application server for Application Engine/Workplace XT in a

highly available environment:

You can create clusters of supported application servers.

Application Engine/Workplace XT is an enterprise application running on a Java

application server and should be made highly available by using either of the
following configurations:

Application Server clusters

v (WebSphere, WebLogic) Managed Application Server Clusters
An administrative server manages a number of application server instances.
Applications and configuration changes are implemented by using an
administrative server/interface and sent to each cluster node.
In this type of configuration the application server software provides the
components to build and deploy the highly available enterprise application.

Farm of independent Application Server instances.

A number of separate server instances run independently behind a load-balancer

or proxy device. No central administration server is used. You must install and
deploy on each farm node.

Configuring load-balancer or proxy server:

Before installing and configuring Application Engine or Workplace XT in a highly

available environment, verify that your load balancer or proxy server has been set
up correctly.

Planning and preparing for FileNet P8 installation 65

 v A load balancing or proxy device will typically direct users to different instances
throughout the group of highly available servers. When one server goes down a
user is automatically directed to an already running instance.
v The load-balancing device can be a hardware or software implementation of a
proxy or load-balancer.
See the application server software's hardware and software support
requirements to determine the supported load-balancing or proxy device
supported for you configuration.
v Application Engine and Workplace XT do not support directory security when
using IIS as a proxy in front of WebSphere Application Server.

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.

Tip: Do not specifying a single Application Engine/Workplace XT server. This will

introduce a single point of failure in the environment.
If you are using load-balancer or proxy device in your configuration you must use
the load-balancer or proxy device to log on to Workplace or Workplace XT for the
first time. Doing this ensures that the Base URL setting, which must be set to the
load-balancer or proxy URL, is correctly set.
If the application is deployed to a farm of application servers, and a load-balancer
is configured for this farm, then a URL could be:
Application Engine: http://loadbalancer URL:loadbalancer port/Workplace
Workplace XT: http://loadbalancer URL:loadbalancer port/WorkplaceXT Use
this URL when completing the installation steps.

Planning for Workplace/Workplace XT shared settings:

You can store Workplace/Workplace XT settings in a shared configuration

directory for high availability environments. This directory can reside on a shared
device as needed.
v If you deploy your Workplace/Workplace XT Web application as a Windows
service on WebSphere, do not use mapped drives to reference shared
configuration folders. Instead, use a UNC share. Note that UNC shares cannot
be Windows administrative shares such as \\host\c$.
v If the share is mountable the mount must be online when Workplace/Workplace
XT is started and accessed.
v If the shared configuration directory is not accessible an error page is returned
when a user tries to access the Workplace/Workplace XT sign-in page.
v Aside from the shared configuration directory no other Application
Engine/Workplace XT software has to reside on shared storage.
v Overwriting of configuration files on subsequent installations.
– If you are performing an installation by using a shared configuration
directory be aware that all installations of Application Engine/Workplace XT
will replace any files that exist in the shared configuration directory.
– If an installation has been completed and settings such as the bootstrap
information have already been set then any subsequent installations by using
the same shared configuration directory will result in the files being
overwritten, losing any settings that have been made.

66 Planning for FileNet P8

 To preserve the settings in the shared configuration directory you should back
up the files in the shared configuration directory and restore them when you
have completed the installation.

Remember: This is not an issue for configurations where all Application

Engine/Workplace XT installations are performed at the same time, but for
cases where the installer must be run again (to add a node to the
configuration for example).

Accessing the documentation

The base documentation URL identifies the server where the IBM FileNet P8
documentation is located. You must decide whether you want to access the online
documentation in IBM Knowledge Center or a locally installed information center.

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 8. 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/

Planning and preparing for FileNet P8 installation 67

 Option Description
Locally installed information center http://server-name:port/application-
name/topic/
server-name
The name of the server where the IBM
FileNet P8 local information center will
be installed.
port
The optional port number.
application-name
The name of the deployed IBM FileNet
P8 documentation application. The
application name is typically p8docs.

For a server-name of myserver, a port of

8080, and an application-name of p8docs, the
base documentation URL is
http://myserver:8080/p8docs/topic/.

2.

Record the base documentation URL in your customized Installation and

Upgrade Worksheet for each instance of that property for each component that
requires it. To find this property, search the worksheet for instances of
Documentation server URL or Documentation URL in Column F, Property or
Parameter (in user interface).

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/.

68 Planning for FileNet P8

Appendix A. Preparing non-English environments for
installing FileNet P8
To run FileNet P8 components in a non-English environment, certain conditions
must be met. Review the following considerations and tasks, organized by
administrator role, if you plan to run FileNet P8 in a non-English environment.

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 71
The FileNet P8 security administrator installation role includes configuring and
maintaining directory servers.
“Database administrator” on page 71
The FileNet P8 database administrator installation role includes configuring
database installations and table spaces, and creating database accounts.
“Application Server administrator” on page 71
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 72
The FileNet P8 administrator configures Process Task Manager for Application
Engine and Workplace XT.
“Limitations on installing in a non-English environment” on page 72
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 70
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 70
Use the localized Microsoft Windows version when available. If the localized
version is not available, use the English version with the appropriate regional
setting.

© Copyright IBM Corp. 2001, 2016 69

 Operating system considerations
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.

Application Engine or Workplace XT

Application Engine and Workplace XT can be installed:

v On any localized version of Windows or in any region on the English version of
Windows

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.

Content Platform Engine

Content Platform Engine can be installed:

v On any localized version of Windows or in any region on the English version of
Windows

If you intend to install Content Platform Engine in a path that contains

non-English characters, you must specify each such character in the path by its
escaped Unicode representation (for example, \u4EF6).

IBM Content Search Services

IBM Content Search Services can be installed:

v On any localized version of Windows or in any region on the English version of
Windows

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.

Microsoft Windows
Use the localized Microsoft Windows version when available. If the localized
version is not available, use the English version with the appropriate regional
setting.

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.

70 Planning for FileNet P8

 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.

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.

Extended characters and user names

Note the following considerations for localized FileNet P8 accounts.
v Content Platform Engine does not support extended (double-byte) characters in
LDAP attributes for authentication purposes. These attributes include, but are
not limited to, such items as cn (common name), ou (organizational unit), or dc
(domain component). ASCII characters are required for these attributes.
v The Content Platform Engine locale must match directory server locale to
manage non-ASCII user names correctly.
v

Database administrator
The FileNet P8 database administrator installation role includes configuring
database installations and table spaces, and creating database accounts.
“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 Linux, UNIX and Windows server

Use the UTF-8 codeset for the DB2 for Linux, UNIX and Windows database server.

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.

Application Server administrator

To support Unicode UTF-8 characters, all FileNet P8 domain application servers
must be properly configured and must have all fix packs installed.
| “Configuring character encoding on WebSphere Application Server”
FileNet P8 requires two WebSphere settings: com.ibm.CORBA.ORBCharEncoding, to
specify the native encoding set of character data that Object Request Broker
uses, and com.ibm.websphere.security.BasicAuthEncoding, to match the
encoding used by Basic Authentication for Web Services so that client
applications can access web services.

| Configuring character encoding on WebSphere Application

| Server
| FileNet P8 requires two WebSphere settings: com.ibm.CORBA.ORBCharEncoding, to
| specify the native encoding set of character data that Object Request Broker uses,

Appendix A. Preparing non-English environments for installing FileNet P8 71

| and com.ibm.websphere.security.BasicAuthEncoding, to match the encoding used
| by Basic Authentication for Web Services so that client applications can access web
| services.

| To set character encoding parameters on WebSphere Application Server:

| 1. Log on to the WebSphere administrative console.
| 2. In the navigation pane, click Servers > Server Types > WebSphere application
| servers > server_name, where server_name is the name of one of your
| application servers.
| 3. In the Container services section, click ORB service > Custom properties >
| New.
| 4. In the Name field, enter com.ibm.CORBA.ORBCharEncoding, set the value to UTF8,
| and save your changes.
| 5. In the Server Infrastructure section, click Java and process management >
| Process definition > Java virtual machine > Custom properties > New.
| 6. In the Name field, enter com.ibm.websphere.security.BasicAuthEncoding, set
| the value to UTF8, and save your changes.
| 7. Restart the application server.
| 8. Repeat steps 2 through 7 for your other application servers.

FileNet P8 administrator
The FileNet P8 administrator configures Process Task Manager for Application
Engine and Workplace XT.

Limitations on installing in a non-English environment

There are certain limitations on installing FileNet P8 in non-English environments.

Important: For additional limitations, see the release notes.

Process Designer

To import a user-defined XSD file that contains non-English characters in Process

Designer, run the following command to convert characters to the Unicode
encoding format to match an operating system other than Windows Content
Platform Engine in a UTF-8 locale, and then import the XSD file into Process
Designer.
Java -cp pe.jar filenet.vw.toolkit.utils.FileConverter /in filename
/out outfilename

Composite Platform Installation Tool

The Composite Platform Installation Tool, which installs a single-server FileNet P8

environment, is not supported on Simplified Chinese Microsoft Windows 2008 R2.

IBM Case Manager

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.

72 Planning for FileNet P8

IBM FileNet Image Services

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.

Appendix A. Preparing non-English environments for installing FileNet P8 73

74 Planning for FileNet P8
Appendix B. FileNet P8 ports
Port numbers that are used by FileNet P8 components are listed along with
information such as communication protocols, the source and target components,
whether load balancers are supported, and other information specific to the
component ports.

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 76
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 79
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 79
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 80
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
81
The following tables list the Rendition Engine and Content Platform Engine
ports information for LIQUENT.
“Database ports” on page 83
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 84
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 85
The following tables list the port numbers used by IBM FileNet Content
Services for FileNet Image Services.

© Copyright IBM Corp. 2001, 2016 75

Content Platform Engine ports
The Content Platform Engine ports information is presented in multiple tables that
list the port names, port numbers, communication protocols, and descriptions.
Table 9. Content Platform Engine ports
Application Transport level Default port
Port name level protocol protocol number From To
LDAP LDAP TCP 389 Content Directory server
Platform
Engine server
LDAP (SSL ) LDAP TCP 636 Content Directory server
Platform
Engine server
LDAP Global Catalog LDAP TCP 3268 Content Global Catalog
Platform server
Engine server
LDAP Global Catalog (SSL) LDAP TCP 3269 Content Active Directory
Platform Global Catalog
Engine server server
WebSphere WSI HTTP TCP 9080 Content Content Platform
Platform Engine server
Engine client
WebSphere WSI (SSL) HTTPS TCP 9443 Content Content Platform
Platform Engine server
Engine,
Administration
Console for
Content
Platform
Engine,
Component
Manager
(Workplace
XT), or a
custom
application
WebSphere EJB IIOP TCP 2809 Content Content Platform
Platform Engine server
Engine client

Table 10. Content Platform Engine ports - continued

Port name Supports SSL?
LDAP No
LDAP (SSL ) Yes
LDAP Global Catalog No
LDAP Global Catalog (SSL) Yes
WebSphere WSI No
WebSphere WSI (SSL) Yes
WebSphere EJB Yes

76 Planning for FileNet P8

Table 11. Content Platform Engine ports - continued
Port name Notes
LDAP The port is on the directory server and specified on the Content Platform Engine
server for authentication.
LDAP (SSL ) The port is on the directory server and specified on the Content Platform Engine
for authentication through SSL.
LDAP Global Catalog The port is used for the Active Directory only.
LDAP Global Catalog (SSL) The port is used for the Active Directory only.
WebSphere WSI The port is on the WebSphere Application Server for Content Platform Engine. The
port is used for communication with Content Platform Engine by clients through
WSI.
WebSphere WSI (SSL) HTTPS over SSL or TLS. (Port 9080 is the non-SSL HTTP port.) Content Platform
Engine and custom applications use WSI. Port 9443 is on the WebSphere
Application Server for Content Platform Engine. The port is used for
communication with Content Platform Engine by clients through WSI.
WebSphere EJB The port is on the WebSphere Application Server for Content Platform Engine. The
port is used for communication with Content Platform Engine by clients through
EJB and for request forwarding between Content Platform Engine servers.

Table 12. Content Platform Engine ports

Application Transport level Default port
Port name level protocol protocol number From To
SMTP (Email Notification) SMTP TCP 25 Content Email server
Platform
Engine server
Process Task Manager / RMI TCP 32771 (for Process Task Component
Component Manager version 1 of Manager on the Manager /
version 1 communications Component Application Process Task
port Manager) Engine server Manager
communication
Component Manager Event RMI TCP 32773 (for Content Component
Port backward Platform Manager version
compatibility Engine server 1 on the
with version 1 Application
of Component Engine server
Manager)
Rules Listener RMI TCP 32774 (for Content Rules Listener
Rules Engine Platform
using Rules Engine server
Connectivity
Framework)
Content Platform Engine HTTP (only for TCP 0 (randomly Content Content Platform
server to server clusters) assigned port Platform Engine server
communication port number) Engine server

Table 13. Content Platform Engine ports–continued

Reply or
Response to Long lived Supports SSL
Port name requestor? sessions? Load Balancer? and TLS?
SMTP (Email Notification) No No No Yes

Appendix B. FileNet P8 ports 77

Table 13. Content Platform Engine ports–continued (continued)
Reply or
Response to Long lived Supports SSL
Port name requestor? sessions? Load Balancer? and TLS?
Process Task Manager / Component Yes Yes No No
Manager version 1 communications port
Component Manager Event Port Yes Yes No No
Rules Listener Yes Yes No No
Content Platform Engine server to server Yes Yes No No
communication port

Table 14. Content Platform Engine ports - continued

Port name Notes
SMTP (Email Notification) The port is on the SMTP server and is configured for Content Platform Engine
email notification in Administration Console for Content Platform Engine.

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.

Communication on this port is bidirectional from the Content Platform Engine

server to the Rules Listener
Content Platform Engine server For a cluster configuration only. If there is a firewall between the Content Platform
to server communication port Engine server instances of a cluster, this value should be set to a specific assigned
port number and that port value should be allowed in the firewall configuration.

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.

Communication on this port is bidirectional between Content Platform Engine

servers in a cluster.

78 Planning for FileNet P8

Application Engine and Workplace XT ports
The Application Engine and Workplace XT servers ports table lists the port names,
port numbers, communication protocols, and description for its use.
Table 15. Application Engine and Workplace XT server ports
Default port
Port name number Notes®
WebSphere 9080 The port is on the WebSphere Application Server for clients to
connect to Workplace and Workplace XT.
WebSphere SSL 9443 The port is on the WebSphere Application Server for clients to
connect to Workplace and Workplace XT through SSL.
WebLogic 7001 The port is on the WebLogic Server for clients to connect to
Workplace and Workplace XT.
WebLogic SSL 7002 The port is on the WebLogic Server for clients to connect to
Workplace and Workplace XT through SSL.
JBoss 8080 The port is on the JBoss Application Server for clients to connect to
Workplace and Workplace XT.
JBoss SSL 8443 The port is on the JBoss Application Server for clients to connect to
Workplace and Workplace XT through SSL.
BPM Web Services Reliable 32767 The port is configured and used on the Application Engine server,
messaging client port for a Component Manager instance.
Content Platform Engine 32771 The port is on the Windows Content Platform Engine server for
(RMI) Process Task Manager to communicate with the Windows Content
Platform Engine Services Manager. Specify this port number in the
jpemgr.properties file, in the jpemgr.port parameter on the Content
Platform Engine.

This port is on the Application Engine server for Process Task

Manager to communicate with the Component Managers and the
Windows Process Workplace (or Workplace XT) Services Manager.
Set the port in Process Task Manager on the Application Engine as
the Registry Port.
Component Manager (Event 32773 The port is on the Application Engine server, and is used when the
Port) Component Manager (running on the Application Engine Server) is
configured to be triggered by events, instead of polling. This port
number must match the port used for the Component Manager
Event Port on the Content Platform Engine.

Process Simulator ports

The Process Simulator ports information, which is segmented into multiple tables,
lists the port names, port numbers, communication protocols, and description for
its use.
Table 16. Process Simulator ports
Application Transport level Default port
Port name level protocol protocol number From To
Registry port RMI TCP 32771 Process Task Process
Manager Simulator
Return RMI TCP 0 Application Process
Engine Simulator

Appendix B. FileNet P8 ports 79

Table 17. Process Simulator ports–continued
Reply or
Response to Long lived
Port name requestor? sessions? Load Balancer? Supports SSL?
Registry port Yes No No No
Return Yes No No No

Table 18. Process Simulator ports–continued

Port name Notes
Registry port The port is on the Process Simulator server. The Process Task Manager application
on the Process Simulator server communicates with the Process Simulator server
process on this port. The Application Engine also communicates with the Process
Simulator server process on this port.
Return The port is on the Process Simulator server and is used to communicate with the
Application Engine server.

By default an anonymous port number is used. However, if the Process Simulator

server resides behind a firewall it will be necessary to specify an explicit port by
entering a value other than 0.

Content Search Services ports

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.
Table 19. Content Search Services ports
Application Transport level Default port
Port name level protocol protocol number From To
Content Search Services proprietary TCP 8191 Content Engine Content Search
server Services

Table 20. Content Search Services ports–continued

Reply or
Response to Long lived
Port name requestor? sessions? Load Balancer? Supports SSL?
Content Search Services server Yes No No Yes (for P8
version 5.1)

Table 21. Content Search Services ports–continued

Port name Notes
Content Search Services server The port is located on the Content Search Services server and is used for
communication between the Content Search Services server and the Content
Engine.

80 Planning for FileNet P8

Rendition Engine and Content Platform Engine ports for LIQUENT
The following tables list the Rendition Engine and Content Platform Engine ports
information for LIQUENT.
Table 22. Rendition Engine and Content Platform Engine ports for LIQUENT
Transport level Default port
Port name protocol number From To
LIQUENT input port TCP/IP 2867 (COM Content Platform Rendition Engine
Repository only) Engine and
Rendition Engine
LIQUENT notify port TCP/IP 2868 Rendition Engine Content Platform
Engine and
Rendition Engine
LIQUENT event port TCP/IP 2869 Content Platform Rendition Engine
Engine and
Rendition Engine
LIQUENT admin port TCP/IP 2870 Content Platform Rendition Engine
Engine and
Rendition Engine
LIQUENT file transfer port TCP/IP 2871 Content Platform Content Platform
Engine and Engine and
Rendition Engine Rendition Engine
LIQUENT job queue port TCP/IP 2872 Rendition Engine Rendition Engine

Table 23. 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 24. Rendition Engine and Content Platform Engine ports for LIQUENT–continued
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.

Appendix B. FileNet P8 ports 81

Table 24. Rendition Engine and Content Platform Engine ports for LIQUENT–continued (continued)
Port name Notes
LIQUENT notify port The port is also related to the distributed processing of jobs on the Rendition
Engine servers. When a job is sent to another Rendition Engine server, then the
originating Rendition Engine server or Rendition Engine client (Content Platform
Engine Publishing server) is notified on this port by the other Rendition Engine
server when the other Rendition Engine server has finished processing the job.
One case of this is when the Rendition Engine server is notifying the Rendition
Engine client (Content Platform Engine Publishing server) that a conversion job
has completed.
LIQUENT event port The port is used by each Rendition Engine server to send or receive events. These
events are used by the Rendition Engine server to keep each other informed of
current activities. The LIQUENT Domain Manager on the Rendition Engine server
uses these events for the job status display.
LIQUENT admin port The port is used by each Rendition Engine server for internal administrative
functions. The primary use is for each Rendition Engine server to publish its
current activity statistics (for example, how busy the business services are) for use
by other Rendition Engine servers to make load balancing decisions.
LIQUENT file transfer port This port is used for transferring source, temporary, and result files between
Rendition Engine servers as well as between Rendition Engine servers and
Rendition Engine clients (Content Platform Engine Publishing servers).
LIQUENT job queue port This port is for job queuing by the render business service on all Rendition Engine
servers.

Tip: If the LIQUENT port number assigned to the Rendition Engine/LIQUENT

software conflicts with the port number required by another application or service
that runs on the Rendition Engine server or the Content Platform Engine
Publishing server, then the default values can be changed in the LIQUENT Domain
Manager on the Rendition Engine server.

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
server’s 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).

82 Planning for FileNet P8

Database ports
The database ports information, which is segmented into multiple tables, lists the
port names, port numbers, communication protocols, and description for its use.
Table 25. Database ports
Application Transport level Default port
Port name level protocol protocol number From To
DB2 for Linux, UNIX, and JDBC or CLI TCP 50000 Content DB2
Windows Platform
Engine, Case
Analyzer and
IBM Content
Navigator
DB2 for z/OS® JDBC or CLI TCP 446 Content DB2
Platform
Engine, Case
Analyzer and
IBM Content
Navigator
Oracle JDBC or OCI TCP 1521 Content Oracle
Platform
Engine, IBM
Content
Navigator, Case
Analyzer, and
Rendition
Engine
Microsoft SQL Server JDBC or TDS TCP 1433 Content Microsoft SQL
Platform Server
Engine, IBM
Content
Navigator, Case
Analyzer, and
Rendition
Engine

Table 26. Database ports - continued

Reply or Response
Port name to requestor? Long lived sessions? Load Balancer?
DB2 for Linux, UNIX, and Windows Yes No Yes
DB2 for z/OS Yes No Yes
Oracle Yes No Yes
Microsoft SQL Server Yes No Yes

Table 27. Database ports - continued

Port name Notes
DB2 for Linux, UNIX, DB2 for Linux, UNIX, and Windows default port. Port 50000 or
and Windows higher can be used.
DB2 for z/OS The default port for DB2 for z/OS is typically changed. Refer to
your database administrator for the port numbers in use.
Oracle Oracle DB default listener. Alternative port is 2483 (TTC) or 2484
(TTC SSL).

Appendix B. FileNet P8 ports 83

 Table 27. Database ports - continued (continued)
Port name Notes
Microsoft SQL Server The port is the default port for SQL Server.

IBM System Dashboard for Enterprise Content Management ports

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.
Table 28. IBM System Dashboard for Enterprise Content Management ports
Application Transport level Default port
Port name level protocol protocol number From To
Listener (first) TCP/IP TCP 32775 IBM System IBM System
Dashboard for Dashboard for
Enterprise Enterprise
Content Content
Management Management
client (such as, Listener
System (running on
Dashboard / Content Platform
FSM) Engine,
Application
Engine, FileNet
Image Services,
and other
servers)
Listener (subsequent) TCP/IP TCP OS defined IBM System IBM System
Dashboard for Dashboard for
Enterprise Enterprise
Content Content
Management Management
client (such as, Listener
IBM System (running on
Dashboard for Content Platform
Enterprise Engine,
Content Application
Management / Engine, FileNet
FSM) Image Services,
and other
servers)

Table 29. IBM System Dashboard for Enterprise Content Management ports–continued
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

84 Planning for FileNet P8

Table 30. IBM System Dashboard for Enterprise Content Management ports–continued
Port name Notes
Listener (first) This is the primary "pilot port" for connection to the IBM System Dashboard for
Enterprise Content Management server. This port also registers the secondary
allocated ports and communicates those numbers to the Dashboard. If needed, an
administrator can use the PchConfig.properties file to override the OS-defined
property and define a specific range of ports to use.
Listener (subsequent) If the first listener port is allocated, the OS will allocate additional ports for
managers to connect to listeners on the IBM System Dashboard for Enterprise
Content Management server. If needed, an administrator can use the
PchConfig.properties file to override the OS-defined property and define a
specific range of ports to use.

Content Services for FileNet Image Services ports

The following tables list the port numbers used by IBM FileNet Content Services
for FileNet Image Services.
Table 31. Content Services for FileNet Image Services ports
Application level Transport level Default port
Port name protocol protocol number From To
tms Custom TCP 32768 administrator FileNet Image
Services server
cor Custom TCP 32769 FileNet Image FileNet Image
Services, FileNet Services server
Image Services
Toolkit, or
Content Engine
server
nch Custom UDP 32770 Content Engine FileNet Image
server Services server
fn_snmpd SNMP UDP 161 SNMP Mgmt FileNet Image
Services
snmp trap SNMP UDP 162 SNMP Mgmt SNMP Mgmt
fn_trapd SNMP UDP 35225 FileNet Image SNMP Mgmt
Services
Native default SNMP UDP 8000 SNMP Mgmt HP-UX OS
SNMP port (HP
only)
IBM FileNet P8 SNMP UDP 8001 SNMP Mgmt fn_snmp (HP and
specific SNMP port Sun)
(HP and Solaris
only)
tpi Custom UDP anonymous FileNet Image FileNet Image
Services Toolkit Services
or FileNet Image
Services

Appendix B. FileNet P8 ports 85

Table 32. Content Services for FileNet Image Services ports–continued
Reply or
Response to Long lived
Port name requestor? sessions? Load Balancer? Supports SSL?
tms Yes No No No
cor Yes Caller is No No
responsible for
closing the
connection
nch Yes No No No
fn_snmpd Yes No No No
snmp trap No No No No
fn_trapd No No No No
Native default SNMP port (HP only) Yes No No No
FileNet P8 specific SNMP port (HP and Yes No No No
Solaris only)
tpi Yes No No No

Table 33. Content Services for FileNet Image Services ports–continued

Port name Notes
tms tms is the Task Manager service. TM_daemon listens for requests from initfnsw
running on the same or a different system analogous to COR_Listen listening for
RPCs.
cor cor is the Courier service. COR_Listen listens on this port for incoming RPC
requests.
nch nch is the NCH daemon. NCH_daemon listens on this port. Pre-4.1.2 listened for
broadcasts, and so on, Post 4.1.2, listens only for old print servers to verify that
NCH is up.
fn_snmpd fn_snmpd is the FileNet Image Services Simple Network Management Protocol
daemon. It listens for SNMP requests from the native OS SNMP daemon. The
native SNMP daemon listens on this port and communicates with fn_snmpd
through other local port. fn_snmpd does not listen on this port.
snmp trap This port is a well-known OS trap daemon port for listening to trap messages. All
FileNet Image Services trap messages received by fn_trapd daemon are eventually
routed to this port.
fn_trapd fn_trapd is the FileNet Image Services trap daemon, which listens for notifications
of the end of FileNet Image Services background processes running on the server
and sys logs information.
Native default SNMP port (HP All non-FileNet Image Services based SNMP requests are routed to this port for
only) native SNMP processing.
FileNet P8 specific SNMP port All FileNet Image Services based SNMP requests are routed to this port for
(HP and Solaris only) fn_snmpd daemon processing.
tpi Used for migration notification. The requester gets the anonymous UDP socket and
waits on completion. When the migration is complete, the ds_notify and pri_notify
processes send TPI notifications to signal completion of a task.

86 Planning for FileNet P8

Notices
This information was developed for products and services offered in the US. This
material may be available from IBM in other languages. However, you may be
required to own a copy of the product or product version in that language in order
to access it.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US

For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS

PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of
express or implied warranties in certain transactions, therefore, this statement may
not apply to you.

This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

© Copyright IBM Corp. 2001, 2016 87

 IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Director of Licensing

IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US

Such information may be available, subject to appropriate terms and conditions,

including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

The performance data discussed herein is presented as derived under specific

operating conditions. Actual results may vary.

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.

Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

Statements regarding IBM's future direction or intent are subject to change or

withdrawal without notice, and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject to
change before the products described become available.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which

illustrate programming techniques on various operating platforms. You may copy,

88 Planning for FileNet P8

 modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:

© Copyright IBM Corp. 2016

Portions of this code are derived from IBM Corp. Sample Programs.
“Privacy policy considerations” on page 90

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.

Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.

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.

Terms and conditions for product documentation

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 89
 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

Except as expressly granted in this permission, no other permissions, licenses or

rights are granted, either express or implied, to the publications or any
information, data, software or other intellectual property contained therein.

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.

IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE

PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING
BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY,
NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.

Privacy policy considerations

IBM Software products, including software as a service solutions, (“Software
Offerings”) may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings
can help enable you to collect personally identifiable information. If this Software
Offering uses cookies to collect personally identifiable information, specific
information about this offering’s use of cookies is set forth below.

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 IBM’s Privacy Policy at http://www.ibm.com/privacy and
IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details the

90 Planning for FileNet P8

section entitled “Cookies, Web Beacons and Other Technologies” and the “IBM
Software Products and Software-as-a-Service Privacy Statement” at
http://www.ibm.com/software/info/product-privacy.

Notices 91
92 Planning for FileNet P8
Index
Special characters configuring application servers in high
availability environments 63
E
.NET configuring the network 27 encrypted NTFS devices 32
configuring Windows 26 Content Platform Engine Encryption products for storage 32
configuring remote access
protocol 35
A deployment on multiple servers 62 F
accounts 57 primary administrative user name 62 file servers
Application Engine 20, 47 remote file access protocols 33 configuring account settings 34
Content Platform Engine 41 setting host aliases 62 file storage area
IBM Content Search Services 23, 24 WebSphere 59 configuring 33
workflow 46 WebSphere environment variables 60 defined 32
Advance storage areas Content Platform Engine installation FileNet Image Services ports 85
replication models 30 account 18 Filenet P8 ports 75
Advanced storage area Content Platform Engine operating fixed storage area 32
advantages 29 system user account 18
Advanced storage areas Content Platform Engine ports 76
preparing 32
Application Engine
Content Platform Engine ports for
LIQUENT 81
G
Content Platform Engine system user 41 GCD administrator 43
creating shared directories 28
pre-installation tasks 65 Content Platform Engine user account for
Application Engine and Workplace XT DB2 for Linux, UNIX and Windows 20
ports 79 Content Search Services ports 80 I
Application Engine operating system cpe_db_user 49 IBM Content Search Services
account 22, 47 installation scenarios 8
Application Engine operating system standby index area policy 25
database user account 21 D IBM Support
application server data collection tools data collection tools 35
configuration 65 IBM Support Assistant Data IBM Support Assistant Data
LDAP user account 40 Collector 35 Collector 35
server cluster 65 IBM Support Assistant Lite Data IBM Support Assistant Lite Data
server farm 65 Collector 35 Collector 35
user account 57 data sources IBM System Dashboard for Enterprise
application server instance resolving names of 64 Content Management ports 84
starting or stopping 64 database IBM Tivoli Directory Server 40
ASA GCD (Oracle) 52 install Content Platform Engine 18
installation tasks 55 storage area 32 installation
authentication database failover support ASA tasks 55
IBM Tivoli Directory Server 40 preparing 63 DBA tasks 47
database ports 83 ITA tasks 15
database user 49 planning 1
B DB2 planning and preparing 1
SA tasks 36
Bootstrap administrator 41 install for FileNet P8 platform 51
installing 51 Installation and Upgrade Worksheet 12
DB2 for Linux UNIX and Windows installation scenarios
IBM Content Search Services 8
C plan for FileNet P8 platform 50
preparing for FileNet P8 50 installing localized version of operating
CIFS DB2 for Linux, Unix and Windows 49 system 69
configuring a Windows-based file DBA installing operating system language
server for a Windows client 34 installation tasks 47 pack 69
COM compatibility clients deployment ITA
configuring Windows 26 planning 2 installation tasks 15
config_mgr_user 19 directory servers
Configuration Manager IBM Tivoli Directory Server 40
setting permissions for user 62
configurations
directory service bind account 45 K
documentation server Kerberos 37
sample 1 installing 67
Configure Windows servers 26
configuring account settings on file
servers 34

© Copyright IBM Corp. 2001, 2016 93

L security
install considerations 37
load balancer server cluster
configuring 66 application server 65
load balancing server farm
configuring 62 application server 65
IBM Content Search Services 25 Single Sign-On 37
SSO
Kerberos 37
M planning considerations 37
managed deployment requirements 37
Application Engine 9 stand-alone deployment
Content Platform Engine 8 Application Engine 9
multi-instance deployment Content Platform Engine 8
Application Engine 9 standby index area policy
choosing 25
IBM Content Search Services 25
N Storage areas 32
Storage plan
network creating 28
prerequisites to configuring 27 Creating a storage plan 28
NFS synchronizing time and date 27
configuring a Windows-based file
server for a non-Windows client 35
non-managed deployment
Application Engine 9 U
Content Platform Engine 8 using localized version of Microsoft
Windows 70

O W
object store
DB2 database 53 WebSphere
object store administrator 44 configure for Content Platform
operating system considerations 70 Engine 58
configuring for Application
Engine 63
P configuring for Workplace XT 63
primary administrative user name 62
ports 75, 76, 79, 80, 81, 83, 84, 85 WebSphere profile for Content Platform
pre-installation tasks Engine 59
Application Engine 65 Windows 2008 inbound rules 26
preparing for database failover Windows-based file server
support 63 configuring for a non-Windows client
Process Simulator ports 79 using NFS 35
profile 59 configuring for a Windows client
proxy server using CIFS 34
configuring 62, 66 workflow system administrator 46
Workplace
shared settings 66
R Workplace XT
realm 37 creating shared directories 28
remote file access protocols 33 Workplace XT operating system
Rendition Engine ports 81 account 22, 47
Replication models 30 worksheet 12
resolving names of data sources 64 autofiltering and sorting 14
roles running the customize macro 13
definition of installation 11

S
SA
installation tasks 36
scenarios
distributed 8
multiple domain 9
standard distributed 9

94 Planning for FileNet P8

IBM®

Product Number: 5724-R76

5724-R81

GC19-3917-04