You are on page 1of 196

EMC Documentum

Content Server Enterprise Edition


Version 6.7

Installation Guide

EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.emc.com

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind
with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness
for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an
applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks
used herein are the property of their respective owners.
Copyright 2012 EMC Corporation. All rights reserved.

Table of Contents

Preface
Chapter 1

Chapter 2

................................................................................................................................ 11
Planning for Content Server Installation

..................................................... 13

Important changes for 6.7 ..................................................................................

13

Content Server and repository overview ............................................................

13

Content Server installation models ....................................................................


Basic installation model ................................................................................

15
15

Configuration decisions ....................................................................................


Location for installing the relational database .................................................
Username Content Server will use to connect to the database ..........................
Size of repository to create ............................................................................
Location for storing the content files ..............................................................
Name and ID to assign to the repository ........................................................
Connection brokers to which to project Content Server information .................
Permit or require secure SSL connections .......................................................
Authenticate users ........................................................................................
Ports to reserve for Content Server use ...........................................................
Extended service features to license ...............................................................
Repository to use as the global registry ..........................................................

17
17
18
18
18
19
19
20
20
21
22
23

......................................
Host preparation checklist ................................................................................
Hardware and network environment requirements ............................................
Internationalization settings ..............................................................................
Server host code page ...................................................................................
Firewalls ..........................................................................................................
Setting up user accounts ...................................................................................
Setting up the installation owner account .......................................................
Installation owner account naming requirements ........................................
Required rights for an installation owner account .......................................
Setting up the repository owner account ........................................................
Repository owner account naming requirements ........................................
Setting up repository user accounts ...............................................................
Preparing UNIX and Linux hosts .......................................................................
Shared memory and semaphore requirements ................................................
XWindows requirement ................................................................................
The /tmp directory ........................................................................................
Root user password ......................................................................................
Setting Documentum environment variables ..................................................
Setting up the services file .............................................................................
Preparing Windows hosts .................................................................................
Setting the PATH Environment Variable .........................................................
Running WDK Applications on the Content Server Host .................................
Restricted Characters ....................................................................................

25

Preparing the Host for Content Server Installation

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

25
27
28
28
29
29
29
29
30
30
30
31
31
31
31
32
32
32
33
34
34
34
35

Table of Contents

Regional Settings ..........................................................................................


SMTP Server on Windows .............................................................................
Disabling User Access Control (UAC) ............................................................

35
35
35

..............................
Database preparation checklists .........................................................................
Requirements for all databases ..........................................................................
Database code page ......................................................................................
Database locales ...........................................................................................
Semantics .....................................................................................................
Database service on Windows .......................................................................
Repository owner account .............................................................................
Database administrator account.....................................................................
Oracle requirements .........................................................................................
Entries in tnsnames.ora file............................................................................
Oracle repository sizes ..................................................................................
SQL Server requirements ..................................................................................
Configuring an ODBC Data Source for SQL Server .........................................
Configuring a 32bit repository on 64-bit SQL server .................................
SQL Server repository sizes ...........................................................................
Sybase requirements .........................................................................................
Sybase repository sizes .................................................................................
DB2 requirements .............................................................................................
Configuring a DB2 database ..........................................................................
Configuring DB2 from the Control Center ..................................................
Configuring a DB2 database from the command line...................................
DB2 performance wizard requirements ..........................................................
Tuning a DB2 database..................................................................................
Running multiple Content Servers on the DB2 host .........................................
DB2 repository sizes .....................................................................................

37

Chapter 4

Pre-Installation Checklist ............................................................................


Installation and configuration checklist ..............................................................

55
55

Chapter 5

Installing Content Server software on a UNIX or Linux host

Chapter 6

Installing Content Server software on a Windows host

Chapter 7

Configuring Content Server and the repository on a UNIX or


Linux host ...................................................................................................

Chapter 3

Preparing the Database for Content Server Installation

40
40
41
41
41
41
42
42
43
44
44
44
45
45
46
46
47
48
48
49
51
51
52
53

....................... 59

............................... 63

Chapter 8

Configuring Content Server and the repository on a Windows host

Chapter 9

Completing the Installation

37

67

............ 73

......................................................................... 79

Reviewing the Content Server installation logs ...................................................

79

Running dm_root_task manually on UNIX or Linux hosts ..................................

80

Running the administrative tool script manually ................................................

80

Changing the default passphrase .......................................................................


Binding Content Server to a network card ..........................................................

81
81

Configuring JBoss application servers for SSL .....................................................

82

Changing the installation owner account............................................................

82

Backing up key store files ..................................................................................

83

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Table of Contents

Chapter 10

Starting Content Server repositories and connection brokers ...............................

83

Adding users and groups to a repository ...........................................................

84

Enabling jobs after installation ...........................................................................


Enabling the purge audit job .........................................................................

84
84

Creating additional repositories or connection brokers ........................................

84

Upgrading Content Server

........................................................................... 87

Upgrade checklist .............................................................................................


Migrating the database to UTF8 ...................................................................
The database_refresh_interval key .................................................................
Completing workflows before an upgrade .....................................................
Upgrading sequence considerations ...............................................................
Upgrading from 5.3 SP6 ................................................................................
Ensuring that the dm_server_config object is unlocked ...................................
Upgrading from a pre-6.5 SP1 Content Server.................................................

87
90
91
91
91
92
93
94

Upgrading the Content Server software .............................................................

94

Running queries on repositories upgraded prior to release 6.5 SP3 .......................

97

Using the update statistics tool ..........................................................................


Arguments ...................................................................................................

97
98

Adding descriptors to a global registry ..............................................................

99

Missing database indexes on repository upgrades from version 5.3 ....................


List of indexes to drop and make .................................................................

101
101

Chapter 11

Enabling FAST with Content Server 6.7

Chapter 12

Uninstalling Content Server

Chapter 13

Chapter 14

..................................................... 105

......................................................................
Order of uninstalling components ...................................................................
Deleting a repository ......................................................................................
Deleting a connection broker ...........................................................................
Uninstalling the Content Server software .........................................................

107
107
108
109
109

Installing Remote Content Servers in Distributed or


Load-Balanced Configurations ..................................................................
Preinstallation requirements............................................................................

111
111

Installing and configuring the remote Content Server........................................

112

Upgrading a distributed or load-balanced configuration ...................................


Deleting a remote Content Server ....................................................................

114
116

Installing Content Server and Java Method Server for


High-Availability
.......................................................................................
Overview .......................................................................................................

119
119

Content Server HA configuration ....................................................................

120

JMS HA configurations ...................................................................................


Content Server and JMS on a single host ......................................................
Content Server and JMS on two hosts...........................................................
Content Server and JMS on multiple hosts ....................................................

121
121
122
123

Choosing an HA configuration ........................................................................


Benefits and best use ...................................................................................
Considerations ...........................................................................................
Performance ...............................................................................................
Tip ............................................................................................................

124
124
124
125
125

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Table of Contents

Chapter 15

Chapter 16

Chapter 17

Supported operating systems ..........................................................................

125

Preinstallation requirements............................................................................

125

Installing and configuring Java Method Server in HA mode ..............................


Installing and configuring JMS for HA on a single host .................................
Installing and configuring JMS for HA on multiple hosts ..............................

125
126
129

Time synchronization between remote JMS hosts and Content Server


hosts ..............................................................................................................

131

Viewing and modifying JMS instances .............................................................

132

........................
Overview .......................................................................................................
Choosing a configuration ................................................................................
Preinstallation requirements............................................................................
Configuring an active/passive cluster ...............................................................
Creating the cluster resource group .............................................................
Installing Content Server software on the nodes ...........................................
Configuring Content Server.........................................................................
Configuring the connection brokers .............................................................

133

Installing Content Server with Microsoft Cluster Services

134
136
137
137
138
138
143

Creating additional cluster resources on Microsoft Cluster Services


2008 ...........................................................................................................
Verifying failover ........................................................................................
Configuring an active/active cluster .................................................................
Creating the first cluster resource group .......................................................
Installing Content Server software on the hosts.............................................
Configuring Content Server on the first and second nodes.............................
Configuring the second cluster resource group .............................................
Modifying server.ini and dfc.properties .......................................................
Configuring the connection broker and repository for failover .......................
Verifying failover ........................................................................................

144
145
146
146
147
147
147
147
148
148

Upgrading Content Server installed with Cluster Services .................................

148

Configuring Multiple Content Servers on a Single Host for a


Particular Repository ................................................................................

151

Windows hosts ...............................................................................................

151

UNIX hosts ....................................................................................................

153

..........................................
Creating the test environment .........................................................................
Precopying tasks ............................................................................................
Copying a repository ......................................................................................

155

Creating a repository copy to test an upgrade

155
156
157

................................ 161

Appendix A

Required Environment Variables for UNIX and Linux

Appendix B

Content Server Installation Directories and Repository


Configuration Scripts ................................................................................
Content Server installation file structure...........................................................
_uninst ......................................................................................................
data ...........................................................................................................
dba ............................................................................................................
fulltext .......................................................................................................
product ......................................................................................................
server_uninstall ..........................................................................................

133

163
163
163
164
164
164
164
164

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Table of Contents

share .........................................................................................................
Additional directories .................................................................................
Scripts run during installation or upgrade ....................................................
Configuration objects ..................................................................................
Appendix C

Appendix D

Appendix E

165
165
168
171

.......................................... 173
Identifying the problem and resolution ............................................................ 173

Troubleshooting a Content Server Installation

While installing on Linux, the installer hangs when the number of


mount points exceeds 4000 ..........................................................................
Error during session construction on Solaris-DB2 .........................................

176
176

Recovering from a failed repository configuration or upgrade ...........................

177

Enabling tracing in repository configuration scripts ..........................................

177

Recovering from a stalled Content Server upgrade............................................

178

...............................
Type categories for tablespace specifications .....................................................
Type categories for extent allocation ................................................................
Object types categorized as large .................................................................
Object types categorized as small .................................................................
Object types categorized as default ..............................................................

181

Object Type Categories for Oracle Database Storage

181
182
182
182
183

Defining Oracle or DB2 Database Parameters for Repository


Tables .......................................................................................................

185

Defining the tablespace ...................................................................................


FUNCTION_SPECIFIC_STORAGE .............................................................
TYPE_SPECIFIC_STORAGE ...................................................................
Defining the Oracle extent sizes ...................................................................
Changing storage parameters for individual object types on Oracle ...............
Changing storage parameters for categories of types on Oracle ......................
User-defined object types ............................................................................

186
186
186
187
188
189
189

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Table of Contents

List of Figures

Figure 1.

Repository structure .............................................................................................

Figure 2.

Basic installation model and component installation order ......................................

16

Figure 3.

Content Server and Repository High Availability ..................................................

120

Figure 4.

Content Server and JMS HA on a single host ........................................................

122

Figure 5.

Content Server and JMS HA on two hosts ............................................................

123

Figure 6.

Content Server and JMS HA on multiple hosts .....................................................

124

Figure 7.

Installing and configuring JMS for HA on a single host .........................................

126

Figure 8.

JMS instances configured for HA on two hosts .....................................................

129

Figure 9.

JMS instances configured for HA on multiple hosts ..............................................

130

Figure 10.

Active/passive cluster .........................................................................................

135

Figure 11.

Active/active cluster............................................................................................

136

14

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Table of Contents

List of Tables

Table 1.

Host preparation checklist.....................................................................................

25

Table 2.

General database installation and configuration checklist ........................................

37

Table 3.

Oracle database installation and configuration checklist ..........................................

38

Table 4.

DB2 database installation and configuration checklist

............................................
SQL Server database installation and configuration checklist ..................................
Sybase database installation and configuration checklist .........................................
Content Server installation and configuration checklist ...........................................
Content Server upgrade checklist ..........................................................................
Update Statistics arguments ..................................................................................
Parameters required by dm_acs_install.ebs script .................................................
Precopying tasks ................................................................................................
Required environment variables ..........................................................................
Subdirectories created during installation ............................................................
Repository configuration scripts ..........................................................................
Troubleshooting checklist ....................................................................................

39

Table 5.
Table 6.
Table 7.
Table 8.
Table 9.
Table 10.
Table 11.
Table 12.
Table 13.
Table 14.
Table 15.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

39
40
56
87
98
115
156
161
166
168
173

Table of Contents

10

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preface
Purpose of the manual
This guide contains information and instructions you need to install or upgrade EMC Documentum
Content Server.
If you are installing full-text indexing, consult the xPlore Installation Guide.

Intended audience
This guide is for system administrators who are responsible for the installation of Content Server.

Revision history
The following revisions have been made to this document:
Revision History

Date

Description

April 2011

Initial publication

June 2012

Removed obsolete settings for Oracle database


and updated the note for Oracle requirements.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

11

Preface

12

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 1
Planning for Content Server Installation

This chapter contains the information you need to plan a Content Server installation or upgrade. This
chapter contains the following topics:
Important changes for 6.7, page 13
Content Server and repository overview, page 13
Content Server installation models , page 15
Basic installation model, page 15
Configuration decisions, page 17

Important changes for 6.7


We especially wanted to highlight two changes to the installation of Content Server release 6.7 for
users familiar with our earlier releases. Please review these two sections:
Oracle library changes for Unix and LinuxOracle client libraries are used differently. Please
review Oracle requirements, page 42, if you use Oracle on Unix or Linux.
Fulltext support change from FAST to xPloreThe default fulltext support is now xPlore. Please
review Chapter 11, Enabling FAST with Content Server 6.7 if you want to install support for
FAST instead.
Of course, we recommend that you review Chapter 4, Pre-Installation Checklist, before you install
or upgrade Content Server.

Content Server and repository overview


Content Server software manages repositories and provides content management capabilities. A
repository consists of three main components: a file store containing the content assets, attribute

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

13

Planning for Content Server Installation

tables within a relational database, and full-text indexes. A repository can store its content files in
any of the following:
Directories on the Content Server hosts file system
Directories on a remote host to which Content Server has access
A variety of storage devices including retention type stores, such as EMC Centera and Network
Appliance SnapLock
Content Server coordinates the different forms of data to create the object-based repository. Objects
in a repository are composed of content files (the source file in its native format) and attributes (also
known as metadata or properties), such as document owner, version, and creation date. Metadata
describes the content and the relationships between this content and other objects in the repository. A
repository uses the metadata to organize the content, and users can use metadata to search for content.
Metadata is stored in tables in a relational database as sets of attributes. A configurable and extensible
set of attributes is stored for each item. A set of attributes can include attributes with a single value,
such as the documents globally unique identifier. Attributes can also have multiple values, such as
keywords that describe the content.
Figure 1, page 14 shows the basic structure of a repository.
Figure 1. Repository structure

Even though Content Server is composed of several components, details of how content is stored in
the repository is hidden from client applications. Content Server treats the content files and metadata
as part of a single entity and handles updates to the document object as a single transaction: Content
Server updates both elements in concert or updates neither of them. Content Server automatically
updates the index entries as well, ensuring that the three types of data remain synchronized.

14

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Planning for Content Server Installation

Content Server installation models


Content Server and repository can be installed in many different ways to support many different
scenarios. However, in this guide, we will focus on the basic installation model. The basic installation
model installs a single Content Server and at least one repository and connection broker on a single
host. For installation models that span multiple hosts, the EMC Documentum Content Server Distributed
Configuration Guide provides details on the additional steps required to support such models.

Basic installation model


A basic installation of Content Server consists of several interrelated components:
File stores, which contain the content files for objects stored in the repository.
A relational database, which stores metadata about the content files.
Content Server, which manages repositories.
Content Server itself consists of several distinct process and components, including an application
server reserved for its internal use.
One or more repositories. One of the repositories will be designated as the global registry.
A connection broker, which provides repository connection information to client applications.
Documentum Foundation Classes (DFC), which provide the programming interface that client
applications use to communicate with Content Server.
An SMTP server, which Content Server uses to send tasks and notification messages to user
mailboxes when necessary.
You can install Content Server in different configurations. In the most basic configuration, which is
typically used in development environments, the Content Server, database, and content files all reside
on the same host. In production environments, the Content Server, and database are almost always
installed on different hosts for increased performance.
Figure 2, page 16 shows a basic installation model and the order in which components are installed.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

15

Planning for Content Server Installation

Figure 2. Basic installation model and component installation order

You can install and start a connection broker on the Content Server host as part of the installation
process, or the Content Server can project to one or more connection brokers located on a different
host, thereby making itself available to client applications. Chapter 4, Pre-Installation Checklist
provides details on installing and starting a connection broker. When a client application wants to
connect to a repository, the following occurs:
1.

The client contacts the connection broker and requests the information it needs to connect with a
Content Server for the requested repository.

2.

The connection broker sends back the IP address for the host on which the Content Server resides
and the port number that the Content Server is using.

3.

The client application uses that information to open a connection to Content Server.

Client applications communicate with Content Server through its programming interface, DFC.
Content Server also uses an SMTP server to send tasks and notification messages to user mailboxes
when necessary.
The file stores, relational database, SMTP server, and license server must be installed and available
before you install Content Server.Chapter 2, Preparing the Host for Content Server Installation
contains information about the steps to take to prepare to install Content Server. Content Server does
not function properly unless the database is installed correctly. Review the requirements in Chapter
3, Preparing the Database for Content Server Installation, and ensure that the database installation
meets these requirements. The SMTP server can be on the Content Server host or a remote host.
During the installation procedure, you provide the name or IP address of the computer hosting the
SMTP server so that Content Server can connect to it. Like the SMTP server, the license server can
be on the Content Server host or a remote host. During configuration of the global repository, you

16

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Planning for Content Server Installation

provide the name or IP address of the license server host, and the port on which the license server
listens, so that Content Server and client applications can connect to it.
The installation or deployment guide for the application, such as the Documentum Web Development
Kit and Webtop Deployment Guide, contains information about installing client applications.

Configuration decisions
When you install Content Server, you are asked to make several configuration decisions. The
remainder of this chapter identifies the decisions you should make before beginning the Content
Server installation procedure. Chapter 3, Preparing the Database for Content Server Installation
and Chapter 4, Pre-Installation Checklist provide checklists where you can record your decisions
for reference during the installation procedure.
Location for installing the relational database, page 17
Username Content Server will use to connect to the database, page 18
Size of repository to create, page 18
Location for storing the content files, page 18
Name and ID to assign to the repository, page 19
Connection brokers to which to project Content Server information, page 19
Permit or require secure SSL connections, page 20
Ports to reserve for Content Server use, page 21
Repository to use as the global registry, page 23
Extended service features to license, page 22

Location for installing the relational database


You can install the relational database that stores repository metadata either locally on the same host
as Content Server or remotely on a separate host running any operating system supported by the
database vendor. For example, Content Server can be installed on a Windows host and use a database
installed on a Solaris host.
In a production environment, the database is almost always installed on a separate host for
performance reasons.
Before you install Content Server Install the database management system and create a database
in which Content Server will create the repository metadata tables. If you install the database on a
separate host, also install the database client software on the Content Server host.
For remote database installations, verify that you can connect to the database by using a database
client from the system where you intend to install Content Server.
For local database installations on a UNIX host, verify that the system path includes the installation
directory for the database. On Windows hosts, the installer updates the system path automatically.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

17

Planning for Content Server Installation

Chapter 3, Preparing the Database for Content Server Installation provides details about installing
the relational database.

Username Content Server will use to connect to the


database
Content Server connects to the database with a user account called the repository owner account. The
repository owner must have a database user account. This database user account must provide
Content Server with access to the database tables underlying the repository.
You can create the repository owner account in the database before installing Content Server, or you
can allow the Content Server configuration program to create the account. The account must have the
appropriate privileges to perform the following tasks:
Connect to the database
Create tables, views, and indexes in the database
Insert records (rows) into the tables
Drop tables, views, and indexes
Before you install Content Server Decide whether to create the database account for the
repository yourself or allow the Content Server configuration program to create the account. If you
allow the Content Server configuration program to create the database account, it automatically
grants the account the proper privileges. If you create the account in advance, grant the account the
proper privileges as described in Repository owner account, page 41.

Size of repository to create


During repository configuration, you are asked to choose a repository size. The repository size option
determines the size of the tablespaces within the database, how data and indexes are distributed
within the database, log file sizes, and whether these settings can be configured.
Before you install Content Server Decide what size of repository to create, based on the projected
amount of content that will be stored in the repository. The details and initial sizes differ depending
on the database vendor. The individual sections for each database vendor in Chapter 3, Preparing the
Database for Content Server Installation provide details.

Location for storing the content files


A repository can store its content files in a variety of storage areas, such as:
In a directory structure in the Content Server hosts file system or on a remote host
On a retention type store

18

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Planning for Content Server Installation

In a relational database as binary large objects (BLOBs), or as data in varchar fields


In an external storage area, such as a legacy system
Large repositories can have multiple file storage areas, of different types, with defined business rules
that specify which content is stored in which storage areas.
The Content Server installation program creates one file-system storage area, which is used as the
default storage area. After the initial installation, you can add additional storage areas and the
business rules for dividing content between them by using Documentum Administrator. The EMC
Documentum Administrator User Guide provides information and instructions about adding additional
storage areas.
Before you install Content Server Choose a location for the default content file storage area,
which the installation program calls the data directory. The data directory can be on the Content Server
host or on another host that Content Server can access over the network. Ensure that the location you
choose for the data directory has sufficient free space for the content files that will be added to it.
The Content Server configuration program creates the data directory on the local host in the directory
Documentum\data unless you provide a different location.

Name and ID to assign to the repository


Each repository requires a unique name and ID of up to 32 characters. The name must consist of
letters, numbers, or underscores (_). The first character must be a letter. The repository name cannot
include spaces or nonalphanumeric characters. All letters and numbers in the name must be ASCII
characters. The repository name "docu is reserved by EMC Documentum.
The repository ID can be any number from 1 to 16777215 and must not start with a zero. Valid
repository IDs are shipped with the Content Server software. You may also choose your own
repository IDs, provided that each repository has a repository ID that is unique in your network and
conforms to other repository ID requirements. You can request additional repository IDs from EMC
Documentum, which ensures that the ID for each repository is unique. You can submit a request for a
repository ID from the following link on the EMC Powerlink web site http://powerlink.emc.com.
Before you install Content Server Decide on a repository name and repository ID for the new
repository you will create.

Connection brokers to which to project Content Server


information
When Content Server starts, it automatically broadcasts information about itself to one or more
connection brokers. Each connection broker that receives the broadcast adds the Content Server to
its list of available servers.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

19

Planning for Content Server Installation

Before you install Content Server


Record the hostname and port number for each existing connection broker (if any) to which you
want to broadcast Content Server connection information.
Decide whether you need to create additional connection brokers on the Content Server host.
The Content Server configuration program by default creates a connection broker on the Content
Server host and configures the Content Server to broadcast its connection information to that
connection broker. You have the option to create multiple connection brokers if, for example, you
want different brokers for different client applications. If you want Content Server to broadcast its
connection information to existing connection brokers on remote hosts, you can configure this
option after the installation.
Identify an open port for the new connection broker to listen on. The default port for the default
connection broker is 1489. If you are using the default port number, ensure that the next port
number (1490) is also available for use because the connection broker requires that two ports be
reserved. If you create multiple connection brokers on the host, assign a unique port number to
each broker. If you try to set ports for the connection broker that are already occupied, then try
to access Content Server using the IAPI command line, the command line tool will fail. In that
case, you need to remove the port numbers you entered that were already occupied manually
from the dfc.properties file.

Permit or require secure SSL connections


Client applications can connect to Content Server through a standard native port or through a secure
port that uses Secure Sockets Layer (SSL) for encryption. During repository configuration, you are
asked what type of connection clients will use to connect to the repository. The choices are:
Native Content Server listens for client connection requests only on ports that are not SSL ports.
Content Server refuses requests for a secure connection.
Secure Content Server listens for client connection requests only on a secure SSL port. The
client and Content Server do not use SSL authentication to authenticate each other. However,
the information exchanged between the client and Content Server is encrypted. Content Server
refuses connection requests other than SSL connections.
Native and secure Content Server accepts both native and secure connection requests.
Note: This feature is only available with a Trusted Content Services license, which you need to
obtain separately.
Before you install Content Server Decide what type of client connections to accept.

Authenticate users
User authentication typically occurs when a user attempts to connect to a repository. Content Server
determines whether the user is a valid, active repository user and, if so, authenticates the user name
and password. You can perform user authentication using one of the following methods:
The default mechanism

20

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Planning for Content Server Installation

The default mechanism authenticates the user against the operating system.
A custom dm_check_password program
You can create a custom password checking program and set up the servers to call that program
for user authentication. This option is useful if you want to use Windows domain authentication
for UNIX users.
An LDAP directory server
If you use a directory server, you have the following options:
Authenticate against the directory server directly, using a secure or a nonsecure connection.
Authenticate using an LDAP-enabled dm_check_password program.
An authentication plugin
Authentication plugins provide an alternate way to customize user authentication. EMC
Documentum provides one authentication plugin with Content Server. The following plugins
are included with Content Server:
Netegrity SiteMinder Policy Server
RSA
Kerberos
Plugins support Web-based Single Sign-On (SSO) and strong authentication.
An inline password
A user can be authenticated using an encrypted password that is stored in the user_password
attribute of the user object.

Ports to reserve for Content Server use


Content Server and its components use a number of ports on the host:
Content Server uses two consecutive port numbers for native client connections and secure client
connections.
On Windows hosts, set the port numbers by using the Content Server configuration program.
On UNIX and Linux hosts, set the port numbers in the services file before installing Content
Server. Setting up the services file, page 33 provides details on how to set port numbers in
the services file.
The application server that Content Server installs listens on one port for administration standard
connections. By default, it uses port 9080. Whether you choose the default port number or another
port number, do not change the port number after the initial configuration.
The connection broker requires two consecutive ports on which to listen. The default connection
broker port is 1489. If you are using the default port number, ensure that the next port number
(1490) is available for use because the connection broker requires that two ports be reserved.
Before you install Content Server Identify available ports to use for Content Server and its
components. Make sure none of the selected ports are being used for other purposes.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

21

Planning for Content Server Installation

Extended service features to license


You use the Content Server installation program and the Content Server configuration program to
activate extended service features by entering the license key for those features.
Some extended features apply to Content Server as a whole, so that any repositories managed by
that Content Server can use those features. Activate extended service features that apply to Content
Server by using the installation program. If you want to activate them after you have already installed
Content Server, run the Content Server installation program again and activate these options.
Some extended features apply to individual repositories, so different repositories managed by a
single Content Server may have access to different extended services. Activate extended service
features that apply to individual repositories by using the Content Server configuration program.
The extended service features that are activated from the Content Server installation program are:
High-Volume Server is an extension of Content Server that supports features implemented to
solve common problems with large content stores. The three broad areas of enhancements that
make up High-Volume Server are:
Lightweight system objects
Batch operations and currency scoping
Database Partitioning
Trusted Content Services provides additional security features, such as encrypted file stores,
in which content files are encrypted and secure socket layer (SSL) communications between
Content Server and DMCL.
Content Services for EMC Centera adds support for EMC Centera content-addressable storage
devices, which provide content storage with guaranteed retention and immutability.
XML Store. An XML store is a native XML database that is fully optimized for XML content. Use
XML stores to store and query large volumes of XML content.
You cannot specify the superuser password for XML Store at install time. The installer uses an
empty string. After installation, you can change that password. Information about changing the
superuser password can be found in EMC Documentum XML Store Installation and Administration
Guide.
Content Services for SnapLock. SnapLock is a feature of Filer, a NAS storage system from Network
Appliance. A Network Appliance SnapLock (NetApp SnapLock) store stores large amounts of
unchanging data such as email archives. SnapLock provides storage level retention capability
through the creation of Write Once Read Many (WORM) volumes on Network Appliance storage
systems. You can create a SnapLock volume in one of two modes: Enterprise and Compliance.
The difference between the two modes is that on the Compliance SnapLock volume, a default (and
minimum) retention of 30 years is applied to the content files created in that volume.
The extended service features that are activated from the Content Server configuration program are:
Content Storage Services enables you to define business rules to govern where content files are
stored.
Retention Policy Services is a compliance-oriented feature that gives you control over how long
and under what circumstances documents and other objects are retained in a repository.
Federation Records Services

22

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Planning for Content Server Installation

Records Manager provides archiving options for business records.


Physical Records Manager (PRM) enables management of paper assets by providing library
services to reserve, borrow, and return physical objects. PRM also includes barcode management
capability for tracking physical objects.
The EMC Documentum Content Server Fundamentals Guide provides details about these products
and the features they activate.
Before you install Content Server Identify which extended services to activate and obtain the
license keys for those services.

Repository to use as the global registry


When an EMC Documentum installation includes multiple repositories, certain installation-wide
elements are shared among all repositories. For example, a distributed configuration uses objects
called network locations which Content Server uses to determine which storage areas are physically
close to which client applications. All repositories share the same network location objects. Another
example is usage tracking. When a user logs into Content Server, or into an application that connects
to Content Server, a record is stored of the user, login time, and application used.
To manage these installation-wide elements, each EMC Documentum installation has a central
repository called the global registry. You need to designate a repository as a global registry. The global
registry is a repository like any other repository, except that all other repositories connect to it when
they need an installation-wide element. When you install a repository, either identify it as the global
registry or designate how to connect to another global registry repository.
Note: Every installation must have a repository designated as a global registry even if you only
plan to have one repository, and even if you are not using distributed Content Servers. Specifying
a repository as a global registry is optional during Content Server installation but a global registry
must be configured before connecting to the repository with any client applications.
If you have a one-repository implementation, that repository can be both a content repository and a
global registry. If you have a Content Server implementation larger than a departmental one, you
might consider creating a separate repository and designate that repository to be the global registry
only.
The Content Server configuration program enables you to do the following now or later:
Use the current repository as a global registry.
Specify a different repository as a global registry.
A global registry user is created in all repositories, regardless of whether the repository is configured
as a global registry.
If you configure the repository as a global registry, you provide the username and password for
the global registry user and the user state is set to Active.
If you do not configure the repository as a global registry, a global registry user is created with the
default username dm_bof_registry and the user state is set to Inactive. This user has read access to
objects in a few folders in the System cabinet of the repository only.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

23

Planning for Content Server Installation

Before you configure a repository Determine whether the repository you create will be a global
registry. If you are installing a single production repository, designate it as a global registry. If the site
has multiple production repositories, designate only one repository as a global registry.
To designate a new repository as a global registry, provide a username and password for the global
registry user in the current repository. Client applications and other repositories will use this login
name and password to connect to the global registry. Record the username and password so that
you can provide it when installing other EMC Documentum products that require global registry
access. The global registry user must have read access to objects in the /System/Modules and
/System/NetworkLocations folders. Do not use the repository owners credentials or the installation
owners credentials. The password you assign to the global registry user will also be automatically
assigned to the user named dm_report_user. This user can access the usage tracking information
stored in the global registry. The passwords for these users do not have to remain the same.
If you plan to connect to an existing global registry repository, provide the repository name, the
username, and the password of the global registry user in that repository. The current repository is
configured to access the remote global registry repository.
The Content Server configuration program gives you the option to designate the global registry
repository at a later time. If you select this option, use Documentum Administrator to identify
the global registry and enter the appropriate connection information. The EMC Documentum
Administrator User Guide provides instructions.

24

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 2
Preparing the Host for Content Server
Installation

Use the information in this chapter to prepare the host on which you plan to install Content Server.
Chapter 3, Preparing the Database for Content Server Installation contains additional information for
preparing the relational database for Content Server.
This chapter contains the following information:
Hardware and network environment requirements, page 27
Internationalization settings, page 28
Setting up user accounts, page 29
Preparing UNIX and Linux hosts, page 31

Host preparation checklist


Use the following checklist to prepare the host for Content Server installation In the Value column,
enter the required value that you will be prompted for during database installation and configuration.
Table 1. Host preparation checklist

Task

Resource

Validate the hardware configuration.

EMC Documentum Content Server


Enterprise Edition Release Notes

Validate the operating system


and operating system-database
configuration combination.

EMC Documentum Content Server


Enterprise Edition Release Notes

Value

Ensure that the Content Server hosts


video card uses a minimum of 256
colors.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

25

Preparing the Host for Content Server Installation

Task

Resource

On UNIX and Linux hosts, ensure


that at least 2 MB of shared memory
is allocated and that semaphores are
enabled

Shared memory and semaphore


requirements, page 31

SMTP hostname:
__________

On Windows, obtain the name of the


SMTP host that the Content Server
will use for email notifications.

Decide whether to use an LDAP


directory server.

EMC Documentum Administrator


User Guide and EMC
Documentum Content Server
Enterprise Edition Release Notes

Decide whether to create the


repository owner account and
database storage areas manually or
allow the installer to create them.

Setting up the installation owner


account, page 29, and consult
the database administrator.

Create any necessary accounts and


groups on the operating system and
in the database.

Setting up user accounts, page


29

On UNIX and Linux, create any


required services file entries.

Setting up the services file, page


33

On UNIX and Linux, optionally


create the installation directory.

Preparing UNIX and Linux


hosts, page 31

On UNIX and Linux, obtain the root


password.

26

Value

root password
__________

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Host for Content Server Installation

Task

Resource

Value

On Windows, determine the


Windows domain where users are
authenticated.

This domain is the default


domain if users do not specify
a Windows domain when they
connect. Choose the domain
with the largest number of users.

domain name
__________

Determine the port numbers to


be used by the repository and
connection broker.

The default connection broker


port is 1489. If you are using
the default port number, ensure
that the next port number (1490)
is available for use because the
connection broker requires that
two ports be reserved.Setting
up the services file, page 33
provides information on port
numbers under UNIX.

port number:
__________

Determine the hostname where the


connection broker will run.
On Windows Server 2008, disable
user account control (UAC).

port number:
__________

hostname:
__________
Disabling User Access Control
(UAC), page 35

Hardware and network environment


