Installation and Upgrade Guide

radiographerfictionData Management

Oct 31, 2013 (4 years and 2 months ago)

669 views

InfoSphere Enterprise Records
Installation and Upgrade Guide
Version 4.5.1
GC19-2795-00
￿￿￿
InfoSphere Enterprise Records
Installation and Upgrade Guide
Version 4.5.1
GC19-2795-00
￿￿￿
Note
Before using this information and the product it supports,read the information in “Notices” on page 163.
Book edition notice
This edition applies to version 4.5.1 of IBM InfoSphere Enterprise Records (product number 5724-R76) and to all
subsequent releases and modifications otherwise indicated in new editions.
© Copyright International Business Machines Corporation 2001,2009.
US Government Users Restricted Rights – Use,duplication or disclosure restricted by GSAADP Schedule Contract
with IBM Corp.
Contents
ibm.com and related resources.....v
How to send your comments.........v
Contacting IBM.............vi
Planning and preparing for installation 1
Planning the installation..........1
InfoSphere Enterprise Records object stores...1
Sample configuration of an InfoSphere Enterprise
Records system............3
Components and guidelines for distribution...3
Definition of installation roles.......8
Using the installation and upgrade worksheet..9
Installing IBM InfoSphere Enterprise Records
Version 4.5.1 on FileNet P8 Platform Version 4.0.11
Performing required preparation tasks.....19
FileNet P8 Platform environment prerequisites.19
FileNet P8 Platform requirements......20
Configuring InfoSphere Enterprise Records for
FIPS 140-2 mode............22
Installation directory access requirements...23
Client installation directory access requirements 26
InfoSphere Enterprise Records installation
authentication requirements........28
InfoSphere Enterprise Records security....28
Installing InfoSphere Enterprise Records for SSL
security...............31
Configuring the InfoSphere Enterprise Records
Web application for redirect logon......31
Configuring the InfoSphere Enterprise Records
Web application for full SSL........33
Additional InfoSphere Enterprise Records
components.............34
Deciding on the number of databases or table
spaces...............35
Installing and configuring IBM
InfoSphere Enterprise Records....37
Installing IBM InfoSphere Enterprise Records
documentation.............37
Copying the required configuration files.....37
Installing IBM InfoSphere Enterprise Records...38
Installing the IBM InfoSphere Enterprise Records
software..............39
(Optional) Installing IBM InfoSphere Enterprise
Records components on other servers......44
Installing IBM InfoSphere Enterprise Records
components on other servers.......44
Installing IBM InfoSphere Enterprise Records
software updates............45
Configuring IBM InfoSphere Enterprise Records tool
servers................46
(Optional) Adding report viewing support....50
Installing and configuring the Crystal Reports
server...............50
Configuring the IBM InfoSphere Enterprise
Records server............52
Installing the latest Content Engine client files on
IBM InfoSphere Enterprise Records servers....54
(Upgrades) Removing Content Engine clients..54
Installing the Content Engine clients.....55
Installing the latest Process Engine client files on
IBM InfoSphere Enterprise Records servers....56
Installing the Process Engine clients.....56
Redeploying Workplace XT or Workplace....59
Deploying the IBM InfoSphere Enterprise Records
Web application.............60
Deployment log files..........60
Re-creating records_manager.war or
records_manager.ear files.........60
Deploying on IBM WebSphere Application Server 61
Deploying on Oracle WebLogic Server....67
Deploying on JBoss Application Server....68
Verifying IBM InfoSphere Enterprise Records
installation and deployment.........70
Configuration and startup tasks.......70
Adding marking sets and addons to the IBM
FileNet P8 domain...........70
Increasing the application server transaction
time-out..............75
Creating object stores for IBM InfoSphere
Enterprise Records...........77
Configuring IBM InfoSphere Enterprise Records
object stores.............77
Setting security for the file plan object store..78
Configuring your object stores for content based
retrieval..............81
Configuring your records object store.....83
(DoD Classified Only) Creating the classified
records security personnel access role.....84
Setting site preferences for IBM InfoSphere
Enterprise Records...........85
(Optional) Verifying the installed entry templates 89
Preparing to configure IBM InfoSphere Enterprise
Records workflows...........90
To configure a process region for IBM InfoSphere
Enterprise Records...........91
Transferring workflow definitions......97
Creating physical record management workflow
subscriptions.............98
Configuring IBM InfoSphere Enterprise Records
sweep applications..........100
Configuring additional IBM InfoSphere
Enterprise Records tools.........102
Optional tasks.............104
Configuring IBM InfoSphere Enterprise Records
Crystal Reports............104
Enabling the record type property.....116
Enabling and subscribing to events.....117
Installing a sample workflow.......117
(Optional) Configuring localized object stores 119
© Copyright IBM Corp.2001,2009
iii
Planning the IBM InfoSphere
Enterprise Records upgrade.....121
Upgrading from FileNet Records Manager V3.7 121
Verify content-based search........122
Configuring the object stores for CBR....122
Upgrading from FileNet Records Manager V4.0 122
Upgrading from FileNet Records Manager V4.5 122
Verify that prerequisites have been
fulfilled..............125
IBM InfoSphere Enterprise Records server....125
Backing up your FileNet Records Manager
installation..............125
Back up existing FileNet Records Manager
databases...............126
Verifying the required security information...126
Determine Secure Socket Layer (SSL) (full or
redirect) authentication..........127
Determine Single Sign On (SSO) authentication..127
Upgrading and configuring IBM
InfoSphere Enterprise Records....129
Upgrading IBM InfoSphere Enterprise Records
documentation.............129
Copying the required configuration files....129
Import existing file plans.........130
Upgrading IBM InfoSphere Enterprise Records
object stores from V3.7..........130
Enabling and subscribing to events......132
Upgrading events for FileNet Records Manager
V4.0 and V4.5............132
Upgrading events for FileNet Records Manager
V3.7...............132
Upgrading IBM InfoSphere Enterprise Records
software...............134
Upgrading IBM InfoSphere Enterprise Records
software..............135
Copying custom changes to the upgraded
actions.xml file............137
Upgrading IBM InfoSphere Enterprise Records
components on other servers (Optional)....138
Upgrading IBM InfoSphere Enterprise Records
components on other servers.......138
Installing IBM InfoSphere Enterprise Records
software updates............141
Configuring IBM InfoSphere Enterprise Records
tools................141
Adding report viewing support (Optional)...141
Installing Content Engine and Process Engine client
files................142
Redeploying Workplace or Workplace XT....142
Deploying the IBM InfoSphere Enterprise Records
Web application............143
Validating the installation........143
Configuration and startup tasks.......143
Adding add-ons to the FileNet domain....144
Reconfiguring IBM InfoSphere Enterprise
Records sweep applications.......144
Reconfiguring the process region for IBM
InfoSphere Enterprise Records and restarting
Component Manager..........145
Upgrading InfoSphere Enterprise Records
Crystal Reports (Optional)........149
Configuring upgraded object stores.....155
Transferring new V4.5.1 workflow definitions
(FileNet Records Manager V3.7 or V4.0
upgrades).............156
Configuring localized object stores (Optional) 156
Removing InfoSphere Enterprise
Records..............159
Removing InfoSphere Enterprise Records
(WebSphere Application Server).......159
Removing InfoSphere Enterprise Records
(WebLogic Server)............160
Removing InfoSphere Enterprise Records (JBoss
Application Server)...........161
Notices..............163
Trademarks..............165
Index...............167
iv
Installation and Upgrade Guide
ibm.com and related resources
Product support and documentation are available from ibm.com
®
.
Support and assistance
Product support is available on the Web.Click Support from the product Web site
at:
FileNet
®
Content Manager Support
http://www.ibm.com/software/data/content-management/filenet-content-
manager/support.html
Information center
You can view the product documentation in an Eclipse-based information center
that you can install when you install the product.By default,the information
center runs in a Web server mode that other Web browsers can access.You can also
run it locally on your workstation.See the information center at
http://publib.boulder.ibm.com/infocenter/p8docs/v4r5m1/index.jsp.
PDF publications
You can view the PDF files online using the Adobe
®
Acrobat Reader for your
operating system.If you do not have the Acrobat Reader installed,you can
download it from the Adobe Web site at http://www.adobe.com.
See the following PDF publications Web sites:
Product Web site
Product Documentation for FileNet
P8 Platform
http://www.ibm.com/support/docview.wss?rs=3278
&uid=swg27010422
How to send your comments
Your feedback is important in helping to provide the most accurate and highest
quality information.
Send your comments by using the online reader comment form at
https://www14.software.ibm.com/webapp/iwm/web/signup.do?lang=en_US
&source=swg-rcf.
Consumability survey
You are invited to tell IBM
®
how to improve the consumability of software
products.If you want to help IBM make IBM FileNet P8 easier to use,take the
Consumability Survey at http://www.ibm.com/software/data/info/
consumability-survey/.
© Copyright IBM Corp.2001,2009
v
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
Installation and Upgrade Guide
Planning and preparing for installation
Before you install IBM InfoSphere

