p8 451 High Availability
p8 451 High Availability
p8 451 High Availability
Version 4.5.1
GC19-2800-00
IBM FileNet P8
Version 4.5.1
GC19-2800-00
Note
Before using this information and the product it supports, read the information in “Notices” on page 175.
This edition applies to version 4.5.1 of IBM FileNet Content Manager (product number 5724-R81), version 4.5.1 of
IBM FileNet Business Process Manager (product number 5724-R76), and to all subsequent releases and
modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2001, 2009.
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 Installing Process Engine in a Microsoft cluster
How to send your comments . . . . . . . . . v server . . . . . . . . . . . . . . . 92
Contacting IBM . . . . . . . . . . . . . vi Migrating Process Engine clusters to farms
(UNIX, Windows) . . . . . . . . . . . 97
What is high availability? . . . . . . . 1 Process Engine database reconnection . . . . 98
Installing a highly available Application
Terms and concepts . . . . . . . . . . . . 1
Engine/Workplace XT . . . . . . . . . . 100
Disaster recovery and high availability . . . . 2
Installing and configuring Application
Server consolidation and high availability . . . 2
Engine/Workplace XT . . . . . . . . . 100
Industry terminology . . . . . . . . . . 3
Configuring and deploying Application
The FileNet P8 architecture in a highly available
Engine/Workplace XT . . . . . . . . . 103
environment . . . . . . . . . . . . . . 3
Verifying Workplace/Workplace XT deployment 105
Choosing between a farm and a cluster . . . . . 4
Enabling the Process Engine Component
Server farms . . . . . . . . . . . . . 4
Integrator . . . . . . . . . . . . . 105
Server clusters . . . . . . . . . . . . . 5
Managing Workplace/Workplace XT settings in
High availability products . . . . . . . . . . 9
a highly available environment . . . . . . 106
Examples of high availability . . . . . . . 10
Installing a highly available Rendition Engine . . 109
High availability products tested with FileNet P8 10
Installing and configuring Rendition Engine . . 109
Installing a highly available Business Process
Planning and preparing for high Framework . . . . . . . . . . . . . . 111
availability . . . . . . . . . . . . . 19 Pre-installation tasks . . . . . . . . . . 112
Planning the installation . . . . . . . . . . 19 Installation tasks . . . . . . . . . . . 113
Understanding the system components . . . . 19 Verifying the Business Process Framework
Definition of installation roles . . . . . . . 32 installation . . . . . . . . . . . . . 118
Using the installation and upgrade worksheet . . 33 Installing a highly available Content Search Engine 118
Performing required preparation tasks . . . . . 35 Installing a highly available CFS-ICI. . . . . . 121
Installation administrator tasks . . . . . . . 36 Installing and configuring Content Federation
Information technology administrator . . . . 37 Services . . . . . . . . . . . . . . 122
Security administrator tasks . . . . . . . . 47 Verifying deployment . . . . . . . . . 124
Database administrator tasks . . . . . . . 48 Installing a highly available IBM FileNet eForms
Application server administrator tasks . . . . 50 for P8 . . . . . . . . . . . . . . . . 125
Process Engine . . . . . . . . . . . . 57 Installing and configuring IBM FileNet eForms
for P8 . . . . . . . . . . . . . . . 125
Installing and configuring for high Verifying IBM FileNet eForms for P8
availability . . . . . . . . . . . . . 59 deployment . . . . . . . . . . . . . 126
Overview . . . . . . . . . . . . . . . 60 Installing a highly available Process Analyzer . . 126
Installing FileNet P8 components in a highly Installing and configuring Process Analyzer . . 127
available environment . . . . . . . . . . . 60 Configuring a database connection to Process
Installing a highly available Content Engine . . . 61 Engine running on Oracle RAC . . . . . . 128
Installation and deployment tasks . . . . . . 61 Installing a highly available IBM InfoSphere
Creating object stores in FileNet P8 4.5.1. . . . 67 Enterprise Records . . . . . . . . . . . 129
Connecting to a highly available Content Engine 69 Pre-installing IBM InfoSphere Enterprise
Enabling application server connections after Records . . . . . . . . . . . . . . 129
database failover . . . . . . . . . . . 71 Installing IBM InfoSphere Enterprise Records 130
Verifying the Content Engine installation and Verifying deployment . . . . . . . . . 133
failover . . . . . . . . . . . . . . . 74 Installing a highly available IBM FileNet Connector
Installing a highly available Process Engine. . . . 74 for Microsoft SharePoint Web Parts 2.2 . . . . . 133
Configuring a Process Engine server farm for a Installing and configuring IBM FileNet
hardware load balancer . . . . . . . . . 74 Connector for Microsoft SharePoint Web Parts
| Configuring a Process Engine server farm for a 2.2 . . . . . . . . . . . . . . . . 134
| software load balancer. . . . . . . . . . 78 Verifying installation . . . . . . . . . . 136
Installing Process Engine in a Veritas cluster Installing a highly available IBM FileNet Connector
server (UNIX) . . . . . . . . . . . . 80 for Microsoft SharePoint Web Parts 2.2.1 . . . . 137
Installing Process Engine in a Veritas cluster Installing and configuring IBM FileNet
server (Windows) . . . . . . . . . . . 86 Connector for Microsoft SharePoint Web Parts
2.2.1 . . . . . . . . . . . . . . . 138
iv High Availability
ibm.com and related resources
Product support and documentation are available from ibm.com.
Product support is available on the Web. Click Support from the product Web site
at:
FileNet Content Manager Support
http://www.ibm.com/software/data/content-management/filenet-content-
manager/support.html
Information center
PDF publications
You can view the PDF files online using the Adobe Acrobat Reader for your
operating system. If you do not have the Acrobat Reader installed, you can
download it from the Adobe Web site at http://www.adobe.com.
You are invited to tell IBM how to improve the consumability of software
products. If you want to help IBM make IBM® FileNet® P8 easier to use, take the
Consumability Survey at http://www.ibm.com/software/data/info/
consumability-survey/.
Contacting IBM
To contact IBM customer service in the United States or Canada, call
1-800-IBM-SERV (1-800-426-7378).
To learn about available service options, call one of the following numbers:
v In the United States: 1-888-426-4343
v In Canada: 1-800-465-9600
For more information about how to contact IBM, see the Contact IBM Web site at
http://www.ibm.com/contact/us/.
vi High Availability
What is high availability?
High availability is the ability of a server system to provide a service to an end
user with as little perceived downtime as possible. Though not guaranteed,
different ranges of high availability exist, from “five nines” with 99.999% uptime,
to 95% uptime.
If a system component fails for any reason, the high availability solution ensures
that another component takes over for the failed component, and that the newly
composed system will maintain the same machine identifications (host names and
IP addresses) as the system before failure, minimizing the disruption to the user.
This technical notice addresses only the hardware and software issues. Other issues
that might impact high availability at a customer's system include: human error,
process problems, and external issues.
Restriction: High availability does not mean that a service is guaranteed to always
be available. Analysts describe a range of high availability targets, from the
so-called "five nines" availability, with 99.999% up-time, at the high end, to basic
availability at 95%. Five nines availability translates to five minutes or less
downtime in a full year of 24 by 7 operations. By contrast, 99% availability allows
up to 87 hours of downtime per year, and 95% allows up to 436 hours, or 18 days,
of downtime, with the cost of providing high availability increases exponentially as
the target moves from 95% to 99% to 99.999%.
“Terms and concepts”
Before you install IBM FileNet P8 products in a high availability system, learn
about high availability concepts and how they pertain to disaster recovery and
server consolidation on the system.
“The FileNet P8 architecture in a highly available environment” on page 3
A highly available FileNet P8 system consists of components such as Content
Engine or Application Engine which are deployed as all-inclusive applications
containing both presentation and business logic on multiple running instances.
“Choosing between a farm and a cluster” on page 4
When choosing between clustering and farming as your type of highly
available architecture you must take into account issues such as scalability and
recovery time, among others.
“High availability products” on page 9
You can integrate IBM FileNet P8 with various high availability products for
load balancing, server clustering, and database services.
When you plan, install, and initially configure a highly available IBM FileNet P8
system, consider the impact of high availability on disaster recovery and server
Although the goal of both high availability and disaster recovery solutions is the
same--keeping your IBM FileNet P8 system available for continued business
operations--the solutions themselves are quite different. For more information, see
the IBM FileNet P8 Disaster Recovery Technical Notice.
Related information
Download the IBM FileNet P8 Disaster Recovery Technical Notice
Download IBM FileNet P8 Disaster Recovery Technical Notice, as well as other
IBM FileNet P8 documentation.
One way of doing this is logical partitioning, where one server is configured to act
like several separate physical servers. The IBM LPAR products for AIX® is one
example.
2 High Availability
Industry terminology
Vendors and industry analysts use a variety of differing terms to describe high
availability concepts. IBM uses the terms server farms and server clusters to
distinguish between these two different technologies.
The Application Engine architecture does not separate the images and static
content of the Workplace application on separate server instance from the servlets
and Java™ server pages of the Workplace application. Instead all these components
are deployed on one server instance.
All IBM FileNet Web applications adhere to industry standards for HA farming. To
be consistent Process Engine supports that HA model as well, in addition to
clustering.
Server farms
A server farm is a group of identical servers accessed through hardware or software
load balancing technology. All the servers are active, provide the same set of
services, and are effectively interchangeable. A load balancer distributes incoming
client requests over the servers in the group.
Server farms are best suited to server tiers such as Content Engine and Application
Engine Web applications that are processing-centric rather than data-centric, as all
the servers in the farm are clones of each other. Processing logic for these
components does not change often, making it easy to keep all the servers identical.
4 High Availability
Figure 1. The basic server farm setup
A load-balanced server farm provides both better availability and better scalability
than a single server. When a server fails, the load balancer automatically detects
the failure and redirects user requests to another server in the farm, thereby
keeping the site available. Administrators can increase system performance and
capacity by adding servers to the farm.
Server clusters
Server clusters are based on the concept of shared software configuration data
storage, making it suitable for data-centric tiers, such as file servers and data
servers, because their data content is constantly changing.
Restriction: IBM FileNet P8 does not support session replication across cluster
nodes.
6 High Availability
Data replication and geographically-dispersed servers should be reserved for a
disaster recovery configuration, where data replication and the difficulties
introduced by wide area networking cannot be avoided.
For more information, see the IBM FileNet P8 Disaster Recovery Technical Notice.
Related information
Download the IBM FileNet P8 Disaster Recovery Technical Notice
Download IBM FileNet P8 Disaster Recovery Technical Notice, as well as other
IBM FileNet P8 documentation.
Cluster configurations
Cluster software vendors support several distinct types of cluster configurations.
Using Symantec's terminology, the IBM FileNet P8 4.5.1 Platform tested the
following notable configurations: Asymmetric, Symmetric, N + 1, and N to M
clusters.
Asymmetric clusters
Asymmetric clusters are asymmetric in the sense that the cluster includes both active
and passive servers. An asymmetric 1-to-1 cluster has one active server and one
passive server. This is the simplest form of server cluster, but also the most
expensive, in effect doubling the number of servers required for a given workload.
There is no drop-off in performance after a failover in an asymmetric 1-to-1 cluster,
assuming the passive server is identical in capability with the active server.
Symmetric clusters
Symmetric clusters are termed symmetric because all the servers (also called nodes)
in the cluster are active. Although there are no passive servers in a symmetric
cluster, the servers typically run different services. No two servers provide the
same service for the same data set simultaneously, because of the difficulty of
maintaining data integrity mentioned earlier.
The net result of a failover in a symmetric cluster is that both services end up
running on one node. Note the potential drop in performance if both nodes are not
provisioned with enough idle capacity to accommodate running both the Process
Engine and database on the same node. For this reason nodes in a symmetric
cluster might have to be more powerful than they would be in a non-HA
environment, but no extra nodes are required, in contrast to an asymmetric cluster.
Restriction: You can only set up symmetric clusters with components that can be
collocated. For more information, see the IBM FileNet P8 Hardware and Software
Requirements document.
N + 1 clusters
An N+1 cluster has N active nodes and only one (1) passive backup node. The lone
passive node acts as the backup for all N active nodes. This is an asymmetric
cluster, since it has a mix of active and passive nodes, but it requires fewer nodes
overall than an asymmetric 1-to-1 cluster configuration for each active node. Each
node in an N+1 cluster is configured with the software for all the services
supported by the cluster. This allows each node to act as the backup for all the
active nodes in the cluster. The benefit is that a failed node, when it comes back
online, can take on the role of backup node. This avoids the need for a failback
from the former backup node to the repaired node, eliminating the disruption in
service caused by a failback event.
All three nodes are configured to run both the Process Engine and the database. If
either the Process Engine or the database node fails, a failover to the backup node
occurs and the appropriate software is started to take over the role. When the
failed node is repaired and brought back up, it becomes the new backup node in
the cluster.
N to M clusters
8 High Availability
cluster can be configured to avoid the need for a failback when the failed node is
available for use again, in the case where a passive backup node is desired. If there
is no passive node in an N-to-M cluster, a failback is presumably preferred to get
the cluster back to its highest performance configuration with all nodes active. The
advantage of an N-to-M cluster over an N+1 cluster is that it can accommodate
multiple failures, since it has M failover targets that can take over for a failed
node.
If the File Store share server node fails, it could be configured to fail over to the
Process Engine Database server. On a second failure, say of the Process Engine the
clustering software on the PE node could be configured to fail over to the Content
Engine Database Server node.
Load balancing/farming
Microsoft Windows® Network Load Balancing and Cisco are two examples of load
balancing applications.
v Microsoft Windows contains software-based load balancing capability called
Network Load Balancing (NLB). As requests come in from remote clients, the
load balancing products spread out the requests across the servers to balance the
workload evenly.
v Cisco offers hardware-based load balancing switches that automatically spread
the incoming client workload across a farm of servers, each providing access to
the same content or services.
Server clusters
Server cluster products from the major server vendors include:
v HP's MC/ServiceGuard for HP-UX
v IBM's HACMP for AIX
v Microsoft Cluster Server for Windows Server 2003
v Sun Cluster for Solaris.
Symantec offers its Veritas Cluster Server product for all of these platforms.
IBM tested IBM FileNet P8 with high availability products from the following
vendors:
v “Load balancing/farming” on page 11.
– BEA Systems
– F5 networks
– IBM
– JBoss
v “Server clusters” on page 16.
– Microsoft.
– Symantec.
v “Database services” on page 18.
– IBM DB2® UDB with Veritas Cluster Server
– Oracle with Veritas Cluster Server
– Oracle Real Application Clusters (RAC). See “Oracle RAC” on page 18.
– SQL Server with Microsoft Cluster Server (MSCS)
All IBM FileNet Web applications adhere to HA industry standards and number of
other high availability vendors have products and configurations that should work
with the IBM FileNet P8 Platform.
10 High Availability
Important: If your high availability configuration differs significantly from those
described here, you should to do a proof of concept test, or even a pilot project, to
confirm that the configuration functions as expected.
“Load balancing/farming”
A number of hardware and software load-balancing products are available for
server farm configurations, including IBM, Oracle, F5 Big IP, and JBoss.
“Oracle WebLogic Server clusters (farms)” on page 15
By using Oracle WebLogic Server you can create a network of clustered
application servers to provide highly available and scalable applications that are
capable of providing service in the event of a machine or hardware component
failure.
“WebSphere clusters (farms)” on page 15
IBM WebSphere Application Server Network Deployment (WebSphere
Application Server ND) provides high availability through clusters, a collection
of servers that work together as a server farm and can be managed as a single
server. You can deploy, start, and stop all servers in the cluster as a single
entity.
“JBoss clusters” on page 16
JBoss Application Servers can be grouped together into a cluster to provide
high availability, but each server is managed individually.
“Server clusters” on page 16
Veritas Cluster Server and Microsoft Cluster Server are two examples of similar
server cluster products. Each machine in the cluster is seen as a node.
“Database services” on page 18
If the database is inaccessible, users will be unable to add and retrieve content
on Content Engine or Process Engine. You should include any database services
in a cluster as part of a highly available environment.
Load balancing/farming
A number of hardware and software load-balancing products are available for
server farm configurations, including IBM, Oracle, F5 Big IP, and JBoss.
For more information, see “Using load balancers with IBM FileNet P8” on page 12.
Table 2. Tested load-balancing/farming solutions
Vendor Notes
Oracle WebLogic Server clusters -
F5 Big IP -
IBM WebSphere Application Server Network Formerly called server group of clones.
Deployment clusters
JBoss Application Server cluster Also called HA partition.
You can use load-balancers to manage client requests across all of the nodes in an
IBM FileNet P8 server farm.
Farming requires a mechanism to balance the load across all the nodes in a farm,
and to redirect client connections to surviving nodes in case of failure. This section
summarizes the load balancing options available for IBM FileNet P8 4.5.1.
“Load balancer support for IBM FileNet P8”
You can use different load-balancing strategies to manage requests to the
Content Engine, Process Engine, Application Engine, and the database
respectively.
“Configuring the time-to-live value for load balancers that use dynamic DNS
servers” on page 14
For load balancers that use dynamic DNS servers, you can configure the
Content Engine, Application Engine, and Process Engine to point the
information that is cached after a failover to the correct address of the active
farm node.
You can use different load-balancing strategies to manage requests to the Content
Engine, Process Engine, Application Engine, and the database respectively.
Content Engine
Content Engine is stateless and supports both hardware and software load
balancers.
Depending on which of the two transports the client applications use to Content
Engine, certain restrictions apply. This table outlines the types of load balancing
that can be used with Content Engine for each transport.
Table 3. Content Engine
Network Load
Hardware load Application Balancing
balancing (all Server load HTTP-plugin feature in
CE clients protocols) balancing load balancing Windows Server
Web Services Yes No Yes Yes
clients (CEWS
transport: HTTP)
Java clients (EJB No (see Yes No No
transport: Important note
IIOP/T3/JNP) later in this
section.)
12 High Availability
Table 3. Content Engine (continued)
Network Load
Hardware load Application Balancing
balancing (all Server load HTTP-plugin feature in
CE clients protocols) balancing load balancing Windows Server
IBM FileNet No No No No
Enterprise
Manager and
other
administrative
applications
Process Engine
Since the Process Engine does not run inside a Java 2 Enterprise Edition (J2EE)
application server, a load balancer external to FileNet Process Engine is required.
FileNet Process Engine 4.5.1 is qualified with a hardware load balancer.
Tip:
v If FileNet Content Engine and FileNet Process Engine are collocated, a hardware
load balancer is required as FileNet Process Engine does not support software
Application Engine
Application Engine supports both hardware and software load balancers. Note,
however, that it is not stateless; you must use a load balancer that supports sticky
sessions such as Cisco Local Director (tested by IBM FileNet). You can also use
WebSphere or WebLogic HTTP plug-in load balancing in combination with an
HTTP server.
Table 5. Application Engine
Network Load
Hardware load Application Balancing
balancing (all Server load HTTP-plugin feature in
AE clients protocols) balancing load balancing Windows Server
Web Browsers Yes + sticky No Yes + sticky Yes + sticky
sessions sessions sessions
Application Yes + sticky No Yes + sticky Yes + sticky
integration sessions sessions sessions
(Office)
Database
When using Oracle RAC as the database service, load balancing is provided
through the built-in capabilities of both the Oracle RAC client and SQL NET.
Configuring the time-to-live value for load balancers that use dynamic DNS servers:
For load balancers that use dynamic DNS servers, you can configure the Content
Engine, Application Engine, and Process Engine to point the information that is
cached after a failover to the correct address of the active farm node.
14 High Availability
Process Engine farms accessed via a load balancer configured to use a dynamic
DNS server might not be accessible after a failover. In this configuration the load
balancer name-to-address translation is cached by the JVM of the application that
accesses the Process Engine API. After a failover, this cache might be pointing to
an incorrect address for the active farm node.
To configure your applications for correct failover in this type of environment you
must set the Time-To-Live (TTL) setting for host name caching on the following
components:
v Content Engine
v Application Engine
v Component Manager on Application Engine (configuration done
post-installation)
v Workplace XT
v Component Manager on Workplace XT (configuration done post-installation)
v Custom client applications that use the Process Engine API.
Set the Time-To-Live (TTL) to a value that is equal to or less than the TTL for the
DNS server. This will force the application to look up the current name-to-address
translation before attempting to connect to the Process Engine load balancer.
WebLogic Server clusters are a network of WebLogic Server instances that work
together as a server farm to provide a highly available Web service. Each instance
is a fully functioning application server. You can deploy several applications to the
entire cluster, thus making the cluster function as a single unit providing the same
application across all machines in the cluster.
Web clients connect to the cluster through either a cluster aware Proxy application
(an application provided by WebLogic Server which includes built-in load
balancing) or a vendor load balancer. In either case the Web client connects to one
address and is transparently redirected to a machine within the cluster.
Important: The base version of IBM WebSphere Application Server that is bundled
with Content Engine does not include cluster support. To configure clusters, you
must have Content Engine installed on servers that are running the WebSphere
Application Server Network Deployment version.
Web clients can connect to the cluster through a proxy HTTP server. For
WebSphere Application Server Network Deployment, the proxy HTTP server uses
the WebSphere Application Server Network Deployment HTTP plug-in. The HTTP
plug-in is cluster-aware and redirects requests to the cluster of application servers.
Another way to load balance the Application Engine is to use a hardware load
balancer. In that case, the Application Engine can be hosted on either the base
version of WebSphere Application Server or WebSphere Application Server
Network Deployment. The Content Engine's CEWS HTTP transport can also be
load balanced via a hardware load balancer, but WebSphere Application Server
Network Deployment is required for load balancing the EJB transport, if it is used.
See “Load balancer support for IBM FileNet P8” on page 12 for details on load
balancing IBM FileNet P8.
JBoss clusters
JBoss Application Servers can be grouped together into a cluster to provide high
availability, but each server is managed individually.
The server on each node is started and stopped individually, and applications must
be deployed separately to each node unless the optional JBoss "farm" service is
used.
Important: Since the farm service is not necessary for a JBoss Application Server
cluster to operate, it will not be discussed further in this document; applications
are to be deployed individually on each node.
Web clients connect to the cluster through a proxy HTTP server such as Apache
HTTP Server with the Apache Tomcat Connector. The Tomcat Connector, mod_jk,
is configured with the location of each JBoss Application Server in the cluster and
redirects each request to a machine in the cluster. For more information, see JBoss
documentation and “Connecting to a highly available Content Engine” on page 69.
Server clusters
Veritas Cluster Server and Microsoft Cluster Server are two examples of similar
server cluster products. Each machine in the cluster is seen as a node.
16 High Availability
Each node in the cluster monitors the local services it is running and broadcasts
this information on a private network connection. This private network connection
allows all nodes in the cluster to know the status of all clustered resources. In the
event that a service on one node fails, another node receives this status through the
private network connection and in response, can start the service locally to
maintain high availability for the service.
In addition to Oracle being supported by out of the box Veritas high availability
agents, a certified Veritas custom high availability agent for the Process Engine is
provided as part of the IBM FileNet P8 Platform software. See “Installing Process
Engine in a Veritas cluster server (UNIX)” on page 80 for more details on the
Veritas high availability agent for the Process Engine.
Microsoft Cluster Server
Microsoft offers clustering technology within its Windows operating
system. Microsoft Cluster Server (MSCS) offers the ability to set up a
number of Windows cluster nodes in order to provide highly available
services, with functionality similar to other cluster products. The maximum
number of nodes that can be clustered depends on the version of the
operating system being used. For more information, consult your operating
system vendor's documentation.
Veritas Cluster Server
Symantec provides a software package called Veritas Cluster Server (VCS)
that provides a network of servers that are capable of running applications
in a high availability environment with clustered storage.
VCS works by monitoring resources and applications associated with a
provided service (for example an application server, database, or network
storage). When a provided service goes offline on one server in the cluster,
it is automatically started on another node in the cluster.
VCS Agents monitor, start, and stop services in a cluster. Agents are a
middle layer between the user interface, and the services running in a
cluster. Commands are given to the Agents and the Agents are responsible
for fulfilling the command and verifying that everything ran without error.
When you issue a command in VCS to bring a resource offline this is in
effect telling the Agent to go and take the resource offline.
VCS provides a highly configurable framework for creating your own
Agents to control services in a cluster. Symantec also provides, for
purchase, several Agents for popular products such as Oracle, Microsoft
SQL Server, and Microsoft Exchange.
Table 6. Tested server clusters
Vendor Notes
Microsoft Cluster Server Windows
Veritas Cluster Server The Symantec Veritas product runs on a
number of hardware and operating systems
platforms, including:
v AIX
v HP-UX
v Solaris
v Microsoft Windows Server
Content Engine and Process Engine both use database servers to store content. If
the database is inaccessible, users will be unable to add and retrieve content on the
Content Engine or Process Engine. You should include any database services in a
cluster as part of a highly available environment. No additional configuration steps
are necessary on the IBM FileNet P8 side to use highly available database instances
for any FileNet P8 components (with the exception of Oracle Real Application
Clusters as noted in the information later in this section).
Table 7. Tested database services
Vendor Notes
IBM DB2 UDB with Veritas Cluster Server -
Oracle with Veritas Cluster Server -
Oracle RAC See “Oracle RAC.”
SQL Server with Microsoft Cluster Server -
(MSCS)
“Oracle RAC”
In addition to the traditional database server clusters, IBM FileNet P8 platform
components support Oracle Real Application Clusters (RAC). Oracle RAC
allows for the active availability of multiple database servers running in
parallel.
Oracle RAC:
The Oracle client settings required to enable load-balancing and TAF in an Oracle
RAC configuration are not specific to any application, including FileNet P8
platform components. See your Oracle documentation for more information on
how to enable client settings for load balancing and Transparent Application
Failover for your Oracle RAC configuration.
For Oracle clusters: The database server name requires a specific format. For more
information, see “Configuring Content Engine” on page 63 and “Creating object
stores in FileNet P8 4.5.1” on page 67.
18 High Availability
Planning and preparing for high availability
You must prepare your system before you install and upgrade IBM FileNet P8
components in a highly available environment.
This section provides instructions for preparing your system to install and upgrade
the core IBM FileNet P8 components in a highly available environment. Installation
instructions are contained in the IBM FileNet P8 Platform Installation and Upgrade
Guide and separate add on installation guides.
“Planning the installation”
You must plan your system rollout before you install IBM FileNet P8
components in a highly available environment.
“Performing required preparation tasks” on page 35
You must perform the required planning and preparation tasks for the
components you are installing.
Prepare your environment for the installation of a highly available IBM FileNet P8
system. In many cases, the items shown will be links to more detailed information
that will help you plan a system rollout. Review this section thoroughly before you
start to set up IBM FileNet P8 components or required independent software
vendor (ISV) software.
“Understanding the system components”
You should understand the IBM FileNet P8 components and how they are
integrated in a highly available environment in your planning.
“Definition of installation roles” on page 32
The tasks in this guide 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 33
The Installation and Upgrade Worksheet is a Microsoft Excel spreadsheet
(p8_worksheet.xls). The worksheet describes the properties and parameters
required to complete IBM FileNet P8 installation, upgrade, and configuration
programs, and provides a way to record the values you assign to these
properties and parameters.
Follow the general information and high level installation steps to help you plan
the high availability installation of your system components.
“Content Engine” on page 20
Content Engine is a critical component in a highly available environment
Content Engine
Content Engine is a critical component in a highly available environment because
it provides users with access and storage facilities for content. If content is not
accessible due to a system failure, the other IBM FileNet P8 components are
affected as well.
For a general overview of Content Engine deployment options, see the "Planning
Content Engine deployment" topic in the Plan and Prepare Your Environment for IBM
FileNet P8 document.
Content Engine provides access and storage facilities for content. When a critical
component fails, users will no longer have access to existing content or be allowed
20 High Availability
to add new content. When content is no longer accessible Application Engine and
Process Engine components are also affected. This makes the health and stability of
the Content Engine a key factor in creating a highly available IBM FileNet P8
environment.
Option Description
WebSphere Application Server Install to your deployment manager node.
Oracle WebLogic Server Install to your Admin Server node.
Metadata and GCD information are cached and any changes made to these areas
might not be reflected among the other Content Engine nodes until the refresh has
occurred.
The GCD cache value is configurable by using IBM FileNet Enterprise Manager via
the properties page of the IBM FileNet P8 domain in the Server Cache tab.
You can install Content Search Engine in a highly available environment by using
Veritas Cluster Server (VCS) or Microsoft Cluster Server (MSCS) technologies.
22 High Availability
Content Search Engine procedure overview:
The installation of Content Search Engine involves the creation of clusters and
highly available storage locations.
Process Engine
Process Engine allows users to create, manage, control, and participate in
workflows.
The following high-level steps are required to make the Process Engine highly
available in a server farm environment on UNIX or Windows platforms:
1. Install and configure the first Process Engine in the farm as described in the
IBM FileNet P8 Platform Installation and Upgrade Guide.
2. Configure the hardware load balancer.
3. Install subsequent Process Engines on the farm servers as described in the IBM
FileNet P8 Platform Installation and Upgrade Guide with some farm specific
exceptions.
4. Start Process Engine on the additional farmed servers.
5. Refresh the Process Engine node on the Process Task Manager and configure it
for the load balancer.
6. Configure Process Engine for the load balancer. For detailed instructions, see
“Configuring a Process Engine server farm for a hardware load balancer” on
page 74 or “Configuring a Process Engine server farm for a software load
balancer” on page 78.
Server clusters are based on the concept of shared software configuration data
storage, making it suitable for data-centric tiers, such as file servers and data
servers, because their data content is constantly changing. There are various
UNIX-based server clustering products that provide high availability for
data-centric servers.
24 High Availability
The following high-level steps are required to make the Process Engine highly
available in a cluster environment on UNIX platforms:
1. Create partition resources in the cluster for the Process Engine.
2. Perform Process Engine pre-installation and configuration tasks on all nodes.
3. Install the Process Engine software on one node as described in the IBM FileNet
P8 Platform Installation and Upgrade Guide.
4. Configure the Process Engine for the cluster.
5. Move the cluster group to second node (repeat this step for each additional
cluster node).
6. Install Process Engine software on second node (repeat this step for each
additional cluster node) as described in the IBM FileNet P8 Platform Installation
and Upgrade Guide.
7. Create a cluster resource to control the Process Engine (by using one of the
following two methods):
v Install/configure the Veritas Certified FileNet Process Engine Agent.
v Use a generic cluster package to create/configure a resource to control the
Process Engine.
Server clusters are based on the concept of shared software configuration data
storage, making it suitable for data-centric tiers, such as file servers and data
servers, because their data content is constantly changing. There are various
Windows-based server clustering products that provide high availability for
data-centric servers.
The following high-level steps are required to make the Process Engine highly
available in a cluster environment on Windows platforms:
1. Create partition resources in the cluster for the Process Engine.
2. Install Process Engine on one node as described in the IBM FileNet P8 Platform
Installation and Upgrade Guide.
3. Configure Process Engine for the cluster.
4. Move the cluster group to second node (repeat this step for each additional
cluster nodes).
Application Engine/Workplace XT
Application Engine/Workplace XT provides front-end access to IBM FileNet P8
content by using the corresponding Workplace/Workplace XT Web application.
Rendition Engine
In a highly available Rendition Engine environment a number of Rendition Engine
servers share the rendition administration and workload. Together they provide
redundancy in the event of network or server failure. The Liquent software uses a
Liquent Vista domain to track all render servers that have been configured and
joined to the domain.
Each Rendition Engine, controlled by the Liquent Vista domain, polls the Rendition
Engine database for submitted rendition jobs in a round-robin fashion. If a job is
available, the Liquent Vista domain assigns it to one of the available Rendition
Engine servers. In this scenario the Liquent Vista domain, distributed across the
26 High Availability
available Rendition Engine servers, acts as a “load balancer” and assigns jobs to
active Rendition Engine servers. If a server becomes unavailable, the available
Rendition Engine servers pick up the workload.
Tip:
v You can install IBM FileNet Rendition Engine in highly available configurations
by using the standard Rendition Engine installer. No extra software is needed to
set up a highly available Rendition Engine.
v IBM FileNet P8 relies on the built in Liquent high availability for Rendition
Engine 4.5.1.
Restriction: This functionality is new for Rendition Engine 4.0.1 and later, and
the instructions in this chapter do not apply to earlier versions of Rendition
Engine.
v If an Rendition Engine server becomes unavailable during rendering, the job
ticket will fail, and a timeout will occur on the ordering Content Engine server.
After the timeout, Content Engine resubmits the job once before signaling an
error. The new job is picked up by another Rendition Engine server.
The following high-level steps are necessary to configure Rendition Engine for high
availability:
1. Install Content Engine, Process Engine, and Application Engine.
2. Perform prerequisite tasks.
3. Install and configure an initial Rendition Engine.
4. Install and configure additional Rendition Engines.
5. Optional: Verify Installation.
CFS-ICI
Content Federation Services for IBM Content Integrator (CFS-ICI) is an optional
component of the IBM FileNet P8 Platform.
Tip:
The following high-level steps are required to make CFS-ICI highly available:
1. Install Content Engine and Process Engine.
2. Install a highly available Application Engine.
3. Install and configure an application server cluster for Content Federation
Services.
4. Install and configure IICE in the cluster. Follow the installation instructions
provided in the Content Integrator Enterprise Edition Support Web site at
http://www.ibm.com/software/data/content-management/support/content-
integrator/.
5. Configure the CFS-ICI environment.
6. Install and Deploy Content Federation Services.
7. Perform Post Installation Steps.
You can install IBM FileNet eForms for P8 on a server with FileNet P8 Application
Engine or Workplace XT installed. Because IBM FileNet eForms for P8 is an add-on
to the Application Engine or Workplace XT, the same high availability solution for
Application Engine or Workplace XT is used to provide availability for eForms.
“IBM FileNet eForms for P8 procedure overview”
The installation of IBM FileNet eForms for P8 requires the installation of
Application Engine or Workplace XT.
28 High Availability
The following high-level steps are required to make eForms for IBM FileNet P8
highly available:
1. Install IBM FileNet eForms for P8 and appropriate patches, as documented in
the IBM FileNet P8 eForms Installation and Upgrade Guide.
2. If Application Engine or Workplace XT is already deployed then redeploy the
Web application.
3. Perform post-deployment configuration steps as noted in the IBM FileNet
eForms for P8documentation.
Process Analyzer
Process Analyzer provides dynamic, chart-based analyses of workflow activity,
based on information collected from Process Engine or Process Simulator.
Restriction: Process Analyzer does not support storing these files in a single
location shared among cluster nodes, so if the Process Analyzer configuration is
changed in Process Task Manager, these changes should be propagated to all other
nodes. In general, this should be done by copying the files to the other nodes,
although it could also be done by running Process Task Manager on each node and
making the same configuration changes.
In a highly available Process Analyzer configuration, you should make all other
system components highly available:
v SQL Server Database Engine
For details, see “Database services” on page 18.
v SQL Server Analysis Services
For details, see “Database services” on page 18.
v Process Engine Database
For details, see “Database services” on page 18.
v Content Engine (can be farmed)
For details, see “Installing a highly available Content Engine” on page 61.
v Process Engine (can be farmed)
For details, see “Installing a highly available Process Engine” on page 74.
You can install InfoSphere Enterprise Records version 4.5.1 in highly available
configurations by using standard application server clustering software.
Tip:
v This procedure covers installation of the InfoSphere Enterprise Records Web
application only.
v This procedure covers the specific details required for installing InfoSphere
Enterprise Records in an application server cluster rather than on a standalone
server.
v Typically, application servers provide their own clustering/farming (the
terminology differs by vendor) for achieving high availability with a Web
application. Application servers use server farms to make applications highly
available. These are groups of identical servers running the same application
server, which in turn runs the same Web application. A load balancer will
typically direct users to different instances throughout the group of servers.
When one server goes down a user is automatically directed to an already
running instance.
30 High Availability
v For instructions on installing InfoSphere Enterprise Records components such as
the InfoSphere Enterprise Records Sweep Application or Crystal Reports, see the
IBM FileNet Records Manager Installation and Upgrade Guide, version 4.5.1.
“Procedure overview for IBM InfoSphere Enterprise Records”
The installation of IBM InfoSphere Enterprise Records requires the installation
of Content Engine, Process Engine, and Application Engine.
Installation administrator
v Runs IBM FileNet P8 installers during initial setup.
v Runs the Configuration Manager tool during initial setup, followed by starting
IBM FileNet Enterprise Manager.
v Runs IBM 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.
Security administrator
v Responsible for configuring the directory servers required by IBM FileNet P8
components, including Content Engine and Application Engine.
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 IBM 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.
32 High Availability
Application server administrator
v Responsible for providing the application servers required by IBM FileNet P8.
v Responsible for application server administrative accounts.
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.
E-mail Administrator
v Creates an e-mail account that will be used to configure the Notification tab of
the Process Task Manager so that Process Engine can send e-mail notifications to
end users. (Required only if you use this feature.)
v Abbreviated as EA.
AutoFiltering is a quick way to display only those rows that meet a certain criteria.
To use AutoFilter:
34 High Availability
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, PE
installer).
3. Click the AutoFilter arrow in the Setup Type column header, select Custom,
and specify Setup Type contains Installation.
4. For a custom AutoFilter, click the AutoFilter in any column header, select
Custom, and specify Setup Type contains “Installation”.
5. To turn off AutoFiltering in a column, click the column AutoFilter arrow and
select (All).
6. 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.
Important: In addition to the preparation tasks later in this section, follow the plan
and prepare instructions in the Plan and Prepare Your Environment for IBM FileNet
P8 document for the components you are installing. For add-on components,
follow the plan and prepare instructions in the corresponding installation guide.
Note that some of the tasks might replace the tasks described for a non highly
available environment.
If you are using the Installation and Upgrade Worksheet for your environment, all
administrators should complete the worksheet with the relevant information as
described in “Using the installation and upgrade worksheet” on page 33.
“Installation administrator tasks” on page 36
You must complete the installation administrator tasks for the different IBM
FileNet P8 components.
“Information technology administrator” on page 37
You must complete the information technology administrator tasks for the
different IBM FileNet P8 components.
“Security administrator tasks” on page 47
You must complete the security administrator tasks for the IBM FileNet P8
components.
“Database administrator tasks” on page 48
You must complete the database administrator tasks for the IBM FileNet P8
components.
Content Engine
In addition to the tasks later in this section, review and perform the required
Content Engine tasks in the "Performing required preparation tasks" section of the
Plan and Prepare Your Environment for IBM FileNet P8 guide.
Remember: File store data must still be shared. For more information, see
“Configuring file stores for high availablilty” on page 65.
In addition to the tasks shown later in this section, review and perform the
required Content Search Engine tasks in the "Performing required preparation
tasks" section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
Process Engine
In addition to the tasks shown later in this section, review and perform the
required Process Engine tasks in the "Performing required preparation tasks"
section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
Application Engine/Workplace XT
In addition to the tasks shown later in this section, review and perform the
required Application Engine or Workplace XT tasks in the "Performing required
preparation tasks" section of the Plan and Prepare Your Environment for IBM FileNet
P8 guide.
Rendition Engine
In addition to the tasks shown later in this section, review and perform the
required Rendition Engine tasks in the "Performing required preparation tasks"
section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
CFS-ICI
In addition to the tasks shown later in this section, review and perform the
required Content Federation Services tasks in the "Performing required preparation
36 High Availability
tasks" section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
eForms
In addition to the tasks shown later in this section, review and perform the
required IBM FileNet eForms for P8 tasks in the "Performing required preparation
tasks" section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
Process Analyzer
In addition to the tasks shown later in this section, review and perform the
required Process Analyzer tasks in the "Performing required preparation tasks"
section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
Before you begin the installation, ensure that all prerequisites are completed. For
details, see "Installation planning considerations" in the IBM FileNet Connector for
SharePoint Web Parts Installation and Upgrade Guide.
Before you begin the installation, ensure that all prerequisites are completed. For
details, see "Installation Planning Considerations" in the IBM FileNet Connector for
SharePoint Document Libraries Installation and Upgrade Guide.
You can update the k2_os_user profile when you install Content Search Engine on
UNIX.
If you are installing Content Search Engine on UNIX, add the following lines to the
profile of the k2_os_user user:
CATALINA_PID=verity_install_path/data/host/log/catalina.pid
export CATALINA_PID
You must create three separate directories when you install Content Search Engine.
Create highly available file shares to store the Content Search Engine binary files
and configuration files, and mount these directories from each Content Search
Engine cluster node at the following locations:
Table 8. Content Search Engine shared directories
File share Mount point UNIX Mount point Windows
Binary Share /opt/IBM/verity Drive:\Program
Files\IBM\FileNet\
ContentEngine\verity
Temp DirectoryShare /opt/IBM/verity/tmp Drive:\Program
Files\IBM\FileNet\
ContentEngine\verity\tmp
38 High Availability
Table 8. Content Search Engine shared directories (continued)
File share Mount point UNIX Mount point Windows
Collections Share /opt/IBM/verity/ Drive:\Program
collections Files\IBM\FileNet\
ContentEngine\verity\
collections
Application Engine/Workplace XT
You can install and configure Application Engine/Workplace XT in a highly
available FileNet P8 environment to provide access to the IBM FileNet P8 content
on the corresponding Application Engine/Workplace XT Web application.
You can create a local or shared directory for the shared configuration files.
For more information on the use of the shared configuration directory and how to
manage it see “Managing Workplace/Workplace XT settings in a highly available
environment” on page 106.
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.
Process Engine
You can install and configure Process Engine in a highly available FileNet P8
environment to create and manage workflows that selectively route your business
information to the appropriate users on your system.
You can configure your hardware load balancer to forward and monitor TCP traffic
on ports 32776 (IOR) and 32777 (broker) only.
For information about required and default ports for your environment, see the
IBM FileNet P8 Ports appendix in the Plan and Prepare Your Environment for IBM
FileNet P8 document.
You can configure the Process Engine nodes hosts files for your server farms and
server clusters.
Server Farm
For each Process Engine server, configure the hosts file on each node in the farm
to:
v Include the network name for every other node in the farm.
v Identify the loadbalancer virtual as itself.
40 High Availability
loadbalancer_virtual_name is the load balancer virtual name, and PE_farm1_server
(1.2.3.4), PE_farm2_server (1.2.3.5), and PE_farm3_server (1.2.3.6) are three Process
Engine servers with unique network addresses and network names for each server.
For UNIX: Verify that the nsswitch.conf file (AIX netsvc.conf and/or irs.conf)
is configured to resolve names via the local hosts file first.
Server Cluster
Configure the hosts file on each cluster node server to follow the following format:
where:
v 1.2.3.4 is the network address for the cluster. This is the address used for the
Clustered IP resource.
v cluster_virtual_name is the name of the cluster.
v local_node_server1 and local_node_server2 are the network names for the Process
Engine servers.
You must configure your UNIX operating system for Process Engine clusters.
Configure operating system accounts for Process Engine. The accounts you create
will depend on the Process Engine server's operating system and the database the
Process Engine will connect to. These accounts must be created on all Process
Engine nodes with identical properties.
Follow the procedures in the tasks applicable to your operating system for
configuring UNIX. When creating partitions:
v It is recommended that the /fnsw/ partition be placed on a local (non-clustered)
storage. The Process Engine binaries are placed in the /fnsw directory and if they
are taken offline there will be no binaries available to shutdown, clean, or
troubleshoot a failed node.
v Create the /fnsw/local partition as a clustered storage resource. Refer to
Installing and configuring Veritas Cluster Server (UNIX) for details.
42 High Availability
directory. Clustering this location ensures that each node uses consistent
information and provides the same data to all users.
You can set up a secure native domain installation to perform a Process Engine
cluster installation in an IBM FileNet P8 environment without Domain
Administrator privileges.
To set up a secure native domain installation, you must first configure the domain
controller by creating FileNet groups and FileNet users and adding nodes to the
Pre-Windows 2000 Compatible Access properties.
Important: The oracle user name is required even if you have a Microsoft SQL
Server relational database. The Process Engine installer checks for this name
and fails if it is not found.
Tip: If you are planning to install Microsoft SQL Server, you do not need to
create a special user for the RDBMS software. The SQL Server installer
configures the system for use with the SQL Server software.
3. Add Nodes to Pre-Windows 2000 Compatible Access Properties.
a. On the Active Directory Users and Computers window, click the Builtin
folder.
b. Right-click the Pre-Windows 2000 Compatible Access object and select
Properties, as shown previously.
c. Click on the Members tab, and click the Add button.
d. Select Node 1 and click the Add button.
e. Select Node 2 and click the Add button.
f. Click OK on the Select Users, Contacts, Computers, or Groups dialog box.
The Pre-Windows 2000 Compatible Access Properties window displays again
and shows that the two nodes have been added.
g. Click Apply on the Pre-Windows 2000 Compatible Access Properties dialog
box to apply the changes.
h. Click OK to close the Pre-Windows 2000 Compatible Access Properties
window.
i. Click OK to close the Active Directory Users and Computers window.
To set up a secure native domain installation, you must configure node servers
after you configure the domain controller.
Perform these procedures on the node 1 server first, and then repeat them on the
remaining servers.
44 High Availability
a. Turn-on the node servers and logon as Domain Administrator on each
server.
b. Open a Command Prompt window.
c. From the C: drive, change to the \temp directory by entering: cd \temp.
Tip: If the temporary directory does not exist on the C: drive, use the
mkdir command to create one.
d. At the \temp directory, type the following command and press enter: copy
con LocalAdminInstall
e. Press and hold Ctrl key, and press the Z key.
f. Press Enter.
g. Verify that the LocalAdminInstall file was successfully created in the
C:\temp directory.
2. Create Local FileNet Groups.
On the node servers, create the following local groups:
Table 12. Local groups
Group name Group description
dba Members should be domain fnsw and
domain oracle.
Process Analyzer
You can install Process Analyzer in a highly available FileNet P8 environment.
Process Analyzer provides chart-based analyses of the workflow activity on your
system by using information that it collects from Process Engine or Process
Simulator.
You can create a shared Temporary directory on the Process Analyzer Engine
server and grant full access rights on the folder to the pa_administrator. You must
set full access rights on the Security and Sharing tabs.
The shared temporary directory must be highly available and part of the group of
resources configured for Process Analyzer. For performance reasons, it should be
located on the same cluster as Process Analyzer.
You can configure the Microsoft Cluster Server Process Analyzer Resource Group
to add resources to the cluster.
46 High Availability
Security administrator tasks
You must complete the security administrator tasks for the IBM FileNet P8
components.
Rendition Engine
You can install and configure multiple Rendition Engine components in a highly
available FileNet P8 environment to share the rendition administration and
workload to provide redundancy in the event of a system failure.
Complete the Security Administrator planning and preparation tasks for the
Rendition Engine components.
“Assigning the FNRE_Admin user”
You must assign the FNRE_Admin user to the Rendition Engine servers.
You must assign the FNRE_Admin user to the Rendition Engine servers.
Important: Use the same named account with the same password on all
Rendition Engine servers.
You must verify the user performing the installation has the correct access
requirements.
When installing IBM InfoSphere Enterprise Records, the installer will create a
number of directory structures, and install the InfoSphere Enterprise Records files
Complete the Database Administrator planning and preparation tasks for Content
Engine included in the Plan and Prepare Your Environment for IBM FileNet P8 Guide.
“Oracle RAC configuration” on page 49
You can install an Oracle RAC database and synchronize the Oracle nodes.
48 High Availability
Related tasks
Preparing Microsoft SQL Server
Plan the SQL Server installation and configuration, install the software, and
configure database components for IBM FileNet P8 components after reviewing the
requirements.
Preparing Oracle server
To prepare your Oracle databases, you must install the database software, and
configure database components for IBM FileNet P8.
Preparing DB2 for z/OS servers
Plan the DB2 for z/OS® installation and configuration, install the software, and
configure database components for IBM FileNet P8 components.
Preparing DB2 for Linux, UNIX and Windows servers
Plan and prepare your IBM DB2 for Linux®, UNIX and Windows servers for IBM
FileNet P8 installation.
Configuring Microsoft SQL Server client for Process Engine
To configure your database clients for Process Engine, you must create ODBC data
sources and, if required, install Microsoft SQL Server Client software for Process
Engine.
Configuring Oracle client for Process Engine
Install the Oracle Client software to prepare for the installation of Process Engine.
Content Engine does not require installation of Oracle Client software.
Configuring DB2 client
Configure the DB2 client. Configuration requirements will be different for Content
Engine and Process Engine and will vary between DB2 for Linux, UNIX and
Windows and DB2 for z/OS.
You can install an Oracle RAC database and synchronize the Oracle nodes.
Do the following to ensure that your Oracle nodes are properly synchronized.
Oracle 9i
If you are using Oracle 9i RAC with IBM FileNet P8, then you must
configure the database instance for Broadcast on Commit (BOC) by setting
the MAX_COMMIT_PROPAGATION_DELAY to a value of 0. You must do
this on all databases that Content Engine uses.
Oracle 10g and 11g
If you are using Oracle 10g or 11g RAC with FileNet P8, you should have
created Oracle users and groups and granted the appropriate permissions
to the ce_db_user when you created Content Engine database accounts. For
more information, see Plan and Prepare Your Environment for IBM FileNet P8.
Rendition Engine
You can install and configure multiple Rendition Engine components in a highly
available FileNet P8 environment to share the rendition administration and
workload and provide redundancy in the event of a system failure.
Complete the Database Administrator planning and preparation tasks for the
Rendition Engine components.
You can configure remote databases to make them available to all the Rendition
Engine servers on the system.
Perform all required Prerequisite tasks as outlined in the IBM FileNet Rendition
Engine Installation and Upgrade Guide, with the following modifications:
Table 13. Remote database configuration tasks
Server Perform
SQL Server "Install Microsoft SQL Server for Rendition
Engine" task.
In a JBoss cluster environment Application Engine and Content Engine must reside
in separate JBoss clusters. Unless given a unique name, all JBoss nodes will be part
of the cluster "Default."
50 High Availability
For each Application Engine node, uniquely name the cluster something other than
default.
Update the JBoss startup file on both Application Engine cluster nodes from:
JBOSSSH=${JBOSSSH:-"$JBOSS_HOME/bin/run.sh -c $JBOSS_CONF -b $JBOSS_HOST"}
to
JBOSSSH=${JBOSSSH:-"$JBOSS_HOME/bin/run.sh -c $JBOSS_CONF -b $JBOSS_HOST"}
-Djboss.partition.name=JBossP8AE
Application Engine/Workplace XT
You can install and configure Application Engine/Workplace XT in a highly
available FileNet P8 environment to provide access to the IBM FileNet P8 content
on the corresponding Application Engine/Workplace XT Web application.
Complete the Application Server Administrator planning and preparation tasks for
Application Engine/Workplace XT.
“Configure the application server”
You can create clusters of supported application servers.
“Configuring load-balancer or proxy server” on page 52
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 53
You can store Workplace/Workplace XT settings in a shared configuration
directory. This directory can reside on a shared device as needed.
“Planning for Component Manager” on page 53
If you will use Component Manager, you must install and run it on each node
in the application server configuration.
52 High Availability
a. Create the p8bpmsystems.properties configuration file in the JRE/LIB
directory of the application server, or in the JRE/LIB directory of the
Component Manager. For example, for WebSphere on Windows, create:
C:\Program Files\IBM\WebSphere\AppServer\
java\jre\lib\p8bpmsystems.properties
b. Add this line to the file:
filenet.pe.ior.cache.ttl.in.seconds=TTL
Where TTL is the IOR cache time-to-live in seconds. For example, to set the
IOR cache time-to-live to 30 seconds:
filenet.pe.ior.cache.ttl.in.seconds=30
If you will use Component Manager, you must install and run it on each node in
the application server configuration.
Complete the Application Server Administrator planning and preparation tasks for
Content Engine.
“Installing JDBC drivers for your selected database”
You can install JDBC drivers for your databases on all of the nodes in the
Content Engine cluster.
“Installing and configuring the application server for high availability”
You can configure the application server cluster to make Content Engine highly
available.
“Configuring the application server for Content Engine”
You must configure the application server for Content Engine with modified
settings for high availability.
“(WebSphere only) Configure Light weight Third Party Authentication (LTPA)”
on page 56
You must configure the WebSphere application for Light weight Third Party
Authentication (LTPA) with specific modifications for high availability.
“Configuring load-balancer or proxy server” on page 56
You can configure the load-balancer or proxy server to manage user requests
over multiple application servers.
You can install JDBC drivers for your databases on all of the nodes in the Content
Engine cluster.
Install the jdbc driver on all nodes in the Content Engine cluster, add the jdbc
driver to the classpath for all servers.
You can configure the application server cluster to make Content Engine highly
available.
54 High Availability
You must configure the application server for Content Engine with modified
settings for high availability.
1. Configure the application server on each node by following the instructions in
the Plan and Prepare Your Environment for IBM FileNet P8 Guide with the
following modification:
v WebSphere Application Server:
Follow the instructions in the Plan and Prepare Your Environment for IBM
FileNet P8 Guide for configuring WebSphere Application Server for Content
Engine, bet the JDBC parameters for the nodes by using the administrative
console, not the individual servers.
v WebLogic Server:
Follow the instructions in the Plan and Prepare Your Environment for IBM
FileNet P8 Guide for configuring WebLogic Server for Content Engine.
v JBoss Application Server:
Follow the instructions in the Plan and Prepare Your Environment for IBM
FileNet P8 Guide for configuring JBoss Application Server for Content
Engine, but use JBOSS_DIST/all as the base configuration file set instead of
JBOSS_DIST/server.
2. (F5 using 3DNS for load balancing by DNS routing) Configure the IOR cache
time-to-live for applications accessing a farmed Process Engine. In a farmed
Process Engine environment where you use F5 for load balancing by using
DNS routing and the 3DNS method, you must configure the client machine
IOR (Interoperable Object Reference) cache time-to-live to a value smaller than
the default 3600 seconds, matching the DNS TTL set for the 3DNS. Having a
cache time-to-live that is longer than the 3DNS TTL will cause the calls to be
routed to only one Process Engine server instead of the preferred Process
Engine server as intended by the 3DNS routing. The cache time-to-live is set by
using the system property filenet.pe.ior.cache.ttl.in.seconds.
The configuration is required for the following components:
v Content Engine
v Application Engine
v Component Manager on Application Engine (configuration done
post-installation)
v Workplace XT
v Component Manager on Workplace XT (configuration done post-installation)
v Custom client applications that use the Process Engine API.
a. Create the p8bpmsystems.properties configuration file in the JRE/LIB
directory of the application server, or in the JRE/LIB directory of the
Component Manager. For example, for WebSphere on Windows, create:
C:\Program Files\IBM\WebSphere\AppServer\
java\jre\lib\p8bpmsystems.properties
b. Add this line to the file:
filenet.pe.ior.cache.ttl.in.seconds=TTL
Where TTL is the IOR cache time-to-live in seconds. For example, to set the
IOR cache time-to-live to 30 seconds:
filenet.pe.ior.cache.ttl.in.seconds=30
You must configure the WebSphere application for Light weight Third Party
Authentication (LTPA) with specific modifications for high availability.
To configure LTPA on the Content Engine cluster, follow the instructions in the
IBM FileNet P8 Platform Installation and Upgrade Guide for configuring Light weight
Third Party Authentication (LTPA) for the version of WebSphere you are running,
with the following modifications:
1. Set timeout to 60,000.
2. After saving your configuration settings, synchronize the changes across all
nodes.
3. If your environment uses Workplace, follow the second part of the "Configure
Light weight Third Party Authentication (LTPA)" step to configure the
Application Engine server for LTPA.
4. If your environment uses Workplace XT, follow the second part of the
"Configure Light weight Third Party Authentication (LTPA)" step in the IBM
FileNet Workplace XT Installation and Upgrade Guide task "Configure IBM FileNet
Workplace XT( <Application server> )" to configure the Workplace XT server
for LTPA.
Related tasks
Configuring Lightweight Third Party Authentication (LTPA)
To set up LTPA security, configure settings to match on both the Content Engine
application server and the Application Engine application server. If your
Application Engine and Content Engine are on the same WebSphere Application
Server, you are not required to configure LTPA.
Related information
Download the IBM FileNet Workplace XT Installation and Upgrade Guide
Download IBM FileNet Workplace XT Installation and Upgrade Guide, as well as
other IBM FileNet P8 documentation.
You can configure the load-balancer or proxy server to manage user requests over
multiple application servers.
56 High Availability
The following are requirements for configurations by using a load-balancer or
proxy-server:
v Session affinity is required for Application Engine and Workplace XT only.
v Virtual server name.
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 Engine server, with the exception of IBM FileNet Enterprise Manager
and other administrative applications. For more information, see “Connecting to
a highly available Content Engine” on page 69.
CFS-ICI
You can install Content Federation Services for IBM Content Integrator (CFS-ICI)
on an application server cluster.
The application server must have a cluster instance configured and it must be
ready for applications to be deployed.
To install CFS-ICI:
1. Install and configure an application server cluster for CFS-ICI.
2. Verify that the cluster nodes and load balancers are started.
Process Engine
You can install and configure Process Engine in a highly available FileNet P8
environment to create and manage workflows that selectively route your business
information to the appropriate users on your system.
Complete the Application Server Administrator planning and preparation tasks for
Process Engine.
“Configuring software load balancer”
You can configure your software load balancer to forward and monitor TCP
traffic on ports 32776 (IOR) and 32777 (broker) only.
For information about required and default ports for your environment, see the
IBM FileNet P8 Ports appendix in the Plan and Prepare Your Environment for IBM
FileNet P8 document.
Follow the required steps to install and configure a highly available IBM FileNet
P8 4.5.1 environment.
“Overview” on page 60
Depending on your configuration, you might have to install at least a portion
of the additional fix pack and interim fix software while you work your way
through the standard IBM FileNet P8 platform installation.
“Installing FileNet P8 components in a highly available environment” on page
60
When you install FileNet P8 components in a highly available environment,
you must include HA-specific modifications in the procedures.
“Installing a highly available Content Engine” on page 61
You can install Content Engine on a server cluster or farm to make it highly
available in an IBM FileNet P8 environment.
“Installing a highly available Process Engine” on page 74
You can install Process Engine in a highly available IBM FileNet P8
environment.
“Installing a highly available Application Engine/Workplace XT” on page 100
You can install Application Engine/Workplace XT in a highly available
environment.
“Installing a highly available Rendition Engine” on page 109
To enable the rendering of HTML and PDF documents in your highly available
FileNet P8 environment, install Rendition Engine.
“Installing a highly available Business Process Framework” on page 111
Business Process Framework is an optional component of IBM FileNet P8
Platform which you can install and configure for high availability in a
supported IBM FileNet P8 environment.
“Installing a highly available Content Search Engine” on page 118
Use this procedure to install and configure IBM FileNet Content Search Engine,
an optional component based on the Autonomy K2 product, in your highly
available IBM FileNet P8 environment.
“Installing a highly available CFS-ICI” on page 121
You can install Content Federation Services for IBM Content Integrator
(CFS-ICI) in a highly available IBM FileNet P8 environment.
“Installing a highly available IBM FileNet eForms for P8” on page 125
You can install and configure IBM FileNet eForms for P8 to be highly available
in an IBM FileNet P8 environment.
“Installing a highly available Process Analyzer” on page 126
You can install and configure Process Analyzer to be highly available in an IBM
FileNet P8 environment.
“Installing a highly available IBM InfoSphere Enterprise Records” on page 129
You can install IBM InfoSphere Enterprise Records in a highly available IBM
FileNet P8 environment.
“Installing a highly available IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2” on page 133
You can install and configure IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2 to be highly available in an IBM FileNet P8 environment.
© Copyright IBM Corp. 2001, 2009 59
“Installing a highly available IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2.1” on page 137
You can install and configure IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2.1 to be highly available in an IBM FileNet P8 environment.
“Installing a highly available IBM FileNet Connector for Microsoft SharePoint
Document Libraries 2.2” on page 141
You can install and configure IBM FileNet Connector for Microsoft SharePoint
Document Libraries 2.2 to be highly available in an IBM FileNet P8
environment.
“Configuration and startup tasks” on page 148
After you install the IBM FileNet P8 components, there are some additional
steps to configure the IBM FileNet P8 system in a highly available environment.
Overview
Depending on your configuration, you might have to install at least a portion of
the additional fix pack and interim fix software while you work your way through
the standard IBM FileNet P8 platform installation.
For more information about available service packs and interim fixes, see the IBM
FileNet P8 Release Notes® and the IBM FileNet P8 Platform Installation and Upgrade
Guide.
60 High Availability
Installing Process Engine at this stage makes it possible to verify that Process
Engine functionality after Application Engine comes online.
For more information, see “Installing a highly available Process Engine” on page
74.
v Application Engine/Workplace XT Server Farm.
This step involves installing and configuring a highly available Application
Engine/Workplace XT.
As Workplace XTApplication Engine/Workplace requires all other FileNet P8
components online in order for you to log in, browse content, and perform any
activities with the Process Engine, it is most often the component that is
installed and configured last.
For more information, see “Installing a highly available Application
Engine/Workplace XT” on page 100.
Follow the tasks and requirements for making Content Engine highly available in
an IBM FileNet P8 environment.
“Installation and deployment tasks”
You can install and deploy FileNet P8 in a highly available environment.
“Creating object stores in FileNet P8 4.5.1” on page 67
Before you can complete your system setup, you must create at least one object
store.
“Connecting to a highly available Content Engine” on page 69
The configuration of the Content Engine connection in a highly available
environment depends on the type of application you want to connect to the
Content Engine. You can configure administrative applications or user
applications to connect to the Content Engine.
“Enabling application server connections after database failover” on page 71
If the database fails over in your environment, your application server must be
able to reconnect.
“Verifying the Content Engine installation and failover” on page 74
You can verify that the Content Engine installation succeeded by using
Enterprise Manager to create a folder and a document in each object store and
then check the new document out and in.
Follow the tasks and requirements for installing and deploying IBM FileNet P8 in a
highly available in an environment.
“Installing Content Engine and related client software” on page 62
You must install the Content Integrator software and related client software to
place the binary files for its components on the server. Install the software on
the web application administrative server.
“Configuring Content Engine” on page 63
You must prepare the Content Engine application for deployment on the
application server in a highly available environment.
62 High Availability
3. Install Content Engine software updates. Follow the instructions in the IBM
FileNet P8 Platform Installation and Upgrade Guide.
4. Install the latestContent Search Engine Client files on all servers where Content
Engine is installed. Follow the instructions in the IBM FileNet P8 Platform
Installation and Upgrade Guide.
5. Install the latest Process Engine Client files on all servers where Content Engine
is installed. Follow the instructions in the IBM FileNet P8 Platform Installation
and Upgrade Guide.
Related tasks
Installing Content Engine
See the full instructions for installing Content Engine in the IBM FileNet P8
Platform Installation and Upgrade Guide.
Configuring Content Engine instances
See the instructions for configuring Content Engine instances in the IBM FileNet P8
Platform Installation and Upgrade Guide.
Installing the latest Process Engine Client files on Content Engine servers
See the instructions for installing the latest Process Engine Client files on Content
Engine servers in the IBM FileNet P8 Platform Installation and Upgrade Guide.
Deploying Content Engine instances
See the instructions for deploying Content Engine instances in the IBM FileNet P8
Platform Installation and Upgrade Guide.
Deploying Content Engine to additional JBoss servers in a cluster
See the instructions for deploying Content Engine to additional JBoss servers in a
cluster in the IBM FileNet P8 Platform Installation and Upgrade Guide.
64 High Availability
Restriction: JBoss Application Server clusters do not have an administrative
server. When installing Content Engine choose a single JBoss Application Server
node on which to install Content Engine, then copy the necessary files to the
rest of the nodes in the cluster. To deploy a Content Engine instance on each
additional JBoss Application Server in your cluster, follow the instructions for
deploying Content Engine to additional JBoss servers in a cluster in the IBM
FileNet P8 Platform Installation and Upgrade Guide.
Tip:
v A fixed file store comprises a file system-based front-end, similar to a
standard file store, and a remote storage system such as Centera or
NetApp/IBM N-Series SnapLock.
v The method and technology used to make file store data highly available can
vary greatly, from file servers built on general-purpose hardware and cluster
technology, such as Veritas Cluster Server or IBM HACMP™, to specialized
devices with built-in high availability such as NAS- and SAN-based offerings
from EMC, NetApp or IBM.
v The implementation and use of these technologies vary, but they can all be
used to provide highly available access to data so long as they meet the
criteria discussed in this section.
Perform the post-deployment configuration steps for your Web application server.
Follow the instructions in the IBM FileNet P8 Platform Installation and Upgrade
Guide.
where ce_server is the name of one of the servers in the farm and port is the
WSI port used by the Web application server where Content Engine is
deployed.
b. For each server node in your configuration, in a browser, go to:
http://ce_server:port/FileNet/Engine
where ce_server is the name of one of the servers in the farm and port is the
WSI port used by the Web application server where Content Engine is
deployed.
c. View the startup context name of the load-balancer or proxy device to verify
the functionality of the load-balanced environment, or the name of the
physical server to verify a single server.
3. Verify Content Engine access through the load balancer.
a. Browse to:
http://ce_load_balancer:port/FileNet/Engine
Tip:
66 High Availability
v Depending on your configuration you can connect to the load balanced
Content Engine installation, and after confirming that Content Engine is up
and running, you can refresh your browser to have the load balancer cycle
through all managed nodes for verification.
v For JBoss Application Server, this cyclic verification will not work because
JBoss Application Server only reports the name of the cluster and not the
individual servers.
Related tasks
Creating the data sources for an object store
See the instructions for creating the data sources for an object store in the IBM
FileNet P8 Platform Installation and Upgrade Guide.
Creating the initial object store
See the instructions for creating the initial object store in the IBM FileNet P8
Platform Installation and Upgrade Guide.
Verifying the Content Engine installation
See the instructions for verifying the Content Engine installation in the IBM FileNet
P8 Platform Installation and Upgrade Guide.
To create the IBM FileNet P8 domain and Global Configuration Data (GCD), follow
the instructions in the IBM FileNet P8 Platform Installation and Upgrade Guide.
After you complete this step, every other Content Engine server instance that starts
in a farm or application server cluster can see the FileNet P8 domain.
Related tasks
Establishing the FileNet P8 domain and Global Configuration Data (GCD)
With Content Engine installed and deployed, you must use IBM FileNet Enterprise
Manager to create a FileNet P8 domain. You can also use Enterprise Manager to set
a URL to the FileNet P8 online help if you did not specify the location when you
ran the Content Engine installation program.
2. Create the initial object store. Follow the instructions in the IBM FileNet P8
Platform Installation and Upgrade Guide.
68 High Availability
Related tasks
Creating the data sources for an object store
See the instructions for creating the data sources for an object store in the IBM
FileNet P8 Platform Installation and Upgrade Guide.
Creating the initial object store
See the instructions for creating the initial object store in the IBM FileNet P8
Platform Installation and Upgrade Guide.
Verifying the Content Engine installation
See the instructions for verifying the Content Engine installation in the IBM FileNet
P8 Platform Installation and Upgrade Guide.
Due to the built-in lag in metadata synchronization across the Content Engine
nodes, changes made on one node are not synchronized immediately after a
configuration change is made via an administrative application. For more
information, see “Content Engine cache refresh delays” on page 22.
In the event the configured Content Engine fails you must reconfigure your
administrative applications to point to a different Content Engine node. For
information, go to the IBM FileNet P8 online help and navigate to System
Administration → Content Engine Administration → FileNet P8 Domain → How
to... → Logon to a domain dialog box.
User applications such as Workplace and Workplace XT are content and process
centric applications used in everyday production to check documents in and out
and access workflows, for example.
For clients such as Application Engine that use an EJB transport to communicate
with Content Engine in an application server cluster configuration, you must use
an URL with a format different from non-highly available configurations.
Restriction: In these examples, the “cemp” portion at the beginning of the URI is
required by IBM FileNet P8 applications, such as Workplace and Workplace XT. If
you are developing and using your own applications, the “cemp” prefix is not
required.
This configuration requires the WebSphere cluster name in addition to the node
names as part of the URL. The default bootstrap port (for example, 9810) is
different from the non-default (for example, 2809) on a non cluster configuration
(that is, a standalone WebSphere installation).
Only one URL is used regardless of SSL use. When using WebSphere an SSL
connection is automatically established by using this transport if the SSL port is
enabled for the WebSphere application server instance.
Example: cemp:corbaloc::testnode1:9810,:testnode2:9810/cell/clusters/
testwascluster/FileNet/Engine
70 High Availability
Non-SSL
cemp:t3://node1 name:node1 port ,node2 name:node2 port
/FileNet/Engine
Even though the individual server names are shown, Oracle WebLogic Server will
load-balance requests through the EJB transport to the Content Engine if the server
instances are part of a Oracle WebLogic Server cluster.
Example: cemp:t3://testnode1:7001,testnode2:7001/FileNet/Engine
The behavior of JBoss Application Server is the opposite of Oracle WebLogic Server
in the previous note; instead of load-balancing through the shown servers, JBoss
Application Server tries the list in order and connects to the first server that
responds.
Example: cemp:jnp://testnode1:1100,testnode2:1100/FileNet/Engine
Applications like Process Engine use the Content Engine CEWS transport to
connect to the Content Engine. This transport can utilize load-balancers to balance
requests to Content Engine servers in a highly available configuration. In this type
of configuration a virtual server name is used by clients to access the Content
Engine.
Use the virtual server name of the load-balancing device when configuring a
connection to Content Engine to ensure that applications will function in the event
of a Content Engine failure.
Example:
http://testvirtual1:7001/wsi/FNCEWS40MTOM/
72 High Availability
7. Save your changes.
To enable JBoss Application Server connection to the GCD and object store
databases after failover:
1. Open the JBoss_HOME/server/all/deploy/*-ds.xml files that you created for the
your data sources in a text editor.
2. Uncomment the following lines, depending on your database type:
Option Description
DB2 <check-valid-connection-sql>
SQL statement
</check-valid-connection-sql>
Follow the tasks and requirements for making Process Engine highly available in
an IBM FileNet P8 environment.
“Configuring a Process Engine server farm for a hardware load balancer”
You can configure a Process Engine server to use a hardware load balancer.
“Configuring a Process Engine server farm for a software load balancer” on
page 78
You can configure a Process Engine server farm to use WebSphere Edge
Components as a software load balancer. This functionally is supported on IPv4
networks only.
“Installing Process Engine in a Veritas cluster server (UNIX)” on page 80
You can install Process Engine in a Veritas cluster server on a UNIX platform.
“Installing Process Engine in a Veritas cluster server (Windows)” on page 86
You can install Process Engine in a Veritas cluster server on a Windows
platform.
“Installing Process Engine in a Microsoft cluster server” on page 92
You can install Process Engine in a Microsoft cluster server.
“Migrating Process Engine clusters to farms (UNIX, Windows)” on page 97
You can migrate existing Process Engine clusters to server farms.
“Process Engine database reconnection” on page 98
When the Process Engine is disconnected from the database, the system tries to
create a new connection.
74 High Availability
1. Verify that you have performed the required preparation tasks as shown in
“Performing required preparation tasks” on page 35.
2. Install the Process Engine software and the Content Engine client software on
the first Process Engine in the farm as described in the IBM FileNet P8 Platform
Installation and Upgrade Guide.
3. Verify that your hardware load balancer is set up to forward and monitor TCP
ports 32776 and 32777.
4. Verify that the load balancer virtual name (loadbalancer_virtual_name ) is in the
host file of the local Process Engine server and that it resolves to that Process
Engine server IP address (IPv4 or IPv6), as shown in Table 17 on page 76.
where:
v loadbalancer_virtual_name is the load balancer variable name. For
example, in the following table showing example host file entries, the
loadbalancer_virtual_name is pe_farm. When configuring isolated region
connections points, use the loadbalancer_virtual_name as the DNS name.
v port# is the port on the Process Engine server used for the vworbbroker
process handling RPCs from the Process Engine API clients. The default
value is 32777.
In this case the hosts file on one of the nodes in the Process Engine farm
might look like this:
For more information, see “Configuring the Process Engine nodes hosts
file” on page 40.
d. Restart the software when prompted after applying the setting for the
vworbbroker.endPoint.
8. (Dual stack IPv4 and IPv6 only) From Process Task Manager, add the
hardware load balancer virtual name registered in DNS for each Process
Engine farm node.
a. Start Process Task Manager (vwtaskman), on the first Process Engine node if
it is not already running.
b. Expand Process Engine → Servers nodes and select the Process Engine
node server to configure.
c. On the Advanced page, add the vworbbroker.endPoint property:
Table 18. vworbbroker.endPoint properties for dual stack environments
Internet protocol version Property entry
IPv6 and IPv4 vworbbroker.endPoint = iiop:
//1.2@pe_server_ipv6_address
:port#,pe_server_ipv4_address:port#
/hostname_in_ior
=loadbalancer_virtual_name
where:
v pe_server_ipv6_address is the IPv6 address of the Process Engine Server.
The format entered in the string for an IPv6 address must have the IPv6
address enclosed in square brackets '[' ']' For example:
[2007::9:181:124:200]
v pe_server_ipv4_address is the address of the Process Engine server in IPv4
format.
v loadbalancer_virtual_name is the load balancer variable name. For
example, in the following table showing example host file entries, the
loadbalancer_virtual_name is pe_farm. When configuring isolated region
connections points, use the loadbalancer_virtual_name as the DNS name.
v port# is the port on the Process Engine server used for the vworbbroker
process handling RPCs from the Process Engine API clients. The default
value is 32777.
The address and port pairs are separated by a comma. For example, add
iiop://[2007::9:181:124:200]:32777,1.2.3.4:32777/
hostname_in_ior=pe_farm, where pe_farm is the loadbalancer_virtual_name.
In this case the hosts file on one of the nodes in the Process Engine farm
might look like this:
76 High Availability
Table 19. Example of hosts file on the Process Engine farm nodes in a dual-stack
environment.
Server Hosts file entry
PE_farm1 1.2.3.4 PE_farm1_server pe_farm
2007::9:181:124:200 PE_farm1_server pe_farm
1.2.3.5 PE_farm2_server
2007::9:181:124:201 PE_farm2_server
1.2.3.6 PE_farm3_server
2007::9:181:124:202 PE_farm3_server
PE_farm2 1.2.3.4 PE_farm1_server
2007::9:181:124:200 PE_farm1_server
1.2.3.5 PE_farm2_server pe_farm
2007::9:181:124:201 PE_farm2_server pe_farm
1.2.3.6 PE_farm3_server
2007::9:181:124:202 PE_farm3_server
For more information, see “Configuring the Process Engine nodes hosts
file” on page 40.
d. Restart the software when prompted after applying the setting for the
vworbbroker.endPoint.
9. Complete the installation and configuration of the Process Engine, verifying
the database connection and completing post-installation configuration on
Windows only. Do not install any software updates until the entire server
farm is installed and configured.
10. Install subsequent Process Engine instances on the farm servers as described
in the IBM FileNet P8 Platform Installation and Upgrade Guide tasks for installing
Process Engine software and Content Engine client software with the
following farm-specific exceptions:
v Use a unique network name for each server in the farm. For information,
see “Configuring the Process Engine nodes hosts file” on page 40.
v When running SQL scripts, choose the option “I have already run the
pre-install scripts manually.”
v Configure all additional Process Engines to use the same database as the
initial Process Engine.
v Do not configure Process Task Manager again as this was done when you
configured the first Process Engine.
11. Refresh the Process Engine node on the Process Task Manager.
12. You should now see all the farmed Process Engine servers under the servers
node.
13. Install any Process Engine software updates as described in the IBM FileNet P8
Platform Installation and Upgrade Guide.
| You must complete the following prerequisites before configuring Process Engine
| server farms for a software load balancer.
| v WebSphere Edge Components must be installed and configured on the target
| server. The target server does not require the installation of WebSphere
| Application Server.
| v The Dispatcher service or process in WebSphere Edge Components must be
| running on the target server. The Dispatcher is used as the software load
| balancer.
| v The load balancer server, the cluster IP, and the nodes must reside on the same
| network (subnet).
| To install and configure Process Engine server farms for a software load balancer:
| 1. Verify that you have performed the required preparation tasks as shown in
| “Performing required preparation tasks” on page 35.
| 2. Install the Process Engine software and the Content Engine client software on
| the first Process Engine in the farm as described in the IBM FileNet P8 Platform
| Installation and Upgrade Guide.
| 3. Start Process Task Manager (vwtaskman), on the first Process Engine node.
| 4. Complete the configuration of Process Task Manager through step 12 using
| the procedures in the IBM FileNet P8 Platform Installation and Upgrade Guide for
| configuring Process Task Manager and return to this task to resume
| configuration for a software load balancer.
| 5. Open your completed Installation and Upgrade Worksheet file.
| Tip: In the Installation and Upgrade Worksheet file, verify the Data → Filter →
| AutoFilter command is enabled. To view only the Process Engine values, filter
| by Process Task Manager in the Installation or Configuration column.
78 High Availability
| 6. Log on to Process Engine as a member of the fnadmin group.
| 7. Complete the installation and configuration of the Process Engine, verifying
| the database connection and completing post-installation configuration. Do not
| install any software updates until the entire server farm is installed and
| configured.
| 8. Install subsequent Process Engine instances on the farm servers as described
| in the IBM FileNet P8 Platform Installation and Upgrade Guide tasks for installing
| Process Engine software and Content Engine client software with the
| following farm-specific exceptions:
| v When running SQL scripts, choose the option I have already run the
| pre-install scripts manually.
| v Configure all additional Process Engine instances to use the same database
| as the initial Process Engine.
| v Do not configure Process Task Manager again because this was done when
| you configured the first Process Engine.
| 9. Refresh the Process Engine node on the Process Task Manager. All of the
| farmed Process Engine servers under the servers node should display.
| 10. Install any Process Engine software updates as described in the IBM FileNet P8
| Platform Installation and Upgrade Guide.
| 11. Configure and administer the Dispatcher.
| a. Start the WebSphere Edge Components Load Balancer administration tool
| to configure the Dispatcher.
| b. Right-click on Dispatcher and select Connect to Host.
| c. Click OK.
| d. Right-click on the Host node and select Start Executor on the server that
| hosts the WebSphere Edge Components.
| e. Right-click on the Executor node to add a cluster.
| f. In the Cluster field, enter the load balancer virtual name.
| g. In the Cluster Address field, enter the load balancer virtual IP address.
| h. Click OK.
| i. Right-click on the cluster and add the Process Engine broker and IOR port
| values. The default values are 32777 and 32776 respectively.
| j. Right-click on the broker port to add the Process Engine server nodes that
| will part of the farm.
| k. Right-click on the IOR port to add the Process Engine server nodes that
| will be part of the farm.
| 12. Setup the vworbbroker.endPoint for the server farm.
| Restriction: The configuration for load balancer on the Process Engine server
| farm must done at the individual node level to enable TCP port monitoring.
| a. At each Process Engine node in the Process Task Manager, set the
| vworbbroker.endPoint property in the Advanced tab to:
| iiop://pe_server_ipv4_address:port#,loadbalancer_virtual_name:port#/
| hostname_in_ior=loadbalancer_virtual_name for example, where the IP
| address of pe_farm1_server is 1.2.3.4: vwbroker.endPoint=iiop://
| 1.2.3.4:32777,cmwinwslb:32777/hostname_in_ior=cmwinwslb
| b. On each of the Process Engine servers that you are configuring for load
| balancing, alias the loopback address to the address of the cluster. This
| enables the load balanced server to accept requests that were forwarded to
| its MAC address by the Dispatcher. Follow the steps in the Configuring the
Install and configure Process Engine software, and configure and use the FileNet
custom agents on Veritas Cluster Server; all steps are applicable for Solaris, AIX,
and HP-UX platforms.
Symantec provides a framework to create custom agents that can control and
monitor particular resources. FileNet has created custom agents by using the
Veritas framework to allow users to create, monitor, and control a Process Engine
resource. The agents have been certified by Symantec for use with their Veritas
Cluster Server product on Solaris, AIX, and HP-UX platforms.
From time to time it can become necessary to recompile the Process Engine Veritas
Agent to accommodate a change in the operating system (if the agent is to be used
on an operating system on which the agent was not compiled) or a change in the
startup and shutdown behavior of the agent (for example to increase the level of
80 High Availability
monitoring). To recompile the Process Engine Veritas Agent or to produce a new
agent binary if needed, follow the instructions in “Recompiling the FileNet Process
Engine Veritas agent” on page 85.
“Installing Process Engine in a Veritas cluster server (UNIX)”
You can install and configure Process Engine servers in a Veritas cluster
“Installing the FileNet P8 4.5.1 Process Engine Agent” on page 83
You can install the FileNet P8 4.5.1 Process Engine Agent.
“Verifying Process Engine installation (UNIX)” on page 84
You can verify your Process Engine installation by using Application Engine
(Workplace).
“Recompiling the FileNet Process Engine Veritas agent” on page 85
You can recompile the FileNet Process Engine Veritas agent if needed.
Important: This configuration is only required for the first Process Engine.
These are steps that should be performed in connection with the steps for
configuring Process Task Manager in the IBM FileNet P8 Platform Installation and
Upgrade Guide.
a. Start Process Task Manager (vwtaskman), on the first Process Engine node.
b. Select the Process Engine node.
where:
v cluster_virtual_name is the cluster variable name. For example, in the
following table showing example host file entries, the cluster_virtual_name
is pe_farm. When configuring isolated region connections points, use the
cluster_virtual_name as the DNS name.
v port# is the port on the Process Engine server used for the vworbbroker
process handling RPCs from the Process Engine API clients. The default
value is 32777.
For example, add iiop://pe_cluster:32777/hostname_in_ior=pe_cluster,
where pe_cluster is virtual name of the Process Engine cluster. In this case
the hosts file on one of the nodes in the Process Engine cluster might look
like this:
Table 20. Example of hosts file on the Process Engine cluster nodes.
Node name Hosts file entry
PE_node1 1.2.3.4 cluster_virtual_namelocal_node_server1
PE_node2 1.2.3.4 cluster_virtual_namelocal_node_server2
where:
v 1.2.3.4 is the network address for the cluster.
v cluster_virtual_name is the name of the cluster
v local_node_server1 and local_node_server2 are the network names for the
Process Engine servers.
d. Restart the software when prompted after applying the setting for the
vworbbroker.endPoint.
6. Complete the installation and configuration of the Process Engine and verifying
the database connection. Do not install any software updates until the entire
cluster is installed and configured.
7. Enable automatic start of Process Engine services from the Process Task
Manager.
a. Fail over to each node and start the Process Task Manager.
b. Check the box to enable automatic startup of Process Engine Processes.
8. After the cluster has been installed and configured, install any software updates
for the Process Engine.
82 High Availability
Related tasks
Installing Process Engine
You can install Process Engine software either interactively or silently. A number of
configuration steps follow the execution of the Process Engine installation program.
Installing the latest Content Engine client files on Process Engine servers
Installing the Content Engine Client files on all Process Engine enables
communication between the Content Engine and the Process Engine. You can
install these files interactively by using the installation wizard or silently by using
the command line and a silent input file.
Configuring Process Task Manager
Start the Process Task Manager and set initial configuration parameters on the
Process Engine.
Verifying connection to the Process Engine database
To verify the connection to the Process Engine database, issue the vwcemp
command.
Completing post-installation Process Engine configuration (Windows only)
You must enable Process Engine to use the largest available contiguous free
memory area for shared memory allocations. Otherwise, at some point during
normal execution, the system fails to allocate shared memory and ceases to
function correctly.
Installing Process Engine software updates
You can install software updates such as modified releases, fix packs, or interim
fixes to Process Engine.
Before putting the Process Engine under cluster control, ensure that you can start
Process Services from each node on which the cluster group is running. If there are
any issues at this point then they must be resolved before creating cluster resources
to control the Process Engine.
You should be able to use the Process Engine components through Application
Engine and not lose the session connection or be prompted for login credentials
throughout this procedure.
Remember: When creating the region ID specify the DNS name of the
clustered IP resource for the Process Engine server.
2. Log on to Workplace.
3. In Site Preferences, select a connection point to use for Tasks functionality.
4. Create and start a workflow.
5. Fail over Process Engine in the cluster.
6. Access the user's inbox and retrieve workflow information during/after the
failover. There might be a slight delay, but eventually the connection point
automatically connects to the Process Engine after the failover.
7. Complete a step in a workflow.
8. Create and start another workflow.
9. Verify that you can access the user's inbox and retrieve workflow information.
84 High Availability
Related tasks
Creating a Process Engine isolated region
Process Engine clients communicate to isolated regions in the database and to the
Process Engine server by using a connection point. Each connection point is
associated with an isolated region. In this task you will create an isolated region.
Creating a Process Engine Connection Point
A connection point identifies a specific isolated region of the workflow database,
and gives it a name that workflow-related applications use to access the region.
Follow these procedures to create a connection point.
Configuring the Process Engine connection point for Application Engine
Before users can access Process Engine tasks and work items from Workplace, you
must configure the connection point on the Application Engine.
You can run the following procedure to recompile the agent or to produce a new
agent binary for use with Veritas Cluster Server.
Restriction: The Veritas custom agent for the Process Engine is intended only for
the Solaris, AIX, and HP-UX platforms. For Process Engine on Windows, FileNet
use Veritas out-of-the-box agents.
Important: Run the Process Engine installer as a domain user created for installing
Process Engine software as detailed in the procedures for setting up a secure native
mode domain task in “Setting up a secure native mode domain installation” on
page 43.
86 High Availability
c. From the Windows Service Control Manager, stop the IMS ControlService
and Process Engine Services Manager services. Kill any other active
Process Engine processes.
d. Installation of the Process Engine software on the first node is complete.
7. Move the cluster group to subsequent nodes in your cluster and install the
Process Engine by using the steps outlined previously.
8. Install subsequent Process Engine instances in the cluster as described in the
IBM FileNet P8 Platform Installation and Upgrade Guide tasks for installing
Process Engine software and Content Engine client software with the
following cluster-specific exceptions:
v When running SQL scripts, choose the option: I have already run the
pre-install scripts manually.
v Configure all additional Process Engines to use the same database as the
initial Process Engine.
9. Configure Process Engine for the cluster on all nodes.
a. In the Process Task Manager, check the box to automatically start the
Process Services.
b. Modify the registry to set the NCH Broadcast value by navigating to:
Windows 2003
HKEY_LOCAL_MACHINE\Software\FileNet\IMS\CurrentVersion
Windows 2008
HKEY_LOCAL_MACHINE\Software\Wow6432Node\FileNET\IMS\
CurrentVersion
c. Add a new DWORD (Windows 2003) or 32bit DWORD (Windows 2008)
Value:
Name: NCHBroadcast
Value: 0
10. Add resources to the cluster to control the Process Engine.
HKLM\\SYSTEM
\\CurrentControlSet
\\Services
\\IMS ControlService
Windows 2008
HKLM\\SOFTWARE
\\Wow6432Node\\FileNET
\\IMS\\CurrentVersion
HKLM\\SYSTEM
\\CurrentControlSet
\\Services
\\IMS ControlService
5. Make the resource dependent on the
clustered disk resource.
IMS ControlService 1. Resource Type: GenericService
2. Set the ServiceName to: IMS
ControlService
3. Make the resource dependent on the
following:
v Lanman name resource
v Clustered disk resource
v IMS ControlService Registry
Replication
Process Engine Services Manager Registry 1. Set the Resource Type: RegRep
Replication
2. Set MountResName to the mount
resource for the clustered disk.
3. Leave the ReplicationDirectory location
on the clustered disk as default or set as
desired.
4. Set Keys to:
HKLM\\SYSTEM
\\CurrentControlSet
\\Services\\VWServicesPE
5. Make the resource dependent on the
clustered disk resource.
88 High Availability
Service name To add the resources:
Process Engine Services Manager 1. Set the Resource Type: GenericService
2. Set the ServiceName to: VWServicesPE
3. Make the resource dependent on the
following resources:
v IMS ControlService
v Process Engine Services Manager
Registry Replication
4. Set the Offline Timeout value for the
resource to a minimum of 60 seconds.
5. Set the Clean Timeout value for the
resource to a minimum of 60 seconds.
11. Configure Process Task Manager to display on all nodes when the Process
Engine service starts running under the cluster virtual name.
a. Start Process Task Manager (vwtaskman).
b. Complete the configuration of Process Task Manager using the procedures
in the IBM FileNet P8 Platform Installation and Upgrade Guide for configuring
Process Task Manager and return to this task to resume configuration.
Configure the Process Engine by using the highly available Content Engine
URL from one of the nodes.
For more information, see “Connecting by using Content Engine Web
Service Transport (CEWS)” on page 71 and the instructions for configuring
Process Task Manager in the IBM FileNet P8 Platform Installation and
Upgrade Guide.
c. Restart the Process Task Manager if it is not running.
d. Select the root node in the navigation tree.
e. In the Local Host field enter in a comma separated list of the physical
node names of the cluster.
f. Close and reopen Process Task Manager.
12. From Process Task Manager, add the cluster virtual name registered in DNS
for the Process Engine cluster:
Important: This configuration is only required for the first Process Engine.
These are steps that should be performed in connection with the instructions
for configuring Process Task Manager in the IBM FileNet P8 Platform
Installation and Upgrade Guide.
a. Start Process Task Manager (vwtaskman), on the first Process Engine node.
b. Select the Process Engine node.
c. On the Advanced page, add the vworbbroker.endPoint property:
where:
where:
v 1.2.3.4 is the network address for the cluster.
v cluster_virtual_name is the name of the cluster
v local_node_server1 and local_node_server2 are the network names for the
Process Engine servers.
d. Restart the software when prompted after applying the setting for the
vworbbroker.endPoint.
13. Complete the installation and configuration of the Process Engine, verifying
the database connection and completing post-installation configuration, where
a new registry entry is added to set a starting address for Process Engine
shared memory. Do not install any software updates until the entire cluster is
installed and configured.
14. Install any Process Engine software updates as described in the IBM FileNet P8
Platform Installation and Upgrade Guide.
90 High Availability
Related tasks
Installing Process Engine
You can install Process Engine software either interactively or silently. A number of
configuration steps follow the execution of the Process Engine installation program.
Installing the latest Content Engine client files on Process Engine servers
Installing the Content Engine Client files on all Process Engine enables
communication between the Content Engine and the Process Engine. You can
install these files interactively by using the installation wizard or silently by using
the command line and a silent input file.
Configuring Process Task Manager
Start the Process Task Manager and set initial configuration parameters on the
Process Engine.
Verifying connection to the Process Engine database
To verify the connection to the Process Engine database, issue the vwcemp
command.
Completing post-installation Process Engine configuration (Windows only)
You must enable Process Engine to use the largest available contiguous free
memory area for shared memory allocations. Otherwise, at some point during
normal execution, the system fails to allocate shared memory and ceases to
function correctly.
Installing Process Engine software updates
You can install software updates such as modified releases, fix packs, or interim
fixes to Process Engine.
You should be able to use the Process Engine components through Application
Engine and not lose the session connection or be prompted for login credentials
throughout this procedure.
Remember: When creating the region ID specify the DNS name of the
clustered IP resource for the Process Engine server.
2. Log on to Workplace.
3. In Site Preferences, select a connection point to use for Tasks functionality.
4. Create and start a workflow.
5. Fail over Process Engine in the cluster.
6. Access the user's inbox and retrieve workflow information during/after the
failover. There might be a slight delay, but eventually the connection point
automatically connects to the Process Engine after the failover.
7. Complete a step in a workflow.
8. Create and start another workflow.
Installing and configuring for high availability 91
9. Verify that you can access the user's inbox and retrieve workflow information.
Related tasks
Creating a Process Engine isolated region
Process Engine clients communicate to isolated regions in the database and to the
Process Engine server by using a connection point. Each connection point is
associated with an isolated region. In this task you will create an isolated region.
Creating a Process Engine Connection Point
A connection point identifies a specific isolated region of the workflow database,
and gives it a name that workflow-related applications use to access the region.
Follow these procedures to create a connection point.
Configuring the Process Engine connection point for Application Engine
Before users can access Process Engine tasks and work items from Workplace, you
must configure the connection point on the Application Engine.
Important: Run the Process Engine installer as a domain user created for installing
Process Engine software as detailed in the procedures for setting up a secure native
mode domain task in “Setting up a secure native mode domain installation” on
page 43.
92 High Availability
Process Engine Services Manager
Set the startup type to manual.
b. Open the Process Task Manager and verify that Process Service started
without error.
c. From the Windows Service Control Manager, stop the IMSService and
Process Engine Services Manager services. Kill any other active Process
Engine processes.
d. Installation of the Process Engine software on the first node is complete.
7. Move the cluster group to subsequent nodes in your cluster and install the
Process Engine by using the steps outlined previously.
8. Install subsequent Process Engine instances in the cluster as described in the
IBM FileNet P8 Platform Installation and Upgrade Guide tasks for installing
Process Engine software and Content Engine client software with the
following cluster-specific exceptions:
v When running SQL scripts, choose the option “I have already run the
pre-install scripts manually.”
v Configure all additional Process Engines to use the same database as the
initial Process Engine.
9. Configure Process Engine for the cluster on all nodes.
a. In the Process Task Manager, check the box to automatically start the
Process Services.
b. Modify the registry to set the NCH Broadcast value by navigating to:
Windows 2003
HKEY_LOCAL_MACHINE\Software\FileNet\IMS\CurrentVersion
Windows 2008
HKEY_LOCAL_MACHINE\Software\Wow6432Node\FileNET\IMS\
CurrentVersion
c. Add a new DWORD (Windows 2003) or 32bit DWORD (Windows 2008)
Value:
Name: NCHBroadcast
Value: 0
10. Add resources to the cluster to control the Process Engine.
11. Configure Process Task Manager to display on all nodes when the Process
Engine service starts running under the cluster virtual name.
a. Start Process Task Manager (vwtaskman).
b. Complete the configuration of Process Task Manager using the procedures
in the IBM FileNet P8 Platform Installation and Upgrade Guide for configuring
Process Task Manager and return to this task to resume configuration.
Configure the Process Engine by using the highly available Content Engine
URL from one of the nodes.
For information, see “Connecting by using Content Engine Web Service
Transport (CEWS)” on page 71.
c. Restart the Process Task Manager if it is not running.
d. Select the root node in the navigation tree.
e. In the Local Host field enter in a comma separated list of the physical
node names of the cluster.
f. Close and reopen Process Task Manager.
12. From Process Task Manager, add the cluster virtual name registered in DNS
for the Process Engine cluster:
Important: This configuration is only required for the first Process Engine.
These are steps that should be performed in connection with configuring
Process Task Manager in the IBM FileNet P8 Platform Installation and Upgrade
Guide.
a. Start Process Task Manager (vwtaskman), on the first Process Engine node.
b. Select the Process Engine node.
c. On the Advanced page, add the vworbbroker.endPoint property:
where:
94 High Availability
v cluster_virtual_name is the cluster variable name. For example, in the
following table showing example host file entries, the
cluster_virtual_name is pe_farm. When configuring isolated region
connections points, use the cluster_virtual_name as the DNS name.
v port# is the port on the Process Engine server used for the vworbbroker
process handling RPCs from the Process Engine API clients. The default
value is 32777.
For example, add iiop://pe_cluster:32777/hostname_in_ior=pe_cluster,
where pe_cluster is virtual name of the Process Engine cluster. The
network names for the Process Engine servers are local_node_server1 and
local_node_server2.
Table 22. Example of hosts file on the Process Engine cluster nodes.
Node name Hosts file entry
PE_node1 1.2.3.4 cluster_virtual_name local_node_server1 ProcessEngine
PE_node2 1.2.3.4 cluster_virtual_name local_node_server2 ProcessEngine
where:
v 1.2.3.4 is the network address for the cluster. This is the address used for
the Clustered IP resource.
v cluster_virtual_name is the name of the cluster
v local_node_server1 and local_node_server2 are the network names for the
Process Engine servers.
v local_node_server1 is the network name of windows on which you are
working and it should be the entry on the first line. The text
ProcessEngine should appear exactly as written.
d. Restart the software when prompted after applying the setting for the
vworbbroker.endPoint.
13. In the FNSW/BIN/ directory, modify the taskman.properties file to add the
network address of the cluster. For each node in the file, add the following
property:
TaskManager.ProcessService.Cluster=true
14. Add the following properties in the Advanced tab of the Process Task
Manager:
PropertyName = clusterNetworkName
PropertyValue = Network Cluster Name
You should be able to use the Process Engine components through Application
Engine and not lose the session connection or be prompted for login credentials
throughout this procedure.
Remember: When creating the region ID specify the DNS name of the
clustered IP resource for the Process Engine server.
2. Log on to Workplace.
3. In Site Preferences, select a connection point to use for Tasks functionality.
4. Create and start a workflow.
5. Fail over Process Engine in the cluster.
6. Access the user's inbox and retrieve workflow information during/after the
failover. There might be a slight delay, but eventually the connection point
automatically connects to the Process Engine after the failover.
7. Complete a step in a workflow.
8. Create and start another workflow.
96 High Availability
9. Verify that you can access the user's inbox and retrieve workflow information.
Related tasks
Creating a Process Engine isolated region
Process Engine clients communicate to isolated regions in the database and to the
Process Engine server by using a connection point. Each connection point is
associated with an isolated region. In this task you will create an isolated region.
Creating a Process Engine Connection Point
A connection point identifies a specific isolated region of the workflow database,
and gives it a name that workflow-related applications use to access the region.
Follow these procedures to create a connection point.
Configuring the Process Engine connection point for Application Engine
Before users can access Process Engine tasks and work items from Workplace, you
must configure the connection point on the Application Engine.
Important: Before you begin the migration, ensure Process Engine is running and
operational in a cluster configuration.
Option Description
MSCS (Windows) Remove the Process Engine generic
service/application for the following:
v IMS Control Service
v Process Engine Services Manager
Veritas (UNIX, Windows) Remove the Process Engine resource.
5. Do not delete any of the other cluster resources such as the shared storage
online.
6. Uninstall Process Engine from the active node. This is the node that has the
shared storage resource mounted.
7. Failover Process Engine to another node in the cluster making that node
active.
8. Repeat steps 3 through 7 on every other node in the cluster to uninstall
Process Engine from these nodes. Every node on which you repeat these steps
must be the active node.
9. Install Process Engine in a server farm by performing the steps in
“Configuring a Process Engine server farm for a hardware load balancer” on
page 74.
Each Process Engine background process (VWRs, VWKs, VWSs, and vwtime)
maintains an open database connection. When that database connection is lost,
each of the background processes attempts for 9 minutes to reconnect for up to 9
minutes. The database connection could be lost due to database failover or other
database connection problem. After a new connection is acquired or the time limit
to reestablish the connection has been reached, an error is logged and that error
might be sent back to the application level. The connection could be reestablished
for reasons such as bringing the database back online, or establishing a connection
to a highly available database.
v If a new connection is successfully acquired, an error message is sent back to the
calling routine telling the internal program routine that requested information
from the database to retry the operation as the connection was reestablished.
v If a new connection cannot be created within that time frame the returned error
indicate that the database is not available message.
Each background process only knows there is a lost connection when some task
tries to access the database. Each open transaction at the time of failure must be
retried. All existing transactions for that process are rolled back and the transaction
information is reset.
The transaction retries either take place automatically within the Process Engine
software, or at the application level where the software can either display an error
message for the user to handle or the program can catch the error and run a
routine such as an automatic retry.
“Examples of errors returned on database disconnect”
Examples of errors returned from a database disconnection.
98 High Availability
Table 23. Invalid or lost database connection error
Entry Description
Tuple: 213,109,173
Message: Invalid or Lost database connection.
Description: Database connection was lost. Could be a
network error or other problems on the
RDBMS server. This error is returned when
a connection was once valid, but is no
longer valid.
Action: Contact your DBA or System Administrator.
Known issues
1. If the following error shows up during a recovery scenario, it can be ignored:
Follow the tasks and requirements for making Application Engine (AE) or
Workplace XT highly available in an IBM FileNet P8 environment.
Important: For steps that require Java Virtual Machine (JVM) settings to be
made make sure to make these changes for every node in the application
server configuration.
2. Deploy your Web application.
If you are using Application Engine, follow the instructions for your
application server in the IBM FileNet P8 Platform Installation and Upgrade
Guide for deploying Application Engine on the application server. If you are
configuring an application server to work with Workplace XT, follow the
instructions for your application server in the IBM FileNet Workplace XT
Installation and Upgrade Guide to deploy the Workplace/Workplace XT
application by using the Administration server.
Important: For steps that require Java Virtual Machine (JVM) settings to be
made make sure to make these changes for every node in the application
server configuration.
– web.xml file
If you need to edit the web.xml file as part of deployment, for example if
you are using single sign-on (SSO), make these changes from the
Follow the instructions for enabling the Process Engine Component Integrator in
the IBM FileNet P8 Platform Installation and Upgrade Guide with the following
modification:
v In the “Specifying connection between Process Engine and Component Manager
(on a Process Engine server)” procedure, leave the Host field empty.
Related tasks
Enabling the Process Engine Component Integrator
By using the Component Integrator functionality included in the IBM FileNet P8
Platform, a step in a workflow can access properties of documents, folders, and
other objects in an object store. Using this functionality requires configuration on
both Application Engine and Process Engine servers.
Specifying connection between Process Engine and Component Manager (on a
Process Engine server)
Configure the connection between the Process Engine and the Component
Manager using Process Task Manager on the Process Engine.
The installer allows you to select the location of a shared configuration directory
during the installation process. This shared configuration directory is used to store
the files that contain preference settings and configuration information for the
Workplace/Workplace XT application. A shared configuration directory allows you
to have a single Workplace/Workplace XT instance with the same configuration
information and preferences across multiple server instances. The process for
managing settings by using a shared configuration directory is documented later in
this section.
Some Component Manager settings are stored on local files on the individual
Application Engine servers, and cannot be successfully modified during runtime.
Configuration changes made through the user interface will only be applied to the
local server, and the modified file(s) will not be distributed throughout the
Important: If the port number assigned to Component Manager conflicts with the
port number required by another application or service that runs on the Process
Engine or the Application Engine server, Process Task Manager will not start and
the necessary vwtaskman.xml will not be automatically created. If this happens,
make a copy of the sample vwtaskman.xml.sample file located on the Process
Engine or Application Engine/Workplace XT servers.
v On Process Engine servers, the file is located in the /fnsw/bin directory.
v On Application Engine servers, the file is located in C:\Program
Files\FileNet\AE\Router on Windows and in /opt/FileNet/AE/Router on
UNIX.
v On Workplace XT, the file is located in C:\Program Files\FileNet\WebClient\
Router on Windows and in /opt/FileNet/WebClient/Router on UNIX.
Open vwtaskman.xml.sample with a text editor, change the port element value to an
available port number, and save the file to vwtaskman.xml in the same directory. In
an HA environment you must do this for every node that is running Component
Manager.
Important: To be able to perform these tasks you must be a user assigned the
Application Engine Administrator access role, and have copy/overwrite
permissions on the directories shown later in this section on all nodes.
“Updating Workplace/Workplace XT settings in a load balanced environment”
You can update Workplace/Workplace XT settings in a load balanced
Application Engine/Workplace XT environment consisting of a load balancer or
proxy device, several HTTP servers and several application server instances.
“Updating Component Integrator settings in a highly available environment”
on page 108
You can update the Component Integrator settings in a highly available
Application Engine/Workplace XT environment.
For more information and a list of all configuration files that can be reloaded, go to
the on-line help and navigate to:
Application Engine:
Developer Help → Workplace Development → Workplace Customization Guide
→ Appendixes → Reloading Workplace Configuration Files
Workplace XT:
Expansion Products → IBM FileNet Workplace XT → Configure Workplace XT
→ Manage Workplace XT configuration files scroll down to Reloading
Workplace XT configuration files.
To install and configure Rendition Engine, follow the instructions in the IBM
FileNet Rendition Engine Installation and Upgrade Guide for installing and configuring
Rendition Engine with the following additional information:
1. Install Content Engine, Process Engine, and Application Engine.
Follow the instructions in the IBM FileNet P8 Platform Installation and Upgrade
Guide.
For high availability installation of these components, see “Installing a highly
available Content Engine” on page 61, “Installing a highly available Process
Engine” on page 74, and “Installing a highly available Application
Engine/Workplace XT” on page 100.
2. Verify that you have performed the required preparation tasks as shown in
“Performing required preparation tasks” on page 35.
3. Install and configure the first Rendition Engine.
a. Follow the instructions in the IBM FileNet Rendition Engine Installation and
Upgrade Guide for installing Rendition Engine and configuring Rendition
Engine connections on Content Engine. If Content Engine is clustered or
farmed use the virtual IP address for the Content Engine cluster or farm
when configuring Rendition Engine.
b. Continue to follow the instructions in the IBM FileNet Rendition Engine
Installation and Upgrade Guide for setting the site preferences on the
Application Engine to use path-based URLs.
Tip:
v You only need to do this once per HA environment.
v Setting the site preferences is not required on an upgrade. However, you
should verify that your settings are valid.
c. Enable word processing macros for rendering on the first Rendition Engine
server.
d. Install Rendition Engine software updates.
Important: After configuring the VistaTempDir, you must verify that you can
access this directory from each existing Rendition Engine server by using the
FNRE_admin user account, and that you can access the VistaTempDir on each
existing Rendition Engine from the current server.
a. Verify accessibility:
v On the Rendition Engine server, select Start → Run and then type
\\Other_RE_Server\VistaTempDir.
v Verify that you can create a text document in the directory by
right-clicking and selecting New → Text Document.
b. Enable word processing macros for rendering. Do this on each Rendition
Engine server.
c. Install Rendition Engine software updates.
d. Optional: Verify Rendition Engine installation. With the addition of each
new Rendition Engine server you should verify that the environment works
without problems.
Before you begin this Business Process Framework installation, you must install
Content Engine, Process Engine, and Application Engine for high availability in
your IBM FileNet P8 environment. Follow the instructions for each of these
components in the IBM FileNet P8 Platform Installation and Upgrade Guide.
v The following procedures describe the installation of the Business Process
Framework Web Application only.
Pre-installation tasks
Complete the pre-installation tasks as the first stage of the Business Process
Framework installation for high availability.
The following procedure assumes that the application server already has a cluster
instance configured and is ready for applications to be deployed.
1. Before you deploy Business Process Framework to an application server, you
must install any required patches that exist for Business Process Framework.
Contact your IBM service representative to determine if any patches are
required.
2. (WebSphere and WebLogic) Verify that your application farm or cluster
configuration is running.
JBoss deploys applications on startup so there is no need to start the
application server until you have installed the application.
3. Configure your Business Process Framework environment.
Follow the instructions in the "Configuration of the environment before BPF
server installation" task in the IBM FileNet Business Process Framework
Installation Guide to complete the following tasks:
a. Prepare the Bootstrap Object Store
b. Configure Users and Groups
c. Edit Workplace Site Preferences
d. Create new Metastore database
Installation tasks
The installation tasks are the final stage of the Business Process Framework
installation for high availability.
For more information about Business Process Framework installation, see the IBM
FileNet Business Process Framework Installation Guide.
Important:
This installation requires that the Application Engine and Business Process
Framework are co-located on the same application server. For more information,
see the "BPF Installation and Upgrade Overview" topic in the IBM FileNet Business
Process Framework Installation Guide.
“Installing Business Process Framework on the first node”
You must install and configure the Business Process Framework Web
Application on the first Application Engine node before you can install it on the
remaining nodes.
“Installing Business Process Framework on the other nodes” on page 115
After you install and configure the Business Process Framework Web
Application on the first Application Engine node in your system, you install it
on the remaining Application Engine nodes in your system.
“Deploying Business Process Framework on server clusters” on page 116
After you install and configure Business Process Framework Web Application
on the nodes on your system, you manually deploy the Business Process
Framework Web Application on application server clusters.
“Deploying Business Process Framework on server farms” on page 117
You can also manually deploy the Business Process Framework Web
Application on application server farms of independent application server
instances.
“Configuring Business Process Framework” on page 118
You must complete the required tasks to configure the Business Process
Framework Web Application in an IBM FileNet P8 environment.
“Making DataSources highly available” on page 118
You can make the DataSources highly available in an IBM FileNet P8
environment after a system failover.
When running the installer with the above fields left blank a number of
non-critical exceptions display in the Installation Summary screen. These
exceptions all relate to configuration entries that were not made and that you plan
to perform manually or have already performed as part of the initial node
installation, and can be ignored.
Follow the instructions in the "Deploy BPF Web Application" task in the
"Troubleshooting and Manual Procedures" section of the IBM FileNet Business
Process Framework Installation Guide with the following modifications for your
application server cluster:
1. WebSphere application server cluster:
a. Configure and deploy the Business Process Framework Web Application
from the administrative server instance.
When installing Business Process Framework through the administrative
server, deploy the Business Process Framework to the cluster of server
instances.
b. Follow the instructions in the "Deploy BPF Web Application" task "IBM
WebSphere <version>" sub-task in the "Troubleshooting and Manual
Procedures" section of the IBM FileNet Business Process Framework
Installation Guide with the following modifications.
c. Select the cluster and/or managed nodes that will be running the
application when mapping modules to servers (the admin node is usually
the default, so it is typical to change this).
d. Click Apply to show the application as deployed to the proper nodes
instead of the default single node.
e. Set UTF-8 encoding parameters on every node.
(WebSphere 6.x) If you are using an IBM HTTP Server to proxy/load-balance
application requests to WebSphere, select the webserver node when mapping
modules to the application.
2. WebLogic application server cluster:
a. Configure and deploy the Business Process Framework Web Application
from the administrative server instance.
When installing Business Process Framework through the administrative
server, deploy the Business Process Framework to the cluster of server
instances.
b. Follow the instructions in the "Deploy BPF Web Application" task "BEA
WebLogic <version>" sub-task in the "Troubleshooting and Manual
Procedures" section of the IBM FileNet Business Process Framework
Installation Guide with the following modification.
c. Make sure the targets for the application include the WebLogic cluster
and/or managed nodes that will be running the application.
3. JBoss application server cluster:
Follow the instructions in the "Deploy BPF Web Application" task in the
"Troubleshooting and Manual Procedures" section of the IBM FileNet Business
Process Framework Installation Guide with the following modifications for your
application server farm:
1. WebSphere farm of independent application server instances:
a. Configure and deploy the Business Process Framework Web Application on
each node.
b. Follow the instructions in the "Deploy BPF Web Application" task "IBM
WebSphere <version>" sub-task in the "Troubleshooting and Manual
Procedures" section of the IBM FileNet Business Process Framework
Installation Guide with the following modifications.
c. Select the cluster and/or managed nodes that will be running the
application when mapping modules to servers. The Deployment Manager is
usually the default, so it is typical to change this.
d. Click Apply to show the application shows as deployed to the proper nodes
instead of the default single node.
e. Set UTF-8 encoding parameters on every node.
If you are using an IBM HTTP Server to proxy/load-balance application
requests to WebSphere, select the webserver node as well as the application
servers when mapping modules to the application.
2. WebLogic farm of independent application server instances:
a. Configure and deploy the Business Process Framework Web Application on
each node.
b. Follow the instructions in the "Deploy BPF Web Application" task "BEA
WebLogic <version>" sub-task in the "Troubleshooting and Manual
Procedures" section of the IBM FileNet Business Process Framework
Installation Guide with the following modification.
c. Make sure the targets for the application include the WebLogic cluster
and/or managed nodes that will be running the application.
3. JBoss farm of independent application server instances:
a. Configure and deploy the Business Process Framework Web Application on
each node.
b. Follow the instructions in the "Deploy BPF Web Application" task "JBoss
4.0.x" sub-task in the "Troubleshooting and Manual Procedures" section of
the IBM FileNet Business Process Framework Installation Guide with the
following modifications.
c. Copy the web application files from the first node to each additional node.
d. Copy the datasource XML files from the first node to each additional node.
e. Restart JBoss on each node.
Follow the instructions in the "Post-install BPF server configuration" tasks in the
IBM FileNet Business Process Framework Installation Guide.
This task includes importing the XML Manifest as well as updating the Workplace
app_server.war./ear file and redeploying Workplace.
To verify the installation follow the instructions in the "Installation Validation" task
in the IBM FileNet Business Process Framework Installation Guide.
Important: For Windows 2008 MSCS, use the virtual name defined for
the Service or Application resource when specifying the Master
Administration Server Information.
v When the installer has finished, K2 will be running. Stop the application
before failing to another node.
UNIX Issue: k2adminstop
Windows
Stop the Verity K2 Administration Server and the Verity K2
Administration Web Server services.
b. Fail over to another node and repeat the install process with the same
parameters.
8. Configure local files to point to cluster address.
After the installation has been completed on all nodes, the following files will
contain local host names and must be edited to have the local node names
changed to the cluster virtual host name:
v verity_install_path/_cseuninst/installvariables.properties
v verity_install_path/config.vcnf
v verity_install_path/data/docs/WEB-INF/web.xml
v verity_install_path/k2/common/base.xml
v verity_install_path/k2/common/verity.cfg
v verity_install_path/data/host/admin/adminN.xml
Where the value of N is stored in verity_install_path/data/admin/
admin.dat.
9. Configure Veritas or Microsoft Cluster Server (MSCS) CSE Resource Group.
For more information about the Content Federation Services installation, see the
IBM FileNet Content Federation Services Installation and Upgrade Guide.
Important: You must do this each time you make changes to your
environment, such as "Set Up Additional External Repositories" later in this
section.
8. Perform Post Installation Steps.
Perform the tasks outlined in the IBM FileNet Content Federation Services
Installation and Upgrade Guide with the following HA related modification: "Set
up additional external repositories"
Required: After making configuration changes like these you must redo the
"Synchronize Connector, Data Maps, and Session Pools across the nodes" task.
Verifying deployment
After you deploy Content Federation Services, verify the Content Federation
Services (CFS) application is performing correctly on failover.
To verify the installation, follow the instructions in the "Verify the CFS Installation"
task in the IBM FileNet Content Federation Services Installation and Upgrade Guide.
Follow the tasks and requirements for making IBM FileNet eForms for P8 highly
available in an IBM FileNet P8 environment.
For this procedure you need a form template created by using the Form Designer
application.
Follow the tasks and requirements for making Process Analyzer highly available in
an IBM FileNet P8 environment.
Important: If the Process Engine database is using Oracle RAC, you must
manually configure the analyzer.properties file used by Process Analyzer to
connect to the Process Engine database. See “Configuring a database
connection to Process Engine running on Oracle RAC.”
v When configuring the Content Engine URI, use the virtual IP or name of the
Content Engine cluster or Content Engine farm load balancer.
v Check Automatically Started in Process Task Manager and clickApply.
Otherwise Process Analyzer won't be started when the VWServicesPA service
is brought online and Process Analyzer will need to be manually started
when the cluster fails over.
5. Configure the Process Task Manager Local Host property
a. In Process Task Manager, select the root node.
b. In the Local Host property, enter a list of comma separated IP addresses for
the separateProcess Analyzer server nodes.
c. Click Apply.
d. Restart the Process Analyzer service on the cluster.
6. Install the Process Analyzer Client
Follow the instructions in the task “Install Process Analyzer Client” in the IBM
FileNet Process Analyzer Installation and Upgrade Guide, by using the virtual IP or
name of the SQL Server Analysis Services server when running the Process
Analyzer Client Configuration Tool.
You can install Process Analyzer client in a single location that multiple end
users will access or on each end user workstation. The determining factors
should be the number of end users who will access the reports and the
sophistication of the end users.
If the Process Engine database is using Oracle RAC, the automatic construction of
the JDBC URL from the data entered in the Process Task Manager (database type,
database host, database name, database port) does not create a complete JDBC
| Attention: IBM InfoSphere Enterprise Records is the new name for IBM FileNet
| Records Manager; you might see both names throughout the documentation as we
| transition to the new name.
For more information about InfoSphere Enterprise Records installation, see the
"Install InfoSphere Enterprise Records" task in the IBM InfoSphere Enterprise Records
Installation and Upgrade Guide.
Verifying deployment
After you deploy IBM InfoSphere Enterprise Records, make sure the application
server is running, and that the Application Engine/Workplace XT and InfoSphere
Enterprise Records applications are started in the application server.
Follow the tasks and requirements for making IBM FileNet Connector for Microsoft
SharePoint Web Parts 2.2 highly available in an IBM FileNet P8 environment.
Restriction: This topic covers installation of IBM FileNet Connector for Microsoft
SharePoint Web Parts 2.2 in a supported IBM FileNet P8 HA environment. Do
NOT install this functional expansion unless it is supported at the release levels of
your FileNet P8 environment. For information, see the IBM FileNet P8 Hardware and
Software Requirements and IBM FileNet P8 Compatibility Matrix documents.
“Installing and configuring IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2” on page 134
You can install and configure IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2 to be highly available in an IBM FileNet P8 environment.
Before you begin the installation, ensure that all prerequisites are completed. For
details, see the installation planning considerations in the IBM FileNet Connector for
SharePoint Web Parts Installation and Upgrade Guide.
Restriction: This topic covers installation of IBM FileNet Connector for Microsoft
SharePoint Web Parts 2.2 in a supported IBM FileNet P8 HA environment. Do
NOT install this functional expansion unless it is supported at the release levels of
your FileNet P8 environment. For information, see the IBM FileNet P8 Hardware and
Software Requirements and IBM FileNet P8 Compatibility Matrix documents.
To install IBM FileNet Connector for Microsoft SharePoint Web Parts 2.2 in a farm
environment:
1. Install and configure a SharePoint farm.
To set up a farmed SharePoint environment, follow the instructions provided
by Microsoft. For example, see the Microsoft TechNet article "Install Office
SharePoint Server 2007 in a server farm environment."
Important: Ensure that your farm meets all requirements as outlined in the
IBM FileNet Connector for SharePoint Web Parts Installation and Upgrade Guide.
2. (IBM FileNet Credential Store Authentication only) Enable FileNet Credential
Store Authentication. Only do this if you are using IBM FileNet Credential
Store authentication with your installation.
a. Note the following information for the remote MS SQL Server database
required to set up the Microsoft SQL Server User Profile Database and
configure IBM FileNet Credential Store Authentication.
v Database Server and Instance
v Database Port
v Database User
v Database Password
b. Optional: Manually create a Microsoft SQL Server User Profile Database.
This step is optional, you can use the IBM FileNet Connector for Microsoft
SharePoint Web Parts setup program to create the database.
Follow the instructions in for optionally creating a Microsoft SQL Server
User Profile Database in the IBM FileNet Connector for SharePoint Web Parts
Installation and Upgrade Guide, Version 2.2 with the following modifications:
Make sure you enter the database server and instance name for the
<hostname> property. For example: database_server/database_instance.
Tip: Enter only the database server name if you use the default database
instance.
– For port number enter the instance port number associated with your
database instance.
– Encryption Key
Each SharePoint node must use the same encryption key.
v Choose a deployment method that suits your SharePoint setup.
Tip: In a farm environment the auto-deployment will fail, and an error will
display in a splash screen at the end of the installer. You must manually
deploy the components after installation. For information, see the "Manually
Deploy Components" task that follows.
v For each node after the first, make sure the information you enter for
"Specify Web Part Properties" is identical to what you entered for the first
node.
Tip: If your FileNet P8 environment is highly available, make sure you point
to the virtual names of the highly available Content Engine, Application
Engine, and Process Engine installations.
For example, for Content Engine use:
http://CE_farm_name:load_balancer_port# /wsi/FNCEWS40MTOM/
where CE_farm_name is the virtual name of your Content Engine farm and
load_balancer_port# is the port for the load balancer for your Content Engine
farm.
4. Verify that the installation was successful.
Check the install log at: C:\Program Files\IBM\
FileNetConnectorForSharePointWebParts\
Verifying installation
After you deploy IBM FileNet Connector for SharePoint Web Parts 2.2, verify
SharePoint and IBM FileNet P8 are running.
To verify installation:
1. Make sure SharePoint and IBM FileNet P8 are running.
Follow the tasks and requirements for making IBM FileNet Connector for Microsoft
SharePoint Web Parts 2.2.1 highly available in an IBM FileNet P8 environment.
Restriction: This topic covers installation of IBM FileNet Connector for Microsoft
SharePoint Web Parts 2.2.1 in a supported IBM FileNet P8 HA environment. Do
not install this functional expansion unless it is supported at the release levels of
your FileNet P8 environment. For information, see the IBM FileNet P8 Hardware and
Software Requirements and IBM FileNet P8 Compatibility Matrix documents.
“Installing and configuring IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2.1” on page 138
You can install and configure IBM FileNet Connector for Microsoft SharePoint
Web Parts 2.2.1 to be highly available in an IBM FileNet P8 environment.
“Verifying installation” on page 140
After you deploy IBM FileNet Connector for Microsoft SharePoint Web Parts
2.2.1, verify SharePoint and IBM FileNet P8 are running.
Before you begin the installation, ensure that all prerequisites are completed. For
details, see the installation planning considerations in the IBM FileNet Connector for
SharePoint Web Parts Installation and Upgrade Guide.
To install IBM FileNet Connector for Microsoft SharePoint Web Parts 2.2.1 in a
farm environment:
1. Install and configure a SharePoint farm.
To set up a farmed SharePoint environment, follow the instructions provided
by Microsoft. For example, see the Microsoft TechNet article "Install Office
SharePoint Server 2007 in a server farm environment."
Important: Ensure that your farm meets all requirements as outlined in the
IBM FileNet Connector for SharePoint Web Parts Installation and Upgrade Guide.
2. (IBM FileNet Credential Store Authentication only) Enable FileNet Credential
Store Authentication. Only do this if you are using IBM FileNet Credential
Store authentication with your installation.
a. Note the following information for the MS SQL Server database required to
set up the Microsoft SQL Server User Profile Database and configure IBM
FileNet Credential Store Authentication.
v Database Server and Instance
v Database Port
v Database User
v Database Password
b. Optional: Manually create a Microsoft SQL Server User Profile Database.
This step is optional, you can use the IBM FileNet Connector for Microsoft
SharePoint Web Parts setup program to create the database.
Follow the instructions in the "(Optional) Create a Microsoft SQL Server
User Profile Database" task in the IBM FileNet Connector for SharePoint Web
Parts Installation and Upgrade Guide, Version 2.2.1 with the following
modifications:
Make sure you enter the database server and instance name for the
<hostname> property. For example: database_server/database_instance.
Tip: Enter only the database server name if you use the default database
instance.
The Database Name is required to configure IBM FileNet Credential Store
Authentication.
3. Install IBM FileNet Connector for Microsoft SharePoint Web Parts on each farm
node.
For each node, follow the instructions in the IBM FileNet Connector for
SharePoint Web Parts Installation and Upgrade Guide with the following
modifications:
Tip: Enter only the database server name if you use the default database
instance.
– For port number enter the instance port number associated with your
database instance.
– Encryption Key
Each SharePoint node must use the same encryption key.
v Choose a deployment method that suits your SharePoint setup.
v For each node after the first, make sure the information you enter for
"Specify Web Part Properties" is identical to what you entered for the first
node.
Tip: If your FileNet P8 environment is highly available, make sure you point
to the virtual names of the highly available Content Engine, Application
Engine, and Process Engine installations.
For example, for Content Engine use:
http://CE_farm_name:load_balancer_port# /wsi/FNCEWS40MTOM/
where CE_farm_name is the virtual name of your Content Engine farm and
load_balancer_port# is the port for the load balancer for your Content Engine
farm.
v Complete the installation on each node before beginning the installation on
the next node.
v Use the exact same settings on each subsequent node as you did on the first
node.
4. Verify that the installation was successful.
Check the install log at: C:\Program Files\IBM\
FileNetConnectorForSharePointWebParts\
sharepoint_web_parts_install_log_2.2.1.txt
5. Verify that the encryption key specified in the web.config file for each
deployed Web application is identical for all nodes.
a. Open the web.config file for each Web application on each farm node.
The file is typically located in C:\Inetpub\wwwroot\wss\
VirtualDirectories\port# where port# is unique for each installation.
b. Verify that the entry for <machineKey> is identical for each Web
applications on all nodes.
Verifying installation
After you deploy IBM FileNet Connector for Microsoft SharePoint Web Parts 2.2.1,
verify SharePoint and IBM FileNet P8 are running.
To verify installation:
1. Make sure SharePoint and IBM FileNet P8 are running.
a. Verify that FileNet P8 is running. Verify that you can log in to Workplace
and Enterprise Manager.
b. Verify that SharePoint can connect to FileNet P8.
Log in to SharePoint and verify that the Web Parts can connect to FileNet
P8 and that you can browse your object store by using the Browse Web
Part.
Add a document to the object store by using SharePoint.
c. IBM FileNet Connector for Microsoft SharePoint Web Parts
Log in to Workplace or Enterprise Manager and verify that you can see the
document you just added via the SharePoint Web Part.
2. Verify that IBM FileNet Connector for Microsoft SharePoint Web Parts connects
after Content Engine failover.
a. Fail over your highly-available Content Engine.
b. Verify that SharePoint can connect to FileNet P8.
Log in to SharePoint and verify that Web Parts connects to FileNet P8 and
that you can browse, view, and open documents in your object store
through SharePoint Web Parts.
3. Verify that IBM FileNet Connector for Microsoft SharePoint Web Parts connects
after Application Engine failover.
a. Fail over your highly-available Content Engine.
b. Verify that SharePoint can connect to FileNet P8.
Log in to SharePoint and verify that Web Parts connects to FileNet P8 and
that you can open documents in your object store through SharePoint Web
Parts.
4. Verify that SharePoint clients have access after a SharePoint failover.
a. Fail over your highly available SharePoint server.
Follow the tasks and requirements for making IBM FileNet Connector for Microsoft
SharePoint Document Libraries 2.2 highly available in an IBM FileNet P8
environment.
Restriction: This topic covers installation of IBM FileNet Connector for Microsoft
SharePoint Document Libraries 2.2 in a supported IBM FileNet P8 HA
environment. Do NOT install this functional expansion unless it is supported at the
release levels of your FileNet P8 environment. For information, see the IBM FileNet
P8 Hardware and Software Requirements and IBM FileNet P8 Compatibility Matrix
documents.
“Installing and configuring IBM FileNet Connector for Microsoft SharePoint
Document Libraries 2.2”
You can install and configure IBM FileNet Connector for Microsoft SharePoint
Document Libraries 2.2 to be highly available in an IBM FileNet P8
environment.
“Verifying installation” on page 145
After you deploy IBM FileNet Connector for Microsoft SharePoint Document
Libraries 2.2, verify SharePoint and IBM FileNet P8 are running.
“Verifying transfer of documents from SharePoint to IBM FileNet P8” on page
148
After you deploy IBM FileNet Connector for Microsoft SharePoint Document
Libraries 2.2, transfer of documents from SharePoint to IBM FileNet P8.
Before you begin the installation, ensure that all prerequisites are completed. For
details, see the installation planning considerations in the IBM FileNet Connector for
SharePoint Document Libraries Installation and Upgrade Guide.
For information on how to install FileNet Connector for Microsoft SharePoint Web
Parts in a highly available environment, see “Installing and configuring IBM
FileNet Connector for Microsoft SharePoint Web Parts 2.2” on page 134.
To install IBM FileNet Connector for Microsoft SharePoint Document Libraries 2.2
in a highly available environment:
1. Install and configure a SharePoint farm.
Important: Ensure that your farm meets all requirements as outlined in the
IBM FileNet Connector for SharePoint Document Libraries Installation and Upgrade
Guide.
2. Install and configure a Microsoft active/passive cluster.
This cluster will host the Doc Lib Connector Remote Admin Services. To set
up a Microsoft active/passive cluster, follow the instructions provided by
Microsoft.
3. (IBM FileNet Credential Store Authentication only) Enable FileNet Credential
Store Authentication. Only do this if you are using IBM FileNet Credential
Store authentication with your installation.
a. Note the following information for the remote MS SQL Server database
required to set up the Microsoft SQL Server User Profile Database and
configure IBM FileNet Credential Store Authentication.
v Database Server and Instance
v Database Port
v Database User
v Database Password
b. Optional: Manually create a Microsoft SQL Server User Profile Database.
This step is optional, you can use the IBM FileNet Connector for Microsoft
SharePoint Document Libraries setup program to create the database.
Follow the instructions in the "(Optional) Create a Microsoft SQL Server
User Profile Database" task in the IBM FileNet Connector for SharePoint
Document Libraries Installation and Upgrade Guide, Version 2.2 with the
following modifications:
Make sure you enter the database server and instance name for the
<hostname> property. For example: database_server/database_instance.
Tip: Enter only the database server name if you use the default database
instance.
The Database Name is required to configure IBM FileNet Credential Store
Authentication.
4. Install IBM FileNet Connector for SharePoint Web Parts on each farm node.
For each node, follow the instructions in the “Install IBM FileNet Connector
for SharePoint Document Libraries” in the IBM FileNet Connector for SharePoint
Document Libraries Installation and Upgrade Guide with the following
modifications:
v Choose "Connector Services" only.
Deselect the option to install the Connector Administration Services; these
will be installed on the active/passive cluster.
v (IBM FileNet Credential Store Authentication only) Configure the
SharePoint farm to use the Microsoft SQL Server User Profile Database.
– If you choose to have the setup program create the database for you,
only do this when running the setup program on the first farm node. For
the consecutive nodes select the option to use an existing database, and
point to the database you created while running the setup program on
the first node.
Tip: Enter only the database server name if you use the default database
instance.
– For port number enter the instance port number associated with your
database instance.
v Verify that the installation was successful.
Check the install log at: C:\Program Files\IBM\
FileNetConnectorForSharePointWebParts\
sharepoint_web_parts_install_log_2.2.0.txt . The log will contain errors
due to the solution(s) not being deployed. This is normal in the case of a
farm.
Example of error:
EXECUTE_DEPLOYWEBPARTS: -2147024894.
Due to error certain actions might need to be done by hand
Status: ERROR
Additional Notes: ERROR -
Batch File error deploying WebParts might need to be done by hand
5. (IBM FileNet Credential Store Authentication only) Specify Application Pool
Security Account.
Perform this task on the remote database server. Follow the instructions in the
"Specify Application Pool Security Account (FileNet Credential Store
Authentication only)" task in the IBM FileNet Connector for SharePoint Document
Libraries Installation and Upgrade Guide, Version 2.2.
6. Install the Connector Administration Services remotely on each cluster node.
For each cluster node in the Microsoft active/passive cluster you created
previously in the "Install and configure a Microsoft active/passive cluster"
task, follow the instructions in the "(optional) Install the Connector
Administration Services on a Remote Server" task in the IBM FileNet Connector
for SharePoint Document Libraries Installation and Upgrade Guide with the
following modifications:
v Change the drive letter on the default install folder to your active/passive
cluster shared drive.
v On the cluster server, choose "Connector Administration Services." The
Web Services are already installed on the SharePoint farm.
where CE_farm_name is the virtual name of your Content Engine farm and
load_balancer_port# is the port for the load balancer for your Content Engine
farm.
10. Deploy the IBM FileNet User Administration Web Part.
On one node in the SharePoint farm, follow the instructions in the "Deploy
the IBM FileNet User Administration Web Part" task in the IBM FileNet
Connector for SharePoint Document Libraries Installation and Upgrade Guide,
Version 2.2, using the virtual host name of the farm instead of "localhost" for a
Share Point farm.
11. Manually deploy the IBM FileNet Redirector on each node in the SharePoint
farm.
On one node in the SharePoint farm, follow the instructions in the "Deploy the
IBM FileNet Redirector" task in the IBM FileNet Connector for SharePoint
Document Libraries Installation and Upgrade Guide, Version 2.2, using the virtual
host name of the farm instead of "localhost" for a Share Point farm.
12. Configure the Remote Admin Server Cluster for fail over.
a. Make sure the following services are set to manual start on both servers in
the active/passive cluster:
v FileNet SharePoint Connector Service
v UFI FileNet P8 Content Engine 4.0 Connector
v UFI Task Routing Engine
v UFI Utility Service
b. Open Cluster Administrator for the Microsoft active/passive cluster.
c. Right-click your group name and choose New → Resource.
d. In the New Resource box, give the new resource a name. For example:
"Doc Lib Connector."
e. Under Resource Type, choose "Generic Service" and click Next.
f. Make sure both servers are shown under "Possible Owners." Click Next.
g. For Dependencies, move the drive that you installed the Doc Lib
Connector Remote Admin Services on from "available resources" to
"resource dependencies."
h. Under Service Name, enter: ibm.ctms.taskrouteservice
i. Leave start parameters blank. Click Next.
Verifying installation
After you deploy IBM FileNet Connector for Microsoft SharePoint Document
Libraries 2.2, verify SharePoint and IBM FileNet P8 are running.
For more information on how to use the Configuration Manager for the tasks
described later in this section, see IBM FileNet P8 Help topic Expansion Products →
IBM FileNet Connector for SharePoint → IBM FileNet Connector for SharePoint
Document Libraries.
Follow the steps for post-installation configuration in the IBM FileNet P8 Platform
Installation and Upgrade Guide with the following exceptions for a highly available
environment:
v In a cluster configuration, when creating Process Engine isolated regions in
Enterprise Manager, specify the cluster_virtual_name for the DNS name of the
Process Engine server.
v In a farmed configuration, when creating Process Engine isolated regions in
Enterprise Manager, specify the loadbalancer_virtual_name for the DNS name of
Process Engine server
Follow the instructions in the IBM FileNet P8 Platform Installation and Upgrade Guide
and the separate add on installation guides to prepare your system to upgrade the
core IBM FileNet P8 components in a highly available environment.
“Planning the upgrade”
You must plan your system rollout before you upgrade IBM FileNet P8
components in a highly available environment.
“Performing required preparation tasks” on page 155
Planning and preparation instructions are provided for the components and
add on components you are installing.
Prepare your system to upgrade the core IBM FileNet P8 components in a highly
available environment. In many cases, there are links to more detailed information
to help you plan a system rollout. Review this information thoroughly before you
start to set up FileNet P8 components or any required independent software
vendor (ISV) software.
“Content Engine upgrade procedure overview” on page 152
Content Engine 4.5.1 is an enterprise application running on a Java application
server which can reside on the same servers as Content Engine 3.5.x or on
separate servers, running independently of each other.
“Process Engine” on page 153
Process Engine allows you to create and manage workflows. You can route
your business information to the appropriate users on your system.
“Application Engine/Workplace XT upgrade procedure overview” on page 154
You can upgrade an Application Engine cluster/server farm to version 5.5.1.
“IBM InfoSphere Enterprise Records” on page 154
You can use IBM InfoSphere Enterprise Records to classify, apply retention
policies and store electronic records according to fiscal, legal and regulatory
requirements.
“Rendition Engine upgrade procedure overview” on page 154
You can upgrade the Rendition Engine from 4.0 to 4.5.1 by replacing the 4.0
version of the software with the 4.5.1 version.
“IBM FileNet Connector for SharePoint document libraries” on page 154
IBM FileNet P8 platform, version 4.5, supports the same version of IBM FileNet
Connector for SharePoint Document Libraries as IBM FileNet P8 platform,
version 4.0.
“IBM FileNet Connector for SharePoint Web parts” on page 154
IBM FileNet P8 platform, version 4.5, supports the same versions of IBM
FileNet Connector for Microsoft SharePoint Web Parts as IBM FileNet P8
platform, version 4.0.
Content Engine can be made highly available by using the processes for making an
application highly available in a Java application server as documented in
“Installing a highly available Content Engine” on page 61.
Important: The clustered services that comprised a highly available 3.5 Content
Engine will be disabled during the upgrade and can be left offline or brought
online after the upgrade as needed.
The 3.5.x Content Engine and 4.5.1 Content Engine can operate independently and
will not conflict with each other. After the upgrade process is complete the 3.5.x
Content Engine cluster resources (if cluster is being used) can be uninstalled as
needed, assuming that the 3.5.x environment is no longer needed.
Object stores that have not yet been upgraded to 4.5.1 are still accessible from the
3.5.x environment. After the object stores and file stores have been converted, the
4.5.1 Content Engine takes ownership of them and they are no longer be available
to the 3.5.x Content Engine.
Process Engine
Process Engine allows you to create and manage workflows. You can route your
business information to the appropriate users on your system.
The procedure for upgrading Process Engine in a highly available IBM FileNet P8
Platform environment differs by configuration (cluster or farm).
“Server farm environments”
You can upgrade a Process Engine cluster in a Process Engine farm.
“Cluster environments”
You can upgrade Process Engine in a high available Process Engine server
cluster environment.
Process Engine farming was initially supported with the IBM FileNet P8 Platform
version 4.0.0 release.
The following high-level steps are necessary to upgrade a Process Engine cluster to
a Process Engine farm:
1. Move all cluster services to the first node.
2. Upgrade the first node to Process Engine 4.5.1.
3. Uninstall Process Engine 3.5.x from the second node in the cluster.
4. Install Process Engine 4.5.1 on the second node by using a unique NCH name.
Cluster environments
You can upgrade Process Engine in a high available Process Engine server cluster
environment.
To upgrade Process Engine you must upgrade the software on all nodes in the
cluster, and upgrade the Process Engine database objects once only from the first
node upgraded.
The following high-level steps are necessary to upgrade the Process Engine for
high availability:
1. Stop all Process Routers in the IBM FileNet P8 environment.
2. Stop all Process Engine services in the cluster.
3. Disable or remove any cluster resources monitoring and controlling the Process
Engine.
4. Upgrade the Process Engine software on one node.
5. Enable or recreate cluster resources to monitor and control the Process Engine.
6. Start Process Engine services.
7. Complete Post-Upgrade Process Engine Configuration steps
8. Upgrade the software on the remaining nodes.
There is no need to complete the post-upgrade steps on any node except the first
node that was upgraded.
To upgrade Rendition Engine from the 4.0 release to the 4.5.1 release, you uninstall
and reinstall the software.
The following high-level steps are necessary to upgrade and configure a highly
available Rendition Engine for high availability:
1. Upgrade Content Engine, Process Engine, and Application Engine.
2. Perform prerequisite tasks as outlined in “Performing required preparation
tasks” on page 155.
3. Uninstall the previous version of Rendition Engine.
4. Upgrade and configure an initial Rendition Engine on the existing Rendition
Engine servers.
5. Upgrade and configure additional Rendition Engines.
6. Optional: Verify Installation.
No changes to the highly available SharePoint environment are required when you
upgrade the IBM FileNet P8 platform from version 4.0 to version 4.5.
No changes to the highly available SharePoint environment are required when you
upgrade the IBM FileNet P8 platform from version 4.0 to version 4.5.
In addition to the administrator preparation tasks, follow the plan and prepare
instructions in the Plan and Prepare Your Environment for IBM FileNet P8 document
for the components you are installing. For add-on components, follow the plan and
prepare instructions in the corresponding installation guide. Note that some of the
tasks later in this section might replace the tasks described for a non highly
available environment.
In addition, if you are using the Installation and Upgrade Worksheet for your
environment, all administrators should complete the worksheet with the relevant
information. See “Using the installation and upgrade worksheet” on page 33.
“Installation administrator tasks”
The Application Installer Administrator must perform the required tasks for the
Content Engine, Process Engine, Application Engine/Workplace XT, and
Rendition Engine components.
“Information technology administrator tasks” on page 156
The Information Technology Administrator must configure the Process Engine
nodes hosts file for server farms and server clusters.
“Security administrator tasks” on page 157
The Security Administrator must perform the required tasks for the Content
Engine and IBM InfoSphere Enterprise Records accounts.
“Database administrator tasks” on page 157
The Database Administrator must perform the required tasks for the Content
Engine.
“Application server administrator tasks” on page 157
The Application Server Administrator must perform the required tasks for the
Content Engine and Application Engine/Workplace XT components.
The following are required tasks for the Application Installer Administrator.
Content Engine
In addition to the various administrator tasks, review and perform the required
Content Engine tasks in the "Perform the required preparation tasks" topic of the
"Plan and prepare for IBM FileNet P8 upgrade" section of the Plan and Prepare Your
Environment for IBM FileNet P8 guide.
Process Engine
In addition to the various administrator tasks, review and perform the required
Process Engine tasks in the "Perform the required preparation tasks" topic of the
"Plan and prepare for IBM FileNet P8 upgrade" section of the Plan and Prepare Your
Environment for IBM FileNet P8 guide.
In addition to the various administrator tasks, review and perform the required
Application Engine or Workplace XT tasks in the "Perform the required
preparation tasks" topic of the "Plan and prepare for IBM FileNet P8 upgrade"
section of the Plan and Prepare Your Environment for IBM FileNet P8 guide.
Rendition Engine
In addition to the various administrator tasks, review and perform the required
Rendition Engine tasks in the "Perform the required preparation tasks" section of
the "Plan and Prepare for upgrade" topic in the Plan and Prepare Your Environment
for IBM FileNet P8.
Server farm
For each Process Engine server, configure the hosts file so that on each node in the
farm it:
v includes the NCH name for every other node in the farm.
v identifies the loadbalancer virtual as itself.
For UNIX: Verify that the nsswitch.conf file (AIX netsvc.conf and/or irs.conf)
is configured to resolve names via the local hosts file first.
Server cluster
Configure the hosts file on each cluster node server to follow the following format:
PEvirtual_ip PEvirtual_dns_name PEclustered_nch_name local_node_name
Perform all of the required security administrator upgrade tasks for your
environment, as shown in the Plan and Prepare Your Environment for IBM FileNet P8
guide, with the following HA specific details:
Content Engine
Specify IBM FileNet P8 accounts for upgrades. This step is required for upgrades
from Content Engine 3.5 only.
(UNIX) Verify that the /bin directory is write-enabled before running the
InfoSphere Enterprise Records installer. The directory need only be write-enabled
during installation, and can be set back to whatever security permission you
choose after the installation completes.
Perform all required database administrator tasks for your environment, as shown
in the Plan and Prepare Your Environment for IBM FileNet P8 guide, with the
following HA specific details:
Content Engine
Create the GCD data source for Content Engine (upgrades from 3.5.x). For more
information about making databases highly available with P8 components, see
“Database services” on page 18.
The following are required tasks for the Application Installer Administrator.
Perform all required application server administrator tasks for your environment,
as shown in the "Plan and prepare for IBM FileNet P8 upgrade" section of the Plan
and Prepare Your Environment for IBM FileNet P8 guide, with the following HA
specific details:
Configure the application server for Content Engine (upgrades from 3.5.x)
Perform the applicable tasks for your setup. For pre-installation, verification, and
configuration steps needed for a highly available Content Engine, see “Installing a
highly available Content Engine” on page 61. The steps shown are needed both for
upgrades and new installations.
Application Engine/Workplace XT
Perform the task "Prepare for Application Engine upgrade" of the IBM FileNet P8
Platform Installation and Upgrade Guide, with the following modifications:
v Backup the shared bootstrap.properties file in the shared network location.
v (AE 3.5 only) A shared configuration directory will be created beneath the
original location of the bootstrap file.
Example: If your 3.5.x shared bootstrap location was Z: the newly created shared
configuration directory will be Z:\AE\.
Follow the tasks and requirements for upgrading a highly available Content
Engine in an IBM FileNet P8 environment.
Important: You must leave the GCD share and virtual network resources
(network name and IP) online. The upgrader requires access to the GCD sysinit
file. If the share is offline it will not be accessible to the upgrader.
In a highly available environment where file store shared folders are highly
available make sure they are kept online. The upgrader requires access to the
shared folders by using the same shared path that is stored in the GCD for the
file store folder.
Perform the "Upgrade Content Engine Data" task from the IBM FileNet P8 Platform
Installation and Upgrade Guide from a single node where you installed the Upgrader
Tool.
Follow the tasks and requirements for upgrading a highly available Process Engine
in an IBM FileNet P8 environment.
“Upgrading Process Engine server farms”
You can upgrade Process Engine in a server farm environment.
“Process Engine cluster pre-upgrade tasks” on page 165
You must complete some pre-upgrade tasks before you can upgrade Process
Engine in a cluster environment.
“Upgrading Process Engine in a Veritas cluster server (UNIX)” on page 165
You can upgrade Process Engine in a Veritas (UNIX) cluster server
environment.
“Upgrading Process Engine in a Veritas or Microsoft Cluster Server (Windows)”
on page 167
You can upgrade Process Engine in a Veritas or Microsoft (Windows) cluster
server environment.
Important: Do not start the Process Engine software on any node in the
farm until all nodes have been updated to Process Engine version 4.5.1
b. On each node, upgrade the Content Engine Client files on Process Engine
servers using the procedures in the IBM FileNet P8 Platform Installation and
Upgrade Guide. Make sure to input information for a highly available
Content Engine. For more information, and for examples, see “Connecting
by using Content Engine Web Service Transport (CEWS)” on page 71.
c. On one of the farm nodes, complete the upgrade from Process Engine 4.0,
4.5.0 or higher, as documented in the IBM FileNet P8 Platform Installation and
Upgrade Guide.
3. Start the Process Engine software on the remaining nodes. At a Windows
command prompt, or a UNIX command line, type the following:
where:
v loadbalancer_virtual_name is the load balancer variable name. For example,
in the following table showing example host file entries, the
loadbalancer_virtual_name is pe_farm. When configuring isolated region
connections points, use the loadbalancer_virtual_name as the DNS name.
v port# is the port on the Process Engine server used for the vworbbroker
process handling RPCs from the Process Engine API clients. The default
value is 32777.
In this case the hosts file on one of the nodes in the Process Engine farm
might look like this:
Table 32. Example of hosts file on the Process Engine farm nodes.
Server Hosts file entry
PE_farm1 1.2.3.4 PE_farm1_server pe_farm
1.2.3.5 PE_farm2_server
1.2.3.6 PE_farm3_server
PE_farm2 1.2.3.4 PE_farm1_server
1.2.3.5 PE_farm2_server pe_farm
1.2.3.6 PE_farm3_server
For more information, see “Configuring the Process Engine nodes hosts file”
on page 40.
d. Restart the software when prompted after applying the setting for the
vworbbroker.endPoint.
5. Install Process Engine software updates on every Process Engine node, and
update Process Engine client software on other IBM FileNet P8 servers as
documented in the IBM FileNet P8 Platform Installation and Upgrade Guide.
Perform the following steps before upgrading your highly available Process Engine
cluster environment.
Important: Do not start the Process Engine software on any node until all
nodes have been updated to Process Engine version 4.5.1
b. On each node, upgrade the Content Engine client files on Process Engine
servers using the procedures in the IBM FileNet P8 Platform Installation and
Upgrade Guide. Make sure to input information for a highly available
Content Engine. For more information, and for examples, see “Connecting
by using Content Engine Web Service Transport (CEWS)” on page 71.
3. Move the cluster group to another node and repeat Step 2. Do this for all nodes
in the cluster that will run Process Engine services.
4. On the last node complete the upgrade from either Process Engine 3.5 or
Process Engine 4.0, 4.5.0 or higher, as documented in the corresponding section
in the IBM FileNet P8 Platform Installation and Upgrade Guide.
For upgrades from version 3.5, note the following cluster-specific information:
v Complete all post-upgrade steps once per cluster, with the exception of
updating email notification. This must be done on every node.
v When configuring isolated regions and connection points, make sure to use
the virtual name of the Process Engine cluster for the DNS when creating the
Process Engine Region ID from the Enterprise Manager.
5. Stop the Process Engine services before putting them under Veritas control by
issuing the following command:
killfnsw -DAyS
Perform this step once per environment from the active cluster node.
6. Install the IBM FileNet P8 4.5.1 Process Engine Agent.
a. Untar the FileNet Process Engine Agent package located under the Veritas
folder on the FileNet P8 Process Engine software package.
b. Copy the files to all nodes in the cluster.
c. On all nodes perform the following steps:
v Create the following directory: /opt/VRTSvcs/bin/FN_ProcessEngine.
v Copy the FN_ProcessEngineAgent agent binary to the following directory
(overwriting the existing file): /opt/VRTSvcs/bin/FN_ProcessEngine.
v Change the permissions on the directory as follows: chmod -R 755
/opt/VRTSvcs/bin/FN_ProcessEngine.
v Copy the file FN_Types.cf the following directory (overwriting the
existing file): /etc/VRTSvcs/conf/config.
Important: Do not start the Process Engine software on any node until all
nodes have been updated to Process Engine version 4.5.1
b. On each node, upgrade the Content Engine client files on Process Engine
servers using the procedures in the IBM FileNet P8 Platform Installation and
Upgrade Guide. Make sure to input information for a highly available
Content Engine. For more information, and for examples, see “Connecting
by using Content Engine Web Service Transport (CEWS)” on page 71.
3. Move the cluster group to another node and repeat Step 2. Do this for all nodes
in the cluster that will run Process Engine services.
4. On the last node complete the upgrade from either Process Engine 3.5 or
Process Engine 4.0, 4.5.0 or higher, as documented in the corresponding section
in the IBM FileNet P8 Platform Installation and Upgrade Guide.
For upgrades from version 3.5, note the following cluster-specific information:
v Complete all post-upgrade steps once per cluster, with the exception of
updating email notification. This must be done on every node.
v When configuring isolated regions and connection points, make sure to use
the virtual name of the Process Engine cluster for the DNS when creating the
Process Engine Region ID from the Enterprise Manager.
5. On all nodes add the NCHBroadcast Value to the Windows registry. See the
task "Modify the registry to set the NCHBroadcast value" in “Installing Process
Engine in a Veritas cluster server (Windows)” on page 86.
6. Enable or recreate the cluster resources and bring the cluster online.
If you are recreating the cluster resources see the Process Engine section of this
document for details on the parameters and service names to configure.
7. Bring the cluster online and verify that the upgrade was successful.
8. Install Process Engine software updates on every Process Enginenode, and
update Process Engine client software on other IBM FileNet P8 servers as
documented in the IBM FileNet P8 Platform Installation and Upgrade Guide.
Verify that you have performed the required preparation tasks as shown in
“Performing required preparation tasks” on page 155.
Follow the tasks and requirements for upgrading a highly available Application
Engine or Workplace XT in an IBM FileNet P8 environment.
Follow the tasks and requirements for upgrading a highly available Rendition
Engine in an IBM FileNet P8 environment.
Perform the instructions in the IBM FileNet Rendition Engine Installation and Upgrade
Guide “Upgrade and configure Rendition Engine” section.
Perform the upgrade tasks as outlined in the IBM FileNet Rendition Engine
Installation and Upgrade Guide “Uninstall previous version of Rendition Engine”
task on each Rendition Engine node.
Perform the optional the IBM FileNet Rendition Engine Installation and Upgrade Guide
“(Optional) Verify Installation” task.
Follow the tasks and requirements for upgrading a highly available Content
Federation Services for IBM Content Integrator in an IBM FileNet P8 environment.
Verify that you have performed the required preparation tasks as shown in
“Performing required preparation tasks” on page 155.
| Attention: IBM InfoSphere Enterprise Records is the new name for IBM FileNet
| Records Manager; you might see both names throughout the documentation as we
| transition to the new name.
Tip:
v The following procedure covers upgrades of the InfoSphere Enterprise Records
Web Application only.
v This document covers the following upgrade paths:
– Version 3.7 to 4.5.1
– Version 4.0 to 4.5.1
– Version 4.5 to 4.5.1
v This document does not include upgrade instructions for FileNet Records
Manager version 3.5.x to FileNet Records Manager version 4.0 or 4.5.
v For instructions on upgrading other components such as the InfoSphere
Enterprise Records Sweep Application or Crystal Reports, see the "Upgrading
and configuring IBM InfoSphere Enterprise Records" section of the IBM
InfoSphere Enterprise Records Installation and Upgrade Guide, version 4.5.1.
To upgrade the InfoSphere Enterprise Records Web application, follow the tasks in
the "Upgrading and configuring IBM InfoSphere Enterprise Records" section of the
IBM InfoSphere Enterprise Records Installation and Upgrade Guide version 4.5.1, with
HA specific modifications to specific tasks as outlined:
| 1. Upgrade FileNet Records Manager Software.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law: INTERNATIONAL
BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
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.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
IBM Corporation
J46A/G4
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.
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.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information is for planning purposes only. The information herein is subject to
change before the products described become available.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both. If these and other IBM trademarked terms are marked on their first
occurrence in this information with a trademark symbol (® or ™), these symbols
indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common
law trademarks in other countries. A current list of IBM trademarks is available on
the Web at http://www.ibm.com/legal/copytrade.shtml (www.ibm.com/legal/
copytrade.shtml).
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the
United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Notices 177
178 High Availability
Index
A configuration and startup tasks
highly available environment 148
Content Engine (continued)
verifying document transfer after
Application Engine configuration procedures failover 147
configuring 100, 103 BPF 118 verifying failover 74
creating shared directories 39 server cluster 156 verifying installation 74
deploying 103 server farm 156 Content Engine data
installation tasks 26 Connector for SharePoint Doc Library 2.2 upgrading 162
installing in a highly available configuring 141 Content Federation Services
environment 39, 100 installation tasks 32 configuring 122
overview 26 installing in a highly available installing in a highly available
pre-installation tasks 51 environment 141 environment 122
server cluster overview 154 verifying deployment 124
JBoss 50 verifying base document transfer 146 Content Search Engine
upgrade tasks 154 verifying connector services 147 configuring 118
upgrading for high availability 169 verifying failover 146 creating shared directories 38
verifying deployment 105 verifying installation 145 installation tasks 23
application server Connector for SharePoint Web Parts 2.2 installing in a highly available
configuration 51, 54 installation restrictions 141 environment 37, 118
enabling connections after database installation tasks 133, 134 overview 22
failover 71 overview 31, 154 updating the k2_os_user profile 38
server cluster 51 verifying document transfer 148
server farm 51 verifying installation 136
Application Server Administrator
pre-installation tasks
Connector for SharePoint Web Parts 2.2.1
configuring 138
D
Content Engine 54 Database Administrator
installation restrictions 137
required tasks 50, 157 required tasks 48, 157
installing in a highly available
architecture 3 database reconnection
environment 138
Process Engine 98
overview 31, 154
database services
verifying installation 140
B Content Engine
high availability 18
DataSources
BPF cache refresh delays 22
making available 118
configuring 118 configuration 55
deployment procedures
deploying on server clusters 116 configuring 63
BPF
deploying on server farms 117 configuring file stores 65
server clusters 116
installing 111 configuring the database for 48
server farms 117
installing on additional nodes 115 connecting 71
disaster recovery 1, 2
installing on the first node 114 creating object stores 67
domain controller
BPF installation database installation 48
configuring 43
installation tasks 113 deploying 64
dynamic DNS servers
overview 111 deploying on server clusters 70
time-to-live 15
pre-installation tasks 112 deploying upgraded instances 162
verifying 118 enabling application server
connections after database
failover 71, 72, 73 E
C highly available connection 69
installation tasks 21
eforms
configuration 125
cache refresh delays installing 62 high availability 28, 29
Content Engine 22 installing in a highly available installation tasks 125
CFS-ICI environment 61, 62 installing in a highly available
high availability 27, 28 overview 20 environment 125
installation 121 post-deployment steps 65 verifying deployment 126
installation tasks 57 pre-installation tasks 54 examples
upgrading for high availability 172 pre-upgrade tasks 160 high availability 10
cluster upgrade tasks server cluster products tested with FileNet P8 10
Process Engine 165 JBoss 50
cluster_virtual_name 40 upgrade
Component Integrator
enabling 106
server clusters 152
server farms 152
F
updating settings 108 file stores
upgrade object store 152
Component Manager configuring 65
upgrading 152, 160, 161
pre-installation tasks 53 FileNet p8
verifying deployment 66
creating object stores 67
T
terms and concepts
disaster recovery 1
server consolidation 1
time-to-live 15
TTL 15
Index 181
182 High Availability
GC19-2800-00