requirements
A Content Server installation has the following hardware and network requirements:
The host for Content Server must meet the hardware and operating system requirements listed in
the EMC Documentum Content Server Enterprise Edition Release Notes.
Depending on which Content Server model you are installing requirements for hardware, disk
space, software, and other environment and system requirements might vary. The Environment
and System Requirements section of the EMC Documentum Content Server Enterprise Edition Release
Notes contains the detailed Content Server installation environment and system requirements.
The hosts name must use only ASCII characters.
If you are installing on a host that uses multiple network cards, by default Content Server binds to
the first network card. Refer to Binding Content Server to a network card, page 81 and to the EMC
Documentum Administrator User Guide, Appendix C for details on how to do that.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

27

Preparing the Host for Content Server Installation

Internationalization settings
Content Server runs in the UTF-8 code page. Perform the following tasks before Content Server
installation:
Install the server host code page.
Set the code page in the database.
Set the server host locale.
The server host locale and the server code page do not have to be the same. For example, if
the host code page is set to ISO-8859_1, the host locale would typically be set to a European
language (English, French, German, Italian, Portuguese, or Spanish). If the host locale is set to
French, a client that connects to the Content Server without specifying a client locale is served
French data dictionary labels.
If the host locale is one of the languages supported by EMC Documentum, the data dictionary
information for that locale is loaded. Otherwise, the server defaults to loading the English
data dictionary information. You can load additional sets of data dictionary information by
modifying the data_dictionary.ini file. Installing additional data dictionary information can
affect server performance, and EMC Documentum only supports the languages that are shipped
with Content Server. The EMC Documentum Administrator User Guide provides information on
leading additional data dictionary information.
On Windows hosts, the host locale is set in the Regional Settings dialog box.
On UNIX and Linux hosts, the host locale is set with the LANG environment variable.
Database code page, page 40 contains information about setting the database code page. EMC
Documentum Content Server Fundamentals provides complete information on Content Server
internationalization.

Server host code page


Content Server may be installed on computers that run the following operating system code pages:
For U.S. and Western European sites, ISO-8859_1 (Latin-1)
For Korean sites, EUC-KR
For Japanese sites that use UNIX, EUC-JP
For Japanese sites that use Windows, Shift_JIS
For Chinese sites with locale zh, ms936
For Russian with locale ru, Windows-1251

28

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Host for Content Server Installation

Firewalls
Typically, the server-side components of Content Server, such as index server, index agent, and
Documentum Administrator, must be behind a firewall. Only the client side applications, such as
Webtop and the connection broker are supported outside the firewall.
For clients and a connection broker outside of a firewall, you need to use connection broker IP
translation as described in the EMC Documentum Administrator User Guide, Appendix G.

Setting up user accounts


Before installing Content Server, set up an installation owner account. Depending on which type of
user authentication you have chosen, you might need to create operating system user accounts for the
users involved in managing and using Content Server and its repository. Set up the user account for
the installation owner and provide the account with the rights necessary to install Content Server.
The following sections describe the user roles and the rights they need to have.

Setting up the installation owner account


The installation owner account is used to install Content Server and create a repository. The
installation owner must have an operating system account with appropriate permissions, as described
in Required rights for an installation owner account, page 30. Content Server runs under the
installation owners account. The installation owner can perform all administrative or maintenance
tasks associated with the installation or the repository.
The installation owner account may be a local account on the Content Server host or a domain
account in the domain where Content Server is installed. The account must be a member of the
local hosts Administrators group. However, the installation owner account must not be the same
account as the Windows Administrator. On UNIX or Linux, do not use the root account as the
installation owner account.
You can create an operating system account to use exclusively for Content Server installation and
repository maintenance. You can use a single operating system account as installation owner for
multiple Content Server installations on the network.

Installation owner account naming requirements


The installation owners username must consist of letters, numbers, dashes (-) or underscores (_). The
first character must be a letter. All characters must be ASCII characters.
The installation owners password must consist of letters, numbers, dashes, underscores, or periods.
Note: On Windows hosts, user accounts are not case-sensitive, but Content Server installation fails
if you connect to the host by using the incorrect case in the username. For example, if the account
is set up as JPSmith and you connect as jpsmith, you can log in to the host, but Content Server
installation fails.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

29

Preparing the Host for Content Server Installation

Required rights for an installation owner account


The installation owner must have the following user rights:
Act as part of the operating system
Create a token object
Increase quotas
Log in as a service
Log in locally
Replace a process-level token
On a standard Windows system, these rights are automatically inherited with membership in the
local Administrators group. The Setup program checks for these rights and grants them if necessary.
The installation owner must have Full Control permission on the directory into which Content
Server is being installed. The installation owner must also have write permission on the directory
from which the installation program is run. On UNIX or Linux hosts, the installation owner must
have read, write, and execute permission on the /tmp directory.
The installation owner must have an email account on the SMTP mail server.
To support external password validation, set up a group account whose members are the installation
owner, any other Content Server administrators, and repository owners. This will be the group that
owns the external password validation program.
On UNIX and Linux hosts, set several environment variables in the installation owners environment.
The Content Server configuration script sets the required variables by default. If you do not use the
Content Server configuration script, you need to manually set the environment variables discussed in
Appendix A, Required Environment Variables for UNIX and Linux.

Setting up the repository owner account


The repository owner operating system account is used to connect to the database. The repository
owner owns all objects in the database. Each repository must have a unique repository owner. To
create a new repository you need a repository owner account. If you want to use the option to use an
existing database account when you are creating a new repository, you must have a database user
account established already.
On Windows hosts, set up a Windows account for the repository owner. For installations that use
DB2 databases, the repository owner must be a valid Windows user on the host where the database
is installed. To use Microsoft Cluster Services, the repository owner must have an account in the
domain in which you install the repository.

Repository owner account naming requirements


The repository owners username must consist of letters, numbers, dashes (-) or underscores (_). The
first character must be a letter. All characters must be ASCII characters.

30

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Host for Content Server Installation

The repository owners password must consist of letters, numbers, dashes, underscores, or periods.

Setting up repository user accounts


Repository users are the end users in the repository. These users may own documents or other objects
that are stored in a repository, but they have no particular responsibilities for the maintenance of
either the repository or the installation.
On Windows, if the default user authentication is used, each user must have a Windows account
in the domain where Content Server is installed. If LDAP authentication or inline password
authentication is used, this is not a requirement.
On UNIX and Linux, if the default user authentication is used, each user must have an operating
system account in the domain where Content Server is installed. If LDAP authentication or inline
password authentication is used, this is not a requirement.

Preparing UNIX and Linux hosts


If you are running Content Server on UNIX or Linux, create the installation owners account and set
variables in the installation owners environment before you install.
This section covers these topics, which include requirements in addition to configuring the
installation owners environment correctly.

Shared memory and semaphore requirements


Content Servers shared memory and semaphore requirements are:
Configure the host with at least two megabytes of shared memory for Content Server.
Content Server uses a semaphore. Ensure that semaphores are enabled on the host.

XWindows requirement
XWindows must be installed on the UNIX host to run the graphical installation program, and the
xterm program must be in the installation owners path. The xterm program may be installed
in various locations depending on the operating system and software packages installed. Some
typical locations are:
On Solaris, /usr/openwin/bin
On HP-UX and AIX, /usr/bin/X11
Verify that the xterm program is in one of the preceding paths or in an alternate location and add
that location to the PATH variable.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

31

Preparing the Host for Content Server Installation

The /tmp directory


The /tmp directory must have at least 1 GB of available space for a Content Server installation.

Root user password


As part of the Content Server installation procedure, run the dm_root_task script to set the correct
file permissions on a pair of programs required for user authentication (dm_check_password and
dm_change_password). Run the script as the root user with the root user password.

Setting Documentum environment variables


Before you install Content Server on a UNIX or Linux host, set environment variables that identify the
directories into which Content Server will be installed. The variables must be set in the installation
owners environment.
You can create the Content Server installation directories before installing the server, or you can allow
the Content Server installation program to create the directories. If you allow the Content Server
installation program to create the directories, ensure that the directory names you provide during the
installation program match the names specified in the environment variables.
Do not use symbolic links (symlinks) for the installation directories, or use them in any environment
variables used by Content Server, as they are not supported. This restriction also applies to
environment variables used to specify the database location. For example, if you use Oracle, the
ORACLE_HOME environment variable cannot use a symbolic link.
The environment variables to set are:
$DOCUMENTUM
This environment variable corresponds to the Content Server installation directory. On Windows
the default is /Documentum on the current host. The installation owner must have read, write,
and execute permission on the $DOCUMENTUM directory and its subdirectories. For UNIX and
Linux, no default directory exists, and $DOCUMENTUM cannot be mounted with the nosuid
option..
$DM_HOME
The value of $DM_HOME must be $DOCUMENTUM/product/version_number. version_number, is
the version of Content Server. For example:
$DOCUMENTUM/product/6.7
$DOCUMENTUM_SHARED
This environment variable sets the directory into which EMC Documentum Foundation Classes
are installed.
The environment variables and installation directories must contain only ASCII characters. The name
of the installation directory must not contain spaces.

32

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Host for Content Server Installation

Setting up the services file


The services file must contain two entries for each repository running on a host. On UNIX and Linux,
manually create the service name entries in the services file before you install the Content Server.
The repository does not have default service names or default port numbers. The service name you
put in the services file must be the same name you provide during repository configuration, which
is then used to create the server.ini file. The service name for the repository can be the same as
the repository name, but this is not required.
The services file must include entries that designate two consecutive port numbers for use by
Content Server:
One for native connections.
One for secure (SSL) connections. Append _s to the name of the repository service for the secure
connections.
Note: Repository service names that end with _s are reserved for secure connections.
Note: Even if you are not using SSL, two consecutive port numbers for use by Content Server are
required.
The default port number on which the connection broker listens is 1489. If you are using the default
port number, ensure the next port number (1490) is also available for use and is not used by any other
item because the connection broker requires that two ports be reserved.
If you decide to use a different port number than 1489, you need to create two network service
entries in the systems service table.
Create the service name entries by using the following format:
service_name port_number/tcp #Put comments here
service_name_s port_number/tcp #Put comments here

If NIS is running, the local services file (/etc/services) is ignored. Place the entries in the NIS services
map. Use the ypwhich command to identify the hostname of the NIS master server, if there is one.
The port numbers can be any unused port numbers greater than 1024. UNIX reserves port numbers
up to 1024 for system use. For example, if the repository service were named "lime, the services
file entries might be:
lime
1497/tcp # 6.5 Repository native connection
lime_s 1498/tcp # 6.5 Repository secure connection

If the correct services file entries are not present, the installer stops.
If you have multiple repositories on a single host, create a services file entry for each repository.
Ensure that the repositories have different names and port numbers.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

33

Preparing the Host for Content Server Installation

Preparing Windows hosts


If you are running Content Server on a Windows host, you must make some configuration changes
in Windows itself and you must ensure that the correct accounts are set up before you install the
server. This section includes the following topics:
Setting the PATH Environment Variable, page 34
Running WDK Applications on the Content Server Host, page 34
Restricted Characters, page 35
Regional Settings, page 35
SMTP Server on Windows, page 35

Setting the PATH Environment Variable


On Windows hosts, you must manually add the path to Java to the PATH system environment
variable. If this is not set correctly, custom Java methods executed by the Java method server and
the LDAP and federation jobs do not run correctly on the host.
During Content Server installation, you are asked for a DFC installation directory. This is typically
Drive:\Program Files\Documentum. Installing DFC also installs the JDK. The full path to the Java
installation is typically Drive:\Program Files\Documentum\java\1.6.0_17\bin, and that is the value
to add to the PATH system environment value.

To modify the PATH environment variable:


1.

Right-click My Computer (or Start > Computer).

2.

Select Properties

3.

Select the Advanced tab (or Advanced system settings).

4.

Click Environment Variables.

5.

In the System Variables section, select PATH and click Edit.

6.

Add the value DFC_install_location\java\1.6.0_17\bin to the path and click Ok.


The DFC installation location is set during server installation. It is typically Drive:\Program
Files\Documentum.

7.

Click Ok and close the System Properties dialog box.

Running WDK Applications on the Content Server Host


EMC Documentum Web Development Kit and applications built with WDK (such as Documentum
Administrator) are run with an application server. If you install WDK or a WDK application on the
Content Server host, install and run the application server using an account that is not an EMC
Documentum user. Using a Documentum user account creates security risks because of trusted login.

34

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Host for Content Server Installation

For more information, refer to the EMC Documentum Web Development Kit and Webtop Deployment
Guide.

Restricted Characters
The name of the directory in which Content Server is installed can only contain ASCII characters.
Additionally, do not use the following characters in path names accessed by EMC Documentum
product installers: ! \ / : * ? " < > |
Do not use spaces in the name of the product installation directory. For example, do not use
c:\Documentum Products\ or /Documentum Products as the name of the installation directory.

Regional Settings
Before you install a repository, the Windows Regional Settings must be set to specify a four-digit date.

To specify a four-digit date:


1.
2.

Choose Start >Settings>Control Panel.


Double-click Regional Options.

3.

Click the Date tab.

4.

Select a date style that includes a four-digit year from the dropdown list.

5.

Click Ok.

SMTP Server on Windows


On Windows hosts, Content Server must be able to connect to an SMTP mail server. The SMTP
server can be an SMTP server located on your network or it can be the SMTP server provided with
Windows. During the installation or upgrade procedure, you must provide the name or IP address of
the computer hosting the SMTP server.
If a valid SMTP server host name is not available during installation, supply an invalid host name
and the installation will finish. Do not leave the field blank. After installation, add a valid SMTP
server host name to the smtp_server attribute of the server config object. Reinitialize the server after
you update the server config object.

Disabling User Access Control (UAC)


Before you can install Content Server on a Windows Server 2008 platform, you must disable user
account control (UAC). To do so, follow these steps:
1.

Navigate to Control Panel > User Accounts.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

35

Preparing the Host for Content Server Installation

2.

Click on Turn User Account Control on and off.

3.

Uncheck the option Use User Account Control to help protect your computer.

4.

Click OK.

36

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 3
Preparing the Database for Content
Server Installation

This chapter contains information on configuring the database for Content Server installation. For
details about installing or supporting a database, refer to the database administrator or the database
vendors documentation. This chapter contains the following topics:
Database preparation checklists, page 37
Requirements for all databases, page 40
Oracle requirements, page 42
SQL Server requirements, page 44
Sybase requirements, page 46
DB2 requirements, page 47

Database preparation checklists


Use the following checklists to prepare for database installation and configuration. In the Value
column, enter any required values. You will be prompted for these values during database
installation and configuration.
Table 2. General database installation and configuration checklist

Task

Resource

Validate the operating system and


the combination of operating system
database configuration.

EMC Documentum Content Server


Enterprise Edition Release Notes

If you are doing a custom Content


Server installation, determine the
datafile size. In a custom installation
you can change the default values.
An express installation uses the
default values.

Database documentation

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Value

datafile size:
__________

37

Preparing the Database for Content Server Installation

Task

Resource

Value

If you are doing a custom Content


Server installation, determine the
log file size. In a custom installation
you can change the default values.
An express installation uses the
default values.

Database documentation

log file size:


__________

"Database administrator
account, page 42 and the
database administrator

database administrator
name:
__________

Review the Content Server-specific


information for the database.
Obtain the database administrator
name and password.

database administrator
password:
__________
Install the database instance with
the UTF-8 code page.

Database documentation

Ensure that the relational database


is installed and running.
Table 3. Oracle database installation and configuration checklist

Task

Resource

Determine whether to migrate


an existing Oracle instance to
AL32UTF8 or AL16UTF8 code page.

Oracle documentation

Decide whether to configure the


database for improved performance.
You need to do this before starting
Content Server.

Oracle documentation

Set up the networking parameters.

"Oracle requirements, page 42

Ensure that the database aliases


are in the tnsnames.ora file on the
Content Server host.

Oracle documentation and


"Entries in tnsnames.ora file,
page 43

Ensure that the Oracle Listener is


running on the Oracle host.

Oracle documentation

Ensure that the Oracle optimizer


meets EMC Documentum
recommendations.

"Oracle requirements, page 42

38

Value

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

Table 4. DB2 database installation and configuration checklist

Task

Resource

Decide whether to configure the


database for improved performance.
You need to do this before starting
Content Server.

DB2 documentation and DB2


requirements, page 47DB2
requirements, page 47

Obtain the database alias name.

"DB2 requirements, page 47

Ensure that the DB2 clients are


installed on the Content Server host.

"DB2 requirements, page 47

Set the DB2 registry environment


variable DB2CODEPAGE

DB2 documentation

Value

database alias name:


__________

1208

Table 5. SQL Server database installation and configuration checklist

Task

Resource

Configure open database


connectivity (ODBC).

"Configuring an ODBC Data


Source for SQL Server, page 44

Use a full SQL Server installation by


using the Custom option.

SQL Server documentation

Ensure that the SQL Server sort


order is set to Dictionary.

SQL Server documentation

Ensure that case-sensitivity and


row-level locking are enabled.

SQL Server documentation

If SQL Server uses Windows


authentication, ensure that the
installation owner has system
administrator privileges in SQL
Server.

SQL Server documentation

Ensure that the repository owner


and installation owner meet the
requirements.

"SQL Server requirements, page


44

Install the SQL Server client on the


Content Server host.

SQL Server documentation

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Value

39

Preparing the Database for Content Server Installation

Task

Resource

If SQL Server is installed remotely,


install Microsoft Data Access
Components 2.71 on the Content
Server host.

SQL Server documentation

Install SQL Server for


internationalization.

SQL Server documentation

Value

. The article "International


Considerations for SQL Server
on the Microsoft MSND Web
site provides more specifics on
this topic.

Table 6. Sybase database installation and configuration checklist

Task

Resource

In the $SYBASE/server_name.cfg file,


set the system parameters number
of open objects, number of open
indexes, and number of locks.

"Sybase requirements, page 46"


and Sybase documentation.

Set the page size to a minimum size


of 8 KB.

Sybase documentation and


"Sybase requirements, page 46

Ensure that the Sybase version is at


least 12.5.

Sybase documentation

Ensure that the Sybase directory


structure is correct.

Sybase documentation and


"Sybase requirements, page 46

Value

Requirements for all databases


Database tables store attribute values for each object in the repository. This section discusses
requirements and decisions that apply to all database vendors.

Database code page


For new repositories, install the database by using the Unicode code page, which can accurately
store characters from all supported languages.
On Oracle, DB2, and Sybase use UTF8. For Oracle, this includes AL32UTF8 and AL16UTF8.
On SQL Server, you can use any collation (SQL Servers name for code page), because this only
determines the code page of varchar and char types. For new SQL Server repositories, Content
Server uses only nvarchar and nchar types, which automatically use Unicode. If you need
to determine the collation settings of an existing SQL Server database, use the system stored
procedure sp_helpsort or view the properties of the particular database in Enterprise Manager.

40

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

Database locales
Typically, Content Server is installed on the English version a database. However, Content Server
installation is also supported on localized databases if the database fulfills the following criteria:
Database supports internationalization of locales (I18N)
Database and adheres to I18N standards
Content Server installation is done with UTF8 and case sensitive (SQL)

Semantics
Content Server installation requires a database server to use byte-length semantics.

Database service on Windows


If Content Server and the database are located on the same Windows host, ensure that the database
service is set to start automatically. Content Server installation sometimes requires a restart of
the computer. After the restart, installation does not proceed correctly unless the database starts
automatically.

Repository owner account


Content Server uses the repository owner (database user) account to connect to the database. Content
Server runs as the installation owner, but a separate database user account must exist to provide the
server with access to the database tables underlying the repository. Each repository must have a
unique repository owner and each repository owner must have a unique database account.
You can create the repository owner account, the database user account, and the database or
tablespace that the repository uses before Content Server installation, or the server installation
software can create the account and database or tablespace.
You can create the repository owner account in the database in one of two ways:
Create the account in the database before installing Content Server. During Content Server
configuration, provide the username and password for the existing user account. Repository
owner account, page 41, provides information about the required privileges for the repository
owner account.
Allow the Content Server configuration program to create the user in the database. Provide the
username and password for a new database user during Content Server configuration. The
default username is the repository name. The Content Server configuration program gives the
appropriate privileges to the repository owner.
Note: On Oracle databases, if you create the account before Content Server installation, provide
a value for the select_catalog_role parameter.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

41

Preparing the Database for Content Server Installation

The account must have the appropriate privileges to perform the following tasks:
Connect to the database.
Create tables, views, and indexes in the database.
Insert records (rows) into the tables.
Drop tables, views, and indexes.
The names of the privileges depend on the RDBMS. If you create the account before running the
installer, give the account these privileges:
On Oracle, the repository owner must have Connect and Resource privileges. The Resource
privilege encompasses creating and maintaining database objects. The repository owner also
must have permission to create any view, resource, and unlimited tablespace. The tablespace
created by the repository owner for tables or indexes must be designated the default, while the
standard Oracle temporary tablespace must be the default for any temporary tables that the
repository owner creates. The name of the temporary tablespace needs to be valid for the Oracle
configuration used. The default name is either temporary_data or temp, depending on which
Oracle version is used.
The repository must also have the Select Catalog Role privilege.
On DB2, grant use of tablespaces, list tablespace, and connect to database privileges.
On DB2, the repository owner does not have an account. The repository owner is created when
you grant the required privileges to an existing operating system account.
On all supported SQL Server versions, the repository owner must be able to access tempdb, and if
the account is created before running the installer, the user must own all tables and views. Ensure
that the repository owner has the Create Any Database privilege.
On Sybase, the repository owner must be able to execute procedures and update statistics.
If you allow the Content Server Setup program to create a database account for the repository owner,
the proper privileges are granted to the repository owner automatically.

Database administrator account


Regardless of the database you use with Content Server, you need to know the database
administrators username and password. This information is needed to create the repository owner
account in the database if you choose to have Content Server installation software create the account
for you.

Oracle requirements
Note: In release 6.7, for UNIX and Linux, we changed the way we link to the Oracle Client library.
Prior to 6.7 we linked statically to the 32bit Oracle Client library. In 6.7 we do not link with the
32bit Oracle Client library at build time, we dynamically link it in to the running process at
runtime. Therefore, you must install a 32bit Oracle Client on the Content Server host, and add the
directory containing the client libraries to the appropriate environment variable (SHLIB_PATH for
HPUX, LIBPATH for AIX or LD_LIBRARY_PATH for Linux and Solaris) of the repository owner

42

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

before configuring or starting Content Server. You must install the 32bit Oracle Client even if you
successfully used the 64bit Client with an earlier release.
For HPUX-IA64, after installing the 32bit Client, you must create a symbolic link from the library file
to libclntsh.o. For example:
ln -s libclntsh.so.11.1 libclntsh.o

The actual version number of the library will depend on the client you have installed.
The Oracle RDBMS must meet these requirements:
On UNIX and Linux, ensure that these environment variables are set in the installation owners
environment:
ORACLE_HOME
TNS_ADMIN
ORACLE_SID
This environment variable points to the location of the tnsnames.ora file. The Content Server
installation program looks first for TNS_ADMIN, then for ORACLE_HOME, in order to locate
the tnsnames.ora file.
For UNIX and Linux hosts, install the 32bit Oracle Client package on the Content Server host and
update the value of the shared library path environment variable (appropriate to your operating
system) to include the library directory. For Windows, install a 32bit client package for a 32bit
Content Server; install a 64bit client package for a 64bit Content Server.

Entries in tnsnames.ora file


Oracle database aliases (TNS aliases) are defined by entries in the tnsnames.ora file. You cannot
connect to an Oracle database without an alias. Configure the tnsnames.ora file on the Content Server
host. Use the Oracle SQL*Net configuration tool to create a database alias referring to the database
instance you plan to use for Content Server. After you create the alias, test the alias by connecting to
the Oracle database.
Entries in the tnsnames.ora file for the Oracle HTTP service and data expo service do not contain
parameters for HOST, SID, and SERVICE. If the first entry in the tnsnames.ora file is for one of these
services, the Content Server installation program is unable to parse the tnsnames.ora file and cannot
connect to the database. Make sure that the first entry in the tnsnames.ora file is not for the Oracle
HTTP service or data expo service.
The database_conn key in the server.ini file must match the database entry in the tnsnames.ora
file. If it does not, you see this error:
Error - Failed to obtain database connection information
corresponding to the repository from the server.ini file.
String index out of range: -1
Please read error log /tmp/installation_owner_name.ServerInstaller.log
for more information.

If you see this error, modify the database_conn key in the server.ini file and continue with the
installation or upgrade.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

43

Preparing the Database for Content Server Installation

Oracle repository sizes


An Oracle repository has the following size and configuration considerations:
In a small repository on Oracle, a single tablespace contains the data and indexes and an index
tablespace cannot be configured.
A small Oracle repository has an initial datafile size of 100 MB.
In a medium or large repository on Oracle, one tablespace contains the data and another
tablespace contains the indexes. An index tablespace can be configured.
A medium Oracle repository has an initial datafile size of 180 MB and an initial index file size
of 180 MB.
A large Oracle repository has an initial datafile size of 250 MB and an initial index file size
of 250 MB.

SQL Server requirements


The SQL Server RDBMS must meet these requirements:
Use a full SQL Server installation on the host where SQL Server is installed. Install the SQL Server
client on the Content Server host, regardless of whether the database is local or remote.
Use the Custom installation option so that you can set the database code page, case-sensitivity,
and other options.
You need to install the SQL Server instance in SQL Server and Windows Authentication mode.
Caution: Install the database in case-sensitive mode with row-level locking enabled. If you
installed SQL Server in case-insensitive mode, you need to reconfigure the database before you
install or upgrade Content Server.

Configuring an ODBC Data Source for SQL Server


SQL Server requires you to add a DSN entry manually. If you have two SQL Server instances on the
same host, enter hostname/instancename, when you provide the SQL Server name.
The SQL Server documentation contains instructions on how to configure an open database
connectivity (ODBC) data source for a new installation of SQL Server. When choosing an
authentication method for SQL Server to use, consider the following:
When prompted for the name of the new data source, type the name of the host on which you are
configuring ODBC and installing Content Server.
When prompted for the driver, select SQL Server. Do not select SQL Server Native Client.
When creating the ODBC data source, you can choose either Windows authentication or SQL
Server authentication as an authentication method.

44

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

Note: This applies only to the ODBC data source.


If you choose Windows authentication for the creating of the ODBC data source, the database
user (repository owner) must have a Windows account and the installation owner must have
System Administrator privileges in SQL Server.
If you choose SQL Server authentication, the database user (repository owner) does not have to
have a Windows account.
However, when installing the entire SQL server instance, you need to install it in SQL Server and
Windows authentication mode.
When configuring the client, consider the following:
If SQL Server is on the same host as Content Server, select Named Pipes.
If SQL Server is on a different host from Content Server, select TCP.

Configuring a 32bit repository on 64-bit SQL server


When you configure a 32bit Content Server on the 64-bit SQL server, the configuration program
looks at the wrong Program Files directory, for example, Program Files (x86). As a result, the data
source drop-down list does not get populated.
To work around this issue, do the following:
1.

On a 64-bit OS, set up DSN for 32-bit applications.

2.

Use the 32-bit ODBC Data Source Administrator tool, which is available at
C:\Windows\SysWOW64\odbcad32.exe.

After the DSN is set, the data source drop-down list is populated.

SQL Server repository sizes


An SQL Server repository has the following size and configuration considerations:
In a small repository on SQL Server, you can change the log file size, but you cannot change the
device size for the database.
A small SQL Server repository has a datafile size of 100 MB and a log file size that is 30% of
the size of the datafile.
In a medium or large repository on SQL Server, you can change the device size and the log file
size for the database.
A medium SQL Server repository has a datafile size of 180 MB and a log file size that is 30%
of the size of the datafile.
A large SQL Server repository has a datafile size of 500 MB and a log file size that is 30% of
the size of the datafile.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

45

Preparing the Database for Content Server Installation

Sybase requirements
The Sybase RDBMS installation must meet these requirements:
In the $SYBASE/$SYBASE_ASZserver_name.cfg file, set the following system parameters to the
values shown.
number of
number of
number of
number of
procedure
number of

open objects = 4000


open indexes = 3000
locks = 35000
user connections = 200
cache size = 48000
open partitions =2500

Note: For Sybase 15.0, increase the number of open partitions.


Ensure that the correct Sybase environment variables are set in the installation owners
environment:
SYBASE
SYBASE_OCS
For Sybase 15.0, set this variable to OCS-15_0. The Sybase documentation set has detailed
information on how to set this variable.
SYBASE_SYSAM
SYBASE_JRE
SYBASE_ASE
If these Sybase environment variables are not set, you see ct_init (CS_VERSION_100) errors.
Appendix A, Required Environment Variables for UNIX and Linux contains information about
these variables.
In a new repository, set a page size of 8 KB.
You can improve performance of some EMC Documentum scripts by increasing the network
packet size to 4 K or 8 K.
On Sybase versions 12.0 and later, ensure that the file isql exists in the directory
$SYBASE/SYBASE_OCS/bin/isql.
If you are using file system devices rather than raw devices, you can manually reset the dsync
option on the tempdb devices by using the sp_deviceattr.
Increase the number of available user connections to at least 200.

Sybase repository sizes


A Sybase repository has the following size and configuration considerations:
In a small repository on Sybase, you can change the log file size, but you cannot change the
device size for the database.
A small Sybase repository has a datafile size of 100 MB and a log file size of 100 MB.

46

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

In a medium or large repository on Sybase, you can change the device size and the log file size
for the database.
A medium Sybase repository has a datafile size of 180 MB and a log file size of 180 MB.
A large Sybase repository has a datafile size of 800 MB and a log file size of 250 MB.

DB2 requirements
The DB2 configuration requirements apply whether DB2 and Content Server are running on
Windows or AIX or a combination.
On AIX, ensure that the following DB2 environment variables are set in the installation owners
environment:
Update the database configuration for the database to 200 using the following command:
MAXAPPLS 200 AUTOMATIC MAXLOCKS 80 AUTOMATIC

DB2_BASE
This must point to /DB2_installation_dir/home/instance_name/sqllib.
DB2INSTANCE
This must point to the name of the default DB2 instance.
To support audit trail functionality, DB2 requires 8K-page capability. During the installation
of version 6.5, the installer automatically creates 8K pages. To find out whether you have 8K
temporary tablespace before an installation or upgrade, run the following command:
db2 LIST TABLESPACES SHOW DETAIL

If the page size parameter is 4096, you have 4K page size, if it is 8192, you have 8K page size.
To create an 8K temporary tablespace, run the following command:
db2 CREATE TEMPORARY TABLESPACE TEMPSPACE2 PAGESIZE = 8192

Ensure that the LIBPATH environment variable includes $DB2_BASE/lib.


Do not set the environment variable DB2OPTIONS. If set to T, the DB2 command-line processor uses
a semicolon (;) as the statement termination character. Content Server does not install properly
on AIX with DB2 when DB2OPTIONS is set.
Before you create a database for use by Content Server, disable the DB2CODEPAGE environment
variable from the command line:
db2set DB2CODEPAGE =

Ensure that the DB2 clients are installed on the Content Server host.
If you install DB2 on the same host as the Content Server, the clients are installed automatically.
If you install DB2 on a different host from the Content Server, you need to manually install
the DB2 clients on the Content Server host.
Set the code page to UTF-8.
Set the DB2NTNOCACHE environment variable:

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

47

Preparing the Database for Content Server Installation

db2set DB2NTNOCACHE=1

You can create the database and set the parameters from the DB2 command line or from the Control
Center. Use the Control Center to run the performance wizard. You can run the Control Center
on AIX, or you can run performance wizard from a Windows system to tune performance for the
instance on AIX.
Use the following general guidelines to install and configure DB2:
1.

Install DB2.

2.

Optionally, use the performance wizard to fine-tune DB2 performance.


You can use the performance wizard at a later time (after you complete configuring DB2), but if
you do so, ensure that the parameter values required by Content Server are not changed.

3.

Configure DB2.

Configuring a DB2 database


You can configure a DB2 database by using one of the following methods:
Configure DB2 from the Control Center
Configure DB2 from the command line
Optionally, you can use the performance wizard to fine-tune DB2 performance after installing and
configuring the database. You can use the performance wizard at a later time, but if you do so, ensure
that the parameter values required by Content Server are not changed.

Configuring DB2 from the Control Center


Use the following procedure to configure a DB2 database from the Control Center:
1.

Start the Control Center.

2.

Right-click the database and choose Configure from the context menu.

3.

Click the Performance tab.


a.

Set the sort heap.


If you are configuring DB2 Enterprise Edition, set the sort heap to 1024.
If you are configuring DB2 Workgroup Edition, set the sort heap to 512.

b. Set the application heap size to 1024.


c.

Set the application control heap size to 256.

d. Set the log buffer size.


If you are configuring DB2 Enterprise Edition, set the log buffer size to 128.
If you are configuring DB2 Workgroup Edition, set the log buffer size to 64
e.

48

Set the lock list size.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

If you are configuring DB2 Enterprise Edition, set the lock list size to a minimum of 500.
If you are configuring the DB2 Workgroup Edition, set the lock list size to 300.
4.

Click the Applications tab and set the maximum number of locks to 80.

5.

Click the Logs tab.


a.

Set the log file size to 1000.

b. Set the number of primary logs to 5.


c.

Set the log second size.


If you are configuring DB2 Enterprise Edition, set the size to 10.
If you are configuring DB2 Workgroup Edition, set the size to 15.

6.

Click OK and close the dialog box.

7.

When the Control Center is displayed, click the database for your repository and right-click
Buffer Pools.

8.

Choose Alter. The Alter Buffer Pool dialog box displays.

9.

Check Use default bufferpool size, and click OK.

10. From the command line, restart the DB2 server:


db2stop force
db2start

Configuring a DB2 database from the command line


Use the following procedure to configure a DB2 database from the command line:
1.

Start the DB2 command line.

2.

Set the application heap size to 1024 or greater, where <dbname> is the name of the database you
created for use by the repository:
update db cfg for <dbname> using applheapsz 1024

3.

Set the application control heap size to 256 or greater