Enterprise Records,ensure that you install and
configure the required components.Review the planning information by role:
system installation administrator,IT administrator,security administrator,database
administrator,and application server administrator.
Planning the installation
You must prepare your environment before you install IBM InfoSphere Enterprise
Records on an IBM FileNet P8 system.Ensure that you gather the necessary
information in the Installation and Upgrade Worksheet.
InfoSphere Enterprise Records object stores
An IBM InfoSphere Enterprise Records object stores can act as a File plan object
store,a record object store,or a combination of the two.
An object store can have more than one file plan and the object store can be
configured with only one default plan at a time.The default can be changed by the
Application Engine Administrator at any time.For more information on setting the
default file plan,see the IBM FileNet P8 help topic Expansion Products →
InfoSphere Enterprise Records → File plans → How to...→ Set the default file
plan.
An IBM FileNet P8 object store is a repository of objects and a suite of
accompanying storage and retrieval services.
For InfoSphere Enterprise Records,an object store can be any of the following:
File plan object store (FPOS)
A FPOS contains a file plan,which is a hierarchy of record management
objects needed to classify records.
Records object store (ROS)
A ROS contains documents that you can declare as records.
Combined FPOS and ROS
A combined FPOS and ROS contains both the file plan and documents.
For best performance,use a database store as the content store for the FPOS.
Important:Do not use periods in the FPOS name.You will not be able to declare a
record if a period is included in the object store name.For more information,see
the IBM FileNet P8 help topic Expansion Products → FileNet Records Manager →
Records → How to...→ Declare a record.The object store acting as the FPOS can
use one or more ROSs in the same IBM FileNet P8 domain for records declaration.
In a production environment,optimize security by ensuring that only a limited
number of Workplace

or Workplace XT

users have access to the entities that
make up your file plan in the FPOS.
You can choose between using a database store or file store as the content storage
area,based on the anticipated size of objects.Content Engine retrieves small
objects such as records objects (less than 1 MB in size) quicker from a database
© Copyright IBM Corp.2001,2009
1
store.Record objects contain a reference to the documents and their content.
Carefully plan which groups should be allowed to administer the object store
(object store administrators) and which groups need general access rights to create,
delete,or modify content.Setting security using groups helps create a more
manageable environment.
Important:When creating a new FPOS,make sure you add the users and groups
you assign Records Administrator privileges to in the FPOS to the object store
administrators group.
Executing queries or running the Disposition Sweep process for a file plan that has
a large number of record categories or record folders returns large data sets and
can therefore result in errors if the database timeout is not set appropriately.For
more information about timeouts configuration,see the following topics:
v FileNet P8 Platform 4.5
– See the Application server administrator tasks and Database administrator
tasks topics in the Plan and Prepare Your Environment for IBM FileNet P8 guide
for information about increasing timeouts.
v FileNet P8 Platform 4.0
– See the Configure an Application Server for Content Engine (appserver) tasks
in the IBM FileNet P8 Platform Installation and Upgrade Guide.
Related concepts
“Using the installation and upgrade worksheet” on page 9
InfoSphere Enterprise Records data models and add-ons
Before configuring an object store,you must choose the IBM InfoSphere Enterprise
Records data model that most closely fits your records management needs.
The data models are contained in add-ons that you will add to your environment
in “Adding marking sets and addons to the IBM FileNet P8 domain” on page 70.
You will configure your object stores to use the selected data models in
“Configuring IBM InfoSphere Enterprise Records object stores” on page 77.
InfoSphere Enterprise Records supports the following data models:
Base Provides core records management functionality and properties.The Base
data model is sufficient for meeting most records management
requirements and is the recommended model.However,it does not adhere
to either the DoD,DoD Classified,or PRO standards.
Department of Defense (DoD)
Includes the properties required by version 2 of the DoD standard (DoD
5015.2).
Department of Defense Classified (DoD Classified)
Includes the properties required by version 2 of the DoD Classified
standard (DoD 5015.2) for managing classified records.
Public Records Office (PRO)
Includes the properties required by the PRO 2002 standard.The PRO data
model might not be supported in subsequent releases of InfoSphere
Enterprise Records.
InfoSphere Enterprise Records and Content Federation Services
To configure a records management solution by using Content Federation Services,
you must configure your IBM InfoSphere Enterprise Records and Content
2
Installation and Upgrade Guide
Federation Services environment and determine the file plan and records
management rules that are required to support your implementation.
For general information about using Content Federation Services with InfoSphere
Enterprise Records,see the IBM FileNet P8 Help topic Expansion Products →
Content Federation Services → Content Federation Services overview → Planning
considerations for CFS → Planning for Records Management.For information on
how to use federated repositories for Image Services with InfoSphere Enterprise
Records,see the IBM FileNet Content Federation Services for Image Services Planning
and Configuration Guide.
For information on how to use federated repositories with IBM Content Manager
OnDemand,see the IBM FileNet Content Federation Services for Content Manager
OnDemand Planning and Configuration Guide.
Sample configuration of an InfoSphere Enterprise Records
system
A typical distribution of IBM InfoSphere Enterprise Records components across
servers in a FileNet P8 environment includes Process Engine server,Content
Engine server,Application Engine or Workplace XT Web application server,a
Crystal Reports server,a database server,a directory server,Enterprise Manager
administration client,and a browser client.
Components and guidelines for distribution
IBM InfoSphere Enterprise Records consists of several components.Use each of
these components to perform a specific set of tasks.For instance,the InfoSphere
Enterprise Records Web Application component is used to create and manage
InfoSphere Enterprise Records entities and other associated objects.
In addition,some of the components or sub-components need to be configured
before they can be used.
The installation instructions explain how to install and configure all InfoSphere
Enterprise Records components on a single server that also hosts Application
Engine or Workplace XT.However,some InfoSphere Enterprise Records
components can be distributed across multiple servers to optimize performance
and system resources.
Directory
server
Browser
client
Enterprise
Manager
Ethernet
Process
Engine
server
Application
Engine server
IBM InfoSphere
Enterprise Records
application server
Crystal
Reports
server
[optional]
Content
Engine
server
Database
server
Figure 1.InfoSphere Enterprise Records in a typical distributed IBM FileNet P8 environment
Planning and preparing for installation
3
Components installed by the setup program
You can install IBM InfoSphere Enterprise Records components,such as InfoSphere
Enterprise Records API and the InfoSphere Enterprise Records Disposition Sweep
and Hold Sweep,by using the InfoSphere Enterprise Records setup program.You
must install other components manually.
You can install the following InfoSphere Enterprise Records components by using
the InfoSphere Enterprise Records setup program:
InfoSphere Enterprise Records Web Application
This component provides a Web-based application that enables you to
configure the InfoSphere Enterprise Records environment and perform
various records management tasks.
You must install the InfoSphere Enterprise Records Web Application on the
same server as the Application Engine or Workplace XT.
Restriction:Running a single InfoSphere Enterprise Records installation
with both an Application Engine and a Workplace XT system on the same
server is not supported.
If Application Engine and Content Engine are collocated,verify that the
server is appropriately sized before you add InfoSphere Enterprise
Records.
InfoSphere Enterprise Records must run on the same Java