updatedb cfg for <dbname> using APP_CTL_HEAP_SZ 256

4.

Set the transaction file sizes.


If you are configuring DB2 Enterprise Edition:
update
update
update
update

db
db
db
db

cfg
cfg
cfg
cfg

for
for
for
for

<dbname>
<dbname>
<dbname>
<dbname>

using
using
using
using

LOGFILSIZ 1000
LOGPRIMARY 5
logbufsz 128
logsecond 10

If you are configuring DB2 Workgroup Edition:


update
update
update
update

5.

db
db
db
db

cfg
cfg
cfg
cfg

for
for
for
for

<dbname>
<dbname>
<dbname>
<dbname>

using
using
using
using

LOGFILSIZ 1000
LOGPRIMARY 5
logbufsz 64
logsecond 15

Set the maximum number of locks:

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

49

Preparing the Database for Content Server Installation

update db cfg for <dbname> using maxlocks 80

6.

Set the lock list size.


On the DB2 Enterprise Edition, set it to a minimum of 500:
update db cfg for <dbname> using locklist 500

On the DB2 Workgroup Edition, set it to 300:


update db cfg for <dbname> using locklist 300

7.

Set the sort heap and buffer page sizes. Ensure that the buffer page size (buffpagesize) is set to
a minimum of 6000.
If you are configuring DB2 Workgroup Edition:
update db cfg for <dbname> using sortheap 512
update db cfg for <dbname> using buffpage buffpagesize

If you are configuring DB2 Enterprise Edition:


update db cfg for <dbname> using sortheap 1024
update db cfg for <dbname> using buffpage buffpagesize

If the repository and the DB2 server are on the same machine and you are configuring DB2
Enterprise Edition, set buffpagesize to 40% of the available physical memory divided by the
page size of your tablespace.
If the repository and the DB2 server are on the same machine and you are configuring DB2
Workgroup Edition, set buffpagesize to 20% of the available physical memory divided by the
page size of your tablespace.
If the repository and the DB2 server are on different machines, set buffpagesize to 80% of the
available physical memory divided by the page size of your tablespace.
Note: If you are running more than one repository and database on the same DB2 server, the
percentage recommended for buffer pool is for the sum of all databases. In all cases, ensure that
the buffer page size is a minimum of 6000.
8.

If you see the SQL1482W error message "The BUFFPAGE parameter will only be used if one of
the buffer pools is defined with a size of -1, change the buffer pool size:
ALTER BUFFERPOOL buffpoolname SIZE -1

9.

From the command line, restart DB2:


db2stop force
db2start

10. If DB2 is installed remotely, use the DB2 Client Configuration Assistant after database creation to
add the database alias to the list of available databases.

50

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

DB2 performance wizard requirements


Using the DB2 performance wizard has the following requirements:
Set the server memory target value.
If DB2 is installed on the Content Server host and you are installing DB2 Enterprise Edition, set
the target memory to 40%.
If DB2 is installed on the Content Server host and you are installing DB2 Workgroup Edition,
set the target memory to 20%.
If DB2 is installed on a different host from Content Server and you are installing DB2
Enterprise Edition, set the target memory to 80%.
Ensure that the buffpage value is at least 6000.

Tuning a DB2 database


This section describes how to do performance tuning of a DB2 database using the Performance
Wizard.
You can skip this step now and do performance tuning later. If you are doing performance tuning
at a later time, verify that the parameters described in the Configuring a DB2 database section of this
document are set to the correct values.
If your DB2 instance runs on AIX, run the Performance Wizard from a Windows system to tune
performance of the instance on AIX.
To tune DB2 performance follow these steps:
1.

Start the Control Center

2.

Right-click the database you created for the repository.

3.

On the context menu, choose Configure Performance Using Wizard. The name of the production
database dialog box is displayed.

4.

Click Next. The server memory dialog box is displayed.

5.

Set the server memory target value.


If DB2 is installed on the Content Server host and you are installing DB2
Enterprise Edition, set the target memory to 40%.
If DB2 is installed on the Content Server host and you are installing DB2
Workgroup Edition, set the target memory to 20%.
If DB2 is installed on a different machine from Content Server and you are installing Enterprise
Edition, set the target memory to 80%.

6.

Ensure that the buffpage value is at least 6000.

7.

Click Next. The workload type dialog box is displayed.

8.

Click Mixed , then click Next . The typical database transaction dialog box is displayed.

9.

Indicate the allowable number of SQL statements and transactions.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

51

Preparing the Database for Content Server Installation

If you are installing DB2 Enterprise Edition, click More than 10 SQL statements and 60
transactions per minute, then click .
If you are installing DB2 Workgroup Edition, click Less than 10 SQL statements and 30
transactions per minute, then click Next.
The database administration priority dialog box is displayed.
10. Click Faster transaction performance (slower recovery), then click Next.
The database data population dialog box is displayed.
11. Click No, then click Next.
After the repository is in use and the database contains more data, you can run the Performance
Wizard again and change this parameter. The number of connected applications dialog box is
displayed.
12. Provide the average number of local and remote connections.
If you are installing DB2 Enterprise Edition, type in four average local connections and 20 average
remote applications and click Next.
If you are installing DB2 Workgroup Edition, type in four average local connections and two
average remote connections and click Next.
These numbers can be larger depending on the number of clients connecting to your repository.
A production repository can have many more client applications connecting.
The isolation level dialog box is displayed.
13. Click Cursor stability (many locks of short duration) and click Next. The Performance Wizard
displays values it recommends based on the information you provided and choices you made.
14. Check Apply these recommendations immediately, then click Finish.
15. From the command line, restart the DB2 server:
db2stop force
db2start

Running multiple Content Servers on the DB2 host


If you run multiple Content Servers on the DB2 host, you might see a DB2 SQL1224N error. This
can occur with multiple repositories on the host or with multiple servers that run against a single
repository. To work around this, change the following parameters:
On AIX, set EXTSHM to ON in the environment of the DB2 instance owner. You can do this in the
.cshrc file or the corresponding system file for the different shells.
setenv EXTSHM ON

On Windows, set the EXTSHM environment variable at the system level.


In the DB2 environment, type this command:
db2set DB2ENVLIST=EXTSHM

52

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Preparing the Database for Content Server Installation

DB2 repository sizes


DB2 repositories have the following size and configuration considerations:
In a small repository on DB2, a single tablespace contains the data and indexes, and you cannot
change an index tablespace.
A small DB2 repository has an initial datafile size of 200 MB.
In a medium or large repository on DB2, one tablespace contains the data and another tablespace
contains the indexes, and you can change an index tablespace.
A medium DB2 repository has an initial datafile size of 400 MB and an initial index file size
of 200 MB.
A large DB2 repository has an initial datafile size of 800 MB and an initial index file size of 300 MB.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

53

Preparing the Database for Content Server Installation

54

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 4
Pre-Installation Checklist

Content Server installation has two stages: The first stage copies Content Server software from the
installation media to the proper directories on the Content Server host and, on Microsoft Windows
hosts, modifies the Windows registry and environment variables. The second stage configures at least
one repository and at least one connection broker and starts the repository and connection broker.
Step-by-step instructions for installing Content Server software are found in these chapters:
Chapter 5, Installing Content Server software on a UNIX or Linux host
Chapter 6, Installing Content Server software on a Windows host
Step-by-step instructions for running the configuration program to create a connection broker and
repository are found in these chapters:
Chapter 7, Configuring Content Server and the repository on a UNIX or Linux host
Chapter 8, Configuring Content Server and the repository on a Windows host
After the installation, complete the tasks described in Chapter 9, Completing the Installation. To
upgrade from a previous release of Content Server, complete the preparatory steps described in
Chapter 10, Upgrading Content Server before installing the new version of Content Server.
You can choose to perform an express repository configuration or a custom repository configuration.
Express configuration minimizes the amount of information that you need to provide. It also limits
how much you can customize the configuration of Content Server and repository. The procedure for
installing and configuring Content Server on Windows and Linux and UNIX hosts calls out explicitly
those steps required for custom installation and configuration only and those required for express
installation only. Otherwise, the steps apply to both installation methods.

Installation and configuration checklist


Before installing Content Server, use the following installation and configuration checklist to review
related documentation and make decisions about your installation. Note any values you will be asked
to enter during the installation in the Value column.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

55

Pre-Installation Checklist

Table 7. Content Server installation and configuration checklist

Task

Resource

Value

Review the Content Server Release


Notes for the server release you are
installing.
Decide whether to install a small,
medium, or large repository.

Size of repository to create,


page 18

Decide whether to enable extended


services products, such as:

Extended service features to


license, page 22

Trusted Content Services


Content Services for EMC Centera
SnapLock
High-Volume Server
Content Storage Services
Retention Policy Services
Physical Records Manager
Review the Content Server-specific
information for the database.

Chapter 3, Preparing the


Database for Content Server
Installation.

For SQL Server, obtain the ODBC data


source name

Configuring an ODBC Data


Source for SQL Server, page
44and the database vendors
documentation

Determine the installation owner


username and password.

Setting up the installation owner


account, page 29 and consult
the database administrator.

installation owner
username:
__________
installation owner
password:
__________

Choose the repository name.

56

The name for a repository


can have up to 32 characters,
and must consist of letter,
numbers, or underscores (_).
The first character must be a
letter. Do not include spaces or
nonalphanumeric characters.
All letters and numbers in the
name must be ASCII characters.
The repository name "docu is
reserved by EMC Documentum.

repository name:
__________

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Pre-Installation Checklist

Task

Resource

Value

Choose the repository ID.

The repository ID can be any


number from 1 to 16777215 and
must not start with a zero (0).
Repository IDs must be unique
on the network.

repository ID:
__________

Obtain the repository owner name


(database user) and password.

Setting up user accounts, page


29

repository owner
name:
__________
repository password:
__________

Obtain the database administrator


name and password.

Database administrator
account, page 42 and the
database administrator

database administrator
name:
__________
database password:
__________

Create an estimate of the repository


size.

Size of repository to create,


page 18

If you assign the Content Server file


store to a shared folder on the network
with a UNC path, you need to meet the
criteria listed in the Value column.

repository size:
__________
Content Server and
the file store need
to be on the same
domain
The installation user
account of Content
Server needs to be
available on the
domain.
The installation user
account needs to
have full access
control for the
filestore.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

57

Pre-Installation Checklist

58

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 5
Installing Content Server software on a
UNIX or Linux host

This first part of the installation process copies files from the installation media to the correct
directories on the hard disk. After installing the software, you will follow the instructions in Chapter
7, Configuring Content Server and the repository on a UNIX or Linux host, to configure one or
more repositories.
Have all checklists from the previous chapters ready before you begin with the installation.
Note: Displaying the installer remotely across platforms is not supported.
Note: When installing Content Server on a Suse11 with Oracle 11.1 platform, the netegrity plugin
does not load. To resolve this issue, install the libstdc++-libc6.2-2.so.3 library on Suse11, then install
Content Server. The netegrity platform will then load properly.

To install Content Server


1.

Log in to the host system using the installation owner account.


Setting up the installation owner account, page 29 provides information about the installation
owner account.

2.

Download the Content Server software for your operating system and database.
You can find the location of the software and instructions for downloading it in the EMC
Documentum Content Server Enterprise Edition Release Notes or in the instructions you received
through email regarding how to download products from the EMC download site.

3.

Expand the compressed archive by typing:


% tar -xvf filename

4.

If you are running from a UNIX environment, ensure that you have execute permission on the
#####.bin file. You can verify this by running the chmod +x ###.bin command.

5.

Run the installation program from the directory into which you expanded the files, which must
be a directory on the local host by typing the following:
% serveroperatingsystemSuiteSetup.bin

operatingsystem is the operating system on which you are installing.


The installation program starts and a Welcome dialog box appears. The Welcome dialog box lists
the products and components that the program makes available for installation.
6.

Read the Welcome dialog box and click Next.


The software license agreement appears.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

59

Installing Content Server software on a UNIX or Linux host

7.

Read the license agreement.

8.

To continue with installation, click I accept the terms of the license agreement and click Next.
If you do not accept the license agreement terms, the Next button becomes unavailable, and you
cannot continue with the installation.

9.

Type the host name and port number for your existing primary connection broker. The default
port number is 1489. If you are using the default port number, ensure that the next port number
(1490) is available for use because the connection broker requires that two ports be reserved.
You can configure additional connection brokers by using the Content Server configuration
wizard.
Note: If you already have EMC Documentum software installed on the host, the installation
program will skip this step because you installed a connection broker with the previous
installation of the EMC Documentum software.

10. To enable Federated Search Services (FS2), select the check box.
If you choose not to enable FS2 services, leave the check box blank, and click Next.
If you choose to enable FS2, type the FS2 services host name and the FS2 services RMI port
number. The default port number is 3005. Click Next.
11. Type the password for the installation owner and click Next.
The dialog box shows the username and domain for the currently logged-in user. This user will
be the installation owner. When you click Next, the installation program validates the password.
12. To enable the High-Volume Server, select the check box, type the High-Volume Server license
key, and click Next.
13. To enable Trusted Content Services, select the check box, type the Trusted Content Services
license key, and click Next.
Note: Archive Services for Reports (ASR) does not work when Trusted Content Services is
enabled.
14. To enable Content Services for EMC Centera, select the check box, type the Content Services
for EMC Centera license key, and click Next.
15. To enable SnapLock, select the check box, type the SnapLock license key, and click Next.
16. To enable XML Store integration, select the check box, type the license key, and click Next.
If you choose not to enable XML Store integration, leave the check box blank and click Next.
17. You can install the DFC developer documentation.
a.

To install the DFC developer documentation, select the Developer Documentation check box.

b. Click Next.
Installing developer documentation requires an additional 18 MB.
18. Enter the connection information for the application server that Content Server installs for its
private use.
a.

60

Type the password for the administration user in the Admin User Password and Re-enter
Password fields. You will use this password and the username admin to access the
administration console for the application server. The password must be at least five
characters long, and it cannot contain double or single quotation marks (" or ).

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server software on a UNIX or Linux host

b. Type the port number to use as the primary port for communications between the application
server and Content Server. The default port is 9080. The selected port must not be used by
another application. A total of 20 ports starting at port number 9080 are reserved for this
application server instance, and all of them must be available.
c.

Click Next.

19. Type a password for managing Accelerated Content Services (ACS) configuration and properties
files.
Accelerated Content Services is a Content Server component used for exchanging content with
Web-based client applications. Use the username acsAdmin and the specified password to access
the components that are used for modifying Accelerated Content Services configuration settings.
a.

Type the password for the acsAdmin user in the Password and Confirm password fields.

b. Click Next.
A panel displays the software to be installed.
20. Click Next to begin the software installation.
The dialog box reports the progress of the installation. If any components already exist on the
host, click Yes or Yes to All to replace the older components.
21. Choose whether to run the dm_root task automatically or manually at a later time. For
instructions on how to run the dm_root task manually, see Running dm_root_task manually
on UNIX or Linux hosts, page 80.
22. Click Finish to exit the Content Server installation program.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

61

Installing Content Server software on a UNIX or Linux host

62

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 6
Installing Content Server software on a
Windows host

The first part of the installation process copies files from the installation media to the correct
directories on the hard disk. After installing the software, you will follow the instructions in Chapter
8, Configuring Content Server and the repository on a Windows host, to configure one or more
repositories.
On Windows, this procedure also sets environment variables needed by Content Server. On
Windows, if you exit the Setup part of the installation program, all Content Server registry entries
are deleted. To install a component that was not previously installed, go through the complete
Setup program.
Have all checklists from the previous chapters ready before you begin with the installation.
Note: Displaying the installer remotely across platforms is not supported.

To install Content Server:


1.

Log in to the host system using the installation owner account.


Setting up the installation owner account, page 29 provides information about the installation
owner account.

2.

Download the Content Server software for your operating system and database.
You can find the location of the software and instructions for downloading it in the EMC
Documentum Content Server Enterprise Edition Release Notes or in the instructions you received
through email regarding how to download products from the EMC download site.

3.

Expand the compressed archive by double-clicking the file.

4.

Run the installation program from the directory into which you expanded the files, which must
be a directory on the local host. Double-Click the serverWinSuiteSetup.exe file (for the 32bit
Windows version) or serverWin64SuiteSetup.exe (for the 64bit Windows version).
Note: When this document was published, the 64-bit version of Content Server was
not yet available (April, 2011). Check the Powerlink website for the latest information
(http://powerlink.emc.com).
The installation program starts and a Welcome dialog box appears. The Welcome dialog box lists
the products and components that the program makes available for installation.

5.

Read the Welcome dialog box and click Next.


The software license agreement appears.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

63

Installing Content Server software on a Windows host

6.

Read the license agreement.

7.

To continue with installation, click I accept the terms of the license agreement and click Next.
If you do not accept the license agreement terms, the Next button becomes unavailable, and you
cannot continue with the installation.

8.

If you are installing on a Windows host that has no other EMC Documentum software installed
on it, choose the installation directory for Content Server.
If you previously installed EMC Documentum software on the host, the relevant directories
might already be set. Skip to Step 16
Click Next to accept the default directory (C:\Documentum) where Content Server and data
installation or click Browse to select a different installation directory. The name of the directory
in which Content Server is installed must contain only ASCII characters and must not include
spaces. Do not use any of these characters in pathnames: ! \ / : * ? " < > | .

9.

You can install the DFC developer documentation.


a.

To install the DFC developer documentation, select the Developer Documentation check box.

b. Click Next.
10. If DFC is not already installed on the host, click Next to accept the default installation directory
(C:\Program Files\Documentum,) for shared programs such as DFC or click Browse to select
a different directory.
If DFC is already installed on the host, the Content Server installation program uses the existing
DFC installation directory.
11. Select a user directory. You can either accept the default user directory C:\Documentum and
click Next or click Browse to choose another directory.
EMC Documentum products use the user directory to store working files, program settings,
and log files.
12. Type the host name and port number for your existing primary connection broker. The default
port number is 1489. If you are using the default port number, ensure that the next port number
(1490) is available for use because the connection broker requires that two port numbers be
reserved.
You can configure additional connection brokers by using the Content Server configuration
wizard.
Note: If you already have EMC Documentum software installed on the host, the installation
program will skip this step because you installed a connection broker with the previous
installation of the EMC Documentum software.
13. To enable Federated Search Services (FS2), select the check box.
If you choose not to enable FS2 services, leave the check box blank, and click Next.
If you choose to enable FS2, type the FS2 services host name and the FS2 services RMI port
number. The default port number is 3005. Click Next.
14. Type the password for the installation owner and click Next.
The dialog box shows the username and domain for the currently logged-in user. This user will
be the installation owner. When you click Next, the installation program validates the password.
15. To enable the High-Volume Server, select the check box, type the High-Volume Server license
key, and click Next.

64

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server software on a Windows host

Note: If you opt to enable the High-Volume Server at a later time, you need to rerun the Content
Server installation program.
16. To enable Trusted Content Services, select the check box, type the Trusted Content Services
license key, and click Next.
17. To enable Content Services for EMC Centera, select the check box, type the Content Services
for EMC Centera license key, and click Next.
18. To enable XML Store integration, select the check box, type the license key, and click Next.
If you choose not to enable XML Store integration, leave the check box blank and click Next.
19. To enable SnapLock, select the check box, type the SnapLock license key, and click Next.
20. Enter the connection information for the application server that Content Server installs for its
private use.
a.

Type the password for the administration user in the Admin User Password and Re-enter
Password fields. You will use this password and the username admin to access the
administration console for the application server. The password must be at least five
characters long, and it cannot contain double or single quotation marks (" or ).

b. Type the port number to use as the primary port for communications between the application
server and Content Server. The default port is 9080. The selected port must not be used by
another application. A total of 20 ports starting at port number 9080 are reserved for this
application server instance, and all of them must be available.
c.

Click Next.

21. Type a password for managing Accelerated Content Services (ACS) configuration and properties
files.
Accelerated Content Services is a Content Server component used for exchanging content with
Web-based client applications. Use the username acsAdmin and the specified password to access
the components that are used for modifying Accelerated Content Services configuration settings.
a.

Type the password for the acsAdmin user in the Password and Confirm password fields.

b. Click Next.
A panel displays the software to be installed.
22. Click Next to begin the software installation.
The dialog box reports the progress of the installation. If any components already exist on the
host, click Yes or Yes to All to replace the older components.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

65

Installing Content Server software on a Windows host

23. Choose whether to continue to Content Server configuration.


To configure Content Server and repositories immediately, click Configure server for new
repository or upgrade existing repository and click Next. The installation program launches
the Server Configuration program. Chapter 8, Configuring Content Server and the repository
on a Windows host contains the procedures for configuring Content Server and the repository.
To configure Content Server at another time, click Configure server later and click Next.
Note: If you use Kerberos for authentication, you must choose to configure Content Server later
and enable the Kerberos plugin before you configure Content Server. Refer to EMC Documentum
Kerberos SSO AuthenticationA Detailed Review for details on how to do that.
24. Click Finish to exit the Content Server installation program.

66

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 7
Configuring Content Server and the
repository on a UNIX or Linux host

This chapter provides instructions for configuring a Content Server repository on a UNIX or Linux
host. Perform this part of the installation after you install the software as described in Chapter 5,
Installing Content Server software on a UNIX or Linux host.

To configure Content Server and the repository:


1.

Start the Content Server configuration program by typing these commands:


% cd $DM_HOME/install
% "./dm_launch_server_config_program.sh

The Welcome dialog box appears.


2.

Click Next.

3.

Choose whether to run the dm_root task automatically or manually later. See Running the
administrative tool script manually, page 80 for details.

4.

Type the password for the installation owner and click Next.
The dialog box shows the username and domain for the currently logged-in user, who must be
the installation owner. When you click Next, the installation program validates the password.

5.

Select whether to perform an Express configuration or a Custom configuration and click Next.
If you select Express, the configuration program creates a new connection broker using a
default name and port number, and uses default values for certain repository configuration
settings. Skip to Step 13
If you select Custom, the configuration program enables you to edit the configuration values
used to create one or more connection brokers, a repository, or both.

6.

On SQL or Oracle databases, when you configure a repository, optionally select the check box to
enable database partitioning. By default, database partitioning is disabled.
If you select this option, the repository that you create is partitioned, but only one partition
exists. To take advantage of data partitioning and create multiple partitions, you must have a
High-Volume Server license.

7.

Choose whether to configure a connection broker, a repository, or both, and click Next.
If you checked connection broker, the connection broker configuration appears.
If you checked repository but not connection broker, the repository configuration appears.
Skip to Step 13 .

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

67

Configuring Content Server and the repository on a UNIX or Linux host

8.

Configure a connection broker on the Content Server host.


a.

Choose Create a new connection broker and click Next.

b. Type a connection broker name (default: Docbroker) and the port number on which the
connection broker listens, or accept the defaults. The default port is 1489. If you are using
the default port number, ensure that the next port (1490) is available for use because the
connection broker requires that two ports be reserved.
c.
9.

Click Automatic to have the connection broker automatically start when the host starts, or
click Manual for manual startup.

Select the mode in which the connection broker connects to the repository.
Select Native for nonsecure connections.
Select Secure for secure connections.
Select Native and Secure if clients can use either connection mode.

10. Click Next. The connection broker is started.


11. To configure additional connection brokers on this host, select Configure an additional
connection broker and click Next. Repeat these steps, making sure to provide each connection
broker with a unique port number that is not used by another application.
To continue with the server configuration, select the Continue with server configuration check
box and click Next.
12. For custom configuration only, select Create a repository and click Next.
13. Choose whether to Create a new repository, Upgrade an existing repository, or Delete an
existing repository. Click Next.
Note: During repository configuration, if the administrative tool script does not run properly
and you see an error message, you can run it manually by using the procedure in Running the
administrative tool script manually, page 80.
14. To enable Content Storage Services, select the check box, type the license key, and click Next.
15. To enable Retention Policy Services, select the check box, type the license key, and click Next.
16. To enable Federated Records Services, select the check box, type the license key, and click Next.
17. To enable Records Manager, select the check box, type the license, and click Next.
18. To enable Physical Records Manager, select the check box, type the license, and click Next.
19. Click Next to accept the default data directory location or browse for a different location.
20. Click Next to accept the default share directory location or type a new location.
The share directory is where client products, sample code, and libraries are stored.
Note: The share directory is not the same as the $DOCUMENTUM_SHARED environment
variable. This environment variable sets the directory into which EMC Documentum Foundation
Classes and other components are installed.
21. To enable data partitioning, select the check box and click Next.
22. Provide the repository information.
a.

68

Type the name of the repository. Name and ID to assign to the repository, page 19 contains
information about repository name requirements.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Configuring Content Server and the repository on a UNIX or Linux host

b. Type the repository ID.


c.

Type a description for the repository.

d. Select the repository size.


e.

Select the authentication domain.

f.

Click Next.

g. Type the service name. The service name must match the entry in the /etc/services file.
23. Click Next.
24. Select whether to create a new database user account and storage areas or use an existing user
account and storage, and click Next. If you use an existing database user account, be sure that
you have previously created a database user account.
Username Content Server will use to connect to the database, page 18 contains information about
this configuration option. The database user is the repository owner.
25. If you chose to use an existing database account and tablespaces or databases, provide the
database connection information.
a.

Choose the correct database connection for your database instance from the drop-down list:
On Oracle, select the connection string.
On DB2, select the database name.
On Sybase, select the database name.

b. Type the username for an existing database user. This user becomes the repository owner,
and must have the privileges identified in Repository owner account, page 41.
c.

Type the database users password.

d. Type the database administrator name.


e.

Type the database administrator password.

f.

Click Next.

g. For Custom configuration only, choose the correct index tablespace or datafile name. Express
configuration uses default values.
h. Click Next.
Content Server starts.
26. If you chose to create a new database user account, provide database connection information.
a.

Choose the correct database connection for your database instance from the drop-down list:
On Oracle, select the connection string.
On DB2, select the database name.
On Sybase, select the database name.

b. Type the database users name.


This user becomes the repository owner, and must have the privileges identified in
Repository owner account, page 41.
c.

Type the database users password and confirm the password.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

69

Configuring Content Server and the repository on a UNIX or Linux host

d. Type the database administrators username and password that was created when setting
up the database.
e.

Click Next.

f.

In a custom installation, you are prompted to either accept or change the default paths and
sizes for database storage. In an express installation the software automatically applies
the default values.
On Oracle, these are the Data Tablespace Data File Path and Index Tablespace Data File
Path.
On SQL Server, these are the Data Device File Path and Log Device File Path.
On Sybase, these are the Data Device File Path and Log Device File Path.
On DB2, these are the Tablespace File Path and Index Data File Path.
The tablespace or database creation dialog box appears.

g. Click Next.
h. For custom configuration only, edit or accept the default database scripts. Express
configuration runs the default scripts.
To edit the tablespace or database creation or deletion script, select the script and click
Edit. When you have saved the file, click Next.
To accept the default scripts and run them, click Next.
The new tablespaces or databases are created.
27. For custom configuration only, accept or modify Content Server initialization values. Express
configuration uses the default initialization file.
The server.ini file contains Content Server initialization information. If you are installing on
DB2 or Oracle and you want to modify the database parameters for the repository tables, edit
the server.ini file during this step. You cannot change these parameters after Content Server
creates the database tables for the repository. Appendix E, Defining Oracle or DB2 Database
Parameters for Repository Tables contains descriptions of the DB2 and Oracle parameters for
repository tables.
To accept the files, click Next.
To edit the server.ini file, select Server Initialization File and click Edit. After you save the
file, click Next.
28. Optionally, you can edit a tablespace script by clicking Edit.
29. Optionally, you can edit an initialization file by clicking Edit.
Caution: Errors in the server.ini file can cause problems with Content Server startup.
30. Click Next.
The configuration program runs the repository configuration scripts based on the settings you
provided.
31. If you dont already have a designated global registry, decide here whether to designate the
current repository as a global registry.

70

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Configuring Content Server and the repository on a UNIX or Linux host

Repository to use as the global registry, page 23 contains details on determining which repository
to designate as the global registry.
To use the current repository as a global registry, select Use this Repository and click Next.
To use a different repository as the global registry repository, select Specify a Different
Repository and click Next
To designate the global registry repository at a different time, select Do Later and click Next.
32. Type the connection information for the global registry.
If you chose the current repository as a global registry, type a username and password for the
global registry user and click Next. The default username is dm_bof_registry. The password
you supply is also used as the initial password for dm_report_user. Record this password to
use later for usage tracking.
Click Next.
If you chose to use a different repository as a global registry, type the repository name and
the global registry users username and password. The repository must be known to the
connection broker.
If you chose Do Later, the global registry connection page does not appear.
A warning message to enable the global registry connection appears. Click CONTINUE.
33. For custom configuration only, accept or modify the repository configuration scripts. Express
configuration runs the scripts without modification.
Appendix B, Content Server Installation Directories and Repository Configuration Scripts
contains information on what each of the scripts does.
To accept the scripts, click Next.
To edit a script, select it and click Edit. After you edit and save all the scripts you are
modifying, click Next.
Caution: Use caution in editing the scripts. Errors in the scripts can cause problems in
the repository.
When you click Next, the repository configuration scripts run, and the bundled DARs are also
installed. A message appears when these tasks are completed.
Note: For more information about DAR files, consult the EMC Documentum Composer User
Guide. If the DAR installation fails, you can still use the repository. Refer to the installation
logs for details.
34. Click Next.
35. Choose whether to restart Content Server to enable SSL client connections.
To enable SSL client connections, click Restart repository now and click Next.
Content Server stops and is restarted.
To restart Content Server at a different time, click Restart repository later and click Next.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

71

Configuring Content Server and the repository on a UNIX or Linux host

36. For custom configuration only, choose whether to configure additional repositories on the host.
Express configuration skips to the next step.
To configure additional repositories, select the check box and click Next. The configuration
program returns to Step 13.
To continue, select Exit from the Content Server configuration, and click Next.
A summary appears with information about the products configured on the host.
37. Click Finish.
38. On AIX, restart Content Server.
This loads required full-text plugins.
The xPlore Installation Guide provides instructions on how to install the full-text indexing software.

72

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 8
Configuring Content Server and the
repository on a Windows host

This chapter provides instructions for configuring Content Server and a repository on a Windows
host. Perform this part of the installation after you install the software as described in Chapter 6,
Installing Content Server software on a Windows host.

To configure Content Server and the repository:


1.

Start the Content Server configuration program.


You can start the configuration program directly from the Content Server installation program, or
you can start it from the operating system:
Log in to Windows as the installation owner, navigate to the %DM_HOME%\install directory,
and launch Server_Configuration_Program.exe.
The Welcome dialog box appears.

2.

Click Next.

3.

Type the password for the installation owner and click Next.
The dialog box shows the username and domain for the currently logged-in user, who must be
the installation owner. When you click Next, the installation program validates the password.

4.

Select whether to perform an Express configuration or a Custom configuration and click Next.
If you select Express, the configuration program creates a new connection broker using a
default name and port number, and uses default values for certain repository configuration
settings. Skip to Step 8.
If you select Custom, the configuration program enables you to edit the configuration values
used to create one or more connection brokers, a repository, or both.

5.

On SQL or Oracle databases, when you configure a repository, optionally select the check box to
enable database partitioning. By default, database partitioning is disabled.
If you select this option, the repository that you create is partitioned, but only one partition
exists. To take advantage of data partitioning and create multiple partitions, you must have a
High-Volume Server license.

6.

Choose whether to configure a connection broker, a repository, or both, and click Next.
If you checked connection broker, the connection broker configuration appears.
If you checked repository but not connection broker, the repository configuration appears.
Skip to Step 13 .

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

73

Configuring Content Server and the repository on a Windows host

7.

Configure a connection broker on the Content Server host.


a.

Choose Create a new connection broker and click Next.

b. Type a connection broker name (default: Docbroker) and the port number on which the
connection broker listens, or accept the defaults. The default port is 1489. If you are using the
default port number, ensure that the next port number (1490) is available for use because
the connection broker requires that two ports be reserved.
c.
8.

Click Automatic to have the connection broker automatically start when the host starts, or
click Manual for manual startup.

Select the mode in which the connection broker connects to the repository.
Select Native for nonsecure connections.
Select Secure for secure connections.
Select Native and Secure if clients can use either connection mode.

9.

Click Next. The connection broker is started.

10. To configure additional connection brokers on this host, select Configure an additional
connection broker and click Next. Repeat these steps, making sure to provide each connection
broker with a unique port number that is not used by another application.
To continue with the server configuration, select the Continue with server configuration check
box and click Next.
11. For custom configuration only, select Create a repository and click Next.
12. Choose whether to Create a new repository, Upgrade an existing repository, or Delete an
existing repository. Click Next.
Note: During repository configuration, if the administrative tool script does not run properly
and you see an error message, you can run it manually by using the procedure in Running the
administrative tool script manually, page 80.
13. Configure a repository.
14. To enable Content Storage Services, select the check box, type the license key, and click Next.
15. To enable Retention Policy Services, select the check box, type the license key, and click Next.
16. To enable Federated Records Services, select the check box, type the license key, and click Next.
17. To enable Records Manager, select the check box, type the license, and click Next.
18. To enable Physical Records Manager, select the check box, type the license, and click Next.
19. To enable data partitioning, select the check box and click Next.
20. Click Next to accept the default fully qualified domain name.
21. Provide the repository information.
a.

Type the name of the repository. Name and ID to assign to the repository, page 19 contains
information about repository name requirements.

b. Type the repository ID.


c.

Type a description for the repository.

d. Select the repository size.

74

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Configuring Content Server and the repository on a Windows host

e.

Select the authentication domain.

f.

Indicate whether Content server starts automatically or manually. Check Automatic to


start Content Server automatically when the host starts or Manual to start Content Server
manually.

g. Click Next.
22. Select the mode in which clients connects to the repository.
Select Native for nonsecure connections.
Select Secure for secure connections.
Select Native and Secure if clients can use either connection mode.
23. Select whether to create a new database user account and storage areas or use an existing
database user account and storage, and click Next. If you choose the option to use an existing
database user account, you must have created a database user account previously.
Username Content Server will use to connect to the database, page 18 contains information about
this configuration option. The database user is the repository owner.
24. If you chose to use an existing database account and tablespaces or databases, provide the
database connection information.
a.

Choose the correct database connection for your database instance from the drop-down list:
On Oracle, select the connection string.
On SQL Server, select an ODBC data source.
On DB2, select the database name.
On Sybase, select the database name.

b. Type the username for an existing database user. This user becomes the repository owner,
and must have the privileges identified in Repository owner account, page 41.
c.

Type the database users password.

d. Type the database administrator name.


e.

Type the database administrator password.

f.

Click Next.

g. For Custom configuration only, choose the correct index tablespace or datafile name. Express
configuration uses default values.
h. Click Next.
Content Server starts.
25. If you chose to create a new database user account, provide database connection information.
a.

Choose the correct database connection for your database instance from the drop-down list:
On Oracle, select the connection string.
On SQL Server, select an ODBC data source.
On DB2, select the database name.
On Sybase, select the database name.

b. Type the database users name.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

75

Configuring Content Server and the repository on a Windows host

This user becomes the repository owner, and must have the privileges identified in
Repository owner account, page 41.
c.

Type the database users password and confirm the password.

d. Type the database administrators username and password that was created when setting
up the database.
e.

Click Next.

f.

In a custom installation, you are prompted to either accept or change the default paths and
sizes for database storage. In an express installation the software automatically applies
the default values.
On Oracle, these are the Data Tablespace Data File Path and Index Tablespace Data File
Path.
On SQL Server, these are the Data Device File Path and Log Device File Path.
On Sybase, these are the Data Device File Path and Log Device File Path.
On DB2, these are the Tablespace File Path and Index Data File Path.
The tablespace or database creation dialog box appears.

g. Click Next.
h. For custom configuration only, edit or accept the default database scripts. Express
configuration runs the default scripts.
To edit the tablespace or database creation or deletion script, select the script and click
Edit. When you have saved the file, click Next.
To accept the default scripts and run them, click Next.
The new tablespaces or databases are created.
26. For custom configuration only, accept or modify Content Server initialization values. Express
configuration uses the default initialization file.
The server.ini file contains Content Server initialization information. If you are installing on
DB2 or Oracle and you want to modify the database parameters for the repository tables, edit
the server.ini file during this step. You cannot change these parameters after Content Server
creates the database tables for the repository. Appendix E, Defining Oracle or DB2 Database
Parameters for Repository Tables contains descriptions of the DB2 and Oracle parameters for
repository tables.
To accept the files, click Next.
To edit the server.ini file, select Server Initialization File and click Edit. After you save the
file, click Next.
27. Click Next.
The installation program runs the repository configuration scripts based on the settings you
provided.
28. Configure the data files or data devices
a.

Type the data tablespace data file path.

b. Type the file size.


c.

76

Type the tablespace data file path.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Configuring Content Server and the repository on a Windows host

d. Type the file size.


29. Optionally, you can edit a tablespace script by clicking Edit.
30. Optionally, you can edit an initialization file by clicking Edit.
Caution: Errors in the server.ini file can cause problems with Content Server startup.
31. Provide the SMTP server information. The SMTP server is used to send email notifications to
the installation owner and repository users.
a.

Type the name or IP address of a computer on the network that hosts an SMTP server.
The computer can be a remote host or the computer that hosts Content Server. All UNIX
operating systems and Windows 2000 Server include an SMTP server.

b. Type the installation owners email address.


c.

Click Next.

32. Decide whether to designate the current repository as a global registry.


Repository to use as the global registry, page 23 contains details on determining which repository
to designate as the global registry.
To use the current repository as a global registry, select Use this Repository and click Next.
To use a different repository as the global registry repository, select Specify a Different
Repository and click Next
To designate the global registry repository at a different time, select Do Later and click Next.
33. Type the connection information for the global registry.
If you chose the current repository as a global registry, type a username and password for the
global registry user and click Next. The default username is dm_bof_registry. The password
you supply is also used as the initial password for dm_report_user. Record this password to
use later for usage tracking.
Click Next.
If you chose to use a different repository as a global registry, type the repository name and
the global registry users username and password. The repository must be known to the
connection broker.
If you chose Do Later, the global registry connection page does not appear.
A warning message to enable the global registry connection appears. Click CONTINUE.
34. For custom configuration only, accept or modify the repository configuration scripts. Express
configuration runs the scripts without modification.
Appendix B, Content Server Installation Directories and Repository Configuration Scripts
contains information on what each of the scripts does.
To accept the scripts, click Next.
To edit a script, select it and click Edit. After you edit and save all the scripts you are
modifying, click Next.
Caution: Use caution in editing the scripts. Errors in the scripts can cause problems in
the repository.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

77

Configuring Content Server and the repository on a Windows host

When you click Next, the repository configuration scripts run, and the bundled DARs are also
installed. A message appears when these tasks are completed.
35. Specify the port that the XML Store should use and the directory where the XML
Store should be created. The default port is 1235 and the default directory is
$DOCUMENTUM\data\xhive_storage.
36. Choose whether to restart Content Server to enable SSL client connections.
To enable SSL client connections, click Restart repository now and click Next.
Content Server stops and is restarted.
To restart Content Server at a different time, click Restart repository later and click Next.
37. For custom configuration only, choose whether to configure additional repositories on the host.
Express configuration skips to the next step.
To configure additional repositories, select the check box and click Next. The configuration
program returns to Step 13.
To continue, select Exit from the Content Server configuration, and click Next.
A summary appears with information about the products configured on the host.
38. Click Finish.
The xPlore Installation Guide provides instructions on how to install the full-text indexing software.

78

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 9
Completing the Installation

This chapter describes required and optional tasks to perform after installing Content Server so
that users can begin working with a repository.
This chapter contains the following sections:
Reviewing the Content Server installation logs, page 79
Running dm_root_task manually on UNIX or Linux hosts, page 80
Running the administrative tool script manually, page 80
Changing the default passphrase, page 81
Binding Content Server to a network card, page 81
Configuring JBoss application servers for SSL, page 82
Changing the installation owner account, page 82
Backing up key store files, page 83
Starting Content Server repositories and connection brokers, page 83
Adding users and groups to a repository, page 84
Enabling jobs after installation, page 84
Creating additional repositories or connection brokers, page 84

Reviewing the Content Server installation logs


The Content Server installer and configuration program both create log files. The log files may
be stored in one of the following directories:
The current working directory.
For the installation program, the current working directory is the directory from which you
started the program. For the configuration program, the current working directory is typically
$DM_HOME/install (UNIX) or %DM_HOME%\install (Windows).
The parent directory of the installation directory, if the installation owner does not have write
permission on the current working directory.
The users home directory, if the installation owner does not have write permission on the parent
directory.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

79

Completing the Installation

The log filenames are install.log and installation_owner_username.ServerConfigurator.log.


Each script that runs during repository configuration creates a log file. These are stored in the
$DOCUMENTUM/dba/config/repository_name directory.
Content Server stores other log files in the $DOCUMENTUM/dba/log directory. After you install or
upgrade Content Server, examine the log file for the repository for error reports. The log is called
repository_name.log.save.date.time. repository_name is the name of the repository you created or
upgraded, and date and time are the date and time the log was saved.
Another log file is $DM_HOME/install/SetupError.log, which contains information on the operating
system environment, the Content Server version, Java environment, and hardware.

Running dm_root_task manually on UNIX or


Linux hosts
The Content Server installation program offers the option to run the dm_root_task script
automatically. If you chose not to have the installation program run it or if dm_root_task
does not run correctly during Content Server installation, the file permissions are incorrect on
the dm_check_password and dm_change_password programs, which are required for user
authentication. You can run the dm_root_task script manually.

To run the dm_root_task manually:


1.

Log in as the root user.

2.

Navigate to the $DOCUMENTUM/dba directory.

3.

Run the task:


dm_root_task

The script runs.


4.

Type the name of the administrators group and press return.


The permissions on the files are changed.

Running the administrative tool script manually


During Content Server installation, if you opt not to run the tool script automatically or if the
administrative tool script does not run properly and you see an error message, you can run it
manually by using the following steps.

To complete the installation and run the administrative tool script:


1.

Click OK to close the error message.

2.

On the dialog box, clear the Run Script Again box and click Next.

3.

Complete the installation.

80

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Completing the Installation

4.

Type the following command:


For Windows:
ddmbasic -f %DM_HOME%\install\admin\toolset.ebs -P repository_name
%DM_HOME%\install\admin database_connection_string -e ToolSetup

For UNIX
dmbasic -f $DM_HOME/install/admin/toolset.ebs -P repository_name
$DM_HOME/install/admin database_connection_string -e ToolSetup

Windows example for repository TestA:


dmbasic -f %DM_HOME%\install\admin\toolset.ebs -P TestArepository
%DM_HOME%\install\admin connect1.documentum.com -e ToolSetup

UNIX example for repository TestA:


dmbasic -f $DM_HOME/install/admin/toolset.ebs -P TestArepository
$DM_HOME/install/admin connect1.documentum.com -e ToolSetup

Changing the default passphrase


During Content Server installation, a key store is created that contains a passphrase that is used for
encryption. After installation, change the default passphrase to a custom passphrase. If you create a
custom passphrase after Content Server installation, any time you restart the server host you need to
run the dm_crypto_boot utility. The EMC Documentum Content Server Administration and Configuration
Guide provides instructions and more details on encryption, key stores, and passphrases.

Binding Content Server to a network card


To configure Content Server to use a different network card, create an initialization file for the
connection broker. The file must include a [DOCBROKER_CONFIGURATION] section to identify the
IP address of the network card. Use the following format:
[DOCBROKER_CONFIGURATION]
host=IP_address_string
service=service_name
port=port_number

IP_address_string is the IP address of the network card.


The service name is the connection brokers service name, defined in the hosts services file. The
port number is the port defined in the service.
If you include a service name, the connection broker starts by using that service.
If you include a port number, the connection broker starts by using that port.
If you do not include a service name or a port number, the connection broker uses the default port
number 1489. If you are using the default port number, ensure that the next port number (1490) is
available for use because the connection broker requires that two ports be reserved.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

81

Completing the Installation

For more details about binding Content Server to a network card, see the EMC Documentum
Administrator User Guide, Appendix C.

Configuring JBoss application servers for SSL


Content Server supports the Hypertext Transfer Protocol (HTTP) and the Hypertext Transfer Protocol
over Secure Socket Layer (HTTPS). The default protocol is HTTP, but you can configure servers
bundled with JBoss application servers for HTTPS. You can configure JBoss servers by editing the
servers configuration file. In addition, you have to configure ACS base URL using Documentum
Administrator. For information on how to configure JBoss servers using Documentum Administrator
refer to EMC Documentum Administrator User Guide.

To configure JBoss application servers for SSL:


1.

Make the Java key store that was created for the server available on the Content Server host.

2.

Open the JBoss server configuration file. The default location of the configuration file
is \Documentum\jboss4.2.0\server\DctmServer_MethodServer\deploy\jboss-web.
deployer\server.xml.

3.

Replace the following configuration:

<Connector port="10080" protocol="HTTP/1.1" SSLEnabled="false"


maxThreads="150" scheme="https" secure="true"
keystoreFile="${jboss.server.home.dir}/conf/
my.keystore" keystorePass="changeit"
clientAuth="false" sslProtocol="TLS" />

with the following configuration:


<Connector port="<your HTTPS port of choice>"
protocol="HTTP/1.1" SSLEnabled="true"
maxThreads="150" scheme="https" secure="true"
keystoreFile="<full path to Java keystore>"
keystorePass=<keystore password>"
clientAuth="false" sslProtocol="TLS" />

4.

Restart the application server.

Changing the installation owner account


Changing the installation owner account is not supported in Content Server. Although a procedure
outlining steps to perform such change was provided in earlier releases, many components of the
product have since changed, thus rendering this procedure incomplete. Consult with the EMC
Professional Services group if you are interested in implementing this functionality.

82

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Completing the Installation

Backing up key store files


After you install the Content Server and repository, back up the key store files, which are all the files
in the directory $DOCUMENTUM/dba/secure.
Take special care to back up and save the aek.key file in that directory. If the key becomes corrupted
and you do not have a backup, your repository cannot be started, and you cannot access encrypted
files.

Starting Content Server repositories and


connection brokers
On Windows systems, you start and stop repositories and connection brokers from the Server
Manager tool. You can also launch the Content Server configuration program from Server Manager
and use it to create additional repositories or connection brokers, or to modify the existing
repositories. Creating additional repositories or connection brokers, page 84 contains details.
Note: If you create a custom passphrase after Content Server installation, run the dm_crypto_boot
utility any time you restart the server host. The EMC Documentum Content Server Administration and
Configuration Guide contains details on the dm_crypto_boot utility.

To start Content Server repositories and the connection broker on Windows hosts:
1.

From Microsoft Windows, select Start > All Programs > Documentum > Documentum Server
Manager.
The Server Manager tool appears.

2.

Select the tab for starting the connection broker (labeled DocBroker) or repository.

3.

Highlight the name of the broker or repository to start.

4.

Click Start.

5.

Start the application server service.


a.

Click Start > All Programs > Administrative Tools > Services.

b. On the Services dialog box, scroll to Documentum Java Method Server.


c.

Right-click Documentum Java Method Server method server.

d. Click Start.
e.

Close the Services dialog box.

To start Content Server and the connection broker on UNIX or Linux hosts:
1.

Navigate to the $DOCUMENTUM/dba directory.

2.

Start the connection broker by running the $Documentum/dba/dm_launch/docbrokerName script,


where docBrokername is the name of the connection broker.

3.

Run the script dm_start_serverconfigname script, where serverconfigname is the object name of the
Content Servers server config object.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

83

Completing the Installation

4.

Start the application server.


a.

Navigate to the $DOCUMENTUM_SHARED/jboss4.2.0/domains/DctmDomain directory.

b. Run the startMethodServer.sh script.

Adding users and groups to a repository


When a repository is created, it contains accounts for the repository owner, installation owner,
and several users required for Content Server functionality, but no other users and no groups. The
installation owner must add users and groups to the repository. You can add users and groups
with Documentum Administrator. The online help for Documentum Administrator and the EMC
Documentum Content Server Administration and Configuration Guide contain information on creating
users and groups.

Enabling jobs after installation


Jobs are automated tools for performing repository maintenance tasks. When the repository is
installed, many jobs are in the inactive state and do not run until the state is changed to active.
After you install the repository, review the EMC Documentum Content Server Administration and
Configuration Guide, Documentum Administrator online Help, and active jobs.

Enabling the purge audit job


The purge audit job deletes old audit trail objects from the repository. The job runs as the installation
owner. However, when a repository is created, the installation owner is not granted sufficient
extended privileges to run the job.
After you create a repository, create a new user with superuser privileges, connect as that user, and
grant the installation owner account Purge Audit extended privileges.

Creating additional repositories or connection


brokers
To create additional repositories or connection brokers in a Content Server installation, do one of the
following:

84

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Completing the Installation

1.

On Windows, do the following:


Start the Documentum Server Manager by selecting Start > All Programs > Documentum
> Documentum Server Manager.
On the Utilities tab, click Server Configuration Program.
Use the instructions in the Content Server configuration sections, to create new repositories or
connection brokers.

2.

On UNIX or Linux, do the following:


Start the Content Server configuration program.
Use the instructions in the Content Server configuration sections, to create new repositories or
connection brokers.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

85

Completing the Installation

86

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 10
Upgrading Content Server

This chapter describes how to upgrade from a previous release and how to upgrade repositories to
Content Server version 6.7. The System Upgrade and Migration Guide contains additional information
on migrating the installation from a previous version to Content Server version 6.7. The System
Upgrade and Migration Guide and the EMC Documentum Content Server Enterprise Edition Release Notes
provide information about supported upgrade paths.
You cannot upgrade to Content Server Version 6.7 from a version earlier than 5.3 SP6. If your
current installation is an earlier version, you will have to upgrade it to 5.3 SP6 or later before you
upgrade to version 6.7.
This chapter contains the following topics:
Upgrade checklist, page 87
Upgrading the Content Server software, page 94
Each step in the upgrade process must be to a platform that is fully supported by EMC Documentum.
Depending on the Content Server release from which you are upgrading, you might need to upgrade
the operating system or database. The documentation provided by the operating system or database
vendor contains information on upgrading those components of the system. After each upgrade step,
test the repository to ensure that all functions are normal.
Note: Windows Server 2003 is not a supported environment for Content Server version 6.7. You must
upgrade your operating system to a supported environment before upgrading Content Server.
Caution: After upgrading, you cannot revert to previous versions of the Content Server.

Upgrade checklist
Use the following checklist for upgrading the Content Server. In the Value column, note any values
you will be prompted for during the upgrade procedure.
Table 8. Content Server upgrade checklist

Task

Resource

Review the EMC Documentum


Content Server Enterprise Edition
Release Notes

EMC Documentum Content


Server Enterprise Edition Release
Notes

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Value

87

Upgrading Content Server

Task

Resource

Review the System Upgrade and


Migration Guide.

System Upgrade and Migration


Guide.

Value

Review Chapter 3, Preparing


the Database for Content
Server Installation, especially
if you use Oracle. There are
some changes to how we link
to Oracle databases in 6.7
detailed in the section, Oracle
requirements, page 42.
If you are installing the xPlore
indexing server, review the
xPlore Installation Guide. If
you wish to enable the FAST
indexing server, which will not
be supported after 2011, refer to
chapter, Chapter 11, Enabling
FAST with Content Server 6.7.

xPlore Installation Guide

Review the section on what


sequence to use in upgrading
your installation, especially if
you are upgrading from a 32bit
to a 64bit Content Server.

Upgrading sequence
considerations, page 91

Back up the repository.

EMC Documentum
Administration and Configuration
Guide

Decide whether to enable


extended services, such as:

Extended service features to


license, page 22

Retention Policy Services


Trusted Content Services
Content Services for EMC
Centera
Content Storage Services
Physical Records Manager

88

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

Task

Resource

Temporarily increase the


amount of rollback space
available in the RDBMS.

Database documentation

Value

The number of rollback


segments should be
commensurate with the size of
the repository and should be in
segments of equal size.
Ensure that you have sufficient
disk space on the computer
hosting the database.
Run the repository consistency
checker script and correct any
errors you find.

EMC Documentum
Administrator User Guide
and Chapter 10, Upgrading
Content Server

Ensure that the


dm_server_config object is
unlocked.

Ensuring that the


dm_server_config object is
unlocked, page 93

Shut down the repository and


all servers running against the
repository.

EMC Documentum
Administration and Configuration
Guide

Shut down any local connection


brokers.

EMC Documentum
Administration and Configuration
Guide

On UNIX and Linux, create the


new installation directory for
the upgraded installation under
the $DOCUMENTUM/product
directory (the new
$DM_HOME directory).

Preparing UNIX and Linux


hosts, page 31

On UNIX and Linux, modify


the DM_HOME variable in
the installation owners .cshrc
or .profile file to point to
$DOCUMENTUM/product/
version_number.

Preparing UNIX and Linux


hosts, page 31

On UNIX and Linux, modify


the library path variable in
the installation owners .cshrc
or .profile file to point to the
location of the shared libraries
required by the server.

Preparing UNIX and Linux


hosts, page 31

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

89

Upgrading Content Server

Task

Resource

Value

Determine the installation


owner username and password

Setting up the installation


owner account, page 29,
and consult the database
administrator.

installation owner username:


__________

On UNIX and Linux, determine


the root password

UNIX and Linux


documentation

installation owner password:


__________
root password:
__________

This is the operating system root


password. The root password
is required to complete the
upgrade.
Determine the names of the
repositories you are upgrading.

repository name:
__________
Content Server version:
__________

Determine the Content Server


version from which you are
upgrading.
If you are upgrading from 5.3
SP6, ensure that one of the
repositories is designated as a
global registry.

Upgrading from 5.3 SP6, page


92

If you are upgrading from 5.3


SP6, create index entries.

Missing database indexes on


repository upgrades from
version 5.3, page 101

Migrating the database to UTF8


If the database was installed with a code page other than UTF-8 under a previous Content Server
version, you do not have to migrate the database to UTF-8 to upgrade the Content Server version.
However, to use Content Servers multilingual functions, you need to migrate the database to UTF-8.
EMC Documentum supports upgrading repositories by using the existing database code page.
On Oracle and Sybase, you can migrate existing repositories to Unicode using the tools supplied
by Oracle and Sybase. Contact Oracle or Sybase for any support you require in migrating the
database.
On DB2, all repositories should have been created by using Unicode. They do not need to be
migrated. If the DB2 repository does not use Unicode, migrate the database by using IBM tools.
Contact IBM for any support you require.
On SQL Server, you cannot migrate the database to Unicode.

90

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

The database_refresh_interval key


During Content Server installation or upgrade, the change checker process runs once per minute by
default. The process updates type caches as types are created or altered. Before you upgrade, ensure
that the key is set to 1 minute or delete it from the server.ini file.

Completing workflows before an upgrade


Before you shut down the repository for the upgrade, make sure that all workflows have completed
and do not submit any new workflows. To ensure that all workflows are completed, follow this
procedure:
1.

Take the repository offline to prevent new workflows from being submitted.

2.

Wait for all automatic tasks to complete.


Use the following DQL query to obtain the number of active automatic tasks in the repository:
select count(r_object_id) from dmi_workitem where
r_auto_method_id> '0000000000000000' and
r_runtime_state in (0,1)

If the query returns a nonzero value, active automatic tasks still need to be processed. If it returns
0, the repository contains no more active automatic tasks, and you can safely stop the repository.
If the query returns 0, run the query a few more times to ensure that no new automatic tasks
are being generated.

Upgrading sequence considerations


Consider the following upgrading sequence information before you begin upgrading Content Server:
If you plan to upgrade to a 64bit version of Content Server from a 32bit version (only available
on Windows for the 6.7 release), use the following sequence:
Note: When this document was published, the 64-bit version of Content Server was
not yet available (April, 2011). Check the Powerlink website for the latest information
(http://powerlink.emc.com).
1.

Upgrade your current 32bit Content Server to a version 6.7 32bit Content Server.

2.

Upgrade/install a 64bit version of the database client on the Content Server host machine (see
below for updating DSNs or TNSNAMES.ORA).

3.

Upgrade the database (if needed).

4.

Create an ORACLE_HOME environment variable in Windows that points to the location of


the 64bit TNSNAMES.ORA file.

5.

Upgrade 32bit 6.7 Content Server to 64bit Content Server.

In step 2, when you install the 64bit client, you must copy the DSNs from the 32bit ODBC
driver to the 64bit driver if used by your database. When you redefine the DSN, you must use
the same level or later level of client library.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

91

Upgrading Content Server

If you use Oracle, the entries from the 32bit TNSNAMES.ORA file have to be copied into the
64bit TNSNAMES.ORA file.
During steps 2 and 3, you may see database connection errors in the repository logs, since the
combination of a 32bit Content Server and a 64bit database client is not supported. These
errors may be safely ignored.
During the upgrade from 32bit to 64bit, Content Server cannot upgrade the
authentication plugins that you have installed. You will need to replace the 32bit
authentication plugins with the 64bit plugins. You will find the plugins in the
%DM_HOME%\install\external_apps\authplugins folder.
Upgrade to a 64bit Content Server is not supported if there is no upgrade path from your
current OS to a 64bit OS.
If you are using the data partitioning feature, which is supported as of version 6.5, you need to
upgrade the database first before you upgrade Content Server. If you are not using the data
partitioning feature, it does not matter which one you upgrade first.
Do not probe log files before the entire upgrade is completed. Partial upgrade is not supported.
You need to upgrade the binaries, the connection broker, and the repositories are the same time.
For operating systems that do not support IPv6 in versions prior to version 6.5, you need to
upgrade the operating system first. You need to upgrade the following operating systems first if
they did not support IPv6 in versions prior to 6.5:
Linux (Red Hat)
Linux (SUSE)
AIX
Solaris
HPUX
Note: Version 6.7 does not support IPv6 on the HPUX-IA operating system.
If you are upgrading from version 5.3. SP6 , 6, or 6 SP1 to version 6.7, the upgrade will not remove
the binaries of the Tomcat and WebLogic application servers. This is because Tomcat and Weblogic
are supported for client and UCF type applications, while JBoss is used for the Java method server.

Upgrading from 5.3 SP6


Upgrades to 6.x require a global registry. Therefore, if you are upgrading from 5.3 SP6 to 6.x, you
need to verify that a 5.3 SP6 repository is designated as a global registry.

To verify that a repository is designated as a global registry:


1.

Using Documentum Administrator, log into the repository that should be the global registry,
using an administrator account.

2.

In Classic view, in the left navigation tree, click the Administration node.

3.

In the page that appears, under the heading "User Management", click Search for Users.

92

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

4.

Search for the following user: "dm_bof_registry" (enter this value next to the User Name label,
and click Search).

5.

View the properties of this user "dm_bof_registry" (click the (i) icon).

6.

Make note of the users State and User Login Name. If the user State is Inactive, this repository
is not the global registry. To make this repository the global registry, follow the subsequent
procedures. If the global registry user is Active, you need to verify some information in your
dfc.properties file on your application servers.
The following step enable you to verify the entries in the dfc.properties file.

7.

From the application server machine, locate the dfc.properties file. Open this file in any text
editor. Ensure the following three attributes are set in the dfc.properties file:
dfc.bof.registry.repository =
dfc.bof.registry.username =
dfc.bof.registry.password =
Without the above three entries, the global registry will not be set. If these entries are missing
or values are not complete, you need to add and populate these values. See the following
procedures for more details.

To enable a global registry:


1.

Log into Documentum Administrator as an administrator in the repository where you want
to enable TBO/SBO functionality.

2.

In Classic view, in the left navigation tree, click the Administration node.

3.

In the page that appears, under the heading "User Management", click Search for Users.

4.

Search for the following user: "dm_bof_registry" (enter this value next to the User Name label,
and click Search).

5.

View the properties of this user "dm_bof_registry" (click the (i) icon). The properties page will
appear.

6.

From the properties page, ensure the following options and values are set to the following:
User State: Active
User Source: Inline Password
Restrict Folder Access: System

7.

For security purposes, change the default password (make a note of the new password).

8.

Click OK on the dm_bof_registry user Properties page

Ensuring that the dm_server_config object is unlocked


If you attempt to upgrade Content Server, but the dm_server_config object is locked, the upgrade
may fail. To check if the object is locked, log in to your database as the database owner and use the
following SQL query to get the object ID of the server configuration object:
SQL> select r_object_id from dm_server_config_s

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

93

Upgrading Content Server

Use the object ID in the following query to verify whether the configuration is locked:
SQL> select r_object_id, r_lock_owner from dm_sysobject_s
where r_object_id = '<object ID>'

If there is a lock owner, then the object is locked.


To unlock the object, use the following SQL (except for Oracle):
SQL> update dm_sysobject_s set r_lock_owner = ' ' set r_lock_machine = ' '
set r_lock_date = ' ' where r_object_id = '<object ID>'

For Oracle, use:


Oracle> update dm_sysobject_s set r_lock_owner = ' ' set r_lock_machine = ' '
set r_lock_date = null where r_object_id = '<object ID>'

Commit the change:


SQL> commit

Finally, restart the repository.

Upgrading from a pre-6.5 SP1 Content Server


When you upgrade from a pre-6.5 SP1 Content Server, indexes are created on dm_acl and dm_group
to improve performance. If you have already created indexes on either of those types, you may notice
an error message during upgrade similar to the following:
[DM_TYPE_MGR_E_INDEX_FAILURE]error: "Failure to create index named
d_1f00e4af80008100 for type dm_group:
error from database system is ORA-01408:
such column list already indexed

Such errors can be safely ignored.

Upgrading the Content Server software


Use these instructions to upgrade Content Server software. The length of time needed to upgrade a
repository depends on the size of the repository. Allow sufficient time for backing up the repository
and performing the upgrade.

To upgrade the software installation:


1.

Back up the repository.

2.

If the repository contains customized repository formats (dm_format objects), back up the
customized formats.
Repository formats are upgraded by the dm_apply_formats.ebs script, which reads values from
the formats.csv file. If the attributes of a format in the repository do not match the format
descriptions in the formats.csv file, the script overwrites the existing values with the values
in the file.

3.

94

Run the consistency checker.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

The consistency checker is a script that looks for repository inconsistencies, such as users with
nonexistent groups, permissions sets with nonexistent users, and sysobjects that point to
nonexistent content files. Fixing inconsistencies in the repository improves the quality of the data
in the repository and results in a smoother upgrade. The syntax is:
dmbasic -fconsistency_checker.ebs -eEntry_Point -- repository_name
superuser password

repository_name is the name of the repository against which you are running the consistency
checker.
superuser is the username of a repository superuser
password is the password for the superusers account.
The results of the consistency checker are directed to standard output.
4.

Fix the inconsistencies reported by the consistency checker as errors.


The EMC Documentum Content Server Administration and Configuration Guide provides information
on the consistency checker.

5.

Disable all jobs.


On Windows, disable jobs in all repositories on the host.
On UNIX and Linux, disable jobs in all repositories in the installation you are upgrading.

6.

For the upgrade on a Windows host, shut down the repositories and connection brokers.
a.

Click Start > Programs > Documentum > Server Manager.

b. Select the correct Content Server and click Stop.


c.

Click the connection broker tab.

d. Select each connection broker.


e.
7.

Click Stop.

For the upgrade on a UNIX or Linux host, shut down the repositories and connection brokers.
a.

For each repository, run the dm_shutdown_repository script, where repository is the name of
the Content Server to be stopped.

b. Stop each connection broker using the dm_stop_connection broker utility.


The EMC Documentum Content Server Administration and Configuration Guide contains
instructions.
8.

Shut down the application server.


To shut down the application server on Windows, stop the service called Documentum Java
method server. Ensure that the application server does not start automatically after a host
restart.
To shut down the Java method server on UNIX or Linux, run the script
$DOCUMENTUM_SHARED/<application_server>/domains/DctDomain/stopMethodServer.sh.

9.

Run the Content Server installation program.


Chapter 5, Installing Content Server software on a UNIX or Linux host and Chapter 6, Installing
Content Server software on a Windows host contain the details.

10. Run the Content Server configuration program.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

95

Upgrading Content Server

The Content Server configuration section in the installation chapter provides the procedure on
running the Content Server configuration program. Perform the procedure with the following
upgrade modification steps:
a.

At step 6, select Custom configuration.

b. At step 8 (Configure a connection broker), select Upgrade an existing connection broker.


c.

At step 9 (Configure a repository), select Upgrade an existing repository and skip to step 12.
The upgraded repository will use the same configuration settings as the existing repository.
If you are upgrading a repository on a Sybase platform, the upgrade procedure may hang
if the database transaction log is too small. When the repository is upgraded, it opens a
long-running transaction while the upgrade script is running. If the transaction log is too
small, the transaction hangs with locked system tables because the database server cannot
write information to the transaction log. To continue with the upgrade:
1.

Run the following command on the Sybase database:


sp_dboption db_name,'trun log on chkpt',true

2.

Run a checkpoint command to truncate the transaction log.

3.

If steps 1 and 2 fail to resolve the issue and allow the upgrade to proceed, increase the
transaction log space.

11. If you upgraded from an installation using FAST fulltext indexing, and selected xPlore fulltext
indexing, you must restart Content Server again after you complete Content Server configuration.
12. After you complete the Content Server configuration, create a nonunique index on the
dm_sysobject.r_object_id and r_aspect_name properties by using the following MAKE_INDEX
command:
EXECUTE make_index WITH type_name='dm_sysobject',
attribute='r_aspect_name',use_id_col=true

The inclusion of the use_id_col argument set to true automatically causes Content Server to
include the r_object_id column in the index.
13. If you are upgrading a repository in a distributed environment that uses a BOCS and
asynchronous write jobs, create an index on the dmr_content_s(i_parked_state, r_object_id)
properties. Use the following MAKE_INDEX command to do so:
EXECUTE make_index WITH type_name='dmr_content',
attribute='i_parked_state',use_id_col=true,id_in_front=false

14. For an upgrade from 6.0 to 6.7:


After the upgrade is complete, for Windows, delete the directory <DctmUserDir>\bea9.2
(typically c:\documentum\bea9.2) as well as the directory <DctmUserDir>\bea9.2 (typically
c:\program files\documentum\bea9.2). For Unix, delete $DOCUMENTUM_SHARED/bea9.2.
For an upgrade from 5.3 SP6 to 6.7:
After the upgrade is complete, for Windows, delete the tomcat directory under
<DctmProgramDir>. For UNIX, delete the tomcat directory from the $DOCUMENTUM_SHARED
directory.
15. Enable all jobs you previously disabled. In Documentum Administrator, navigate to
Administrator>Job Management>Jobs. For each of the previously disabled jobs, right-click the
job and select Properties. In the Properties window, set the State option to Active.

96

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

16. On a Windows upgrade, the Startup Type is set to Manual for the Documentum Docbase Service
repository name service. If you want the repository to automatically start after a server reboot,
navigate to Start>All Programs>Administrative Tools>Services, and set the Startup Type to
Automatic.

Running queries on repositories upgraded


prior to release 6.5 SP3
Any repository that is running a Content Server version earlier than 6.5 SP3 and is upgrading, the
following query returns one parent only, although there may be multiple parents:
SELECT r_object_id,object_name,i_folder_id FROM dm_message_archive
WHERE i_chronicle_id IN ('0901e2ee80005962');

To resolve this issue, run the following command from the API command line in DA:
apply,c,NULL,PATCH_MATERIALIZED_OBJECTS,TYPE,S,dm_message_archive

Using the update statistics tool


The Update Statistics tool generates current statistics for the RDBMS tables owned by the repository
owner. Generating statistics is always useful, particularly after you perform load operations or
if table key values in the underlying RDMBS tables are not normally distributed. When you are
upgrading Content Server from 5.3 SP6 to 6.x the performance will degrade significantly until you
run the update statistics tool on the database.
Note: Do not run the UpdateStats job if you are using Oracle 10g or a later version.
When you run the tool against an Oracle or Sybase database, the tool uses a file that contains
commands to tweak the database query optimizer. For Oracle, the file is named custom_oracle_stat.sql.
For Sybase, it is named custom_sybase_stat.sql. The file is stored in %DOCUMENTUM
%\dba\config\repository_name ($DOCUMENTUM /dba/config/repository_name). You can add
commands to this file. However, do so with care. Adding to this file affects query performance. If
you do add a command, you can use multiple lines, but each command must end with a semicolon
(;). You cannot insert comments into this file.
The -dbreindex argument controls whether the method also reorganizes database tables in addition
to computing statistics. For SQL Server and DB2, you can set the argument to either READ or FIX.
Setting it to READ generates a report on fragmented tables but does not fix them. Setting it to FIX
generates the report and fixes the tables. (In either case, the report is included in the overall job report.)
For Sybase, the -dbreindex argument is only effective if set to FIX, to reorganize the tables. Setting it
to READ does not generate a report on Sybase. If you include the -dbreindex argument set to FIX, the
repository owner (the account under which the tool runs) must have sa role privileges in the database.
The -dbreindex argument has no effect on a Oracle database.
The tool generates a report that is saved in the repository in System/Sysadmin/Reports/ UpdateStats.
The exact format of the report varies for each database.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

97

Upgrading Content Server

The Update Statistics tool is installed in the active state, running once a week. Because this tool can be
CPU and disk-intensive, it is recommended that you run the tool during off hours for database use.
Consult with your RDBMS DBA to determine an optimal schedule for this tool.

Arguments
Table 9, page 98, lists the arguments for the tool.
Table 9. Update Statistics arguments

Argument

Datatype

Default

Description

-dbreindex

string

READ

Controls whether the tool actually


updates statistics or only reports on
RDBMS tables that need updating.
READ generates only the report.
This setting is valid only for SQL
Server and DB2 databases.
FIX generates the report and
updates the tables. This setting
is valid on SQL Server, DB2, and
Sybase databases. However, on
Sybase, it only fixes the tables. A
report is not generated.
This argument is not available for
Oracle databases.

-server_name

string(32)

Name of the database server.


This is a required argument on
SQL Server and Sybase. It is set for
the job when the administration
tools are installed in repositories
running against a SQL Server or
Sybase database.

-queueperson

string(32)

User who receives email and inbox


notifications from the tool. The
default is the user specified in the
operator_name property of the
server config object.

-window_interval

integer

120

Execution window for the tool.

98

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

Guidelines
Run this tool after you perform large loading operations.
When the job is run with -dbreindex set to READ and the statistics need updating, the report will say:
-dbreindex READ. If rows appear below, the corresponding
tables are fragmented.
Change to -dbreindex FIX and rerun if you want to reindex
these tables.

When the job is run with -dbreindex set to FIX, the report will say:
-dbreindex FIX. If rows appear below, the corresponding
tables have been reindexed.
Change to -dbreindex READ if you do not want to reindex
in the future.

Report sample
The Update Statistics report tells you when the tool was run and which tables were updated. The
report lists the update statistics commands that it runs in the order in which they are run. Here is a
sample of the report:
Update Statistics Report:
Date of Execution: 06-04-96
update
go
update
go
update
go
update
go
update
go
. . .
End of

statistics dmi_object_type
statistics dm_type_s
statistics dm_type_r
statistics dm_type_r
statistics dmi_index_s

Update Statistics Report

Adding descriptors to a global registry


If you are upgrading from a repository prior to version 6.5 that is not the global registry, you first
need to run a script on the global registry that adds descriptors to the global registry. Descriptors
are configuration objects that the distributed content transfer system uses. The distributed content
transfer system includes UCF, ACS, BOCS, DMS, and part of DFC. You cannot modify these
descriptors. You only need to run this script once. If the repository you are upgrading is the global
registry, you dont need to run this script.
To add the descriptors in a Windows environment run the following script:
%Documentum%\product\6.5\install\admin>dmbasic -f
dm_acs_install.ebs -e UpgradeDescriptors -<repository name> <user name> <password>

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

99

Upgrading Content Server

Start upgrade of validation descriptors on docbase


<repository name>
Connected to docbase <repository name>
as user <user name>.
Successfully created a dm_validation_descriptor named
getpage_2.1 with version 2.1 with parameters 'filepath,cacheid,
basepath,mode,servername,objectid,format,pagenum,pagemod,timestamp,
command,page_plugin_name'
Successfully created a dm_validation_descriptor named move_2.1
with
version 2.1 with parameters 'filepath,cacheid,basepath,mode,
servername,objectid,format,pagenum,pagemod,timestamp,command,
content_objid'
Successfully created a dm_validation_descriptor named write_2.1
with version 2.1 with parameters 'mode,servername,docbaseid,
storeid,timestamp,command,formatid,content_objid,store_data,partition'
Successfully created a dm_validation_descriptor named park_2.1
with version 2.1 with parameters 'mode,servername,docbaseid,
storeid,timestamp,command,formatid,content_objid,store_data,partition'
Successfully created a dm_validation_descriptor named
store_2.1 with version 2.1 with parameters 'mode,servername,
docbaseid,storeid,timestamp,command,formatid,content_objid,
store_data,partition,parked_data_token,parked_fork_token'
Successfully created a dm_validation_descriptor named
write2_2.1 with version 2.1 with parameters 'mode,servername,
docbaseid,storeid,timestamp,command,formatid,content_objid,
store_data,partition,parked_data_token,parked_fork_token'
Successfully created a dm_validation_descriptor named read_2.1
with version 2.1 with parameters 'filepath,cacheid,basepath,
mode,servername,objectid,format,pagenum,pagemod,timestamp,command'
Successfully created a dm_validation_descriptor named
precache_2.1 with version 2.1 with parameters 'filepath,
cacheid,basepath,mode,servername,objectid,format,pagenum,
pagemod,timestamp,command'
Upgrade of dm_validation_descriptor data succeeded.

To add the descriptors in a UNIX environment run the following command:


$DOCUMENTUM/product/6.5/install/admin>dmbasic -f
dm_acs_install.ebs -e UpgradeDescriptors -<repository name> <user name> <password>

The output of the script is the same as the output for Windows.
The descriptors might already exist if you run the script a second time for the same global registry, or
if the global registry is a 6.5 repository. If the descriptors already exist, the output from the script is:
%Documentum%\product\6.5\install\admin>dmbasic -f dm_acs_install.ebs
-e UpgradeDescriptors -- <repository name>
<user name> <password>
Start upgrade of validation descriptors on docbase
<repository name>
Connected to docbase <repository name> as
user <user name>.
Upgrade of dm_validation_descriptor data succeeded.

100

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

Missing database indexes on repository


upgrades from version 5.3
When you upgrade a repository from version 5.3 to version 6.5 and later, several indexes are not
created. In general, these indexes are new ones added to repositories since 5.3, and are created
correctly for new repositories. You can add these indexes manually by first issuing the DROP_INDEX
command, then the MAKE_INDEX command.
The syntax for the DROP_INDEX command is:
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,<id>
OR
apply,c,NULL,DROP_INDEX,NAME,S,<name>
Note: You must examine the database to find the index name to use in the second form. It takes the
format "d_1f...", and the index name must be in all lowercase.
The syntax for the MAKE_INDEX command is:
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,<name>,[ATTRIBUTE,S,<name>],
USE_ID_COL,B,<value>,UNIQUE,B,<value>,RESERVED_ID,I,<id>,ID_IN_FRONT,B,<value>
Note: RESERVED_ID should be the value added to LONG_MIN, not the actual value that is used
for the ID.
The following is a listing of the indexes you need to drop and then make. The list includes the
type and attributes of the index, and the commands needed to drop and then make the index.
Where the command includes the text, <fill in name>, you must find the index name, as described
above, and use it instead of <fill in name>. The MAKE_INDEX commands are long, and run over
multiple lines in this listing.

List of indexes to drop and make


Type: dmi_queue_item
Columns: item_id, task_state, name, sign_off_user, priority, date_sent
Include ID Field: Yes
ID in Front: No
Unique: No
ID (decimal): 81
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,81
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dmi_queue_item,ATTRIBUTE,S,item_id,
ATTRIBUTE,S,task_state,ATTRIBUTE,S,name,ATTRIBUTE,S,sign_off_user,
ATTRIBUTE,S,priority,ATTRIBUTE,S,date_sent,USE_ID_COL,B,T,ID_IN_FRONT,B,F,
UNIQUE,B,F,RESERVED_ID,I,81
Type: dmr_content
Columns: data_ticket, storage_id, format
Include ID Field: No
Unique: No
ID (decimal): 84
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,84
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dmr_content,ATTRIBUTE,S,data_ticket,
ATTRIBUTE,S,storage_id,ATTRIBUTE,S,format,USE_ID_COL,B,F,UNIQUE,B,F,

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

101

Upgrading Content Server

RESERVED_ID,I,84
Type: dmr_content
Columns: i_parked_state
Include ID Field: Yes
ID in Front: No
Unique: No
ID (decimal): 89
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,89
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dmr_content,ATTRIBUTE,S,i_parked_state,
USE_ID_COL,B,T,ID_IN_FRONT,B,F,UNIQUE,B,F,RESERVED_ID,I,89
Type: dm_acl
Columns: owner_name, object_name
Include ID Field: Yes
ID in Front: No
Unique: Yes
ID (decimal): None
apply,c,NULL,DROP_INDEX,NAME,S,<fill in name>
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_acl,ATTRIBUTE,S,owner_name,
ATTRIBUTE,S,object_name,USE_ID_COL,B,T,ID_IN_FRONT,B,F,UNIQUE,B,T
Type: dm_message_archive
Columns: i_sharing_parent
Include ID Field: No
Unique: No
ID (decimal): None
apply,c,NULL,DROP_INDEX,NAME,S,<fill in name>
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_message_archive,ATTRIBUTE,S,i_sharing_parent,
USE_ID_COL,B,F,UNIQUE,B,F
Type: dm_message_archive
Columns: message_id, message_link_count, parent_message_id
Include ID Field: No
Unique: Yes
ID (decimal): None
apply,c,NULL,DROP_INDEX,NAME,S,<fill in name>
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_message_archive,ATTRIBUTE,S,message_id,
ATTRIBUTE,S,message_link_count,ATTRIBUTE,S,parent_message_id,USE_ID_COL,B,F,UNIQUE,B,T
Type: dm_sysobject
Columns: i_folder_id
Include ID Field: Yes
ID in Front: No
Unique: No
ID (decimal): 16
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,16
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_sysobject,ATTRIBUTE,S,i_folder_id,
USE_ID_COL,B,T,ID_IN_FRONT,B,F,UNIQUE,B,F,RESERVED_ID,I,16
Type: dm_sysobject
Columns: r_aspect_name
Include ID Field: Yes
ID in Front: Yes
Unique: No
ID (decimal): 85
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,85
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_sysobject,ATTRIBUTE,S,r_aspect_name,
USE_ID_COL,B,T,UNIQUE,B,F,RESERVED_ID,I,85

102

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Upgrading Content Server

Type: dm_sysobject
Columns: owner_name
Include ID Field: No
Unique: No
ID (decimal): 93
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,93
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_sysobject,ATTRIBUTE,S,owner_name,
USE_ID_COL,B,F,UNIQUE,B,F,RESERVED_ID,I,93
Type: dm_audittrail
Columns: id_2
Include ID Field: No
Unique: No
ID (decimal): 83
apply,c,NULL,DROP_INDEX,RESERVED_ID,I,83
apply,c,NULL,MAKE_INDEX,TYPE_NAME,S,dm_audittrail,ATTRIBUTE,S,id_2,
USE_ID_COL,B,F,UNIQUE,B,F,RESERVED_ID,I,83

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

103

Upgrading Content Server

104

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 11
Enabling FAST with Content Server 6.7

The Documentum 6.7 Content Server does not have support for the FAST indexing server enabled.
xPlore is the default indexing server. If you have used FAST and want to continue to use it while you
evaluate or migrate to xPlore, use these instructions for a new installation. You can chose to enable
FAST before configuring the Content Server, or you can enable FAST after configuring Content Server.
If you are upgrading to 6.7, chose whether to install FAST support or xPlore support during the
upgrade. If you are upgrading from Content Server 6.5 SP2 or SP3, you must do step 3 from the
procedureTo enable the FAST indexing server after configuring the Content Server, page 106, even
if you selected FAST support during the upgrade (dont do step 1 and step 2 if you selected FAST
support during the upgrade). If you chose xPlore during upgrade and later decide to enable FAST
instead, use the procedure, To enable the FAST indexing server after configuring the Content Server,
page 106.
Note: The FAST indexing server will not be supported by Microsoft after 2011. xPlore is a fully
functional replacement with many added features and better performance.

To enable the FAST indexing server before configuring the Content Server
1.

Create a fast.ini file with the following case-sensitive entries:


[INDEX AGENT]
INDEX_AGENT_TYPE=Fast

2.

Launch the Content Server configuration program with the following command for your
environment. Substitute the full path to fast.ini or place the file in the launch directory:
UNIX or Linux:
dm_launch_server_config_program.sh -config fast.ini
Windows:
Server_Configuration_Program.exe -config fast.ini

3.

If you are upgrading from Content Server 6.5 SP2 or SP3, do the following using iAPI. Substitute
your values for FAST_indexserver_hostname and desired FAST_search_base_port+2100. The default
FAST_search_base_port is 13000, so the default value for FAST_search_base_port+2100 that you
would use in the SET command is 15100:
iAPI>retrieve,c,dm_ftengine_config
iAPI>append,c,l,param_name
SET>fds_qrserver_host
iAPI>append,c,l,param_name
SET>fds_qrserver_port
iAPI>append,c,l,param_value
SET>FAST_indexserver_hostname
iAPI>append,c,l,param_value
SET>FAST_search_base_port+2100

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

105

Enabling FAST with Content Server 6.7

iAPI>save,c,l

To enable the FAST indexing server after configuring the Content Server
1.

Run the script fulltext_setup_for_fast.ebs in $DOCUMENTUM/product/6.7/install/admin (UNIX


and Linux) or %DOCUMENTUM%\product\6.7\install\admin (Windows).
dmbasic -f fulltext_setup_for_fast.ebs -eSetupForFAST -repository_name username
password fulltextHome isRemoteCS

repository_name is the name of the repository against which you are running the consistency
checker.
username is the username of a repository superuser.
password is the superuser password.
fulltextHome is the path to the fulltext subdirectory of $DOCUMENTUM or
%DOCUMENTUM%.
isRemoteCS specifies whether the Content Server is remote. Not case-sensitive. Valid values: t
and f.
For example:
dmbasic -f fulltext_setup_for_fast.ebs -eSetupForFAST -- testenv admin N0123
c:\documentum\fulltext f

2.

Restart the Content Server.

3.

If you are upgrading from Content Server 6.5 SP2 or SP3, do the following using iAPI. Substitute
your values for FAST_indexserver_hostname and desired FAST_search_base_port+2100. The default
FAST_search_base_port is 13000, so the default value for FAST_search_base_port+2100 that you
would use in the SET command is 15100:
iAPI>retrieve,c,dm_ftengine_config
iAPI>append,c,l,param_name
SET>fds_qrserver_host
iAPI>append,c,l,param_name
SET>fds_qrserver_port
iAPI>append,c,l,param_value
SET>FAST_indexserver_hostname
iAPI>append,c,l,param_value
SET>FAST_search_base_port+2100
iAPI>save,c,l

106

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 12
Uninstalling Content Server

This chapter explains how to delete a repository or connection broker and how to uninstall an
existing Content Server installation. Do not uninstall an existing installation to upgrade to a new
Content Server release, because all upgrades based on an existing installation. Use the procedures in
this chapter only if you want to uninstall an existing Content Server, a repository and its contents, a
connection broker, or a Content Server software installation.
This chapter contains the following information:
Order of uninstalling components, page 107
Deleting a repository, page 108
Deleting a connection broker, page 109
Uninstalling the Content Server software, page 109
To delete a repository or connection broker or uninstall Content Server, you need to meet the
following requirements:
Be able to log in as the installation owner
Have sufficient database privileges to drop tablespaces or databases

Order of uninstalling components


Uninstall the software components in this order:
1.

Shut down and uninstall the index agent if full-text indexing is installed.
The Content Server Fulltext Indexing System Installation and Administration Guide provides
information about uninstalling full-text indexing components.

2.

Shut down the repository.

3.

Shut down and uninstall the index server if full-text indexing is installed. The repository must be
shut down for this.

4.

Delete the repository.

5.

Delete any connection broker located on the current host.

6.

Uninstall the Content Server software.

7.

Uninstall the Index Agent Configuration Program if full-text indexing is installed.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

107

Uninstalling Content Server

Deleting a repository
Use these instructions to delete a repository.
To delete a repository you need to meet the following requirements:
Be able to log in as the installation owner
Have sufficient RDBMS privileges to drop tablespaces or databases.
Note: If the repository has a Content Transformation Services (CTS) product installed on it, you need
to uninstall the CTS product before deleting the repository. If you do not, the CTS product will not
be available in all other repositories.

To delete a repository:
1.

Log in to the host as the Content Server installation owner.

2.

Start the Content Server configuration program.


On Windows, click Start > All Programs > Documentum > Documentum Server Manager,
select the repository, and click Delete, then click Ok.
On UNIX and Linux, navigate to the $DM_HOME/install directory and run the
dm_launch_server_config_Program.sh program.
The Content Server configuration program starts.

3.

Click Next.

4.

On Windows, provide the installation owner password and click Next, then skip to step 9.

5.

Select Custom Installation and click Next.

6.

Select Create New, Upgrade, or Delete Repositories and click Next.

7.

Select Delete an Existing Repository, select the repository to delete, and click Next.
You are asked if you want to delete the component.

8.

Click OK.
The installer stops the Content Server and provides the location of the tablespace or database
deletion script.
This is $DOCUMENTUM/server_uninstall/delete_db/repository_name, where repository_name is
the name of the repository.

9.

Click OK.

10. Indicate whether to configure another repository or exit from the configuration program and
click Next.
An information dialog box appears.
11. Click Finish.
12. From the database, drop the database tables associated with the repository.

108

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Uninstalling Content Server

Deleting a connection broker


Use these instructions to delete a connection broker.
Note: To delete a connection broker, you need to be able to log in to Windows as the installation
owner.

To delete a connection broker:


1.

Connect to the host as the Content Server installation owner.

2.

Start the Content Server configuration program.


On Windows, click Start > Documentum > Server Manager > Connection Broker, select the
connection broker, and click Delete.
On UNIX and Linux, navigate to the $DM_HOME/install directory and run the
dm_launch_server_config_Program.sh program.

3.

Click Next.

4.

On Windows, provide the installation owner password and click Next, then skip to step 9.

5.

Select Custom Installation and click Next.

6.

Select Create New, Upgrade, or Delete Connection Brokers and click Next.

7.

Select Delete an Existing Connection Broker, select the connection broker to delete, and click
Next.

8.

When prompted to delete the component, click OK.

9.

Indicate whether to configure another connection broker or exit from the configuration program
and click Next.
If you indicated to configure another connection broker, the program returns to the connection
broker dialog box, and you can repeat the connection broker deletion procedure. If you indicated
not to configure another connection broker, an information dialog box appears.

10. Click Finish.

Uninstalling the Content Server software


Use these instructions to uninstall the Content Server software from a host. You can only uninstall the
software after deleting all repositories and connection brokers in the installation.

To uninstall the Content Server software:


1.

Delete all repositories and connection brokers in the installation.


Use the instructions in Deleting a repository, page 108 and Deleting a connection broker, page 109.

2.

On Windows:
a.

Click Start > Settings > Control Panel > Add/Remove Programs.

b. Select Documentum Content Server and click Remove.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

109

Uninstalling Content Server

c.

Select EMC Java Method Server Node and click Remove.

d. Select Documentum Task Chaining Framework and click Remove.


e.

Select Documentum Application Server and click Remove.

f.

Select Documentum Service Wrapper and click Remove.

g. Optionally, uninstall the DFC Runtime Environment.


Note: Do not uninstall the DFC Runtime Environment if any other EMC Documentum
software is installed on the host.
3.

On UNIX and Linux:


a.

Navigate to the $DOCUMENTUM/_uninst/Server directory.

b. Run the Content Server uninstaller:


uninstall.bin.

c.

Navigate to $DOCUMENTUM_SHARED/_uninst/jmsn and uninstall the EMC Java Method


Server Node:
uninstall.bin.

d. Navigate to $DOCUMENTUM_SHARED/_uninst/tcf and uninstall the Documentum Task


Chaining Framework:
uninstall.bin.

e.

Navigate to $DOCUMENTUM_SHARED/_uninst/JBoss/server and uninstall the application


server:
uninstall.bin.

f.

Navigate to $DOCUMENTUM_SHARED/_uninst/serviceWrapper and uninstall the


Documentum service wrapper:
uninstall.bin.

g. Optionally, navigate to $DOCUMENTUM_SHARED/_uninst/dfc and uninstall the DFC


Runtime Environment:
uninstall.bin

Note: Do not uninstall the DFC Runtime Environment if any other EMC Documentum
software is installed on the host.

110

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 13
Installing Remote Content Servers
in Distributed or Load-Balanced
Configurations

This chapter provides instructions for installing and configuring remote Content Servers in
distributed or load-balanced content configurations.
If you are creating a new single-repository in a distributed or load-balanced content configuration, a
configuration program separate from the Content Server configuration program is used for installing
remote Content Servers and creating the storage areas on the remote hosts and related location objects.
Review the Distributed Content Guide before you install a distributed configuration.
This chapter contains the following topics:
Preinstallation requirements, page 111
Installing and configuring the remote Content Server, page 112
Upgrading a distributed or load-balanced configuration, page 114
Deleting a remote Content Server, page 116

Preinstallation requirements
The following requirements and limitations exist when you are installing remote Content Server
in distributed or load-balanced configurations:
The remote host must meet the same preinstallation requirements as the primary Content Server
host.
The database client software must be installed on remote Content Server hosts. The remote
Content Server configuration program must connect to the database to properly create the
following objects for the remote server.
server config
acs config

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

111

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

file store storage


location
When a remote Content Server is created for a distributed or load-balanced content environment,
the server.ini file from the primary Content Server host is copied from the primary host to the
remote host. The values used on the primary and remote hosts for database connectivity must be
identical to ensure that the value of the database_conn key on the primary Content Server host is
valid on the remote hosts. For example, if the database is SQL Server, ensure that the DSN name
for the SQL Server instances ODBC data source is the same on all hosts.
All hosts in a distributed or load-balanced configuration must be set to the same UTC time.
A repository that uses a distributed or load-balanced storage area with encrypted file stores as
components cannot use shared content.
EMC Documentum Web Publisher and EMC Documentum Site Caching Services are not
supported in distributed or load-balanced configurations, in federations, or where replication is
used.
Caution: After a repository has been configured to use distributed or load-balanced storage,
it is not possible to revert to using nondistributed storage.
Note: If the Content Server file store is assigned to a shared folder on the network with a UNC
path, you need to meet the following requirements:
Content Server and the file store need to be on the same domain
The installation user account of Content Server needs to be available on the domain.
The installation user account needs to have full access control for the file store.

Installing and configuring the remote Content


Server
Use these instructions to install and configure the remote Content Server.

To configure the remote Content Server:


1.

Copy the Content Server installation files from the installation media to the correct directories
on the host.
This step is identical to the process used to copy files onto the primary Content Server host. The
Content Server installation sections in the Content server installation chapter provide instructions.

2.

Start the remote Content Server configuration program.


On Windows, the configuration program starts automatically following a reboot of the host.
If the configuration program does not start automatically, or if you have to delete the remote
Content Server and need to reconfigure the remote Content Server, do the following:
Navigate to %DM_HOME%\install.
Double-click cfsConfigurationProgram.exe.
On UNIX or Linux, navigate to $DM_HOME/install and type:

112

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

%dm_launch_cfs_server_config_program.sh

A Welcome dialog box appears.


3.

Click Next.
On Windows, the Installation Owner Password dialog box appears.
On UNIX or Linux skip to Step 5.

4.

On Windows, type the installation owners password and click Next.

5.

Type the hostname of the primary connection broker for the repository and verify or type the port
number on which the connection broker listens and click Next.
The port defaults to 1489. If you are using the default port number, ensure that the next port
number (1490) is available for use because the connection broker requires that two ports be
reserved.

6.

Select the repository for which you are installing the remote Content Server, type the username
and password for a superuser in that repository and click Next.
The repository list is populated with repositories known to the connection broker for which you
provided information in the previous step. The superuser name defaults to the Documentum
installation owners name.

7.

Type the name and port number for the connection broker on the current host, indicate whether
connection broker startup following a system restart is automatic or manual, and click Next.
The default values are Docbroker and 1489. If you are using the default port number, ensure that
the next port number (1490) is available for use because the connection broker requires that two
ports be reserved. The connection broker is started.

8.

Accept the default location of the data directory or browse to a different location and click Next.
The data directory is where content files are stored in the repository.

9.

Accept the default location of the share directory or browse to a different location and click Next.
The share directory is where clients, example code, and required libraries are stored.

10. Accept the default service name for the new remote Content Server or type a different name
click Next.
11. Click Finish.
The remote Content Server is configured and running.
12. The remote Content Server installation cloned a copy of the dm_server_config object from the
original repository. Examine the dm_server_config object to verify that all the app_server_name
and app_server_uri entries apply to the remote Content Server. For example, if an index agent or
Business Process Engine are installed on the original repository, you may have entries for them
that point to the original host machine on the remote host. Remove any of these attributes if they
are not applicable to the new remote Content Server installation.
13. To start the application server instance that is running the Java method server and Content
Server, do one of the following:
On Windows hosts, restart after the installation.
On UNIX or Linux distributed or load-balanced configurations, use Documentum
Administrator to set the Get method for each component of the distributed or load-balanced
store to Surrogate Get.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

113

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

Upgrading a distributed or load-balanced


configuration
This section describes the overall procedure for upgrading an existing distributed or load-balanced
configuration.
Use these guidelines in deciding how to upgrade a distributed or load-balanced configuration.
Repository federations
EMC Documentum supports federations that contain repositories of different versions. In this
release, any mix of versions 6.0, 6.5.x, and 6.7 repositories may be federation members. If you are
upgrading the repositories in a federation, upgrade the governing repository first.
If the governing repository is a version 5.3 or 5.3 SP1 repository, keep in mind the following:
Prior versions do not support dynamic groups. Consequently, any dynamic groups defined
in the governing repository are propagated to any members prior to version 5.3 as standard,
nondynamic groups.
Similarly, prior versions do not support access restricting (AccessRestriction,
ExtendedRestriction) entries in ACLs. If the federations federation mode is replicating ACLs
with those kinds of entries to member repositories prior to version 5.3, the entries are ignored
by Content Servers prior to version 5.3.
The restricted_folder_ids attribute for users (introduced in version 5.3) is a local attribute. This
means that any restricted users in the governing repository are propagated as unrestricted
users in the member repositories. If the member is a version 5.3 or 5.3 SP1 repository, you can
set that attribute locally.
Repositories with distributed or load-balanced content
Shut down the primary Content Server and all remote Content Servers. Upgrade the primary
Content Server first, then upgrade the remote Content Servers.
Repositories with object replication
Upgrade the source repository, then the target repositories. If you have a group of repositories
where each repository is both a source and a target, the upgrade can begin with any of the
repositories. This can apply, for example, if objects are replicated from repository A to repository
B, repository B to repository C, and from repository C to repository A.
You can replicate between repositories that use different Content Server versions, but you lose
attributes that are in the newer version, since they cannot be replicated to a version that does
not contain them. Content Server version 6.5 supports replication among server versions 5.1
and later only.
If you are upgrading a distributed or load-balanced configuration on Windows, do not reboot the
remote hosts by using Terminal Services. Reboot the remote hosts directly from those hosts.

To upgrade a distributed or load-balanced configuration:


1.

114

On the primary host, use the instructions in Upgrading the Content Server software, page 94, to
upgrade Content Server, connection brokers, and repository.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

2.

On each remote host, use the instructions in Upgrading the Content Server software, page 94,
to upgrade Content Server, but cancel the process before running the repository configuration
scripts.

3.

Create an acs config object in the repository for the ACS server installed with each remote
Content Server.
For example, if there are three remote Content Servers, you need to create three acs config objects.
a.

On the remote Content Server host, navigate to $DM_HOME/install/admin (UNIX or Linux)


or %DM_HOME%\install\admin (Windows).

b. Run the dm_acs_install.ebs script:


dmbasic -f dm_acs_install.ebs -e Install -- repository_
name user_name password acs_name server_config_name Java_
method_server_port acs_protocol
CleanupCacheAcsObject CacheAcsDescriptionFile
HostName

The parameters are described in Table 10, page 115. The acs config object is created in server
config mode and uses the network locations, connection broker projection targets, and stores
from the associated server config object. If you need to change the mode to acs config mode,
in which you manually set network locations, connection broker projection targets, and
stores, use Documentum Administrator to change the mode and create the manual settings.
Do not manually modify the new acs config object by using the API or DQL.
Table 10. Parameters required by dm_acs_install.ebs script

Parameter

Description and values

repository_name

Name of the repository served by the remote


Content Server and its ACS server, where
the acs config object is being created.

user_name

Username of a user with superuser


privileges, for example, the installation
owner.

password

Password for the superuser account.

acs_name

Object name of the acs config object you are


creating. This may be any arbitrary name,
but the name must be unique among the
object names of acs config objects and the
server config objects of both the primary
Content Server and any remote Content
Server.

server_config_name

Object name of the server config object of


the remote Content Server.

Java_method_server_port

Port where the application server on the


remote Content Server host listens, which
was provided during remote Content Server
installation. Do not change this port number
after the initial configuration.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

115

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

Parameter

Description and values

acs_protocol

Communication protocol used by the ACS


server. Valid values are http and https.

CleanupCacheAcsObject

Set to T if upgrading from version 5.3.


When set to T, the script deletes all the
dm_acs_config objects with is_cache_acs
set to T, and an object dump of those
objects is written to the file named in
CacheAcsDescriptionFile. You will create
dm_bocs_config objects for all the objects
listed in the file. In 5.3, instead of separate
BOCS config objects, dm_acs_config objects
with is_cache_acs set to true were used.
Set to F if not upgrading from 5.3

4.

CacheAcsDescriptionFile

File to store object dump of candidate


dm_bocs_config objects. See
CleanupCacheAcs description.

HostName

Fully-qualified domain name of host. This


value is used to set the acs_url attribute
of the dm_acs_config used by the server
named in dm_server_name.

If the remote Content Servers are installed in a different file-system path from the primary
Content Server, create new site-specific location objects for locations that are new in the upgraded
repository.
a.

Connect to the repository by using Documentum Administrator.

b. Create site-specific dm_dba and auth_plugin location objects that contain the locations on
each of the remote sites of the dba directory ($DOCUMENTUM/dba on UNIX or Linux;
%DOCUMENTUM%\dba on Windows) and the authentication plugin.
c.
5.

In the server config object for the remote Content Server, set the auth_plugin_location and
dba_location to the location objects you just created.

Start the application server.

Deleting a remote Content Server


Use these instructions to delete a remote Content Server and its software installation in a distributed
or load-balanced content environment. These instructions delete only the remote Content Server.
They do not delete the repository or affect the primary Content Server for the repository.
To delete the remote Content Server, you need to be able to log in as the installation owner.
On Windows, do not use the Server Manager program to uninstall the server. It launches the
configuration program for primary Content Servers, not remote Content Servers.

116

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

Before you delete the software installation, also delete any connection brokers on the host. Use the
instructions in Deleting a connection broker, page 109.

To delete a remote Content Server:


1.

Log in to the host as the Content Server installation owner.

2.

Navigate to the $DM_HOME/install directory (UNIX or Linux) or %DM_HOME%\install folder


(Windows).

3.

Start the remote Content Server configuration program.


On Windows, double-click cfsConfigurationProgram.exe.
On UNIX or Linux, navigate to $DM_HOME/install and type:
%dm_launch_cfs_server_config_program.sh

A Welcome dialog box appears.


4.

Click Next.

5.

On Windows, type the installation owners password and click Next.

6.

Select Delete remote Content Server and click Next.

7.

Type the installation owners name and password and click Next.
The service is deleted.

8.

Click Finish.

To delete the server software installation from the remote host:


1.

Navigate to $DOCUMENTUM/_uninst/Server (UNIX or Linux) or %Documentum%\_


uninst\Server (Windows)

2.

Run the server uninstaller:


On Windows, double-click uninstall.exe.
On UNIX, type:
uninstall.bin.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

117

Installing Remote Content Servers in Distributed or Load-Balanced Configurations

118

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 14
Installing Content Server and Java
Method Server for High-Availability

This chapter describes how to install and configure Content Server and Java Method Server in
high-availability mode. This chapter contains the following information:
Overview, page 119
JMS HA configurations, page 121
Choosing an HA configuration, page 124
Supported operating systems, page 125
Preinstallation requirements, page 125
Installing and configuring Java Method Server in HA mode, page 125
Viewing and modifying JMS instances, page 132

Overview
Content Server and Java Method Server (JMS) each support high-availability (HA). Content Server
supports two HA types: failover and load balancing. JMS supports failover only.
Failover
In a failover setup, if one of the Content Servers fails, the other Content Servers in the failover
setup continue with the service.
Load balancing
Load balancing involves operating redundant Content Servers where the service load is balanced
between Content Servers to maximize performance. In a standard Content Server load-balancing
scenario, proximity values are used to determine which Content Server processes an item. In a
cluster scenario, third-party load-balancers are used.
JMS is a customized version of an application server for executing Content Server Java methods. EMC
Documentum provides a servlet called DO_METHOD to execute Documentum server methods.
The method server itself is a Java-based web application. It communicates with the Content Server
via HTTP calls. Each time a method is invoked, the Content Server makes an HTTP request passing
the name of the Java class which implements the method along with any specified arguments to a
servlet which knows how to execute the specified method.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

119

Installing Content Server and Java Method Server for High-Availability

Technically, all EMC Documentum Java server methods are simple Java classes. JMS runs as an
independent process. You can stop or start the process without recycling Content Server. On
Windows platforms, the JMS can be run as a Windows service or as a process.
Before JMS can support HA, Content Server must be in a standalone HA configuration first.
You can also install additional private JMS instances. Before you can install additional JMS instances,
you must package all the web applications previously deployed to the default embedded JBoss
application server with the jmsPackage.bat batch file. You then deploy that file to the new JMS to
maintain consistency between the two JMS instances.
Additionally:
The default Java Method Server for a remote Content Server (RCS) does not participate in JMS
failover.
A JMS node must be bound to a Content Server host and cannot be installed on a stand-alone
independent machine.
JMS load balancing is not supported. A single Content Server cannot be explicitly associated to
multiple Java method servers.

Content Server HA configuration


The following figure depicts a fully redundant HA system, including Content Server, connection
brokers, JMS, full-text indexing system, and applications serving multiple repositories with a
third-party cluster load balancer. Third-party load balancers are only supported on clusters, not on
standard Content Server HA. The figure illustrates an HA system built on the EMC Documentum
platform. Each box in the diagram indicates a system component that can be installed on its own
host. Dotted lines in the diagram indicate those system components (application servers, content
stores, database and database stores) for which third party products provide HA through clustering.
HA for the rest of the components is provided through EMC Documentum processes. The following
figure shows Content Server HA in the form of clusters using third-party load balancer.
Figure 3. Content Server and Repository High Availability

If a repository serves many users, having multiple servers can provide HA and enhance performance.
You can also dedicate one server to a particular application or group of users and have other servers

120

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server and Java Method Server for High-Availability

available to everyone. High availability provides those options. The servers used for load balancing
must project identical proximity values to any given connection broker. In that way, when a DFC
client determines which server, it will randomly pick one of the servers. If the values are different, the
DFC client will always choose the server with the lowest proximity value. If a Content Server stops
and additional servers are running against the repository with proximity values less than 9000, the
client library, with a few exceptions, will gracefully reconnect any sessions that were connected to
the stopped server to one of those servers. The exceptions are:
If the client application is processing a collection when the disconnection occurs, the collection is
closed and must be regenerated again when the connection is reestablished
If a content transfer is occurring between the client and server, the content transfer must be
restarted from the beginning
If the client had an open explicit transaction when the disconnection occurred, the transaction was
rolled back and must be restarted from the beginning
If the additional servers known to a sessions connection broker do not have the same proximity
value, the client library will choose the next closest server for failover. Sessions cannot failover to
a Content Server whose proximity is 9000 or greater. Content Servers with proximity values set
9000 or higher are called remote Content Servers, usually located at remote, distributed sites.
Note: A client session can only fail over to servers that are known to the connection broker used by
that session. To ensure proper failover, make sure that Content Servers project to the appropriate
connection brokers and with appropriate proximity values.

JMS HA configurations
JMS supports the following HA configurations:
Content Server and JMS on a single host
Content Server and JMS on two hosts
Content Server and JMS on multiple hosts
Content Server HA deployment involves two or more Content Servers. JMS HA involves adding
JMSs to additional Content Servers such that each Content Server has a dedicated JMS. JMS HA is
automatically enabled by associating each Content Server with their dedicated JMS.

Content Server and JMS on a single host


The following figure depicts two Content Servers and their embedded instances of JMS set up on a
single machine, serving one repository.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

121

Installing Content Server and Java Method Server for High-Availability

Figure 4. Content Server and JMS HA on a single host

When installing the first Content Server, JMS is installed by default. When adding a Content Server
on same host, the JMS for the second Content Server is not installed. Instead is shares the JMS of the
first Content Server.

Content Server and JMS on two hosts


The following figure depicts two Content Servers and two instances of JMS set up on two machines,
serving one repository. In this configuration all jms_config objects are automatically configured
for HA.

122

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server and Java Method Server for High-Availability

Figure 5. Content Server and JMS HA on two hosts

Content Server and JMS on multiple hosts


The following figure depicts multiple Content Servers and multiple instances of JMS set up on
multiple machines, serving one repository. In this configuration, during failover, JMS requests are
distributed in a round-robin fashion to the remaining failover nodes.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

123

Installing Content Server and Java Method Server for High-Availability

Figure 6. Content Server and JMS HA on multiple hosts

Choosing an HA configuration
Choose an HA configuration based on available hardware and your business needs.

Benefits and best use


An HA solution provides both HA and enhanced performance. Use it when the system availability is
critical or Content Server performance is important or both.

Considerations
If the performance bottleneck is somewhere other than on Content Server, for example, in disk access
or WDK applications, adding more Content Servers will not improve performance significantly. If
you are using full-text indexing and need to improve search performance, start with an investigation
on the full-text components.

124

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server and Java Method Server for High-Availability

Performance
The high availability solution improves performance in general. A load-balancing HA model can
improve performance and availability, but it might require additional resources. A failover HA
model enhances availability.

Tip
The EMC Documentum System Sizing Tool dynamically generates estimates of your hardware
resource requirements based on your user and hardware profile. You can download the EMC
Documentum System Sizing Tool from the Powerlink site (http://powerlink.EMC.com).

Supported operating systems


Content Server and JMS HA is supported on all operating systems that Content Server supports.
See the EMC Documentum Content Server Enterprise Edition Release Notes for details on supported
operating systems.
Installation and configuration tasks for each operating system differ only in how the shared folder is
set up and the location of the installation files. For example, under UNIX and Linux, the jmsTools
folder is located under $DOCUMENTUM_SHARED/jmsTools, while on Windows it is located under
$DOCUMENTUM/jmsTools). The installation and configuration procedures that follow are based
on a Windows installation.

Preinstallation requirements
Before you install and configure Content Servers and repositories, read the following chapter of
this guide:
Chapter 2, Preparing the Host for Content Server Installation
Chapter 3, Preparing the Database for Content Server Installation

Installing and configuring Java Method Server


in HA mode
This section details how to install and configure JMS in HA mode.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

125

Installing Content Server and Java Method Server for High-Availability

Installing and configuring JMS for HA on a single host


Installing and configuring JMS HA involves several major steps:
Installing and configuring the main Content Server
Adding secondary Content Servers
Preparing JMS for HA and verifying the dm_jms_config objects setup
Adding additional JMS
Verifying the JMS HA installation and configuration
The following graphic shows an upgrade from a single JMS connected to two Content Servers on a
single host supporting one repository to two JMS instances each connected to its own Content Server,
both Content Servers on a single host supporting one repository.
Figure 7. Installing and configuring JMS for HA on a single host

To install and configure the main Content Server:


1.

Follow the instructions in Chapter 4, Pre-Installation Checklist to install the main Content Server.

2.

After the installation completes, run the Content Server configuration program following the
instructions in Chapter 4, Pre-Installation Checklist. The Content Server Configuration program
guides you through creating a repository.
The installation of the main Content Server also installs an instance of JMS. A single
dm_jms_config object for that instance of JMS is created in the repository.

126

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server and Java Method Server for High-Availability

To add secondary Content Servers:


1.

Run the cfsConfigurationProgram.exe program. On Windows, this program is located in the


/Documentum/product/6.7/install directory. On UNIX and Linux, this program is located in
the $DM_HOME/install directory.

2.

Provide the appropriate information when prompted to do so by the program.

3.

When you are being prompted for the service name, choose a service name that is different from
that of the primary Content Server.

To prepare the JMS for HA and to verify the dm_jms_config objects setup:
By default the CFS configuration program would install Content Server as a remote Content
Server (RCS) and set its projection to the connection broker to have proximity values of 9001 and
9010. However, JMS HA at present does not support RCS configurations, so you need to make the
following changes manually:
1.

Locate the server.ini file. This file is typically located in /Documentum/dba/config/<repository_


name>/server_<machine_name>_<service_name>.ini.

2.

Modify the DOCBROKER_PROJECTION_TARGET for a single host setting: Comment out the
second set of settings, and the proximity value of the first set. The default proximity value will
then be 1. For example:
[DOCBROKER_PROJECTION_TARGET]
host = cshost1
port = 1489
#proximity=9001
[DOCBROKER_PROJECTION_TARGET_1]
#host =
#port =
#proximity =
#host=cshost1
#port=1489
#proximity=9010

3.

Restart Content Server

4.

Use Documentum Administrator to disassociate CS2 from JMS 1.

To add Java Method Servers on Windows hosts:


Before you can add JMS instances, you must package all the web applications previously deployed to
the default embedded JBoss application server with the jmsPackager.bat batch file.
1.

Run the jmsPackager.bat file located in /DOCUMENTUM/jmsTools/bin/jmsPackager.bat. When


the packager completes you will be prompted to enter any key to continue to the JMS installation.

2.

To add an instance of JMS, navigate to /DOCUMENTUM/jmsTools/bin and click jmsconfig.exe to


start the installation wizard. The Welcome dialog box appears.

3.

Read the Welcome dialog box, which lists the products to be installed, and click Next.
The software license agreement appears.

4.

Read the license agreement.

5.

To continue, click I accept the terms of the license agreement and click Next.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

127

Installing Content Server and Java Method Server for High-Availability

If you do not accept the license agreement terms, the Next button becomes unavailable, and
you cannot continue with the JMS addition.
6.

Select Create Instance and click Next.

7.

Type a name for the JMS instance and click Next.

8.

Type the admin user password and the listen port for the application server and click Next.

9.

Type the installation owner password and click Next.

10. Type the fully qualified domain name (FQDN) and click Next.
11. Type the primary installation owner user name and password, and click Next. The wizard
now deploys the web application package.
12. Click Finish to complete the addition of the JMS instance.
13. Use Documentum Administator to associate the second Content Server to the second JMS
instance.

To add Java Method Servers on UNIX and Linux hosts:


Before you can add JMS instances, you must package all the web applications previously deployed to
the default embedded JBoss application server with the jmsPackager.sh file.
1.

Run the jms.Packager.sh file located in $DOCUMENTUM_SHARED\jmsTools\bin\jmsPackager.


sh. When the packager completes you will be prompted to enter any key to continue to the
JMS installation.

2.

To add an instance of JMS, navigate to $DOCUMENTUM_SHARED\jmsTools\bin and


click$DOCUMENTUM_SHARED/jmsTools/bin/jmsconfig.sh to start the installation wizard.
The Welcome dialog box appears.

3.

Read the Welcome dialog box, which lists the products to be installed, and click Next.
The software license agreement appears.

4.

Read the license agreement.

5.

To continue, click I accept the terms of the license agreement and click Next.
If you do not accept the license agreement terms, the Next button becomes unavailable, and
you cannot continue with the JMS addition.

6.

Select Create Instance and click Next.

7.

Type a name for the JMS instance and click Next.

8.

Type the admin user password and the listen port for the application server and click Next.

9.

Type the installation owner password and click Next.

10. Type the fully qualified domain name (FQDN) and click Next.
11. Type the primary installation owner user name and password, and click Next. The wizard
now deploys the web application package.
12. Click Finish to complete the addition of the JMS instance.
13. Use Documentum Administator to associate the second Content Server to the second JMS
instance.

128

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server and Java Method Server for High-Availability

Installing and configuring JMS for HA on multiple hosts


Installing and configuring JMS HA involves several major steps:
Installing and configuring the main Content Server
Adding Content Servers
Preparing JMS for HA and verifying the dm_jms_config objects setup
Adding additional JMS
Verifying the JMS HA installation and configuration
The following graphic shows an upgrade from two embedded JMS instances, each connected to its
own Content Server on a two hosts supporting one repository to two JMS instances set up for HA
with Content Servers on two hosts supporting one repository.
Figure 8. JMS instances configured for HA on two hosts

The following graphic shows an upgrade from multiple embedded JMS instances, each connected to
its own Content Server on multiple hosts supporting one repository to multiple JMS instances set up
for HA with Content Servers on multiple hosts supporting one repository.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

129

Installing Content Server and Java Method Server for High-Availability

Figure 9. JMS instances configured for HA on multiple hosts

To install and configure the main Content Server:


1.

Follow the instructions in Chapter 4, Pre-Installation Checklist to install the main Content Server.

2.

After the installation completes, run the Content Server configuration program following the
instructions in Chapter 4, Pre-Installation Checklist. The Content Server Configuration program
guides you through creating a repository.
The installation of the main Content Server also installs an instance of JMS.

To add Content Servers:


1.

On multiple hosts, you need to run the install program to extract all required files for each host.

2.

Run the cfsConfigurationProgram.exe program. On Windows, this program is located in the


/DOCUMENTUM/product/6.7/install directory. ON UNIX and Linux, this program is located in
the $DM_HOME/install directory.

130

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server and Java Method Server for High-Availability

3.

Provide the appropriate information when prompted to do so by the program.

4.

When you are being prompted for the service name, EMC recommends to choose a service
name that is different from that of the primary Content Server. See chapter 9 of this guide for
more details.

To prepare the JMS for HA and to verify the dm_jms_config objects setup:
By default the configuration program would install Content Server as a remote Content Server (RCS)
and set its projection to the connection broker to have proximity values of 9001 and 9010. However,
JMS HA at present does not support RCS configurations, so you need to make the following changes
manually:
1.

Locate the server.ini file. This file is typically located in /Documentum/dba/config/<repository_


name>/server_<machine_name>_<service_name>.ini.

2.

Modify the DOCBROKER_PROJECTION_TARGET for a single host setting: Comment out the
second set of settings, and the proximity value of the first set. The default proximity value will
then be 1. For example:
[DOCBROKER_PROJECTION_TARGET]
host = cshost1
port = 1489
#proximity=9001
[DOCBROKER_PROJECTION_TARGET_1]
#host =
#port =
#proximity =
#host=cshost1
#port=1489
#proximity=9010

3.

Restart Content Server

4.

To verify that the dm_jms_config objects in the repository were set up correctly, use the JMS
Admin panel in Documentum Administrator.
There will be two dm_jms_config objects.

5.

Use the Documentum Administrator to associate the second JMS with the second Content Server.

Time synchronization between remote JMS


hosts and Content Server hosts
You must synchronize the date and time between the remote host and the Content Server host, or you
will not be able to authenticate connections between them. To do so you can do one of the following:
Set the Content Server host and the remote host system date/time to the same values.
Add the environment variable: CLIENT_AUTH_SIG_THRESHOLD to the start logic for the
remote JMS. Set this environment variable to the number of allowable seconds that the JMS
date/time may differ from the Content Server date/time. The default value, if the environment
variable is not set, is 1800 seconds (30 minutes).

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

131

Installing Content Server and Java Method Server for High-Availability

Viewing and modifying JMS instances


Use Documentum Administrator to perform the following JMS configuration tasks:
Viewing and updating JMS instances. Updating JMS instances is limited to associating and
disassociating JMS instances to and from Content Servers.
Associating additional Content Servers with JMS instances
Reset Content Server memory cache about JMS availability
View Content Server cache memory about JMS availability
Refer to the EMC Documentum Administrator User Guide for details on how to perform these tasks.

132

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 15
Installing Content Server with Microsoft
Cluster Services

This chapter describes how to install and configure Content Server to provide failover support under
Microsoft Cluster Services. Content Server supports Microsoft Cluster Services 2008. This chapter
contains the following information:
Preinstallation requirements, page 136
Overview, page 133
Choosing a configuration, page 134
Configuring an active/passive cluster, page 137
Creating additional cluster resources on Microsoft Cluster Services 2008, page 144
Configuring an active/active cluster, page 146
Upgrading Content Server installed with Cluster Services, page 148

Overview
Microsoft Cluster Services supports the following forms of clustering:
Active/passive clusters
In active/passive clustering, the cluster includes active nodes and passive nodes. The passive
nodes are on standby and are only used if an active node fails. In active/passive clusters, both
nodes support the same repository.
Active/active clusters
In active/active clusters, all nodes are active. One node is considered the primary node, and the
other node is considered the secondary node. If one node fails or is taken offline, the remaining
node takes on the additional processing operations. In active/active clusters, each node supports a
different repository.
In a cluster environment, every service that the cluster runs uses resources of the cluster node. Every
service has its own resources, such as hard drive, IP address, and network name, assigned to it. All
resources that a clustered service uses form a resource group. The connection broker and Content
Server are a part of this resource group. In a cluster, all resources form a virtual server that can move
from one physical server to another to provide failover support.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

133

Installing Content Server with Microsoft Cluster Services

Choosing a configuration
A Content Server installation supports two types of cluster service configurations:
active/passive
active/active
This chapter provides detailed installation instructions for both configurations. Choose the
configuration based on available hardware and your organizations business needs. Figure 10, page
135 illustrates Content Server and connection broker setup in an active/passive cluster.

134

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

Figure 10. Active/passive cluster

In an active/passive configuration, both nodes support the same repository. Content Server and
connection broker run on the primary node. If the primary node fails, the secondary node that was on
standby takes ownership of the resource group. After the cluster resources are brought online on the
secondary node, the connection broker and Content Server start on the secondary mode.
In an active/active configuration, each node supports a different repository. Each node is considered
the standby to the other node. Each node owns its own resource group. Each resource group has
its own virtual IP address, a virtual hostname, shared disk, connection broker, and Content Server.
Figure 11, page 136 illustrates Content Server and connection broker setup in an active/active cluster.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

135

Installing Content Server with Microsoft Cluster Services

Figure 11. Active/active cluster

If a node fails or is taken offline, its resource group is moved to the remaining node in the cluster.
The remaining node then manages two resource groups. When the failed node is running again, the
cluster administrator can move one resource group back.

Preinstallation requirements
Before you install and configure Content Server and a repository under Microsoft Cluster Services,
read Chapter 2, Preparing the Host for Content Server Installation, and perform the preinstallation
tasks described there. Complete the checklist in Installation and configuration checklist, page 55.

136

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

Whether you are configuring an active/passive cluster or an active/active cluster, set up the shared
disks to be used by the repositories. Ensure that the shared disks include a directory to use for
content storage.
If you are configuring an active/active cluster, the user who configures Microsoft Cluster Services
must have read and write permissions on both nodes on the directories where the connection broker
logs reside.
Note: Fulltext indexing is not supported in installations that use Cluster Services.

Configuring an active/passive cluster


Follow these procedures to configure an active/passive cluster and install servers and a Content
Server. Complete all procedures in the sections that follow in the order in which they are listed:
Creating the cluster resource group, page 137
Installing Content Server software on the nodes, page 138
Configuring Content Server, page 138
Configuring the connection brokers, page 143
Verifying failover, page 145
Note: When setting up an active/passive cluster in a Windows cluster environment, configuration
of a repository on the second cluster node can fail if you are using different aek.key files and
dbpassword.txt files for each node. In active/passive cluster configuration, both the primary
and secondary node must have the same aek.key file (located in \Documentum\dba\secure)
and dbpasswd.txt (located in \Documentum\dba\config\docbase_name). When creating the
environment manually copy the two files from the primary node to the secondary node.

Creating the cluster resource group


Use this procedure to set up the cluster resource group.

To create the cluster resource group:


1.

Use the MSCS Cluster Administrator utility to create a cluster resource group that contains the
following resources:
A virtual IP address
Content Server uses this IP address. Other products can share the IP address because the
connection broker and Content Server only listen on particular ports.
A virtual network hostname
The virtual network hostname is for the virtual IP address.
A shared disk partition
This is the location of the repository data directory, where content files are located.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

137

Installing Content Server with Microsoft Cluster Services

2.

Move the resource group between the primary and standby hosts to ensure that the virtual IP
address, virtual network hostname, and shared disk partition fail over properly.
a.

In the Cluster Administrator, right-click the cluster group name.

b. Click Move Group.


The resource group is toggled between the hosts and the owner name changes.
3.

Ensure that the first node owns the resource cluster group.

Installing Content Server software on the nodes


The first part of the installation process copies files from the installation media to the hard disk. On
each of the two nodes, copy the files from the installation media to create a Content Server installation
on each node. Use the same drive letter on each node for the installation.

Configuring Content Server


The second part of the installation involves configuring Content Server and its associated connection
broker, which includes configuring them for Microsoft Cluster Services.

To configure Content Server


1.

Start the Content Server configuration program.


Log in to Windows as the installation owner, navigate to the DM_HOME\install directory, and
launch Server_Configuration_Program.exe.
The Welcome dialog box appears.

2.

Click Next.

3.

Type the password for the installation owner and click Next.
The dialog box shows the username and domain for the currently logged-in user, who must be
the installation owner. When you click Next, the installation program validates the password.

4.

If you did not enable Trusted Content Services during installation, optionally select the check box
and type the Trusted Content Services license key and click Next.

5.

If you did not enable Content Services for EMC Centera during installation, optionally select the
check box and type the license key and click Next.

6.

Click Custom Configuration and click Next.

7.

Select to configure a connection broker and a repository, and click Next.

8.

Configure a connection broker on the Content Server host.


a.

Choose Create a new connection broker and click Next.

b. Type a connection broker name (default: Docbroker) and the port number on which the
connection broker listens, or accept the defaults. The default port is 1489. If you are using the
default port number, ensure that the next port number (1490) is available for use because
the connection broker requires that two ports be reserved.

138

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

c.

Click Automatic to have the connection broker automatically start when the host starts, or
click Manual for manual startup.

d. Click Next. The connection broker is started.


Note: Do not configure additional connection brokers on this host.

9.

e.

Click Next.

f.

To continue to configuring a repository, select Continue with server configuration and


click Next.

Select Create a repository and click Next.


a.

To enable Content Storage Services in the repository, select the check box, type the license
key, and click Next.

b. To enable Retention Policy Services in the repository, select the check box, type the license
key, and click Next.
c.

To enable Federated Records Services in the repository, select the check box, type the license
key, and click Next.

d. To enable Records Manager in the repository, select the check box, type the license key,
and click Next.
e.

To enable Physical Records Manager in the repository, select the check box, type the license
key, and click Next.
The Data Directory dialog box appears.

f.

Click Next to accept the default data directory location or browse for a new location.
The data directory is the location where content files are stored. Do not choose a directory
that is used by another repository for content file storage or any other purpose.

g. Click Next to accept the default share directory location or browse for a new location.
The share directory is where client products, sample code, and libraries are stored.
Note: The share directory is not the same as the $DOCUMENTUM_SHARED environment
variable. This environment variable sets the directory into which EMC Documentum
Foundation Classes and other components are installed.
h. Type the directory where the database client software is installed and click Next. If the
configuration program cannot locate the database client software required to connect to the
database, it asks you to identify the directory that contains the software.
i.

Type the name of the repository. Name and ID to assign to the repository, page 19 contains
information about repository name requirements.
Note: If you are installing on the second node, use the same repository name you used for
the first node.

j.

Type the repository ID. Name and ID to assign to the repository, page 19 contains information
about repository ID requirements.
Note: If you are installing on the second node, use the same repository ID you used for
the first node.

k. Type a description for the repository.


l.

Select the repository size.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

139

Installing Content Server with Microsoft Cluster Services

m. Select the authentication domain.


n. Indicate whether Content server starts automatically or manually. Check Automatic to
start Content Server automatically when the host starts or Manual to start Content Server
manually.
o.

Click Next.

10. Type connection broker connection information for the connection broker to which you want
the repository to broadcast its connection information. Express configuration broadcasts to
the default local connection broker
a.

Type the connection broker port number.


The port number is the port where the connection broker listens. The fault port number is
1489. If you are using the default port number, ensure that the next port number (1490) is
available for use because the connection broker requires that two ports be reserved.

b. Type the connection broker hostname and click Next.


c.

Click Test connection broker to test the connection broker.

11. Select the mode in which client applications connect to the repository.
Select Native for unsecure connections.
Select Secure for secure connections.
Select Native and Secure if clients can use either connection mode.
12. Click Next.
13. If you are installing on the first node, select Create a new database user account, then provide
database information.
a.

Choose the correct database connection for your database instance from the drop-down list.

b. Type the database users name.


This user becomes the repository owner, and must have the privileges identified in
Repository owner account, page 41.
c.

Type the database users password and confirm the password.

d. Type the database administrators username and password.


e.

Click Next.

f.

Accept the default paths and sizes for database storage or change them and click Next.

g. Edit or accept the default database scripts.


To edit the tablespace or database creation or deletion script, select the script and click
Edit Script. When you have saved the file, click Next.
To accept the default scripts and run them, click Next.
The new tablespaces or databases are created.
14. If you are configuring the second node, chose Use an existing database account and provide
database information.
a.

Choose the correct database connection for the database instance from the drop-down list.

b. Type the database users name.

140

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

Use the account you created for the first node. This user is the repository owner.
c.

Type the database users password.

d. Click Next.
e.

Choose the correct index tablespace or datafile name.

f.

Click Next.

15. If you are installing on the first node, accept or modify Content Server initialization values.
Express configuration uses the default initialization file. The server.ini file contains Content
Server initialization information. If you are installing on DB2 or Oracle and you want to
modify the database parameters for the repository tables, edit the server.ini file during this
step. You cannot change these parameters after Content Server creates the database tables for
the repository. Appendix E, Defining Oracle or DB2 Database Parameters for Repository Tables
contains descriptions of the DB2 and Oracle parameters for repository tables.
To accept the files, click Next.
To edit the server.ini file, select the Server Initialization File and click Edit . After you have
edited and saved the file, click Next.
16. If you are installing on the second node, perform the following steps:
a) Select the Server Initialization File, click Edit server.ini file, set the following parameters,
and save it:
[DOCBROKER_PROJECTION_TARGET]
host = <MachineB>
port = 1489
[DOCBROKER_PROJECTION_TARGET_1]
host = <MachineB>
port = 1489
proximity = 200

b) Copy the aek.key (from Documentum\dba\secure) and dbpasswd.txt (from


Documentum\dba\config\<repository_name>) from the primary node to the secondary node.
c) Click Next.
17. If you are installing on the first node, provide the SMTP server information. The SMTP server is
used to send email notifications to the installation owner and repository users.
a) Type the name or IP address of a computer on the network that hosts an SMTP server. The
computer can be a remote host or the computer that hosts Content Server. All UNIX operating
systems and Windows 2000 Server include an SMTP server.
Type the installation owners email address.
Click Next.
18. If you are installing on the second node, click Cancel and exit the installation program.
19. Decide whether to designate the current repository as a global registry.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