Virtual
Machine (JVM) as Application Engine or Workplace XT.
InfoSphere Enterprise Records 4.5.1 on FileNet P8
Platform 4.5
InfoSphere Enterprise Records 4.5.1 on FileNet P8
Platform 4.0
For information on Application Engine,see the following
Plan and Prepare Your Environment for IBM FileNet P8
tasks,as appropriate for your application server
environment:
v Configure Application Engine or Workplace XT
(WebSphere
®
Application Server)
v Configure Application Engine or Workplace XT
(WebLogic Server)
v Configure Application Engine or Workplace XT (JBoss
Application Server)
For information on Application Engine,see the following
IBM FileNet P8 Platform Installation and Upgrade Guide
tasks,as appropriate for your application server
environment:
v Configure an Application Server for Application Engine
(WebSphere Application Server)
v Configure an Application Server for Application Engine
(WebLogic Server)
v Configure an Application Server for Application Engine
(JBoss Application Server)
For information on IBM FileNet Workplace XT,see the
following IBM FileNet Workplace XT Installation and
Upgrade Guide tasks,as appropriate for your application
server environment:
v Configure Workplace XT (WebSphere Application
Server)
v Configure Workplace XT (WebLogic Server)
v Configure Workplace XT (JBoss Application Server)
InfoSphere Enterprise Records API
This component includes the JAR files that provide interfaces and classes
for creating a custom application or customizing records-related operations.
The InfoSphere Enterprise Records Web Application requires the
InfoSphere Enterprise Records API,which is automatically installed with
this component (automatically selected for a custom installation).For
custom installations,if you do not plan to install the InfoSphere Enterprise
4
Installation and Upgrade Guide
Records Web Application,you can install the InfoSphere Enterprise
Records API component on any developer system.The InfoSphere
Enterprise Records API JAR files do not need to be collocated with any
IBM FileNet P8 component.
InfoSphere Enterprise Records Disposition Sweep and Hold Sweep
These components include the files required for configuring the Disposition
Sweep and Hold Sweep processes and for scheduling the sweep tasks.
These components are used to manage the disposition and holding of
records based on a defined schedule.
You can install the sweep components on any server.The components do
not need to be collocated with the InfoSphere Enterprise Records Web
Application or any other IBM FileNet P8 core component,such as the
Content Engine.
Tip:Testing has shown that installing the sweep components on the
Content Engine server helps to ensure fast access to the object store for
sweep calculations.To install only these components on the Content
Engine server,run the InfoSphere Enterprise Records installer on the
Content Engine and use the Custom installation option.For more
information,see “(Optional) Installing IBM InfoSphere Enterprise Records
components on other servers” on page 44.
File Plan Import Export tool
This component enables you to import an external file plan,or export a file
plan to an external environment.
Tip:Testing has shown that installing the File Plan Import Export Tool on
the Content Engine server helps ensure fast access to the object store.To
install this component on the Content Engine server,run the InfoSphere
Enterprise Records installer on the Content Engine and use the Custom
installation option.For more information,see “(Optional) Installing IBM
InfoSphere Enterprise Records components on other servers” on page 44
Transfer tool
This component enables you to transfer active records and record folders
to an external system for permanent archiving.For more information,see
“(Optional) Installing IBM InfoSphere Enterprise Records components on
other servers” on page 44.
Components installed manually
You must install several IBM InfoSphere Enterprise Records components by
manually configuring or importing those components into each InfoSphere
Enterprise Records object store.
Configure or import the following IBM InfoSphere Enterprise Records components
into each object store that is used for InfoSphere Enterprise Records:
InfoSphere Enterprise Records Data Model
This component includes the add-on files to add the required properties
into an object store for the following records management standards:
v Base
v Public Records Office (PRO)
v Department of Defense 5015.2-STD (DoD)
v Department of Defense 5015.2-STD (DoD Classified)
Planning and preparing for installation
5
Configuring an object store with a data model enables you to create a file
plan in the object store.A file plan refers to a hierarchy of record
management objects used to classify records.For more information,see
“InfoSphere Enterprise Records data models and add-ons” on page 2 and
“Configuring IBM InfoSphere Enterprise Records object stores” on page 77.
InfoSphere Enterprise Records Workflow
This component includes the required JAR files and the configuration files
to configure and use InfoSphere Enterprise Records workflows.For more
information,see “Preparing to configure IBM InfoSphere Enterprise
Records workflows” on page 90.
InfoSphere Enterprise Records Crystal Reports
This optional component includes Crystal Reports templates that help you
track records management activities.For more information,see
“Configuring IBM InfoSphere Enterprise Records Crystal Reports” on page
104.
Restriction:
v An SSL-enabled Process Engine cannot be collocated with the Crystal
Reports Application Server.Due to a conflict between the versions of the
DLL nss3.dll used by the two products,you cannot collocate it with the
Crystal Reports Application Server if the Process Engine is configured
with SSL.
v (Windows
®
2003 SP

1 only) Before you install Crystal Reports you must
set Data Execution Protection (DEP) for essential Windows programs
and services only.Failure to do this prevents services required by
Crystal Reports from starting automatically.
On the Windows 2003 server,complete the following steps:
1.Click My Computer,and select Properties.
2.Select the Advanced tab.
3.Select Performance Settings.
4.Select the Data Execution Prevention tab.
5.Select the Turn on DEP for essential Windows programs and
services only option.
6.Click OK.
7.Click OK.
The Content Engine Java TM Client connectivity module must be installed
on the Crystal Reports server.For detailed information on the setup
requirements for reports,see:“(Optional) Adding report viewing support”
on page 50 and “Configuring IBM InfoSphere Enterprise Records Crystal
Reports” on page 104.
Configuration files
There are a number of IBM InfoSphere Enterprise Records configuration files
installed in the RM_install_path/FileNet/Config/RM directory.
The following configuration files are installed in the RM_install_path/FileNet/
Config/RM directory:
v Actions.xml
v containericons.properties
v content_redir.properties
v icons.properties
6
Installation and Upgrade Guide
v InfoPages.xml
v PolicyProcessors.xml
v PropertiesPage.xml
v RecordProperties.xml
v ReportConfig.properties
v ReportsDefinitions.xml
The installation software
Separate installation software is available for installing IBM InfoSphere Enterprise
Records on each of the supported platforms.There are several package directories
that contain the files:Events,LocalizationAddOns,Reports,
RM37PreContentEngineUpgrade,and Samples.There are also files installed:
media.inf,4.5.1.0-P8RM-platform.ext,readme.htm,
RM_install_silent_input.txt:,and version.txt.
The supported platforms are listed in IBM FileNet P8 Hardware and Software
Requirements.
The following package directories and files are included in the InfoSphere
Enterprise Records installation software:
Events This directory contains the XML and JAR files that you can use to perform
tasks such as auto-declaration of records.This directory contains a
Readme.pdf with instructions on how to create and subscribe to events.
For UNIX
®
platforms,the Events directory is packaged as a TAR file.After
copying the file to your system you must extract the Events directory from
the file.
LocalizationAddOns
This directory contains localized source files for the InfoSphere Enterprise
Records add-on.
Reports
This directory contains the Crystal Reports templates for generating reports
to help you manage the InfoSphere Enterprise Records environment.
RM37PreContentEngineUpgrade
This directory contains a program for preparing object stores for upgrades
from FileNet Records Manager V3.7 to InfoSphere Enterprise Records
V4.5.1.
Samples
This directory contains a sample file plan,sample templates,and a sample
workflow.
media.inf
This file contains information used by the setup software.
4.5.1.0-P8RM-platform.ext
This is the setup program used to install the InfoSphere Enterprise Records
components.
readme.htm
This file contains instructions on how to access the general documentation
for the InfoSphere Enterprise Records product.
RM_install_silent_input.txt:
This is the silent install input file used to install the InfoSphere Enterprise
Records components.
Planning and preparing for installation
7
version.txt
This file contains information on the product build versions used in this
release of InfoSphere Enterprise Records.
Definition of installation roles
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.
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.
The role of IA is usually filled by an IBM FileNet Certified Professional (FCP).
Information technology administrator
v Responsible for the networking and operating systems settings required by IBM
FileNet P8.
v Responsible for performing certain security configurations.
v Abbreviated as ITA.Responsible for providing the information in the rows in
the Installation and Upgrade Worksheet with a value of ITA in the Role column.
Security administrator
v Responsible for configuring the directory servers required by 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.
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.
8
Installation and Upgrade Guide
IBM FileNet P8 administrator
v This role designation actually refers to the administrator or administrators who
perform regular maintenance of Content Engine,Process Engine Application
Engine,Workplace or Workplace XT.
v The administrator who logs on to Enterprise Manager by using the gcd_admin
account or an object_store_admin account is considered an IBM FileNet P8
administrator.
v Abbreviated as P8A.Responsible for providing the information in the rows of
the Installation and Upgrade Worksheet with a value of P8A in the Role column.
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.
Using the installation and upgrade worksheet
The Installation and Upgrade Worksheet is a Microsoft
®
Excel spreadsheet
(p8_worksheet.xls).The worksheet describes the properties and parameters
required to complete IBM FileNet P8 installation,upgrade,and configuration
programs,and provides a way to record the values you assign to these properties
and parameters.
Administrators who are preparing the environment for installation or upgrade of
IBM FileNet P8 components must use the worksheet during their preparation tasks
to record the appropriate values and provide them to the Installation
Administrator who runs the installation or upgrade programs.
Some of the features of the Installation and Upgrade Worksheet are:
v Instructions:describes the worksheet and includes a button that runs the
Customize Worksheet macro.
v The two highlighted columns,Property or Parameter and ENTER YOUR
VALUE HERE,provide the simplest view of the requirement.The others add
identifying information and help you sort and filter the rows usefully.
v The Role column assigns each row to an administrator and uses the following
acronyms:
– ITA:Information Technology Administrator
– ASA:Application Server Administrator
– DBA:Database Administrator
– SA:Security Administrator
– P8A:IBM FileNet P8 Administrator
v Property definitions are contained in the column titled Description.
v Some rows,though not all,contain a hyperlink in the PPG Links column.Click
this hyperlink to run a query against the IBM Information Center,which opens
with the Search Results pane showing the topics that contain the words in the
query phrase.Browse the search results until you have enough information to be
able to enter a value in the Worksheet row.
Planning and preparing for installation
9
Related reference
Installation and Upgrade worksheet
Running the Customize Worksheet macro
The Customize Worksheet macro lets you extract only those rows that describe
your environment.
Important:For support of the full range of built-in filter and macro features,use
Microsoft Excel to view the Installation and Upgrade Worksheet file.You can use
other spreadsheet programs to view the file;however,filter and macro support can
vary.For example,in Calc from OpenOffice.Org,the column filters work as
expected,but the Customize Worksheet button does not.
To run the Customize Worksheet macro:
1.Open the Installation and Upgrade Worksheet (p8_worksheet.xls) and click the
Instructions worksheet (also called a tab).
2.Scroll down until you see the button representing the Customize Worksheet
macro.Click the button.
3.Select the components and options that describe the environment you are
preparing for IBM FileNet P8.
v Installation or Upgrade
v FileNet P8 Components
v Application Server type
v Operating system
v Database type
v Directory Server type
v Number of object stores (adds new sets of rows for creating additional data
sources)
v Name of customized sheet
4.Click OK.The macro copies the rows that fulfill your selection criteria into a
new worksheet with the name you entered.Enter the values for your
environment into this new worksheet.
5.Click the name of the new worksheet at the bottom of the Excel window.Add
your preparation values into this new worksheet.
6.Notice that the new worksheet has buttons at the top titled Show Installer
View and Show Full View,depending on its state.The Show Installer View
displays only those columns that you need while running installation or
configuration programs.
Autofiltering and sorting the Worksheet
There are several ways to organize the Worksheet to make finding properties and
entering values easier.
AutoFiltering is a quick way to display only those rows that meet a certain criteria.
To use AutoFilter:
1.Make sure AutoFiltering is enabled.(Select the entire row with the column
headers,then click Data → Filter → Autofilter.) AutoFilter arrows will appear to
the right of the column labels.
2.Click the AutoFilter arrow in the Installation or Configuration Program
column header and select the program you are interested in (for example,PE
installer).
10
Installation and Upgrade Guide
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.
Installing IBM InfoSphere Enterprise Records Version 4.5.1 on
FileNet P8 Platform Version 4.0
If you are installing IBM InfoSphere Enterprise Records V4.5.1 on a FileNet P8
Platform 4.0 system,you can use a consolidated checklist of the requirements and
planning considerations.
You must identify information you need during the installation and configuration
process.
The lists are divided by user or role.Note that your organization may have
different administrator roles,and that some of the responsibilities of listed roles
may vary.
Important:Print and fill out this form before you begin the IBM InfoSphere
Enterprise Records installation and configuration process.Where applicable,the list
items indicate which role needs the information you provide.IBM FileNet P8
recommends coordinating communication among the various roles to facilitate an
easier installation process.
FileNet P8 Platform environment prerequisites
The core components of the IBM FileNet P8 suite of products (Content Engine,
Process Engine,and Application Engine or Workplace XT) must be installed before
starting the IBM InfoSphere Enterprise Records installation.
Content Engine,Process Engine,and Application Engine or Workplace XT must
already be updated to the latest patch levels that are compatible with IBM
InfoSphere Enterprise Records.
See the IBM FileNet P8 Compatibility Matrix to determine the most current,
compatible fix pack levels for Content Engine,Process Engine,and Application
Engine or Workplace XT.
The environment must meet all applicable requirements listed in the IBM FileNet
P8 Hardware and Software Requirements document.
IBM FileNet Workplace or Workplace XT must be installed and available.
Planning and preparing for installation
11
If the site is using the InfoSphere Enterprise Records supplied reports,the server
where you install Crystal Reports must also have the Content Engine Java Client
Files and Enterprise Manager (optional) installed.Therefore,be sure that you have
the FileNet P8 Platform installation media available.
See “(Optional) Adding report viewing support” on page 50,“Configuring IBM
InfoSphere Enterprise Records Crystal Reports” on page 104,and the Crystal
Reports documentation.
Related information
Product documentation,requirements,and compatibility for IBM FileNet P8
Platform
Documentation
Ensure that you have enabled JavaScript