141

Installing Content Server with Microsoft Cluster Services

Repository to use as the global registry, page 23 contains details on determining which repository
to designate as the global registry.
To use the current repository as a global registry, select Use this Repository and click Next.
To use a different repository as the global registry repository, select Specify a Different
Repository and click Next
To designate the global registry repository at a different time, select Do Later and click Next.
20. Type the connection information for the global registry.
If you chose the current repository as a global registry, type a username and password for the
global registry user and click Next. The default username is dm_bof_registry.
If you chose to use a different repository as a global registry, type the repository name and
the global registry users username and password. The repository must be known to the
connection broker.
If you chose Do Later, the global registry connection page does not appear.
A warning message to enable the global registry connection appears. Click CONTINUE.
21. Accept or modify the repository configuration scripts. Express configuration runs the scripts
without modification.
Appendix B, Content Server Installation Directories and Repository Configuration Scripts
contains information on what each of the scripts does.
To accept the scripts, click Next.
To edit a script, select it and click Edit. After you edit and save all the scripts you are
modifying, click Next.
Caution: Use caution in editing the scripts. Errors in the scripts can cause problems in
the repository.
When you click Next, the repository configuration scripts run, and the bundled DARs are also
installed. A message appears when these tasks are completed.
22. Click Next.
23. Choose whether to restart Content Server to enable SSL client connections.
To enable SSL client connections, click Restart repository now and click Next.
Content Server stops and is restarted.
To restart Content Server at a different time, click Restart repository later and click Next.
24. If you are installing on the first node, select Repository Headstart and click Edit Script.
25. Modify the Repository Headstart script to point to the location object of the shared drive on
which the repository resides.
a.

Locate these lines:


status=dmAPISet("set,c,l,file_system_path", dataHome &
Basic.PathSeparator$ _ & docbaseNameOnly &
Basic.PathSeparator$ & "content_storage_01")

Modify the Repository Headstart script to point to the location object of the shared drive:

142

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

drive_letter:\documentum\data\repositoryname\content_storage_01

where drive_letter is the shared drive where the repository data directory resides and
repositoryname is the name of the repository.
b. Change them to:
status=dmAPISet("set,c,l,file_system_path",
"drive_letter:\documentum\data\
repositoryname\content_storage_01")

drive_letter is the shared drive where the repository data directory resides.
repositoryname is the name of the repository.
Example:
E:\documentum\data\repository1\content_storage_01

26. Run the default scripts unless you are familiar with the internal configuration of Content Server.
To run the default repository configuration scripts, click Next.
To edit additional repository configuration scripts, select the script and click Edit. Click Next
after you edit and save any of the scripts.
The scripts run and the repository is configured.
27. Click Finish.
28. Once you have finished setting up the two nodes against the cluster, confirm the virtual host name.
29. Disable clustering by changing the host name of one of the nodes to the virtual host name.
30. Confirm that the connection broker and Content Server launch correctly with the fix.
31. Change nodes virtual host name back to the original host name, and verify that it launches
correctly.
32. Repeat step 31, step 32 and step 34 until all nodes have new tickets.
33. Shut down Content Server and the connection broker.
34. Move the cluster group to the second node.
35. Use the instructions in Installing Content Server software on the nodes, page 138, and
Configuring Content Server, page 138, to repeat the installation and configuration procedures
for the second node.
36. To start the application server instance that is running the Java method server and ACS server,
restart the Windows hosts after the installation is completed.

Configuring the connection brokers


You need to configure the connection brokers on both nodes to listen on the virtual network host.

To configure the connection brokers:


1.

Start Server Manager by clicking Start > Programs > Documentum > Documentum Server
Manager.

2.

Click Docbroker, then click Edit Service.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

143

Installing Content Server with Microsoft Cluster Services

3.

Add the following line to the service command:


-host virtual_network_host_name

For example, if the virtual network hostname is dmcluster1:


-host dmcluster1

4.

Click OK.

5.

Highlight repository and click Edit server.ini.

6.

Edit the DOCBROKER_PROJECTION_TARGET section of the server.ini file:


[DOCBROKER_PROJECTION_TARGET]
host=virtual_network_host_name

For example:
host = dmcluster1

7.

Save the server.ini file.

8.

Navigate to C:\Documentum\config and open the dfc.properties file in a text editor.

9.

Edit the primary connection broker entry of the dfc.properties file:


For example:
dfc.docbroker.host[0] = dmcluster1

10. Save the dfc.properties file.


11. Repeat this procedure on the other node.

Creating additional cluster resources on Microsoft


Cluster Services 2008
Use this procedure to create cluster resources for the connection broker and Content Server. Perform
the procedure only on the node that presently owns the existing resource group.

To configure the connection broker and repository for failover:


1.

Navigate to Start > Programs > Administrative Tools > Failover Cluster Management. The
Failover Cluster Management console is displayed.

2.

Right-click the Services and Applications node and select the Configure a Service or
Applicationoption. The High Availability Wizard is displayed.

3.

Select Generic Service to configure for high availability and click Next. The Select Service
screen is displayed.

4.

Select the Documentum Docbroker Service connection broker service from the list and click
Next. The Client Access Point screen is displayed.

5.
6.

144

In the Name field, specify the virtual host name.


Specify the IP address you want to assign in the text fields below the Networks and Address
columns, and click Next. The Select Storage screen is displayed.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

7.

Select the shared storage you want to assign to the specified service, and click Next. The
Replicate Registry Settings screen is displayed.

8.

Click Next. The Confirmation screen is displayed.

9.

Click Next. The Summary screen is displayed confirming that the High availability was
successfully configured for the service or application.

10. Click Finish. When the configuration is completed, the Services and Applications node lists the
new service you configured.
11. Right-click the new service, and select Properties. The Properties dialog box for the service is
displayed.
12. In the General tab, select NODE1 and NODE2 in the Preferred owners list.
13. Click OK.
14. Right-click the Documentum Docbroker Service connection broker service, and select Properties.
The Properties dialog box is displayed.
15. In the General tab, ensure that the Use Network Name for computer name option is selected
by default, and click OK.
16. Right-click the Documentum Docbroker Service connection broker service in the console, and
select the Bring this resource online option. The resource is brought online and the Online icon is
displayed in the Status column of the Summary screen.
17. Right-click the configured service, select Add a resource > Generic Service. The New Resource
Wizard dialog box is displayed.
18. Select Documentum Docbase Service in the Select Service list of the Select Service screen.
19. Click Next. The Confirmation screen is displayed.
20. Click Next. The Summary screen is displayed confirming that the High availability was
successfully configured for the service or application.
21. Click Finish. The Documentum Docbase Service is added to the Other Resources list.
22. Right-click the Documentum Docbase Servicein the Summary screen, and select Properties. The
Properties dialog box for the service is displayed.
23. In the Dependencies tab, add the Documentum Docbroker Service.
24. In the General tab, ensure that the Use Network Name for computer name option is selected, and
click OK.
25. Right-click the Documentum Docbase Service in the Summary screen console, and select
the Bring this resource online option. The resource is brought online and the Online icon is
displayed in the Status column of the Summary screen.

Verifying failover
After you complete the preceding procedures, verify that failover works properly.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

145

Installing Content Server with Microsoft Cluster Services

To verify failover:
1.

On a client computer, ensure that the dfc.properties entries refer to the virtual network hostname
or virtual IP address.

2.

Connect to the repository from the client computer.

3.

Start the Cluster Administrator utility.

4.

Move the resource group from the node where it is running to the other node.

5.

After the resource group comes online on the other node, verify that the client can run queries.

Configuring an active/active cluster