support in your Web browser to support
searching within the IBM FileNet P8 Help.Also ensure you have the latest
installation documentation.
When installing InfoSphere Enterprise Records:
v Ensure that you have a copy of the IBM FileNet P8 Platform Installation and
Upgrade Guide available.
v Ensure that you have the latest version of the IBM FileNet Records Manager
Installation and Upgrade Guide available.
v Determine where the IBM FileNet P8 Platform documentation is installed.See
“Installing IBM InfoSphere Enterprise Records documentation” on page 37.
IBM InfoSphere Enterprise Records considerations
Decide whether to perform a typical install,a custom install,or both (for example,
you might choose to do a typical install on one server and then do a custom install
on developer machines to install only the InfoSphere Enterprise Records API).
Decide where to install Disposition Sweep.See “Installing IBM InfoSphere
Enterprise Records” on page 38.
v Typical:
v Custom:
v Both:
Decide where to install Hold Sweep.See “Components and guidelines for
distribution” on page 3.
v Server Name:
Decide where to install File Plan Import Export Tool.See “Components and
guidelines for distribution” on page 3.
v Server Name:
Decide where to install Transfer Tool.See “Components and guidelines for
distribution” on page 3.
v Server Name:
Decide whether to use the reports supplied by InfoSphere Enterprise Records
(Crystal Reports).See “Components and guidelines for distribution” on page 3.
v Server Name:
12
Installation and Upgrade Guide
If the site is using the reports supplied by InfoSphere Enterprise Records,decide
where to install the Crystal Reports application server.See “Components and
guidelines for distribution” on page 3 and “Configuring IBM InfoSphere Enterprise
Records Crystal Reports” on page 104.
v Yes:
v No:
If the site is using the reports supplied by InfoSphere Enterprise Records,then
determine which reports you want to use.See “Components and guidelines for
distribution” on page 3.
v Server Name:
See “Configuring IBM InfoSphere Enterprise Records Crystal Reports” on page 104.
v Report Names:
Determine which data model (Base,DoD,DoD Classified,or PRO) you want to
use.See “InfoSphere Enterprise Records data models and add-ons” on page 2 and
“Configuring IBM InfoSphere Enterprise Records object stores” on page 77.
v Base:
v DoD:
v DoD Classified:
v PRO:
Identify the object stores that you plan to use and create.
Determine the FPOS name (make the name meaningful,because this is the name
that users see when browsing object stores).Note that you will need this name
when you perform the task to transfer workflow definitions.
Tip:Do not use periods in the FPOS name.You will not be able to declare a record
if a period is included in the object store name.For more information,see the IBM
FileNet P8 Help topic Expansion Products → Records Manager → Records → How
to...→ Declare a record.
In addition,determine whether you want to use a database storage area or a file
storage area as the content storage area for the InfoSphere Enterprise Records
object store.See “InfoSphere Enterprise Records object stores” on page 1 and
“Creating object stores for IBM InfoSphere Enterprise Records” on page 77.
v Object Store Name:
v Function (FPOS,ROS,or Both):
v Type (database or file storage area):
Decide whether to install the sample declare record workflow.See “Installing a
sample workflow” on page 117.
v Yes:
v No:
Decide whether to enable SSL.See “Installing InfoSphere Enterprise Records for
SSL security” on page 31.
v No SSL:
v Redirect for login:
v Full SSL:
Planning and preparing for installation
13
Optional IBM InfoSphere Enterprise Records considerations
There are optional tasks that an administrator can perform after InfoSphere
Enterprise Records is installed and configured (none of these tasks require you to
install specific files from the installation media).However,you can choose to
perform some or all of these tasks as part of the installation and configuration
process.
Decide whether to allow users to create and manage links.See “Setting site
preferences for IBM InfoSphere Enterprise Records” on page 85.
v Yes:
v No:
Decide whether to add a link from Workplace or Workplace XT to InfoSphere
Enterprise Records.See “Setting site preferences for IBM InfoSphere Enterprise
Records” on page 85.
v Yes:
v No:
Decide whether to allow users with insufficient privileges to create a record folder
to instead be able to send a request to a user with the Records Manager role to
create a folder.See “Setting site preferences for IBM InfoSphere Enterprise
Records” on page 85.
v Yes:
v No:
Decide whether to use record types.See “Enabling the record type property” on
page 116.If yes,list the Record classes that must have a Record Type property
assigned to them.
v Yes:
v No:
For a site using the DoD,DoD Classified,or PRO data model,decide whether to
enable/subscribe to any of the events mentioned in “Enabling and subscribing to
events” on page 117.If yes,list the events.
v Yes:
v No:
Application Engine or Workplace XT server
Determine if you want to install IBM InfoSphere Enterprise Records in a directory
other than the default on the Application Engine or Workplace XT server.
Identify the location of the Workplace or Workplace XT bootstrap.properties file.
See “Installing IBM InfoSphere Enterprise Records” on page 38.
v Directory path:
Identify the complete path for the WEB-INF folder of the installed Workplace or
Workplace XT application.See “Installing IBM InfoSphere Enterprise Records” on
page 38.
v Directory path:
14
Installation and Upgrade Guide
Identify the connection point that is listed in the Workplace or Workplace XT Site
Preferences under General view → Tasks site preference.See “Configuring
component queues” on page 95 and “Transferring workflow definitions” on page
97.
v Directory path:
Identify the folder where the Java executable is located (for example,
c:\bea\jdk141.05\bin).See “Configuring IBM InfoSphere Enterprise Records
sweep applications” on page 100.
v Directory path:
Determine if your Workplace installation uses Application-Managed Authentication
(AMA) or Container-Managed Authentication (CMA) authentication.
When accessing the Workplace login page,if the URL ends with
/ContainerLogin.jsp,installation will run CMA authentication.
Tip:The InfoSphere Enterprise Records application should use the same
authentication method as the deployed Workplace or Workplace XT application.
Workplace XT installations only use CMA authentication.They do not use AMA
authentication.
See “Installing the IBM InfoSphere Enterprise Records software” on page 39.
v AMA:
v CMA:
General requirements
If you are installing IBM InfoSphere Enterprise Records with Application Engine,
your Web client operating system or browser language must be set to the same
locale as the Application Engine,and the Content Engine and Process Engine must
support the same locale as the Application Engine.
The environment must meet all applicable requirements listed in the IBM FileNet
P8 Hardware and Software Requirements document available on the IBM Information
Management support page at http://www.ibm.com.
If InfoSphere Enterprise Records and Workplace/Workplace XT are configured for
SSL,to use Workplace/Workplace XT Java Applets on a client machine,you must
download a certificate,and then import the certificate into your Java plug-in
keystore.
For more information,see the IBM FileNet P8 Help topic Workplace → Workplace
User Help → Basics → Use Java Applets.
The Java Virtual Machine (JVM) located on the server on which you install
Disposition Sweep must be JDK (Java Development Kit) 1.4 or higher.
Authentication requirements
You can reference the user names and passwords to authenticate to various
components.
The privileges for which you need a user name and password.See “Adding
marking sets and addons to the IBM FileNet P8 domain” on page 70.
v GCD Administrator (role)
– User Name:
Planning and preparing for installation
15
– Password:
Application Engine or Workplace XT server
The user who installs IBM InfoSphere Enterprise Records components must have
permissions as documented in “Installation directory access requirements” on page
23.See “Installing IBM InfoSphere Enterprise Records” on page 38.
v User Name:
v Password:
Web application server (Application Engine or Workplace XT server)
v For a WebSphere Application Server,you need sufficient privileges to log on to
the WebSphere Administrative Console.
v For a WebLogic Server,you need sufficient privileges to log on to WebLogic.
JBoss Application Server does not require a user name and password.See
“Deploying the IBM InfoSphere Enterprise Records Web application” on page 60.
v User Name:
v Password:
Object store administrator role for FPOS.See the following topics:
v “Configuring IBM InfoSphere Enterprise Records object stores” on page 77
v “Setting security for the file plan object store” on page 78
v “Creating physical record management workflow subscriptions” on page 98
v “Configuring IBM InfoSphere Enterprise Records Crystal Reports” on page 104
v “Enabling the record type property” on page 116
v “Enabling and subscribing to events” on page 117
v Accounts:
Object store administrator role for ROS.See “Configuring your records object
store” on page 83.
v Accounts:
(DoD Classified only) Object store administrator role (for Application Engine or
Workplace XT site preferences object store).See “(DoD Classified Only) Creating
the classified records security personnel access role” on page 84.
v Accounts:
Object store administrator (FPOS).See “Transferring workflow definitions” on page
97.
v User Name:
v Password:
For Sun Java System Directory Server,you need to supply the fully-qualified
LDAP name (for example,uid=Administrator,cn=CE Admin Group,ou=FileNet,
dc=com ).
Application Engine Administrator access role.See the following topics:
v “Refreshing the Workplace and Workplace XT base URL” on page 88
v “To configure a process region for IBM InfoSphere Enterprise Records” on page
91
16
Installation and Upgrade Guide
v User Name:
v Password:
Classified Records Security Personnel access role.See the following topics:
v “(DoD Classified Only) Creating the classified records security personnel access
role” on page 84
v “Setting site preferences for IBM InfoSphere Enterprise Records” on page 85
v User Name:
v Password:
PWDesigner access role.See “Installing a sample workflow” on page 117.
v Accounts:
The following are privileges for which you need to be a member of several groups
(including a InfoSphere Enterprise Records group) to complete a task.See “Setting
site preferences for IBM InfoSphere Enterprise Records” on page 85 and
“Configuring component queues” on page 95.
Process Engine Administrator and Records Administrator roles.
v Accounts:
PWConfiguration access role and Records Administrator roles.See “To configure a
process region for IBM InfoSphere Enterprise Records” on page 91.
v Accounts:
Process Engine Configuration group,PWConfiguration access role,and Records
Administrator role.See “To configure a process region for IBM InfoSphere
Enterprise Records” on page 91.For information on the Process Engine
Configuration Group,see the IBM FileNet P8 Help topic FileNet P8
Administration → Enterprise-wide Administration → Process Task Manager →
Process Engine → Configure Process Engine → Security.
v Accounts:
Process Engine Administrator and Records Administrator role.See “Configuring a
process region for InfoSphere Enterprise Records” on page 92.
v Accounts:
Process Engine Administrator,Records Administrator role,the right to start FileNet
Records Manager component queues.See “Configuring component queues” on
page 95.
v Accounts:
Process Engine Administrator,object store administrator (FPOS),and Records
Administrator role.See “Configuring IBM InfoSphere Enterprise Records sweep
applications” on page 100.
v Accounts:
Object store administrator (FPOS) and Records Administrator role.See the
following topics:
v “Configuring your object stores for content based retrieval” on page 81
v “Configuring IBM InfoSphere Enterprise Records Crystal Reports” on page 104
v “(Optional) Verifying the installed entry templates” on page 89
Planning and preparing for installation
17
v Accounts:
Content Engine server
Decide on a permanent location on the Content Engine server for folders that will
contain IBM InfoSphere Enterprise Records configuration files.
See “Copying the required configuration files” on page 37.
v Configuration File Directory:
Identify the name and port number of the Content Engine server.See “Installing
IBM InfoSphere Enterprise Records” on page 38.
v Content Engine Server Name:
v Port No.
If you plan to use the SendEmailOnSupercede event,identify the IP address or the
machine name of the mail server.See “Enabling and subscribing to events” on
page 117.
v Mail Server Name:
v IP Address:
IBM InfoSphere Enterprise Records users
Plan which users and groups should be allowed to administer the FPOS and which
ones need general access rights to create,delete,or modify content.
See “InfoSphere Enterprise Records security” on page 28,“Setting security for the
file plan object store” on page 78 and “Configuring your records object store” on
page 83.See “Authentication requirements” on page 15 for additional
considerations.
v Security role:
– Classification Guide Administrators (DoD Classified only)
– Records Administrator
– Records Manager
– Records Reviewer/Privileged Users
– Records Users
v Assigned to:
– Classification Guide Administrators (DoD Classified only)
– Records Administrator
– Records Manager
– Records Reviewer/Privileged Users
– Records Users
If importing the PRO data model,select the security marking propagation option
that you want to set for objects.See “Security markings propagation” on page 30.
v No propagation:
v Folder to Record:
v Record to Folder:
Determine the Document classes on the ROS for which the CanDeclare property
must be set to True (which specifies that instances of the class can be declared as a
record).Then,determine if the setting should be propagated to subclasses.See
“Configuring your records object store” on page 83.
18
Installation and Upgrade Guide
v Document Class
v Propagate to Subclasses (Yes or No)
Determine which groups to assign to the Records Manager work queues to specify
who can process work queue items.See “To configure a process region for IBM
InfoSphere Enterprise Records” on page 91.
v Groups:
Performing required preparation tasks
In order to install IBM InfoSphere Enterprise Records,there are several tasks to
complete for a person serving as the system’s installation administrator,IT
administrator,security administrator,database administrator,and application
server administrator.
In addition to the 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.
FileNet P8 Platform environment prerequisites
You must install the following core components of the IBM FileNet P8 suite of
products before you install IBM InfoSphere Enterprise Records:Content Engine,
Process Engine,and Application Engine or Workplace XT.
Important:You must complete the Application Engine or Workplace XT
installation,including installing the latest Content Engine and Process Engine client
files on the server.Failing to complete this step might cause the InfoSphere
Enterprise Records installer to fail.
Content Engine,Process Engine,and Application Engine or Workplace XT must
already be updated to the latest patch levels that are compatible with InfoSphere
Enterprise Records.See the IBM FileNet P8 Compatibility Matrix to determine the
most current,compatible fix pack levels for Content Engine,Process Engine,and
Application Engine or Workplace XT.The environment must meet all applicable
requirements listed in the IBM FileNet P8 Hardware and Software Requirements
document.
IBM FileNet Workplace or Workplace XT must be installed and available.
Restriction:Running a single InfoSphere Enterprise Records installation with both
an Application Engine or Workplace XT system on the same server is not
supported.
Content Engine and Process Engine Client Installers must have been run for
Workplace or Workplace XT.
If the site is using the reports supplied by InfoSphere Enterprise Records,the
server where you install Crystal Reports must also have the Content Engine Java
Client Files and Enterprise Manager (optional) installed.Therefore,be sure you
have the FileNet P8 Platform installation media available.See “(Optional) Adding
report viewing support” on page 50,“Configuring IBM InfoSphere Enterprise
Records Crystal Reports” on page 104,and the Crystal Reports documentation.
Planning and preparing for installation
19
Related information
Product documentation,requirement,and compatibility for IBM FileNet P8
Platform
Application Engine or Workplace XT server
The IBM InfoSphere Enterprise Records application should use the same
authentication method as the deployed Workplace or Workplace XT application.
Workplace XT installations only use CMA authentication.They do not use AMA
authentication.
v Identify the folder where the Java executable is located (for example,
c:\bea\jdk141.05\bin ).
– Folder:
See “Configuring IBM InfoSphere Enterprise Records sweep applications” on
page 100.
v Determine if your Workplace installation uses Application-Managed
Authentication (AMA) or Container-Managed Authentication (CMA)
authentication.
When accessing the Workplace login page,if the URL ends with
/ContainerLogin.jsp,installation will run CMA authentication.
See “Installing the IBM InfoSphere Enterprise Records software” on page 39.
Installing interactively or silently
Install IBM InfoSphere Enterprise Records interactively or silently.For a sample
silent installation script and instructions,see the file RM_install_silent_input.txt
in the InfoSphere Enterprise Records installation software.
Installation modes
Install IBM InfoSphere Enterprise Records in Typical and Custom mode.
You can install InfoSphere Enterprise Records in the following modes:
Typical
Use this mode to install all InfoSphere Enterprise Records components on
one server,except the InfoSphere Enterprise Records source code which
requires a custom installation.
Custom
Use this mode to distribute the installation of various InfoSphere
Enterprise Records components across several machines.Using this mode,
you can select and install each InfoSphere Enterprise Records component
independently.
For more information,see “Installing IBM InfoSphere Enterprise Records” on page
38.
FileNet P8 Platform requirements
You must apply the required minimum level of IBM FileNet P8 service packs or fix
packs to your installed FileNet P8 components before you install or upgrade to
IBM InfoSphere Enterprise Records V4.5.1.
See the IBM FileNet P8 Compatibility Matrix to determine the most current,
compatible fix pack levels for Content Engine,Process Engine,and Application
Engine or Workplace XT.
Install either Application Engine or Workplace XT.Do not install both platforms.
20
Installation and Upgrade Guide
Over the life of IBM FileNet P8,fix pack requirements can change.For more
details,see the IBM FileNet P8 Compatibility Matrix.
General requirements
The environment you are installing in must meet all applicable requirements
concerning locale support and SSL information.
The requirements are listed in the IBM FileNet P8 Hardware and Software
Requirements document.
If you are installing IBM InfoSphere Enterprise Records with Application Engine,
your Web client operating system or browser language must be set to the same
locale as the Application Engine,and the Content Engine and Process Engine must
support the same locale as the Application Engine.
If InfoSphere Enterprise Records and Workplace or Workplace XT are configured
for SSL,to use Workplace or Workplace XT Java applets on a client machine,you
must download a certificate,and then import the certificate into your Java plug-in
keystore.For more information,see the IBM FileNet P8 Help topic Workplace →
Workplace User Help → Basics → Use Java Applets.
The Java Virtual Machine (JVM) located on the server on which you install
Disposition Sweep must be JDK (Java Development Kit) 1.4 or higher.
InfoSphere Enterprise Records server
If you install InfoSphere Enterprise Records tools on servers other than the
InfoSphere Enterprise Records Web application server,you must install the
minimum JRE or JDK versions on those servers.There is also information on FIPS
and JRE for IPv6.
Ensuring minimum required disk space and temp space for installation
See the http://www.ibm.com/support/docview.wss?rs=3278&uid=swg27013654.
Ensuring minimum JRE or JDK levels for InfoSphere Enterprise Records tools
servers
For more information,see IBM FileNet P8 Hardware and Software Requirements
document.
v InfoSphere Enterprise Records Transfer Tool or File Plan Import Export tool:JRE
or JDK version 1.5 or higher
v InfoSphere Enterprise Records Disposition or Hold Sweep:JRE or JDK version
1.4 or higher
Ensuring requirements for Federal Information Processing Standards
(FIPS) 140 encryption
If you use FIPS 140 encryption in your environment you must install WebSphere
Application Server 7 or WebSphere Application Server 7 Client on all servers
running InfoSphere Enterprise Records components.
Ensuring JRE for IPv6 support
If you use the IPv6 standard in your environment you must install a JRE that
supports IPv6,such as IBM JRE 1.5,on all InfoSphere Enterprise Records servers.
Planning and preparing for installation
21
For more information,see the IBM FileNet P8 Hardware and Software Requirements
document.
Content Engine server
Increase the Content Engine Query Page Size for better performance by the IBM
InfoSphere Enterprise Records Tools.
v Increase the Content Engine Query Page Size for better performance by the
InfoSphere Enterprise Records Tools.
1.In Enterprise Manager,click Enterprise Manager and select Properties.
2.On the Properties page,next to property name,Subsystem Configurations,
click the menu and select Server Cache Configuration Properties.
3.On the Server Cache Configuration Properties page,select the Properties tab
and increase the value of Query Page Max Size to at least 10,000.
v Decide on a permanent location on the Content Engine server for folders that
will contain InfoSphere Enterprise Records configuration files:
– Configuration File Directory:
See “Copying the required configuration files” on page 37.
v If you plan to use the SendEmailOnSupercede event,identify the IP address or
the machine name of the mail server:
– Mail Server Name:
See “Enabling and subscribing to events” on page 117.
Non-English environment installation
In IBM InfoSphere Enterprise Records,all available languages of the Base data
model and the Portuguese version of the DoD data model are fully translated.You
must import the localized add-ons to your Base object stores to enable localization.
For details on the supported levels of vendor software components and version
requirements for non-English installations,see the IBM FileNet P8 Hardware and
Software Requirements document.
Supported data models
For information,see “Copying the required configuration files” on page 37 and
“(Optional) Configuring localized object stores” on page 119.
Configuring InfoSphere Enterprise Records for FIPS 140-2
mode
You must modify the java.security file to enable your IBM InfoSphere Enterprise
Records environment for FIPS 140-2 mode.
The location of the java.security file depends on your IBM JRE installation.
For information,see “InfoSphere Enterprise Records server” on page 21.For
example,for a Windows WebSphere Application Server installation,the default
location is:C:\Program Files\IBM\WebSphere\AppServer\java\jre\lib\security.
To modify the java.security file:
Modify the java.security file in the IBM JRE security folder by adding the
following information:
security.provider.N =com.ibm.crypto.fips.provider.IBMJCEFIPS
22
Installation and Upgrade Guide
Where N is the relative position of the entry in the list of security providers.
Verifying installation administrator home directory permissions
(UNIX)
If are installing IBM InfoSphere Enterprise Records as a non-root user,you must
verify that the user’s home directory exists and that the user has full permissions
on the directory and all subdirectories.
Running the installer with prefilled Application Engine or
Workplace XT entries
To have the installer prefill the fields for the required Application Engine or
Workplace XT configuration values listed below,you must run the installer as the
same user that installed Workplace or Workplace XT.
Prefilled values:
v The folder containing the Application Engine or Workplace XT
bootstrap.properties file.
v The WEB-INF folder of the installed Application Engine or Workplace XT
application.
Installing future upgrades and fix packs
To be able to install future upgrades and fix packs,the installer must access the
install database for the current installed version.To provide access to this database
for future installs,you must make sure the database is accessible.
UNIX
You must install future upgrades or fix packs as the same user that initially
installed IBM InfoSphere Enterprise Records.The installer database is placed in the
installing user’s home directory.
Restriction:If you use a different user,the installer cannot detect the existing
software on your server and the upgrade or fix pack install fails.
The default location of this directory is:User_home/InstallShield/Universal/
FileNet.
Windows
Make sure you don’t delete the install database from the InstallShield directory.
Restriction:If you delete the database,the installer cannot detect the existing
software on your server and the upgrade or fix pack install fails.
The default location of this directory is:C:\Program Files\Common
Files\InstallShield\Universal\FileNet.
Installation directory access requirements
When you install IBM InfoSphere Enterprise Records,the installer program creates
and places the InfoSphere Enterprise Records files into RM_install_path/FileNet/
RM,RM_install_path/FileNet/Config.
The default location of RM_install_path directory is:
v UNIX:/opt/
v Windows:C:\Program Files
Planning and preparing for installation
23
Depending on how you installed Application Engine or Workplace XT,the
RM_install_path/FileNet/folder structure might already exist.If this is the case,
the Installation Administrator user who is installing the InfoSphere Enterprise
Records software must have the read and write access to these folders.
Installing InfoSphere Enterprise Records into the same directory
structure as the installed Application Engine or Workplace XT
If you are installing InfoSphere Enterprise Records into the same directory
structure as an existing Application Engine or Workplace XT installation,you must
give the Installation Administrator user read and write access to the installation
directories.
Give read and write access to the following directories:
Table 1.Required read and write permissions
Directory Default location
RM_install_path/
UNIX/opt/
Windows
C:\Program Files\
RM_install_path/FileNet/
UNIX/opt/FileNet
Windows
C:\Program Files\FileNet
RM_install_path/FileNet/Config
UNIX/opt/FileNet/Config
Windows
C:\Program Files\FileNet\Config
(Application Engine) WEB-INF/lib directory
UNIX/opt/FileNet/AE/Workplace/WEB-INF/lib
Windows
C:\Program Files\FileNet\AE\Workplace\WEB-
INF\lib
(Workplace XT) WEB-INF/lib directory
UNIX/opt/FileNet/WebClient/WorkplaceXT/WEB-INF/
lib
Windows
C:\Program Files\FileNet\WebClient\
WorkplaceXT\WEB-INF\lib
In addition,the user needs read privileges on the directory containing the
Application Engine or bootstrap.properties or Workplace XT
wcmapiconfig.properties file:
Table 2.Required read permissions
Directory Default location
(Application Engine) configuration directory
UNIX/opt/FileNet/Config/AE
Windows
C:\Program Files\FileNet\Config\AE
24
Installation and Upgrade Guide
Table 2.Required read permissions (continued)
Directory Default location
(Application Engine) WEB-INF directory
UNIX/opt/FileNet/AE/Workplace/WEB-INF
Windows
C:\Program Files\FileNet\AE\Workplace\WEB-
INF\
(Workplace XT) configuration directory
UNIX/opt/FileNet/Config/WebClient
Windows
C:\Program Files\FileNet\Config\WebClient\
(Workplace XT) WEB-INF directory
UNIX/opt/FileNet/WebClient/WorkplaceXT/WEB-INF
Windows
C:\Program Files\FileNet\WebClient\
WorkplaceXT\WEB-INF\
Installing InfoSphere Enterprise Records into a directory
structure other than that used by the installed Application
Engine or Workplace XT
If you are installing InfoSphere Enterprise Records into a directory structure that
does not coincide with an existing Application Engine or Workplace XT
installation,you must give the Installation Administrator user read and write
access to the following directories.
Give read and write access to the following directories:
Table 3.Required read and write permissions
Directory Default location
RM_install_path/
UNIX/opt/
Windows
C:\Program Files\
(Application Engine) WEB-INF/lib directory
UNIX/opt/FileNet/AE/Workplace/WEB-INF/lib
Windows
C:\Program Files\FileNet\AE\Workplace\WEB-
INF\lib
(Workplace XT) WEB-INF/lib directory
UNIX/opt/FileNet/WebClient/WorkplaceXT/WEB-INF/
lib
Windows
C:\Program Files\FileNet\WebClient\
WorkplaceXT\WEB-INF\lib
In addition,the user needs read privileges on the directory containing the
Application Engine or bootstrap.properties or Workplace XT
wcmapiconfig.properties file:
Planning and preparing for installation
25
Table 4.Required read permissions
Directory Default location
(Application Engine) configuration directory
UNIX/opt/FileNet/Config/AE
Windows
C:\Program Files\FileNet\Config\AE
(Application Engine) WEB-INF directory
UNIX/opt/FileNet/AE/Workplace/WEB-INF/
Windows
C:\Program Files\FileNet\AE\Workplace\WEB-
INF\
(Workplace XT) configuration directory
UNIX/opt/FileNet/Config/WebClient/
Windows
C:\Program Files\FileNet\Config\WebClient\
(Workplace XT) WEB-INF directory
UNIX/opt/FileNet/WebClient/WorkplaceXT/WEB-INF/
Windows
C:\Program Files\FileNet\WebClient\
WorkplaceXT\WEB-INF\
See “Installing IBM InfoSphere Enterprise Records” on page 38.
Client installation directory access requirements
When installing the Content Engine and Process Engine files,the user who
performs the installation must have read and write access to the following folders
on the IBM InfoSphere Enterprise Records server.
Table 5.Required read and write permissions for client installers
Directory Default location
RM_install_path/
UNIX/opt/
Windows
C:\Program Files\
Common files directory
UNIX/opt/FileNet/RM/CommonFiles
Windows
C:\Program Files\FileNet\RM\CommonFiles
InfoSphere Enterprise RecordsWEB-INF/lib directory
UNIX/opt/FileNet/RM/RecordsManager/WEB-INF/lib
Windows
C:\Program Files\FileNet\RM\RecordsManager\
WEB-INF\lib
You must provide read,write,and execute permissions to the following directories,
including their subdirectories and any files they contain.
26
Installation and Upgrade Guide
Table 6.Required read,write,and execute permissions for client installers
Directory Default location
Content Engine client installer directory
UNIX/opt/FileNet/CEClient
Windows
C:\Program Files\FileNet\CEClient
Process Engine client installer directory
UNIX/opt/FileNet/BPMClient
Windows
C:\Program Files\FileNet\BPMClient
Application Engine server
UNIX/opt/FileNet/AE/Router
Windows
C:\Program Files\FileNet\AE\Router
Application Engine server
UNIX/opt/FileNet/AE/CE_API
Windows
C:\Program Files\FileNet\AE\CE_API
Workplace XT server
UNIX/opt/FileNet/WebClient/Router
Windows
C:\Program Files\FileNet\WebClient\Router
Workplace XT server
UNIX/opt/FileNet/WebClient/CE_API
Windows
C:\Program Files\FileNet\WebClient\CE_API
See “Installing the latest Content Engine client files on IBM InfoSphere Enterprise
Records servers” on page 54 and “Installing the latest Process Engine client files on
IBM InfoSphere Enterprise Records servers” on page 56.
File permissions
The following files need read permissions in order for IBM InfoSphere Enterprise
Records to work correctly.
Table 7.Required read permissions for IBM InfoSphere Enterprise Records
File Default location
Application Engine bootstrap.properties
UNIX/opt/FileNet/Config/AE/bootstrap.properties
Windows
C:\Program Files\FileNet\Config\AE\
bootstrap.properties
Workplace XT bootstrap.properties
UNIX/opt/FileNet/Config/WebClient/
bootstrap.properties
Windows
C:\Program Files\FileNet\Config\WebClient\
bootstrap.properties
Planning and preparing for installation
27
InfoSphere Enterprise Records installation authentication
requirements
To complete the installation of IBM InfoSphere Enterprise Records,you must use a
number of pre-defined user accounts with specific authentication requirements.
These requirements include,but are not limited to,object store administration
privileges for each file plan object store (FPOS) and records object store (ROS),
local administrative privileges for the servers on which you are installing,and
certain Workplace or Workplace XT access roles to configure workflows for
InfoSphere Enterprise Records.
For a full list of the InfoSphere Enterprise Records Authentication Requirements,
see the P8 Worksheet.
For more information about users and groups created as part of the IBM FileNet
P8 Platform installation,see the Specify IBM FileNet P8 Accounts topic in the IBM
FileNet P8 Platform Installation and Upgrade Guide (FileNet P8 Platform 4.0) or Plan
and Prepare Your Environment for IBM FileNet P8 (FileNet P8 Platform 4.5).
InfoSphere Enterprise Records security
To provide a secure and reliable environment for storing,accessing,and disposing
of records,IBM FileNet P8 makes use of security roles,default instance security,
security inheritance,and security markings.
Before you install and configure the InfoSphere Enterprise Records environment,
review your security requirements for records management.
In general,assign security settings to groups rather than individual users.This
makes your system inherently more maintainable.
Important:It is best to set up and assign InfoSphere Enterprise Records security
before you start using your InfoSphere Enterprise Records environment.Adjusting
the default security settings after the system is in use is complex.
InfoSphere Enterprise Records security roles
IBM InfoSphere Enterprise Records supports the out-of-the-box security roles.Each
role defines the functional access rights for the user.
The access rights granted to users in these roles vary slightly based on the data
model.You assign groups (and possibly users) to security roles as part of
configuring each FPOS in your environment.For more information about setting
security roles,see “Setting security for the file plan object store” on page 78.
Important:
v Carefully identify the groups that should be assigned to each role before you
install InfoSphere Enterprise Records.When you set security roles,the security
of all of the InfoSphere Enterprise Records-related classes in the FPOS is
updated.Once you have set the security roles,you can later update the security
classes by reconfiguring the security roles.However,reconfiguration does not
update the security for record objects already created.
v When assigning the roles in InfoSphere Enterprise Records,make sure that there
is no role duplication of users when selecting groups and users for each role.If a
user has been assigned more than one role,unexpected behavior occurs when
the permissions of one role conflict with the permissions of another.For
28
Installation and Upgrade Guide
example,do not assign#AUTHENTICATED-USER to the Records User role,as it
negates the permissions needed by users assigned as Records Managers,Records
Reviewers,and Records Administrators.
v Make sure you keep track of the users and groups you assign to each role,as
described in the following table.You need this information when you make
changes in the security role mappings in the future.A security role planning
table enables you to manage your role assignments.
Table 8.Security roles
Security role Applicable data models Required?Functional access rights
Classification Guide
Administrators
DoD Classified No
Records Administrator All Yes In addition to the functional
access rights listed above,
the Records Administrator
role has the same functional
access rights as the Records
Manager role.
InfoSphere Enterprise
Records
All Yes
Records Reviewer PRO Yes
Records Privileged User Base,DoD,and DoD
Classified
Yes
Records Users All Yes
Related concepts
“Using the installation and upgrade worksheet” on page 9
Security settings for objects
Each object in an object store has associated security settings.
When an IBM InfoSphere Enterprise Records object is created,the security settings
are defined by:
v The default instance security of the object class.
The default instance security defines the initial security assigned to newly
created class objects.Use the Security Script wizard in IBM FileNet Enterprise
Manager,or invoke the Security Script Wizard from the InfoSphere Enterprise
Records Web application to run the script that sets the default instance security
for all objects.
v Security inherited from the folder in which the object is created.
v Security applied directly to the object.
Security markings
In addition to the examples listed above,an object can inherit a security marking
or can have a security marking directly assigned to it.Security markings allow a
user with an IBM InfoSphere Enterprise Records or Records Administrator role to
define the security for a record category that is then automatically set for all
folders and records associated with that category.
Markings are special property values that control access to objects.Users can access
an object if they meet the criteria set by the instance security and the marking
Planning and preparing for installation
29
value.For more information,see the IBM FileNet P8 Help topic FileNet P8
Administration → Enterprise-wide Administration → FileNet P8 Security →
Authorization → Markings.
Marking sets that you create are applicable to the entire FileNet P8 domain.
Therefore,once you create marking sets for a FileNet P8 domain,the markings are
available to all object stores in that domain.For information on how to create the
required marking sets,see “Adding marking sets and addons to the IBM FileNet
P8 domain” on page 70.
The following marking sets are created for the FileNet P8 domain on the Content
Engine server when you run the marking set script:
Table 9.InfoSphere Enterprise Records marking sets
Marking set name Contains Used in data model
Security Categories DoD Classified
1.Top Secret
2.Secret
3.Confidential
4.Unclassified
DoD Classified
Security Categories
1.Top Secret
2.Secret
3.Confidential
4.Restricted
5.Unclassified
PRO
Prevent RM Entity Deletion Marking that prevents users who do
not have the Records Administrators
or Records Manager role from
deleting record categories,record
folders,or records.
DoD,DoD Classified and Base
Prevent RM Entity Deletion PRO Marking that prevents users who do
not have the Records Administrators
role from deleting record categories,
record folders,or records.
PRO
Supplemental Marking (PRO and DoD) Does not contain any
markings.
You can create markings in this set to
meet your application-specific
requirements.
(DoD Classified) Pre-populates the
following markings:
v Restricted Data
v Formerly Restricted Data
DoD,DoD Classified,and PRO
Security markings propagation
In general,child objects inherit security markings from the parent object.However,
the PRO data model also allows parent objects to inherit settings from the child
object if the child is given a more secure marking.Content Engine events are used
to propagate updates to the parent security markings.
30
Installation and Upgrade Guide
Before you install IBM InfoSphere Enterprise Records,you should select the
security marking propagation option that you want to set for objects.By default
the system is configured to No propagation.
The following three security marking propagation options are available in
InfoSphere Enterprise Records:
v No propagation:Disables propagation from parent to child or child to parent.
This is the recommended and default option.
v Folder to Record:Child objects inherit security markings from the parent object.
v Record to Folder:Parent objects inherit security markings from the child object if
the child is given a more secure marking.
For more information about setting the security propagation option,see the IBM
FileNet P8 Help topic Expansion Products → InfoSphere Enterprise Records →
FileNet P8 Security → How to...→ Configure security marking propagation.
Installing InfoSphere Enterprise Records for SSL security
If you configure SSL for IBM InfoSphere Enterprise Records,you must use the
same mode as that used by Workplace or Workplace XT.
The option not to use SSL is provided primarily for development systems or other
non-production systems where the security provided by SSL might not be required.
There are two basic SSL configurations under which InfoSphere Enterprise Records
Web application can be used:
Redirect for login
In this mode,when users access the InfoSphere Enterprise Records Web
application,they are automatically redirected to a secure site for logon
authentication.If the logon succeeds,the user is automatically redirected to
the non-SSL site and can start using the InfoSphere Enterprise Records Web
Application.
Full SSL
In this mode,the InfoSphere Enterprise Records Web Application runs
under SSL.
Configuring the InfoSphere Enterprise Records Web
application for redirect logon
Configure the IBM InfoSphere Enterprise Records Web application for redirect
logon by enabling and configuring SSL,installing the Web application,selecting
the correct bootstrap.properties file,deploying the Web application and
configuring the process region.
To configure the IBM InfoSphere Enterprise Records Web application for redirect
logon:
1.Enable SSL on the application server that runs InfoSphere Enterprise Records.
See your SSL documentation.
2.Ensure that Application Engine or Workplace XT has been configured for SSL
redirection.
For more information about configuring Application Engine SSL security,see
the Set up Application Engine SSL security topic in the IBM FileNet P8 Platform
Installation and Upgrade Guide.
Planning and preparing for installation
31
For information about configuring Workplace XT security,see the Set up SSL
Security for Workplace XT topic in the IBM FileNet Workplace XT Installation and
Upgrade Guide.
3.Install the InfoSphere Enterprise Records Web Application using the
instructions provided in “Installing IBM InfoSphere Enterprise Records” on
page 38.
If Application Engine or Workplace XT has been configured for two-server
redirection,then you must install the InfoSphere Enterprise Records Web
Application on the associated Application Engine or Workplace XT servers.
During the InfoSphere Enterprise Records Web Application installations when
prompted for the Workplace or Workplace XT bootstrap.properties file,select
the same file that is being used by Application Engine or Workplace XT
installations.
4.(InfoSphere Enterprise Records using CMA only) Update your web.xml file for
CMA:
a.If you have made custom changes to your existing InfoSphere Enterprise
Records web.xml file,copy the web.xml file from the deploy location back
into the install location (RM_install_path/FileNet/RM/RecordsManager/
WEB_INF) before editing for SSL redirect.
Table 10.Deployment location for servers
Server Deploy location
WebSphere Application Server WAS_HOME/profiles/default/installedApps/
node_name/RecordsManager.ear/
recordsmanager.war
WebLogic Server RM_install_path/FileNet/RecordsManager
JBoss Application Server JBOSS_HOME/server/server_name/deploy/
application_name.war or.ear
b.(WebSphere Application Server only) Modify the web.xml file in the
RM_install_path/FileNet/RM/RecordsManager/WEB_INF directory:Copy the
security_constraint section,and paste the new copied section directly after
the original,then change the url_pattern element to ContainerLogin.jsp
and the transport-guarantee element to CONFIDENTIAL in the newly inserted
security_constraint element.Finally,remove the second occurrence of the
url-pattern element,for example:
<security-constraint>
<web-resource-collection>
<web-resource-name>action</web-resource-name>
<description>Define the container secured resource</description>
<url-pattern>/ContainerLogin.jsp</url-pattern>
</web-resource-collection>
<auth-constraint>
<role-name>All Authenticated</role-name>
</auth-constraint>
<user-data-constraint>
<description>User data constraints</description>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>
c.(WebLogic Server and JBoss Application Server only) Modify the web.xml
file in the RM_install_path/FileNet/RM/RecordsManager/WEB_INF directory:
In the user-data-constraint element,change the transport-guarantee element
to CONFIDENTIAL,for example:
32
Installation and Upgrade Guide
<user-data-constraint>
<description>User data constraints</description>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
5.Deploy the InfoSphere Enterprise Records Web Application using the
instructions provided in “Deploying the IBM InfoSphere Enterprise Records
Web application” on page 60.
6.Update the Workplace or Workplace XT Site Preferences using the information
provided in “Setting site preferences for IBM InfoSphere Enterprise Records” on
page 85.
Tip:If Application Engine or Workplace XT has been configured for two-server
redirection,then the InfoSphere Enterprise Records Web Application
installations use the same site preferences file.
7.Configure the process region for InfoSphere Enterprise Records using the
instructions provided in “To configure a process region for IBM InfoSphere
Enterprise Records” on page 91.
Important:Perform this task once only,even if Application Engine or
Workplace XT has been configured for two-server redirection.Instances of