In an active/active cluster, each node initially has its own repository and Content Server. You create
two cluster resource groups, and each node owns one. If a Content Server fails on one node, a second
Content Server starts on the second node to keep the repository on the first node running.
Each cluster resource group has the following:
virtual IP address
virtual network hostname
one shared disk drive (where the repository resides)
one connection broker
one Content Server
To configure an active/active cluster, complete the procedures in the following sections in the order in
which they are listed:
Creating the first cluster resource group, page 146
Installing Content Server software on the hosts, page 147
Configuring Content Server on the first and second nodes, page 147
Configuring the second cluster resource group, page 147
Modifying server.ini and dfc.properties, page 147
Verifying failover, page 148

Creating the first cluster resource group


Create the first cluster resource group by following the instructions in Creating the cluster resource
group, page 137.

146

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

Installing Content Server software on the hosts


On each of the two nodes, copy the files from the installation media to create an Content Server
installation on each node. Chapter 6, Installing Content Server software on a Windows host contains
instructions.
Note: Use the same drive letter on each node.

Configuring Content Server on the first and second


nodes
In an active/active configuration configure a Content Server on each of the two nodes. The procedure
for configuring Content Server in an active/active cluster is the same as configuring Content server in
an active/passive cluster. Follow the instructions in Configuring Content Server, page 138 on the first
and the second node in the cluster.

Configuring the second cluster resource group


Create the second cluster resource group by following the instructions in Creating the cluster
resource group, page 137.

Modifying server.ini and dfc.properties


You might want to edit server.ini and dfc.properties on both nodes to ensure that each repository
projects to the connection brokers on the two nodes.
In the following examples, assume that the virtual network hosts for the two cluster resource groups
are called dmcluster1 and dmcluster2. It does not matter which cluster resource group is primary
and which is backup.
Edit all four of the server.ini files so that they read as follows:
[DOCBROKER_PROJECTION_TARGET]
host=dmcluster1
[DOCBROKER_PROJECTION_TARGET_1]
host=dmcluster2

Edit the two dfc.properties files so that they read as follows:


dfc.docbroker.host[0]=dmcluster1
dfc.docbroker.host[1]=dmcluster2

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

147

Installing Content Server with Microsoft Cluster Services

Configuring the connection broker and repository for


failover
The procedure for configuring the connection broker and repository for failover in an active/active
cluster is the same as configuring them in an active/passive cluster. But the configuration for failover
needs to be done separately for each of the two repository services binding them with their respective
dependant resources. The section, Configuring Content Server, page 138, has the procedure for
configuring the connection broker and repository for failover in an active/passive cluster.

Verifying failover
After you complete the preceding procedures, verify that failover works properly.

To verify failover:
1.

On a client computer, ensure that the dfc.properties entries refer to both virtual network
hostname or virtual IP address.

2.

Connect to both repositories from the client computer.

3.

Start the Cluster Administrator utility.

4.

Move the two resource groups back and forth between the nodes.

5.

After a resource group comes online on a new node, verify that the client can run queries.

Upgrading Content Server installed with


Cluster Services
Use the following general procedure to upgrade Content Server installed with Microsoft Cluster
Services. This procedure applies to upgrades on active/passive, active/active, single-repository,
and multirepository configurations.

To upgrade an active/passive, single-repository cluster:


1.

Shut down the Content Servers on both nodes.


This shuts down the repository.

2.

Shut down both hosts.

3.

Restart the first node.


Do not restart the Content Server on the first node.

4.

On the first node, upgrade Content Server software.


Use the instructions in Upgrading the Content Server software, page 94.

5.

Upgrade and configure the repository and connection broker.

6.

Open the Services dialog box and verify that the application server was created correctly.

148

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Installing Content Server with Microsoft Cluster Services

If the Documentum Java method server is started, it was created correctly.


7.

Test the repository to verify that it is functioning correctly.

8.

Shut down the repository on the first node.

9.

Shut down the first node.

10. Start the second node.


11. Start the connection broker on the second node.
12. Upgrade Content Server software on the second node.
Use the instructions in Upgrading the Content Server software, page 94.
13. Start the configuration program and select Custom Configuration.
14. Select Upgrade and the repository to upgrade.
15. When the configuration program reaches the panel on which scripts are run, click Cancel.
Do not run the scripts. The application server is created and the repository is upgraded.
16. To start the application server instance that is running the Java method server and ACS server,
restart the Windows hosts after the upgrade is completed.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

149

Installing Content Server with Microsoft Cluster Services

150

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 16
Configuring Multiple Content Servers
on a Single Host for a Particular
Repository

You can run multiple Content Servers on a single host against a particular repository. This chapter
provides instructions for creating such a configuration.
This chapter contains the following topics:
Windows hosts, page 151
UNIX hosts, page 153

Windows hosts
Use these instructions after a repository is configured to create additional servers for that repository
on the repository host. The EMC Documentum Content Server Administration and Configuration Guide
provides instructions on configuring additional servers for a repository on remote hosts

To configure additional servers on a Windows host:


1.

Connect to the repository as a superuser by using Documentum Administrator and create a new
server config object by saving the object with a new object name.
For example, if the existing server config object is called caruso, call the new server config
object caruso1.
In Documentum Administrator, navigate to Administration > Basic Configuration. From the File
menu, select Save As... and save the config object with a new name.

2.

Disconnect from the repository.

3.

Create a server.ini file for the new Content Server.


a.

On the Content Server host file system, navigate to the


%DOCUMENTUM%\dba\config\repository_name directory, where repository_name is the
name of the repository.

b. Create a copy of the server.ini file called server1.ini.


c.

Open the server1.ini and change the following lines:


service=caruso1

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

151

Configuring Multiple Content Servers on a Single Host for a Particular Repository

server_config_name=caruso1

These values must match the entries in the \Winnt\System32\drivers\etc\ file.


d. Save the server1.ini file.
4.

Navigate to the \Winnt\System32\drivers\etc\ and open the services file in a text editor.

5.

Assign port numbers to the new Content Server.


For example, if these entries exist for the primary Content Server
dm_caruso 10000/tcp # repository service caruso
dm_caruso_s 10001/tcp # repository secure service

Add the following entries for the new Content Server:


dm_caruso1 10005/tcp # repository service caruso1
dm_caruso1_s 10006/tcp # repository secure service

6.

Save the services file.

7.

Create Windows registry entries for the new Content Server.


a.

Open the registry and back it up.

b. Navigate to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\.
c.

Locate the service key for the existing Content Server.

d. Use the Save Key menu to write out the key values for the existing Content Server service.
e.

Create a new key with a new name.

f.

Restore the key values you wrote out to the new key.

g. Change the ImagePath variable to include the path to the new server.ini file and a new log file.
For example, if the existing ImagePath is
d:\Documentum\product\6.5\bin\dmserver_v4.exe -repository_name
test1 -security acl -init_file
d:\Documentum\dba\config\test1\server.ini -run_as_service
-install_owner dmadmin -logfile
d:\Documentum\dba\log\test1.log

The new ImagePath would be:


d:\Documentum\product\6.5\bin\dmserver_v4.exe -repository_name
test1 -security acl -init_file
d:\Documentum\dba\config\test1\server1.ini -run_as_service
-install_owner dmadmin -logfile
d:\Documentum\dba\log\test1_1.log

The Windows documentation from Microsoft contains additional information on creating


a new service
8.

Set the new Content Server to manual start mode using Start > Programs > Administrative
Tools > Services panel.

9.

Restart the host.

10. Click Start > Programs > Administrative Tools > Services and start up the new Content Server.
11. Start IDQL and verify that the Content Server is running correctly:
$ IDQL caruso.caruso1 -Uusername -Ppassword

152

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Configuring Multiple Content Servers on a Single Host for a Particular Repository

UNIX hosts
Use these instructions after a repository is configured to create additional servers for that repository
on the repository host. The EMC Documentum Content Server Administration and Configuration Guide
provides instructions on configuring additional servers for a repository on remote hosts.
To create this configuration, edit the etc/services file, which requires root privileges.

To configure additional servers on a UNIX host:


1.

Connect to the repository as a superuser by using Documentum Administrator and create a new
server config object by saving the object with a new object name.
For example, if the existing server config object is called caruso, call the new server config
object caruso1.
In Documentum Administrator, navigate to Administration > Basic Configuration. From the File
menu, select Save As... and save the config object with a new name.

2.

Disconnect from the repository.

3.

Create a server.ini file for the new Content Server.


a.

On the Content Server host file system, navigate to the $DOCUMENTUM/dba/config/


repository_name directory, where repository_name is the name of the repository.

b. Create a copy of the server.ini file called server1.ini.


c.

Open the server1.ini file and change these parameters:


service=caruso1
server_config_name=caruso1

These values must match the entries in the /etc/services file.


d. Save the server1.ini file.
4.

Navigate to /etc/services and open the services file in a text editor.

5.

Assign port numbers to the new Content Server.


For example, if these entries exist for the primary Content Server
dm_caruso 10000/tcp # repository service caruso
dm_caruso_s 10001/tcp # repository secure service

Add the following entries for the new Content Server:


dm_caruso1 10005/tcp # repository service caruso1
dm_caruso1_s 10006/tcp # repository secure service

6.

Save the services file.

7.

Navigate to the $DOCUMENTUM/dba directory and make a copy of the Content Server startup
and shutdown scripts:
cp dm_start_caruso dm_start_caruso1
cp dm_shutdown_caruso dm_shutdown_caruso1

8.

Open the startup script in a text editor.

9.

Change
logfile=$logdir/caruso.log

to

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

153

Configuring Multiple Content Servers on a Single Host for a Particular Repository

logfile=$logdir/caruso1.log

10. Change
./documentum -repository_name caruso -security acl -init_file
/trout1/documentum/dba/config/caruso/server.ini $@ >> $logfile 2>&1 &

to
./documentum -repository_name caruso -security acl -init1\_file
/trout1/documentum/dba/config/caruso1/server1.ini $@ >> $logfile 2>&1 &

11. Open the shutdown script in a text editor.


12. Change
DM_PID=`./iapi caruso -U$DM_DMADMIN_USER -P -e << EOF
grep 'root_pid' | sed -e 's/ .*[: A-Za-z]//'

to
DM_PID=`./iapi caruso.caruso1 -U$DM_DMADMIN_USER -P -e << EOF
grep 'root_pid' | sed -e 's/ .*[: A-Za-z]//'

13. Change
./iapi caruso -U$DM_DMADMIN_USER -P -e << EOF

to
./iapi caruso.caruso1 -U$DM_DMADMIN_USER -P -e << EOF

14. Save the shutdown file.


15. Start both servers:
dm_start_caruso
dm_start_caruso1

16. Start IDQL and verify that the Content Server is running correctly:
$ IDQL caruso.caruso1 -Username -Password

17. Check the log file for the new Content Server in $DOCUMENTUM/dba/log/caruso1.log.

154

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Chapter 17
Creating a repository copy to test an
upgrade

This chapter contains the following topics:


Creating the test environment, page 155
Precopying tasks, page 156
Copying a repository, page 157

Creating the test environment


You cannot create copies of more than one repository in a single new installation if the repositories
were created in different installations.
Use the instructions for creating a repository copy on the same platform as the original repository.
The procedure is not supported for moving a repository from one platform to another.
Before upgrading a repository, create an environment in which to test the upgrade process. To do
this, create a new installation using the original Content Server software version, copy the repository,
and upgrade that copy. After the upgraded copy is tested, upgrade the original repository.
For example, if you are copying two repositories, Paris and London, that were created in separate
Content Server installations, you need to copy them to separate Content Server installations. Creating
a repository copy requires you to copy the aek.key and dbpasswd.txt files from the original repository
host to the repository copy host, because each repository copy must have access to the aek.key and
dbpasswd.txt files from its original installation.
If you are copying two repositories, Tokyo and Beijing, that were created in the same Content
Server installation, you can create their copies in the same new installation, with the aek.key and
dbpasswd.txt files from the original installation copied to the installation where you create the copies.
If you want to test operations involving the content files, copy the content files to the repository
copy as well.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

155

Creating a repository copy to test an upgrade

Precopying tasks
Before you create the repository copy, complete these tasks and note any appropriate values in
the Value column:
Table 11. Precopying tasks

Task

Resource

Value

Obtain the repository name.

Consult the
repository
administrator.

repository name: ____________

Obtain the repository ID from the


server.ini file.

Consult the
repository
administrator.

repository ID: ____________

Obtain the repository owners name


and password.

Consult the
repository
administrator.

repository owner: ____________

Create a database instance separate


from the database instance used by
the production repository.

Consult the DBA.

Obtain connection information for


the alternative database instance.

Consult the DBA


and database
documentation

Decide whether to copy the content


files.

Identify a target host on which to


create the repository copy
Obtain the system or administrator
username and password for the
database.
Note the drive on which the
production repository resides.

connection: ____________

target host: ____________


Consult the DBA.

admin user name: ____________

drive: ____________

Decide whether to create the copy


on the equivalent drive.
Decide whether to create the copy
on a drive equivalent to the drive
on which the production repository
resides. If the copy is on a different
drive, there are additional steps you
need to perform.

156

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Creating a repository copy to test an upgrade

Copying a repository
In the instructions that follow, the test repository is called the repository copy. The original repository
is called the production repository.
Caution: The instructions that follow assume that the production repository is running on the
network while the repository copy is tested. However, shut down the production repository or
take it off the network while you test the repository copy. Conflicts and data corruption can
result from having two repositories on the network with the same name and repository ID.

To copy a repository:
1.

Shut down the production repository.

2.

On the target host, create a new Content Server installation and repository (the repository copy)
of the same version number as the production repository.
Follow the instructions in the Chapter 4, Pre-Installation Checklist, for the Content Server
installation.
Note: When you create the repository copy, ensure that you use the same repository name,
repository ID, and repository owner name and password as the production repository.
When you create the repository copy, ensure that you use the same repository name,
repository ID, and repository owner name and password as the production repository.
Ensure that you use a different database instance from the instance used by the production
repository and that you provide the correct connection information when you install.
For example, under Oracle the tnsnames.ora on the host where the repository copy resides
must point to the Oracle instance used by the copy, not the instance used by the production
repository.
Ensure that the repository copy projects to a connection broker different from the connection
broker used by the production repository.
Copy the $DOCUMENTUM/dba/secure/aek.key dbpasswd.txt files from the original host to
the same location on the repository copy host.

3.

Apply to the repository copy any patches you applied to the production repository.

4.

Connect to the database instance serving the production repository.

5.

Use the database vendors tools to export all objects owned by the repository owner and export
the schema for the tables comprising the repository.
Contact the database vendor for any technical support you need to use the database tools.

6.

On the production repository hosts file system, create a backup of the $DOCUMENTUM/data/
repository_name directory. This is the directory containing the repositorys content files.

7.

Stop the repository copy.

8.

Connect as the database system administrator to the database instance that is serving the
repository copy. For example, on Oracle, connect as the System account.

9.

Destroy the existing tablespaces or database by using the dm_DeleteTableSpace.sql script in


$DOCUMENTUM/dba/config/repository_name/.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

157

Creating a repository copy to test an upgrade

The scripts are database-specific. Run the script using the tools provided by the database vendor.
10. Delete the physical database file from the file system.
The name and location of the physical file are in the dm_CreateTableSpace.sql script.
11. Create new tablespaces or databases for the repository copy by using the dm_CreateTableSpace.sql
script in $DOCUMENTUM/dba/config/repository_name/.
The scripts are database-specific. Run the script by using the tools provided by the database
vendor.
12. Import the database export taken from the production repository into the newly created
tablespaces or database.
13. Verify that the database tables have the correct value for the test system hostname by checking
the following values:
r_host_name and web_server_loc in dm_server_config_s
host_name in dm_mount_point_s
target_server in dm_job_s
projection_targets in dm_server_config_r
object_name in dm_acs_config_s
acs_base_url in dm_acs_config_r
14. Connect to the database that is serving the repository copy as the repository owner .
15. If any of the values in Step 13 are incorrect, use SQL Server to correct the values.
16. Set the server to rebuild the Documentum views with this SQL Server statement:
update dm_type_s set views_valid=0

17. If you are testing operations that require the content files, copy the content file backup from the
production repository to the file system of the repository copy.
18. Navigate to the DOCUMENTUM/dba/config/repository_name directory and open the server.ini
file in a text editor.
19. Ensure that the preserve_existing_types key in the SERVER_STARTUP section is set to TRUE:
preserve_existing_types=T

20. Save the server.ini file.


21. Start the Content Server for the repository copy.
22. Retrieve all the dm_jms_config objects from the repository copy and verify that the base_uri
attribute and projection_targets attribute are set correctly.
a.

Start IDQL and connect to the repository as the installation owner.

b. Run the following command to get a list of all dm_jms_config objects:


select * from dm_jms_config

c.

Run the following command to change each projection target:


update dm_jms_config objects set projection_targets[x]='new_target'
where r_object_id='object_id'

d. Run the following command to change each base URI:

158

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Creating a repository copy to test an upgrade

update dm_jms_config objects set base_uri[x]='new_base_uri'


where r_object_id='object_id'

e.

After making these changes, restart Content Server for the changes to take effect.

23. If you are testing the migration of a Web content management repository, modify the user objects
to reflect the new authentication domain.
a.

Start IDQL and connect to the repository as the installation owner.

b. Run the following commands:


update dm_user objects
set user_os_domain =new_machine_name
where user_os_domain =old_machine_name

c.

Disconnect from the repository and exit IDQL.

24. If the Content Server and content files of the copy reside on a drive different from the drive
used by the production repository, use IDQL to update the file_system_path attribute of the
dm_location and dm_mount_point objects to the new location:
update dm_location objects
set file_system_path='newpath' where file_system_path='old path'
update dm_mount_point objects
set file_system_path='newpath' where file_system_path='old path'

25. Deactivate all jobs by changing the is_inactive attribute on all job objects to TRUE.
26. Upgrade the repository copy to and verify the upgrade.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

159

Creating a repository copy to test an upgrade

160

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Appendix A
Required Environment Variables for
UNIX and Linux

This appendix lists the required environment variables for UNIX, Linux, and the databases.
If you are installing Content Server on UNIX or Linux, you need to set certain environment variables
in the installation owners environment. If you use the dm_launch_server_config_program.sh
script to start the Content Server configuration program, all required environment variables,
except for those required by each database are set automatically. If you do not use the
dm_launch_server_config_program.sh script, you need to manually set all environment variables.
You can set all of the following variables, except LC_ALL and DISPLAY, by sourcing
$DM_HOME/bin/dm_set_server_env.sh or $DM_HOME/bin/dm_set_server_env.csh. Set the
variables LC_ALL and DISPLAY in the installation owners .cshrc file (C shell) or .profile file (Bourne
or Korn shells). Alternatively, set the variables in a file called by the .cshrc file or .profile file or
in other ways permitted by UNIX.

Table 12. Required environment variables

Environment variable

Description

Required values

DOCUMENTUM

Directory in which Content


Server is installed

Any directory in the installation


owners environment

DM_HOME

Directory that contains the link


to the directory containing the
executables

$DOCUMENTUM/product/
version_number

DOCUMENTUM_SHARED

Directory in which DFC is


installed

Any directory in the installation


owners environment

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

161

Required Environment Variables for UNIX and Linux

Environment variable

Description

Required values

DISPLAY

Controls the display

localhost:0.0

LC_ALL

C
Caution: If this value is
not set correctly, the Java
method server will fail.

162

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Appendix B
Content Server Installation Directories
and Repository Configuration Scripts

This appendix describes the file structure, scripts, and configuration objects that are a part of a
Content Server installation. The following topics are discussed:
Content Server installation file structure, page 163
Scripts run during installation or upgrade, page 168
Configuration objects, page 171

Content Server installation file structure


A Content Server installation consists of a number of files distributed among several directories.
Some of these files, such as the executable files, are supplied as part of the Content Server installation
package. Others, such as the Content Server startup file, are created during the installation process.
The installation procedure creates the following subdirectories in the $DOCUMENTUM directory:
_uninst
data
dba
fulltext
product
server_uninstall
share

_uninst
This directory contains the Content Server uninstaller.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

163

Content Server Installation Directories and Repository Configuration Scripts

data
The files and directories in this category are the content storage areas. These directories must exist
and location objects must be defined for them in the repository before you start Content Server. The
installation procedure creates a default storage area and associated location object and a default
full-text index object and associated location object.
The data directory contains directories that store the data manipulated by users and Content Server.
The installation procedure creates a subdirectory for the repository in the data directory and in that
repository subdirectory, creates a content storage area.
The data includes the full-text indexes and the content files associated with objects in the repositories.
The location of these directories is the most flexible component of the configuration.
Most sites will want to add more storage areas and index directories, particularly as the repository
grows larger. The EMC Documentum Content Server Administration and Configuration Guide provides
information and instructions about adding additional storage areas and full-text index storage
directories.

dba
The dba directory contains the log and config directories and several files.
The log directory is where the Content Server places any log files generated by user actions during
a session with the Content Server. The Content Server creates any necessary subdirectories for
these log files under the log directory.
The config directory includes a subdirectory for each repository that contains the startup files for
Content Server.

fulltext
The fulltext directory contains the third-party full-text indexing software.

product
The product subdirectory contains the Content Server executables.

server_uninstall
This directory contains a script that you can run manually to destroy a repositorys database tables
after you delete the repository.

164

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Content Server Installation Directories and Repository Configuration Scripts

share
The share directory holds all the files that can be shared by the Content Server and the clients. Clients
that connect to the share directory remotely can benefit in file sharing and event notification. The
client must be using NFS software to receive these benefits. The EMC Documentum Content Server
Administration and Configuration Guide contains details.
The share directory has four subdirectories:
data
The data directory contains data that is read and written by the Content Server and the clients.
The data directory has several subdirectories. Ensure that these subdirectories can be mounted
by clients.
events
The events subdirectory contains a file for any user who has queued inbox items that have not
been viewed. The files are empty. They serve as a flag to the Content Server that items that
have not been viewed are in that users inbox.
common
The common subdirectory is where the Content Server puts copies of requested content files if
users are not using client local areas and if users do not specify an alternate location for the files.
clients
The clients subdirectory contains the win and unix subdirectories, which respectively contain
the files and executables for Windows and UNIX clients.
temp
The temp subdirectory is used by the Content Server as a temporary storage space. For
example, results generated by the execution of a procedure by using the Apply methods
DO_METHOD function are stored here.
sdk
The sdk subdirectory contains two subdirectories of files that are useful to software developers.
The two subdirectories are:
Include
This subdirectory contains the dmapp.h file and the import libraries.
example
This subdirectory contains code examples.

Additional directories
The directories that are created during installation are described in Table 13, page 166 .

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

165

Content Server Installation Directories and Repository Configuration Scripts

Table 13. Subdirectories created during installation

Directory

Description

bin

Contains the Content Server software.

convert

Contains the transformation engine executable


files.

dba/auth

When you install Content Server, a default


base directory is created. Under default base
directory the installer creates a subdirectory
specific to the repository. The repository
configuration also creates an auth_plugin
location object that points to the base directory
and sets the auth_plugin_location attribute in
the server to the name of the location object. Any
plugin installed in this directory is loaded into
every server at startup for all repositories. To use
a plugin only with a particular repository, place
the plugin in the repository-specific dba/auth
directory.
For example, if you want to use the
Netegrity plugin with a repository called
engr_db, move the Netegrity module to
the DOCUMENTUM\dba\auth\engr_db
directory.
When Content Server starts, it loads the plugins
found in its repository-specific directory first
and then those found in the base directory.

dba/secure/ldapdb

Contains the secure connection attributes. You


need to define the following setup values to use
a secure LDAP connection:
SSL mode
SSL port
Certificate database location
The ssl_mode attribute in the ldap_config object
defines whether the LDAP server is using a
secure or nonsecure connection. You need to set
this when defining the LDAP setup values.
To configure a secure connection, chose Secure
as the SSL mode. When you do, the interface lets
you edit the SSL port field. SSL port, represented
in the ldap config object by the ssl_port attribute,
identifies the port the LDAP server uses for the
secure connection. This value is 636 by default.

166

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Content Server Installation Directories and Repository Configuration Scripts

Directory

Description
Certificate database location, represented in
the ldap_config object by the certdb_location
attribute, identifies the location of the certificate
database. The attribute value is the name of
the location object pointing to the certificate
database. The value is ldapcertdb_loc. The
directory that ldapcertdb_loc points to is
DOCUMENTUM\dba\secure\ldapdb.

example*

Contains code examples.

external_apps

Contains a shared library.

fusion

Contains files required for electronic signature


functionality, a Trusted Content Services feature.

include*

Contains header files for any external


applications that will communicate with
Content Server.

install

Contains the installation scripts.

java

Contains the Java package bundled with Content


Server.

messages

*.e files (error messages).

Oracle

Contains the language files needed by Oracle.


During installation, the environment variable
ORA_NLS33 is set to that location. Do not
remove that directory or reset the that variable.

tcf

References the task chaining framework, which


is related to lifecycles and is part of the BPS and
BPM group.

Uniscape

Contains NLS files for server code page


conversions.

unix*

Contains the libraries for a UNIX client.

unsupported

Contains executable files that are provided for


your convenience but that are not supported by
Content Server.

webcache

Includes webcache.ini. The documentation


for Documentum Interactive Delivery
Services/Interactive Delivery Services
Accelerated contains details.

thumbsrv

Installation directory for Thumbnail Server.


The documentation for Documentum Media
Services contains details.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

167

Content Server Installation Directories and Repository Configuration Scripts

Directory

Description

win*

Contains the executable files for a Microsoft


Windows client. These include IAPI and IDQL
for MS Windows and the DDE server and
libraries.

* Optional
jboss

Contains application server installation files


used to create an instance for the Java method
server.

Scripts run during installation or upgrade


During repository configuration, the following scripts are run, whether you are installing a new
repository or upgrading an existing repository:
Table 14. Repository configuration scripts

Script name

Location

Purpose

headstart.ebs

$DM_HOME/install/
admin

Loads the initial


default objects for
the repository. Creates
mount point objects,
location objects, file
store objects, and
method objects.

dm_apply_formats.ebs

$DM_HOME/bin

Creates or updates
format objects, which
are required for
content file operations.

dm_cas_install.ebs

$DM_HOME/install/
admin

Creates a method,
location, template
type, folder structure,
and template object for
use of the electronic
signature.

csec_plugin.ebs

$DM_HOME/install/
admin

dm_routerconv_
install.ebs

$DM_HOME/install/
admin

168

Loads methods that


are used for converting
routers to workflow
template.

Other

Run only during an


upgrade.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Content Server Installation Directories and Repository Configuration Scripts

Script name

Location

Purpose

templates.ebs

$DM_HOME/install/
admin

Creates default
templates that are used
by EMC Documentum
clients for creating
new documents in the
repository.

replicate_bootstrap.
ebs

$DM_HOME/bin

Creates objects and


registered tables
that are required for
replication.

desktop_client.ebs

$DM_HOME/install/
desktop_client

Creates folders
required by
Documentum Desktop
and installs the default
SmartList .

disable_fulltext_jobs.
ebs

$DM_HOME/install/
admin

dfc.ebs

$DM_HOME/install/
admin

Loads default
objects required by
the Documentum
Foundation Classes.

Dfc_bof2.ebs

$DM_HOME/install/
admin

Creates the types for


dm_module, dmc_jar,
and dmc_java_library
and configures a
repository to use DFC
version 5.3 SP1 and
later.

dfc_javadbexpr.ebs

$DM_HOME/install/
admin

Creates types, relation


types, acls, and
repository folders
for DFC evaluation of
validation expression
constraints in Java.

dm_bpmmodules_
install.ebs

$DM_HOME/install/
admin

createMethodServerObject.ebs

$DM_HOME/install/
admin

csec_plugin_upgrade_
53.ebs

$DM_HOME/install/
admin

Upgrades the
plugin for using
content-addressable
storage areas.

toolset.ebs

$DM_HOME/install/
admin

Installs repository
administration tools.

Other

Run only during an


upgrade.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Run only during an


upgrade.

169

Content Server Installation Directories and Repository Configuration Scripts

Script name

Location

dm_bpm_install.ebs

$DM_HOME/install/
admin

dm_wfTimer_
upgrade.ebs

$DM_HOME/install/
admin

Purpose

Other

Converts workflow
pre- and post-timers
set up in repositories
prior to version 5.3 to
the version 6.5 timer
implementation.

Run only during an


upgrade.

dmbasic -f
dm_wfTimer_
upgrade.ebs
-e Install -repository_
nameuserpassword

dm_setup_java_
lifecycle.ebs

$DM_HOME/install/
admin

create_fulltext_objects.
ebs

$DM_HOME/install/
admin

Creates repository
objects related to
full-text indexing.

dm_ldap_install.ebs

$DM_HOME/install/
admin

Creates or upgrades
the ldap config object
type and upgrades any
existing ldap config
objects.

dm_storageservices_
install.ebs

$DM_HOME/install/
admin

dm_emailTemplate_
install.ebs

$DM_HOME/install/
admin

dm_xml_install.ebs

$DM_HOME/install/
admin

Installs object types


and formats for XML
files.

dm_gwm_install.ebs

$DM_HOME/bin

Executes scripts
that install
workflow-related
types, methods,
folders, and jobs.

upgrade_java_
methods_51.ebs

$DM_HOME/install/
tools

Upgrades existing Java


methods.

ci_schema_install.ebs

$DM_HOME/install/
tools

Installs the object types


used by Documentum
Content Intelligence
Services.

170

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Content Server Installation Directories and Repository Configuration Scripts

Script name

Location

Purpose

display_config_setup.
ebs

$DM_HOME/install/
tools

Configures the
repository for the
Documentum Offline
Client.

offline_config_setup.
ebs

$DM_HOME/install/
tools

Migrates offline
configuration settings
from the offline_config
object to the docbase
config object.

upgrade_
contentreplication_
job.ebs

$DM_HOME/install/
admin

dm_acs_install.ebs

$DM_HOME/install/
admin

dd_populate.ebs

$DM_HOME/bin

Other

Run only during an


upgrade.

Populates the data


dictionary with
attribute and type
information from
datafiles.

Configuration objects
Each repository contains objects that together define your configuration. These objects include:
Server config object
Docbase config object
Fulltext index objects
Location objects
Mount point objects
Storage objects
Format objects
Method objects

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

171

Content Server Installation Directories and Repository Configuration Scripts

As you make choices about how to configure the installation and repositories, modify these objects or
add new ones. The EMC Documentum Content Server Administration and Configuration Guide contains
details on configuration.

172

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Appendix C
Troubleshooting a Content Server
Installation

This appendix contains information for troubleshooting common Content Server installation
problems. This appendix contains the following sections:
Identifying the problem and resolution, page 173
Recovering from a failed repository configuration or upgrade, page 177
Enabling tracing in repository configuration scripts, page 177
Recovering from a stalled Content Server upgrade, page 178

Identifying the problem and resolution


When experiencing a problem, perform the following preliminary actions:
Ensure that you are connected as the installation owner.
On UNIX and Linux, ensure that the environment variables are set correctly in the installation
owners environment.
Appendix A, Required Environment Variables for UNIX and Linux provides details.
Review the Content Server installation logs.
Reviewing the Content Server installation logs, page 79 provides details.
Table 15, page 173 can help you identify the problem you are experiencing, a possible cause, and
recommended resolution."
Table 15. Troubleshooting checklist

Symptom

Cause

Fix

Content Server installation or


upgrade fails

You are trying to install or


upgrade the Content Server but
you are not connected as the
installation owner.

Connect using the installation


owner account.

The environment variables are


not set correctly.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

173

Troubleshooting a Content Server Installation

Symptom

Cause

Fix

While installing a repository,


you see an error message that
indicates that the user is not a
valid UNIX user:

Three possible causes of this


error:

To fix these three causes:

Configuration of the
docbase fails with the
message 'user must be
a valid unix user'
exec(): 0509-036
Cannot load program
/u01/app/documentum/
product/5.2/bin/
dmisvaliduser because
of the following
errors: 0509-150
Dependent module
libldap50.so could not
be loaded. 0509-022
Cannot load module
libldap50.so. 0509-026
System error: A file
or directory in the
path name does not
exist.

1.

The installation owner


account does not have
the installation owner
group designated as the
users primary group.
Group ownership of the
Documentum binaries is
incorrect.

2.

The shared library path


environment variable is not
set correctly.

3.

On DB2, the $DB2_BASE


environment variable is not
set correctly.

1.

Make the installation


owner group the
installation owners
primary group.

2.

Set the shared library


path environment variable
correctly. Appendix A,
Required Environment
Variables for UNIX
and Linux provides
information on setting
environment variables

3.

Chapter 3, Preparing the


Database for Content
Server Installation and the
documentation for DB2
contain more information

Content Server upgrade


appears unresponsive.

There might be a cyclic group.

Recovering from a stalled


Content Server upgrade, page
178 contains details.

On Windows hosts, you see


the following error during
installation:

The correct video driver for the


video card is not installed on
the host.

Review the hardware and


software configuration of the
host.

Could not initialize


interface awt exception
ExceptionInitializationError

You see the following error


during an upgrade of an older
repository:
Failed to retrieve
serverconfig
object with name
<serverconfigname>.

The dm_ContentReplication
method has some parameter
arguments left over from
EDMS98.

Delete the following entry from


the dm_ContentReplication
method:
serverconfigname
[domain\]user,passwd

***Failed to encrypt
passwords for
docbase ec_epac,
status -1057226550
**Operation failed **

174

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Troubleshooting a Content Server Installation

Symptom

Cause

Fix

Invalid Oracle views belonging


to types _sv, _sp, _rv, and _rp.

Make the views valid before


upgrading Content Server.

A view in Oracle becomes


invalid when the base tables it
references change (for example,
by adding/dropping a column,
or dropping a unique constraint
index).

To determine which views


in the Oracle installation
are invalid, you can run
the following query from
SQLPLUS logging in as the
repository owner:

[DM_CRYPTO_E_NO_LOCAL_
COMPONENT_STORE] error:
"No local component
store for server"
Please read error log
C:\WINNT\Temp\dm_chec_
bin.ServerConfigurator.
log for more
information.

You see the following errors


during upgrade from 5.3 SP6 to
6.7 on Oracle 10:
Tue Feb 22 21:48:08
2005 098000
[DM_SESSION_I_
INIT_BEGIN]info:
"Initialize
dmContent." Tue Feb
22 21:48:08 2005
567000 [DM_SESSION_
I_INIT_BEGIN]info:
"Initialize
dmiSubContent." Tue
Feb 22 21:48:08 2005
598000 [DM_TYPE_MGR_E_
CANT_FIND_TABLE]error:
"Failure to find table
dmi_subcontent_sv
as part of fetch of
type dmi_subcontent:
error from database
system is ORA-24372:
invalid object for
describe" Tue Feb
22 21:48:08 2005
598000 [DM_SESSION_
E_INIT_FAILURE1]error:
"Failure to complete
dmiSubContent
initialization."

You might also see this


message:
ORA-24372: invalid
object for describe

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

select object_name,
object_type from
user_objects where
status='INVALID';

To recompile the views:


ALTER VIEW view_name
COMPILE;

The Oracle-supplied package


named DBMS_UTILITY
has a procedure named
COMPILE_SCHEMA. This
procedure will compile all
stored code, views, and so on,
for the schema provided. The
best way to compile all database
objects that are invalid is to
use a script in the $ORACLE_
HOME/rdbms/admin directory
named utlrp.sql. This script
finds all objects in the data
dictionary that are invalid and
compiles them. This script is
typically mentioned in patch
notes but you can use it any
time a schema change occurs.

175

Troubleshooting a Content Server Installation

While installing on Linux, the installer hangs when the


number of mount points exceeds 4000
On a Linux machine, installation can hang when there are too many mount points open in the box.
Check the output in bytes by entering the following command:
mount | wc -c

The installer hangs when the number returned by the previous command exceeds 4000.
To work around this problem, do the following: Copy and paste the following into your Telnet
session, and run the installation as usual:
cd /tmp
mkdir bin.$$
cd bin.$$
cat > mount <<EOF
#! /bin/sh
exec /bin/true
EOF
chmod 755 mount
export PATH=`pwd`:$PATH

After the installation completes, delete /tmp/bin.$$ by running the following command (in the same
Telnet session):
rm -r /tmp/bin.$$

Error during session construction on Solaris-DB2


On Solaris-DB2 platform, when running cstests/acsRead test suites on version 6.5, the test cases
might fail with the following message:
"Unable to create session - error during session construction"
To work around this, make the following changes in the configuration:
1.

Change MAXAPPLS using the following db2 command: UPDATE DATABASE CONFIGURATION
FOR <database_name> USING MAXAPPLS 200 AUTOMATIC MAXLOCKS 80 AUTOMATIC

2.

Increase the number of semaphores as follows:


set noexec_user_stack=1
set semsys:seminfo_semmni=4096
set semsys:seminfo_semmsl=4096
set semsys:seminfo_semvmx=32767
set semsys:seminfo_semopn=4096
set semsys:seminfo_semume=4096
set shmsys:shminfo_shmmax=4294967295
set shmsys:shminfo_shmmni=2400

176

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Troubleshooting a Content Server Installation

Recovering from a failed repository


configuration or upgrade
If repository configuration fails, whether you are upgrading an existing repository or creating a new
one, you can recover from the failure.
Typical reasons for a failure include problems with the database connection or errors in Content
Server creation. Before you proceed with the following instructions, read the Content Server
installation logs and correct any problems. Reviewing the Content Server installation logs, page 79
provides details about logs.

To recover from a failed installation or upgrade:


1.

Correct any problems noted in the Content Server installation logs.

2.

Restart the Content Server configuration program.

3.

Select Custom installation.

4.

Select the repository where the failure occurred.

5.

Check Upgrade.
This takes you through the configuration steps again and reruns the scripts that create the
repository.

Enabling tracing in repository configuration


scripts
When the repository configuration scripts fail, it helps to see the command that was being run at the
time of the failure in addition to the information in the output file. You can obtain this information by
enabling tracing in the scripts.

To enable tracing in the repository configuration scripts:


1.

Restart the Content Server configuration program configuration program.

2.

Select Custom installation.

3.

At the where you can modify the configuration scripts, open the problem script for editing.

4.

Immediately after the connect call, add the following line to the script:
sta$ = dmAPIExec("trace,c,4," & "trace_file_name")

5.

Save the script.

6.

Rerun the script.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

177

Troubleshooting a Content Server Installation

Recovering from a stalled Content Server


upgrade
A Content Server upgrade that stalls in the middle or takes hours to complete can be caused by
cyclic groups. A cyclic group is a subgroup of a member group, causing the Content Server to cycle
during the upgrade. If the Content Server has encountered a cyclic group, the last line of the Content
Server log is:
Thu Jun

28 14:00:14 2007 715540 [DM_SESSION_I_INIT_BEGIN]info:"Initialize dmGroup."

Use the following instructions to identify the cyclic group. After you locate the cyclic group, contact
EMC Documentum Technical Support for assistance in correcting the problem, which requires direct
SQL Server statements in the database.

To identify and correct a cyclic group:


1.

From the operating system, stop the Content Server startup.


On Windows, open Task Manager, select the correct Content Server process on the Processes
tab, and click End Process.
On UNIX and Linux, determine the correct Content Server process and use the kill command
to end the process.

2.

If you are on UNIX or Linux, restart the Content Server using the osqltrace option:
dm_start_repositoryname -osqltrace

3.

If you are on Windows, edit the Content Server startup command, then restart the Content Server.
a.

Click Start > Programs > Documentum > Server Manager.

b. Select the correct repository.


c.

Click Edit Service.

d. In the Command field, add -osqltrace after the repository name.

4.

e.

Click Okay.

f.

Restart the Content Server.

When the Content Server appears to be unresponsive, open the Content Server log and identify
the query that is looping.
If there is a cyclic group, the last query in the log is recorded multiple times and takes this format:
Thu Jun 28 13:33:17 2007 435439: 21547[1]
SELECT SB_.R_OBJECT_ID FROM repository_owner.dm_group_s SB_
WHERE (SB_.R_OBJECT_ID=:objectp AND SB_.I_VSTAMP=:versionp)
Thu Jun 28 13:33:17 2007 435608: 21547[1] :objectp = 1200fb8080000909
Thu Jun 28 13:33:17 2007 435608: 21547[1] :versionp = 0

In the preceding example, the cyclic group has the r_object_id of 1200fb8080000909.
5.

Run the following query:


SELECT group_name
FROM dm_group_s
WHERE r_object_id='r_object_id_of_cyclic_group

178

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Troubleshooting a Content Server Installation

This query returns the name of the group, which you need for determining which group is
the cyclic group.
6.

Run the following query:


SELECT groups_names
FROM dm_group_r
WHERE r_object_id = r_object_id_of_cyclic_group

The query returns the names of each group that is a member of the problem group.
7.

For each of the group names returned, run this query:


SELECT r_object_id from dm_group_s where group_name = member_group_name'

The query returns the r_object_id for each member group.


8.

Repeat steps 6 and 7 iteratively for each subgroup until you locate the cyclic group.

9.

Contact EMC Documentum Technical Support for assistance in correcting the problem.

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

179

Troubleshooting a Content Server Installation

180

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Appendix D
Object Type Categories for Oracle
Database Storage

This appendix lists the object types by their size category. An object types size category is used
in two contexts:
To determine where to create the object types tables and indexes if the optional
[FUNCTION_SPECIFIC_STORAGE] parameters are defined in the server.ini file
To determine the default initial and next extent allotments for the object types tables in the RDBMS
This appendix contain the following topics:
Type categories for tablespace specifications, page 181
Type categories for extent allocation, page 182
The categories for each context are not the same. Type categories for tablespace specifications, page
181, helps you to find the categories for tablespace determination and to Type categories for extent
allocation, page 182, shows the tables listing the categories for extent allotments.
Appendix E, Defining Oracle or DB2 Database Parameters for Repository Tables provides information
about setting the default storage parameters.

Type categories for tablespace specifications


By default, the tables and indexes for all object types are created in the same tablespace. However,
you can set parameters in the server.ini file to define alternate tablespaces for large and small
object types. When you do so, the system sorts the objects into large and small for the purposes of
determining which object types to create in which tablespace.
The majority of the object types are considered small for this purpose. The following list shows the
object types that are considered large. Any type not appearing on this list is considered small.
dm_acl

dm_process

dmi_dump_object_record

dm_assembly

dm_reference

dmi_linkrecord

dm_audittrail

dm_relation

dmi_load_object_record

dm_composite

dm_router

dmi_otherfile

dm_document

dm_script

dmi_queue_item

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

181

Object Type Categories for Oracle Database Storage

dm_folder

dm_smart_list

dmi_replica_record

dm_locator

dm_sysobject

dmr_containment

dm_note

dm_workflow

dmr_content

dm_procedure

dm_workitem

Type categories for extent allocation


This section lists object type size categorizations for extent allocation and the default initial and
next extent storage parameters for each category.
The object types are categorized as large, small, or default based on how many objects of the type
will be created in the repository. For example, dm_document is categorized as large because most
enterprises create large numbers of documents in a repository. Similarly, dm_docbase_config is
categorized as small because a repository has only one docbase config object. Those types that do not
fall into either the large or small category are categorized as default.

Object types categorized as large


The object types categorized as large are created with an initial extent size of 100 K. The next extent
size is 1 M. The following object types are categorized as large for the purposes of allocating extents.
dm_acl

dm_reference

dmi_dump_object_record

dm_assembly

dm_relation

dmi_load_object_record

dm_document

dm_router

dmi_object_type

dm_folder

dm_sysobject

dmi_queue_item

dm_locator

dmi_containment

dmi_replica_record

dm_note

dmr_content

dmi_subcontent

Object types categorized as small


The object types categorized as small are created with an initial extent size of 10 K. The next extent
size is 50 K. The following object types are categorized as small for the purposes of allocating extents.
dm_alias

dm_filestore

dm_relation_type

dm_blobstore

dm_foreign_key

dm_server_config

dm_distributed_store

dm_format

dm_store

dm_dump_record

dm_fulltext_index

dmi_change_record

dm_docbase_config

dm_linkedstore

dmi_expr_code

182

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Object Type Categories for Oracle Database Storage

dm_docbaseid_map

dm_load_record

dmi_recovery

dm_extern_file

dm_location

dmi_session

dm_extern_free

dm_mount_point

dmi_sequence

dm_extern_store

dm_opticalstore

dmi_tdk_collect

dm_extern_url

dm_outputdevice

dmi_tdk_index

dm_federation

dm_registered

dmi_vstamp

Object types categorized as default


The object types categorized as default are created with an initial extent size of 20K. The next extent
size is 100K. The following object types are categorized as default for the purposes of allocating
extents.
dm_acs_config

dm_cabinet

dm_domain

dm_activity

dm_client_registration

dm_expression

dm_aggr_domain

dm_client-rights

dm_federation_log

dm_application

dm_cond_expr

dm_func_expr

dm_app_ref

dm_cond_id_expr

dm_group

dm_aspect_type

dm_component

dm_job

dm_audittrail

dm_cont_transfer_config

dm_job_request

dm_bocs_config

dm_dd_attr_info

dm_key

dm_builtin_expr

dm_dd_info

dm_ldap_config

dm_cabinet

dm_dms_config

dm_lightweight

dm_literal_expr

dm_public_key_certificate

dm_user

dm_media_profile

dm_query

dm_value_assist

dm_method

dm_qual_comp

dm_value_func

dm_nls_dd_info

dm-retainer

dm_value_list

dm_plugin

dm_script

dm_value_query

dm_policy

dm_smart_list

dm_validation_descriptor

dm_process

dm_staged

dm_workflow

dm_procedure

dm_type

dm_workitem

dmc_aspect_type

dmc_relationship_def

dmc_wfsd_element_string

dmc_calendar

dmc_routcase_condition

dmc_wfsd_parent

dmc_calendar_event

dmc_scope_config_relation

dmc_wfsdrp_boolean

dmc_completed_workitem

dmc_transition_condition

dmc_wfsdrp_date

dmc_datatable

dmc_type_info

dmc_wfsdrp_double

dmc_datatable_row

dmc_wf_package_skill

dmc_wfsdrp_integer

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

183

Object Type Categories for Oracle Database Storage

dmc_datatable_schema

dmc_wfsd_element

dmc_wfsdrp_parent

dmc_datatable_settings

dmc_wfsd_element_boolean

dmc_wfsdrp_string

dmc_module

dmc_wfsd_element_date

dmc_workqueue

dmc_preset_info

dmc_wfsd_element_double

dmc_workqueue_policy

dmc_preset_package

dmc_wfsd_element_integer

dmi_autittrail_attrs

dmi_dist_comp _record

dmi_package

dmi_registry

dm_expr_code

dmi_transactionlog

dmi_wf_timer
dmi_workitem

184

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Appendix E
Defining Oracle or DB2 Database
Parameters for Repository Tables

To improve performance and increase the throughput of the system, you might want to control where
repository information is stored. For example, you can store frequently used data on different disks
than less frequently used data. Defining database parameters to store data in different tablespaces
also partitions data into smaller, more manageable pieces.
When a repository is created, the system automatically creates object-type tables and indexes in the
underlying database. The object-type tables and indexes are described in EMC Documentum Content
Server Fundamentals.
If you do an express installation of Content Server, by default, Content Server creates all object-type
tables and indexes in the same tablespace. The size and number of the extents allotted for each
table are determined by default configuration parameters. If you do a custom Content Server
installation, you are prompted to configure the object-type tables and indexes, and you can create
them in separate tablespaces.
You can edit the server.ini file to change any configuration parameters when the repository is created,
before you start the Content Server.
On DB2, you can change the tablespace for the object-type tables and indexes. On Oracle, you
can change two parameters:
The tablespace for the object-type tables and indexes
The size of the extents allotted for system-defined object types
You cannot change the number of extents allotted for the object types.
Under Oracle 10, always create tablespaces as locally managed tablespaces (LMTs) using the
LOCAL value. If you have dictionary managed tablespaces (DMTs) under Oracle 10, use the
Oracle DBMS_SPACE_ADMIN package to convert DMTs to LMTs, for example,
SQL> exec dbms_space_admin.Tablespace_Migrate_TO_Local('Table_space1');

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

185

Defining Oracle or DB2 Database Parameters for Repository Tables

The Oracle documentation set contains details on extent management and DMT-to-LMT
conversion.

Defining the tablespace


The parameters in the [FUNCTION_SPECIFIC_STORAGE] and [TYPE_SPECIFIC_STORAGE]
sections of the server.ini file define the tablespace in which to create the object-type tables and indexes.

FUNCTION_SPECIFIC_STORAGE
Set the parameters in the [FUNCTION_SPECIFIC_STORAGE] section to define the tablespace for the
type tables and indexes for a particular category of object types. EMC Documentum sorts object types
into the categories large and small for the purposes of defining their tablespace.
Object types in the large category are those that are expected to have a large number of object
instances. For example, dm_SysObject is in the large category.
Object types in the small category are those that are expected to have very few object instances.
For example, dm_docbase_config is in the small category. Each repository has only one Docbase
config object.
The format of the [FUNCTION_SPECIFIC_STORAGE] section is:
[FUNCTION_SPECIFIC_STORAGE]
database_table_large=tablespace_name
database_table_small=tablespace_name
database_index_large=tablespace_name
database_index_small=tablespace_name

For example, to define a tablespace for the object-type tables in the large category, include the
following lines in the server.ini file, substituting the name of the tablespace:
[FUNCTION_SPECIFIC_STORAGE]
database_table_large=tablespace_name

For example, to put the indexes for the large category in the tablespace named production_1, include
the following lines in the server.ini file:
[FUNCTION_SPECIFIC_STORAGE]
database_index_large=production_1

You can specify the function-specific parameters singularly or in any combination.

TYPE_SPECIFIC_STORAGE
Set the parameters in the [TYPE_SPECIFIC_STORAGE] section in the server.ini file to define a
tablespace for the type tables or indexes for a specific object type.
The format of the [TYPE_SPECIFIC_STORAGE] section is:
[TYPE_SPECIFIC_STORAGE]
database_table_typename=tablespace_name
database_index_typename=tablespace_name

186

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Defining Oracle or DB2 Database Parameters for Repository Tables

You can specify the type-specific parameters individually. For example, to put the object-type
tables for the dm_SysObject type the tablespace named sysobj_space, include the following lines
in the server.ini file:
[TYPE_SPECIFIC_STORAGE]
database_table_dm_sysobject=sysobj_space

If you want to put both the tables and indexes for an object type nondefault tablespaces, define the
tablespace for each. Defining a tablespace for an object types tables does not affect where the types
indexes are stored. The system creates the indexes in the default tablespace. Defining a tablespace for
a types indexes does not affect where the types tables are stored.
For example:
[TYPE_SPECIFIC_STORAGE]
database_table_dm_sysobject=sysobj_space
database_index_dm_sysobject=sysobj_idx_space

The object-type tables and indexes of any object type not specified in a type-specific parameter are
created in the default tablespace or, if specified, in the tablespace for the types category.
If the server.ini file includes both function-specific and type-specific parameters that apply to an
object type, the type-specific parameters override the function-specific parameters. For example,
suppose you add the following function-specific and type-specific parameters to the file:
[FUNCTION_SPECIFIC_STORAGE]
database_index_large=production_1
[TYPE_SPECIFIC_STORAGE]
database_table_dm_sysobject=sysobj_space

Both parameters apply to the dm_SysObject type because dm_SysObject is in the large category.
The object-type tables for dm_SysObject are created in the sysobj_space tablespace because the
type-specific parameter overrides the function-specific parameter.

Defining the Oracle extent sizes


For the purposes of extent allocation, the Documentum object types are sorted into three categories:
large, small, and default. The category name describes the quantity of expected objects of the type.
For example, dm_document is considered a large type because most enterprises generate large
quantities of documents. In contrast, dm_repository_config is a small type because there is only one
docbase config object in a repository. Those object types that typically do not have large numbers of
objects or very small numbers of objects fall into the default category.
A types category determines how much database storage is allocated to it by default. Object types
categorized as:
Large object type receive an initial extent of 100 KB and a next (second, third, fourth.) extent of
1 MB.
Small object types receive an initial extent of 10 KB and a next extent of 50 KB.
Default object types receive an initial extent of 20 KB and a next extent of 100 KB.
The default storage parameters set the initial and next extent sizes. There are also parameters that
define the default minimum and maximum number of extents allotted to an object type table and
the percentage increase of extents allotted after the second extent. The minimum number of allotted
extents is 1 and the maximum number is determined by Oracle, based on the data block size. By

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

187

Defining Oracle or DB2 Database Parameters for Repository Tables

default, object-type tables and indexes are allocated the minimum number of extents when they
are created.
The percentage increase default is 10 percent. This means that extents allotted after the second extent
are increased in size by 10 percent over the previously allocated extent. For example, if the second
extents size is 100 KB, then the size of the third extent is 110 KB, 10 percent greater than 100 KB. The
fourth extent would be 121 KB, 10% greater than 110 KB.
You can change the initial and next extent default sizes for an individual object type or for an entire
category by setting parameters in the server.ini file before the repository is created.
You can change the following parameters by using the Oracle ALTER TABLE command through
sqlplus:
Next extent
Minimum extent
Maximum extent
Percentage increase
The Oracle documentation contains instructions.

Changing storage parameters for individual object


types on Oracle
To change the initial and next extent parameters for an object type, add a [TYPE_EXTENT_SIZE]
section to the server.ini file. This section has the following format:
[TYPE_EXTENT_SIZE]
database_ini_ext_typename=new_value[K|M]
database_next_ext_typename=new_value[K|M]

typename must be the internal name of a system-defined object type. It cannot be a user-defined
object type.
The database_ini_ext_typename parameter defines the size of the initial extent allotted to the type.
The database_next_ext_typename parameter defines the size of the second extent allotted to the type.
new_value is an integer. If you include K, the value is interpreted as Kilobytes. If you include M, the
value is interpreted as Megabytes. If you include neither K nor M, the value is interpreted as bytes.
For example, to change the defaults for dm_sysobject, add the following lines to the server.ini file:
[TYPE_EXTENT_SIZE]
database_ini_ext_dm_sysobject=new_value[K|M]
database_next_ext_dm_sysobject=new_value[K|M]

You can set either parameter or both for an object type. The section can include parameter
definitions for more than one object type. For example:
[TYPE_EXTENT_SIZE]
database_ini_ext_dm_sysobject=new_value[K|M]
database_next_ext_dm_sysobject=new_value[K|M]
database_next_ext_dm_user=new_value[K|M]

188

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Defining Oracle or DB2 Database Parameters for Repository Tables

Changing storage parameters for categories of types


on Oracle
To change the initial and next extent parameters for all object types in one category, add a
[FUNCTION_EXTENT_SIZE] section to the server.ini file. This section has the following format:
[FUNCTION_EXTENT_SIZE]
database_ini_ext_large=new_value[K|M]
database_ini_ext_small=new_value[K|M]
database_ini_ext_default=new_value[K|M]
database_next_ext_large=new_value[K|M]
database_next_ext_small=new_value[K|M]
database_next_ext_default=new_value[K|M]

The database_ini_ext_large parameter defines the size of the initial extent allotted by default
to object types categorized as large.
The database_ini_ext_small parameter defines the size of the initial extent allotted by default to
object types categorized as small.
The database_ini_ext_default parameter defines the size of the initial extent allotted by default to
object types categorized as default.
The database_next_ext_large parameter defines the size of the second extent allotted by default
to object types categorized as large.
The database_next_ext_small parameter defines the size of the second extent allotted by default to
object types categorized as small.
The database_next_ext_default parameter defines the size of the second extent allotted by default to
object types categorized as default.
new_value is an integer. If you include K, the value is interpreted as Kilobytes. If you include M, the
value is interpreted as Megabytes. If you include neither K nor M, the value is interpreted as bytes.
For example, to change the default extent sizes for all large object types, add the following
to the server.ini file:
[FUNCTION_EXTENT_SIZE]
database_ini_ext_large=new_value[K|M]
database_next_ext_large=new_value[K|M]

You can set any combination of the parameters. It is not necessary to set the parameters for all
three categories. You can also set only one of the parameters for a category. To illustrate, the
following example sets the initial extent for objects categorized as large and the next extent for
object types categorized as default:
[FUNCTION_EXTENT_SIZE]
database_ini_ext_large=200K
database_next_ext_default=120K

User-defined object types


A user-defined object type derives its database storage parameters from its supertype. If the type
has no supertype, then the type is assigned to the large category for tablespace assignment and to
the default category for the extent allocations

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

189

Defining Oracle or DB2 Database Parameters for Repository Tables

You cannot change the storage parameters for user-defined object types.
On DB2, if you create a tablespace for objects of type dm_SysObject, then create a user-defined object
type whose supertype is dm_SysObject, the user-defined object type is not stored in the tablespace
for dm_SysObject. Instead, the user-defined object type is stored in the default tablespace, unless
you define the tablespace for dm_SysObject in the server.ini file.

190

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Index

32bit Content Server


installing, 63
64bit Content Server
installing, 63
upgrading to, 91

A
accounts
installation owner, 29
repository owner, 18, 30, 41
active/active clusters, 147
described, 135, 146
first cluster resource group, 146 to 147
repository configuration, 147
server.ini file, 147
verifying failover, 148
active/passive clusters
configuring, 137
configuring the repository, 138
connection broker configuration, 143
creating resource groups, 137
creating resources, 144
described, 134
installing Content Server, 138
verifying failover, 145
administrative tool scripts, 80
aek.key file, 155

B
backing up key store files, 83

C
ci_schema_install.ebs script, 170
client connections, 20
clients directory, 165
cluster resource groups
creating, 137
resources, 137
cluster resources

creating, 144
code pages
supported, 28
common directory, 165
config directory, 164
configuration
basic server installation, 168
default, 168
file locations, 165
objects, described, 171
overview, 172
requirements, 32
configuration decisions
repository size, 18
configuring
repositories, 67, 73
configuring Content Server, 17
CONNECT privileges, 42
connecting to database, 17
connection broker
required ports, 21
connection brokers
described, 15
in resource groups, 133
Microsoft Cluster Services, 143
Content Server
configuration, 17
connection types, 20
Content Storage Services, 22
in resource groups, 133
installation owner, 29
internationalization, 28
Retention Policy Services, 22
Trusted Content Services, 22
uninstalling, 109
uninstalling Content Server, 107 to 109
Content Services for retention type store
described, 22
Content Storage Services, 22
content-addressed storage, 22
copying repositories, 155

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

191

Index

create_fulltext_objects.ebs, 170
CSEC. See Content Services for retention
type store
csec_plugin_upgrade_53.ebs, 169
cyclic groups, 178

D
data directories, described, 18, 164
database
code page, 40
database accounts, 17
database location, 136
database requirements
repository owner, 30, 42
database_refresh_interval key, 91
databases
DB2, 47
installation location, 17
Oracle requirements, 42
requirements, 40
requirements for upgrade, 90
SQL Server requirements, 44
Sybase, 46
UTF-8, 90
Windows requirements, 41
DB2
current configuration, 48
environment variables, 47
performance wizard, 47
repository owner requirements, 42
requirements, 47
dba directory, 164
dd_populate.ebs script, 171
desktop_client.ebs script, 169
dfc.ebs script, 169
directories
clients, 165
common area, 165
config, 164
content storage, 137
data, 18, 164
dba, 164
DM_HOME, 164
event subdirectory, 165
events, 165
log, 164
product, 163
required for installation, 32
SDK, 165

192

share, 165
temp, 165
version, 32
disks, shared, 137
display_config_setup.ebs script, 171
distributed configurations
installation requirements, 112
shared content model, 112
upgrading, 114
UTC time, 112
distributed content, 114
dm_apply_formats.ebs script, 168
dm_cas_install.ebs, 168
dm_change_password, 32
dm_check_password, 32
dm_gwm_install.ebs script, 170
DM_HOME environment variable, 32, 164
dm_ldap_install.ebs script, 170
dm_root_task script, 32
dm_routerConv_install.ebs script, 168
dm_wfTimer_upgrade.ebs, 170
dm_xml_install.ebs script, 170
docu, 19
Documentum Administrator
adding groups, 84
Documentum Content Intelligence
Services, 170
DOCUMENTUM environment variable, 32
Documentum Foundation Classes
dfc.ebs script, 169
Documentum Offline Client, 171

E
EMC Documentum Site Caching
Services, 112
EMC Documentum Web Publisher, 112
enabling repository configuration script
tracing, 177
environment variables, 32
DB2, 47
DM_HOME, 32
DOCUMENTUM, 32
installation owner environment, 161
LANG, 28
ORACLE_HOME, 43
Sybase, 46
events subdirectory, 165
exiting installation, 63
external password checking, 30

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Index

external password validation, 30

F
failover, 134
failover verification, 148
failover, verifying, 145
files
aek.key, 155
services, 33
Sybase configuration, 46
tnsnames.ora, 42 to 43

G
global registry
network locations, 23
SBOs, 23
groups, 84
installation owner, 30

H
hardware requirements, 25
headstart.ebs script, 168
host locales, 28
host preparation
UNIX, 31
hostname requirement, 27
hosts, 27

I
index agent
required ports, 21
index server
required ports, 21
installation owner
case-sensitivity of username, 29
described, 29
environment variables, 161
password, 29
required permissions On UNIX and
Linux, 30
root account, 29
Sybase requirements, 46
uninstalling Content Server, 107 to 109
username, 29
Windows requirements, 30
Windows rights, 30
installation owner group, 30

installing
copying server software, 55
sequence, 55
installing content server
required ports, 21
installing Content Server
basic configuration for server, 168
configuration requirements, 32
configuration scripts, 168
configuring repositories, 138, 147
connection brokers, 15
copying software, 59, 63
database, 47
DB2, 47
directory structure, 163
environment variables, 161
exiting, 63
hardware requirements, 25
Microsoft Cluster Services, 133
multiple servers on UNIX and
Linux, 151
multiple servers on Windows, 151
preparing, 25
repository size, 18
typical configurations, 15
UNIX group accounts required, 30
internationalization, 28
database code page, 40
server host code pages, 28
SQL Server, 40
Unicode, 40
UTF-8, 90

J
Java method server
required ports, 21

K
key store files, backing up, 83

L
LANG environment variable, 28
loadbalanced configurations, 112
local administrators group, 30
local database installations, 17
log directory, 164
logs, server installation, 80

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

193

Index

Microsoft Cluster Services, 147


active/active clusters, 135, 137
active/passive clusters, 134, 137
configuration options, 134
configuring active/active clusters, 146
configuring active/passive clusters, 137
to 138
configuring connection brokers, 143
configuring the repository, 147
connection broker projection, 147
content storage directories, 137
database location, 136
Documentum configurations, 134
installation choices, 134
modifying server.ini file, 147
preinstallation tasks, 136
repository owner, 30
resource groups, 133
shared disks, 137
user permissions, 137
verifying failover, 148

passwords, 29, 31
port numbers, 33
ports
native connections, 33
required, 21
secure connections, 33
postinstallation tasks
adding groups, 84
adding users, 84
administrative tool script, 80
PURGE AUDIT, enabling, 84
reviewing server installation logs, 80
preinstallation requirements
database, 17
database administrator account, 42
database code page, 40
DB2, 47
directories, 32
DM_HOME, 32
environment variables, 161
hostname, 27
hosts, 27
installation directory, 32
repository owner, 18, 41
supported code pages, 28
XWindows, 31
product directory, described, 163
PURGE AUDIT job, 84

N
native connections, 20, 33
network cards, 27
network location objects, 23

O
object replication, 114
object type categories, 181
ODBC configuration, 44
offline_config_setup.ebs script, 171
Oracle
CONNECT privileges, 42
database aliases, 43
environment variables, 43
ORACLE_HOME, 43
preinstallation requirements, 43
repository owner requirements, 42
repository sizes, 44
RESOURCE privileges, 42
TNS aliases, 43
tnsnames.ora file, 43
ORACLE_HOME environment
variable, 43
order of uninstalling, 107

194

R
remote database installations, 17
replicate_bootstrap.ebs script, 169
repositories
active/active clusters, 147
active/passive cluster, 137
configuring, 67, 73, 138, 147
copying, 155
global registry, 23
owner, 42
services file entries, 33
size, 18
user authentication, 31
users, 31
repository
ID, 19
name, 19
repository configuration failure, 177
repository configuration scripts

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

Index

ci_schema_install.ebs, 170
create_fulltext_objects.ebs, 170
csec_plugin_upgrade_53.ebs, 169
dd_populate_install.ebs, 171
desktop_client.ebs, 169
dfc.ebs, 169
display_config_setup.ebs, 171
dm_apply_formats.ebs, 168
dm_cas_install.ebs, 168
dm_gwm_install.ebs, 170
dm_ldap_install.ebs, 170
dm_routerConv_install.ebs, 168
dm_wfTimer_upgrade.ebs, 170
dm_xml_install.ebs, 170
headstart.ebs, 168
offline_config_setup.ebs, 171
replicate_bootstrap.ebs, 169
templates.ebs, 169
toolset.ebs, 169
upgrade_java_methods_51.ebs, 170
repository copies, 155
repository federations
upgrading, 114
repository owner
database privileges, 42
database requirements, 42
DB2, 42
described, 18, 41
Microsoft Cluster Services, 30
Oracle, 42
password, 31
RDBMS account, 18, 41
required Windows privileges, 42
SQL Server, 42
username, 30
Windows, 30
requirements
ports, 21
reserved terms, 19
resource groups, 133
RESOURCE privileges, 42
Retention Policy Services, 22
root account, 29
root password, 90
root task, 32

S
scripts
dm_root_task, 32

repository configuration, 168


server configuration, 142
SDK directory, 165
secure connections, 20, 33
semaphore requirements, 31
server installation logs, 80
server.ini file, 147
database_conn key, 43
services file, 33
port numbers, 33
service name, 33
share directory, described, 165
shared content configurations, 112
shared disks, 137
shared memory requirements, 31
size of repository, 18
SQL Server
custom installation, 44
enabling case-sensitivity, 44
enabling row-level locking, 44
internationalization, 40
ODBC configuration, 44
repository owner requirements, 42
requirements, 44
stalled server upgrade,
troubleshooting, 178
Sybase
configuration file, 46
devices, 46
environment variables, 46
installation owner, 46
requirements, 46

T
temp directory, described, 165
templates.ebs script, 169
Terminal Services, 114
testing an upgrade, 155
tnsnames.ora file, 42 to 43
toolset.ebs script, 169
troubleshooting
diagnosis, 173
enabling repository configuration
script tracing, 177
repository configuration failure, 177
stalled server upgrade, 178
Trusted Content Services
described, 22
port numbers, 33

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide

195

Index

services file, 33

U
Unicode, 40
uninstalling Content Server, 109
Content Server, 107
installation owner, 107 to 109
order, 107
requirements, 107 to 109
UNIX
host preparation, 31
installing multiple servers, 151
UNIX requirements, 32
directories, 32
environment variables, 32, 161
installation owner account, 30
root account, 29
semaphores, 31
services file, 33
shared memory, 31
shells, 161
space available, 32
XWindows, 31
unsecure connections, 20
upgrade_java_methods_51.ebs script, 170
upgrading Content Server
database_refresh_interval ey, 91
described, 87
distributed configurations, 114
distributed content, 114
effects on system, 87
object replication, 114

196

repository federations, 114


testing, 155
UTF-8, 90
users, 84
authentication on Windows, 31
UTC time, 112
UTF-8 code page, 28

V
verifying failover, 145, 148
version directory, 32
virtual IP addresses, 133
virtual network hostnames, 133

W
Windows
installing multiple servers, 151
repository owner, 42
user authentication, 31
Windows requirements
database service, 41
installation owner account, 29
installation owner user rights, 30
local administrators group, 30
repository owner, 30
Terminal Services, 114

X
XWindows, 31

EMC Documentum Content Server Enterprise Edition Version 6.7 Installation Guide