Docu10450 - Documentum Content Server 6.6 Full Text Indexing Deployment Guide

EMC ® Documentum ®
Content Server
Version 6.6
Full-text Indexing Deployment 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 2010 EMC Corporation. All rights reserved.
Table of Contents
Preface ................................................................................................................................. 7
Chapter 1 Prepare for Installation ................................................................................. 9

Pre-installation procedure .................................................................................. 9
Preinstallation checklist .................................................................................... 13
Chapter 2 Install ........................................................................................................... 15

Overview ......................................................................................................... 15
Install a high-availability deployment ................................................................ 16
Installing the index server and the index agent configuration program................. 17
Configure indexing and querying ...................................................................... 21
Enabling synonym searches .......................................................................... 21
Disabling indexing of specific object types ...................................................... 21
Rendition formats to index ............................................................................ 22
Configuring format objects to specify which renditions are indexed ................. 22
Supported formats and mime_types .......................................................... 23
Configuring TRY_FTDQL_FIRST query retries on failure ................................ 23
Forcing permissions checks against the repository properties .......................... 24
Configuring batched returns for non-FTDQL queries ...................................... 24
Configuring the index agent .............................................................................. 24
Modifying the IndexAgent.xml file to map file stores .......................................... 26
Reviewing the installation log files..................................................................... 27
Installing the index server in a multinode configuration ...................................... 27
Creating the InstallProfile.xml Configuration File ........................................... 28
Host section ............................................................................................. 28
Administrative services section ................................................................. 30
Content distributor section ........................................................................ 31
Status server section ................................................................................. 31
Search engine section ................................................................................ 32
Document processor section ...................................................................... 33
Query server section ................................................................................. 34
Webcluster section .................................................................................... 34
Other sections .......................................................................................... 36
Installing a multinode configuration .............................................................. 36
Configuring the index agent .......................................................................... 37
Modifying the indexagent.xml file to map file stores ................................... 39
Configuring directed routing ......................................................................... 40
Creating full-text collections ...................................................................... 41
Mapping file stores to collections ............................................................... 42
Mapping collections to index columns ....................................................... 43
Adding a node ............................................................................................. 45
Removing a node.......................................................................................... 47
Chapter 3 Upgrade ....................................................................................................... 49
EMC Documentum Content Server Version 6.6 Full-text Indexing Deployment Guide 3
Table of Contents
Overview ......................................................................................................... 49
Adding the full-text indexing system after upgrading from a 5.3
repository ....................................................................................................... 49
Upgrading a full-text system on Content Server upgraded from 6.5 or
later ................................................................................................................. 50
Upgrading a full-text system on Content Server upgraded from 5.3
SP6, 6.0, or 6.0 SP1 ............................................................................................ 51
Chapter 4 Uninstall ...................................................................................................... 53

Uninstall order ................................................................................................. 53
Deleting an index agent .................................................................................... 53
Deleting the index agent configuration program ................................................. 54
Deleting an index server ................................................................................... 55
Deleting a full-text Index ................................................................................... 55
4 EMC Documentum Content Server Version 6.6 Full-text Indexing Deployment Guide
Table of Contents
List of Figures
Figure 1. The first available document processor handles each incoming document ................ 33
Figure 2. Mapping file stores to collections to index columns ................................................. 41
Table of Contents
List of Tables
Table 1. Required environment variables ............................................................................ 11

Table 2. Checklist for Full-text Indexing ............................................................................. 13
Preface
Purpose of the manual

This manual contains information and instructions for installing, upgrading, and maintaining the
full-text indexing system (including multiple nodes) used with EMC Documentum Content Server. It
describes decisions you need to make and requirements that you need to meet before you install the
full-text indexing software. It also provides step-by-step instructions for installing and upgrading
the software in several different configurations.
Intended audience
This manual is intended for the person installing Content Server and the full-text indexing software.
Typically, a system administrator installs the software.
Related documentation
• The EMC Documentum Content Server Full-text Indexing Administration Guide contains instructions
about configuring and administering your full-text indexing system.
• The Content Server Installation Guide contains information on installing Content Server.
• The Documentum Administrator online help system contains instructions for managing the index
queue and for starting and stopping the index server and index agent, in basic, consolidated,
and high-availability deployments. No Documentum Administrator support is provided for
multinode deployments.
• The EMC Documentum Search Development Guide contains complete information on querying.
Revision history
The following revisions have been made to this document:
Preface
Revision History
Date Description
May 2010 Initial publication for version 6.6.
Fixed these issues:

• CS-14260: In the procedure in Installing
the index server and the index agent
configuration program, page 17, added steps
1 and 18.
Chapter 1
Prepare for Installation
Use the information in this chapter to prepare your installation for the full-text indexing component
installation.
These topics are included:
• Pre-installation procedure, page 9
• Preinstallation checklist, page 13
Pre-installation procedure
1. Install Content Server and configure a repository.
Use the instructions in the Content Server Installation Guide.
2. Host names
You need to identify the host where the index server and index agent are installed by a fully
qualified domain name (FDQN). For example, the host name isolde.documentum.com is
acceptable, but an IP address, for example, 172.04.8.275 is not acceptable.
3. Ports to use for the index agent
The index agent runs in the application server container. When an index agent instance is
configured, you need to designate two ports for the index agent and application server to use.
The default ports for the first index agent on a host are 9200 and 9080. The default for any other
index agents are 90220 for index agent 2, 9240 for index agent 3, and so on. If the index agent is
on the Content Server host, ensure that the ports are not the ports used for the application server
instance in which the Java method server and ACS server run.
4. Ports to use for the index server
The index server requires a contiguous range of 4000 free ports. You must designate which ports
to use during installation. The default range is from 13000 to 17000.
5. Index server operating system and host
Note: Installing the index server installs Java on the host. The installed version of Java is the same
version as the Java version installed with Content Server.
You need to install the index server on a supported operating system. EMC Documentum
recommends using a host on which a clean installation of the operating system has been
performed.
Install the index server on a disk partition separate from the system partition and larger than
the system partition.
Caution: Do not install the index server on VMware in a production environment.
Constraints on third-party software on the index server host — The following restrictions
apply to the index server host:
• Do not run network security scanning software on a host where the index server is installed.
Network security scanners might lock index server processes, which can create intermittent
search and indexing failures.
• Do not run backup utilities while the index server is running.
Backup utilities might lock indexing processes.
• Do not run antivirus software on the %FASTSEARCH% directory, where the index server and
indexes are stored.
Antivirus software interferes with index server startup and proper functioning. Antivirus
software might quarantine log and other frequently-changed files.
EMC Documentum recommends testing any third-party monitoring tools on a development
system before the tools are deployed to a production system where the index server is installed.
Windows host requirements for the index server — The following restrictions apply to
Windows hosts:
• Do not run the Windows Index System on the index server host.
• On 32-bit Windows hosts, do not set the /3GB option in the boot.ini file.
• Disable automatic Windows updates on index server hosts.
• Do not install the index server on a domain controller.
Note: If a 5.2.x repository is running on a Windows host and you are performing a pre-upgrade
index migration, you must install the index agent and index server on a host other than the
Content Server host. For more information, refer to Chapter 3, Upgrade.
6. Host time settings
Set the time zone on the host where the index server runs to Greenwich Mean Time (GMT) or
Universal Time Coordinated (UTC). On Windows hosts, clear Automatically adjust clock for
daylight saving changes.
7. Ensuring correct network configuration
If you are installing the indexing software on a host other than the Content Server host, ensure
that the domain name service (DNS) entries for the two machines are correct so that they are able
to locate each other on the network.
To verify the DNS entries:
a. On the index server host, look up the Content Server host:
nslookup FQDN_of_Content_Server_host
where FQDN_of_Content_Server_host is the FQDN of the Content Server host.
This returns one or more IP addresses for the Content Server host.
b. Use the first IP address returned in step 1 for a reverse lookup:

nslookup IP_address_returned
The correct return value is the same FQDN you entered in step 1.
c. If the two nslookup commands do not return the correct values, update the DNS servers used
by the two hosts to reflect the correct FQDNs.
d. If necessary, on Windows with more than one network card, update the host files to ensure
that the correct IP address for each host is listed first.
e. If the nslookup commands succeeded and return the correct values, ping the index server
host from the Content Server host to ensure that it responds to the pin and to ensure that the
IP address that responds to the ping is the IP address defined in the ftengine config object.
8. Index agent and index server installation account
You need to install the index agent and index server under the same user name under which you
installed Content Server (the Content Server installation owner). If you are installing the index
agent and index server on a host other than the Content Server host, ensure that the user exists
on that host. Refer to “Installation Owner Account” in the correct section for your operating
system, in Chapter 3, “Preparing for Installation,” of the Content Server Installation Guide, for more
information on the installation owner account.
9. Environment variables on UNIX and Linux hosts
You must set the following environment variables in the installation owner’s environment on
UNIX and Linux hosts before installing the index agent and index server:
Table 1. Required environment variables
Environment Variable Description Required Values

DOCUMENTUM The directory in which the Any directory in the
indexing software is installed installation owner’s
environment
DOCUMENTUM_SHARED The directory in which the Any directory in the
Documentum Foundation installation owner’s
Classes (DFC) are installed environment
LD_LIBRARY_PATH, The index server library $DOCUMENTUM/fulltext/
SHLIB_PATH, or LIBPATH location IndexServer/lib
$DOCUMENTUM/fulltext/
fast
$DOCUMENTUM_SHARED/
dfc
$DOCUMENTUM_SHARED/
IndexAgents/ftintegrity
FASTSEARCH Location of the index server $DOCUMENTUM/fulltext/
IndexServer
DISPLAY Controls the display localhost:0.0
Environment Variable Description Required Values

LC_ALL C
JAVA_HOME The home directory for the Any directory in the
Java installation on the host installation owner’s
environment
10. Ensuring that the index server environment is correct on UNIX and Linux hosts
The index server installation includes a script that sets required environment variables for
running the index server. The script is setupenv.sh or setupenv.csh, depending on the shell from
which you run, and it is located in the indexserver_install_dir/bindirectory. You can source this
script to ensure that the environment variables are correct.
11. The deprecated DFC_DATA environment variable on UNIX hosts
The DFC_DATA environment variable was deprecated after the 5.1 EMC Documentum
release, but it is still used by Documentum installers for backward compatibility. If you are
installing the indexing software on a UNIX host where older EMC Documentum software
required setting DFC_DATA, the installer uses the value of DFC_DATA to create the /config
directory ($DFC_DATA/config). However, the startupIndexAgent.sh script expects to
find the $DOCUMENTUM_SHARED variable set and expects the /config directory to be
$DOCUMENTUM_SHARED/config.
If the /config directory is not $DOCUMENTUM_SHARED/config, edit the startupIndexAgent.sh
script so that it points to the valid /config directory path on the index agent host. Replace these
lines:
CLASSPATH=$DOCUMENTUM_SHARED/dctm.jar:$DOCUMENTUM_SHARED/config:
$DOCUMENTUM_SHARED/dfc/dfc.jar:$DOCUMENTUM_SHARED/dfc/dfcbase.jar:
$DOCUMENTUM_SHARED/dfc/log4j.jar
with:
CLASSPATH=$DOCUMENTUM_SHARED/dctm.jar:$DOCUMENTUM/config:
$DOCUMENTUM_SHARED/dfc/dfc.jar:$DOCUMENTUM_SHARED/dfc/dfcbase.jar:
$DOCUMENTUM_SHARED/dfc/log4j.jar
12. Installing the index server on Windows hosts

The Windows file cscript.exe is required for running the index server installer. Do not delete
cscript.exe from a Windows host on which you are installing the index server.
Preinstallation checklist
Use following the checklist to ensure that you have performed all required tasks before installing
or upgrading the full-text indexing software.
Table 2. Checklist for Full-text Indexing
Task For More Information Completed?

Determine which full-text CenterStage System Planning
indexing configuration to use. Guide
Determine the port numbers Pre-installation procedure,
the index agent uses. page 9, CenterStage System
Planning Guide
Determine the base port the Pre-installation procedure,
index server uses. page 9, CenterStage System
Planning Guide
Ensure that 4,000 ports above Pre-installation procedure,
the base port number are page 9, CenterStage System
unused and available for the Planning Guide
index server, for example, if the
base port number is 3,000, port
numbers from 3,000 to 7,000
must be available.
Determine the user accounts Pre-installation procedure,
to use for installing the index page 9, CenterStage System
agent and index server. Planning Guide
Ensure that the user accounts Network administrators
are set up.
Ensure that the disk space and • CenterStage System Planning
memory requirements for the Guide
indexing software are met.
• Chapter 1, Prepare for
Installation
For a Content Server upgrade, Chapter 3, Upgrade

decide whether to migrate
the indexes before or after
the server and repository are
upgraded.
Determine where the full-text CenterStage System Planning
indexes are to be created and Guide
stored.
Task For More Information Completed?

Ensure that any additional Chapter 1, Prepare for
hosts required by the index Installation
agent and index server are
configured.
Mount the drive where the • Hardware and operating
content files are located to system vendor
make the content accessible to documentation
the index servers.
• CenterStage System Planning
Guide
Determine for which languages Full-text Indexing Administration
grammatical normalization is Guide, “Overview” chapter
required.
Chapter 2
Install

• Overview, page 15
• Install a high-availability deployment, page 16
Review this section before you install a high-availability configuration or if you are converting an
existing installation to high availability.
• Installing the index server and the index agent configuration program, page 17
• Configuring the index agent, page 24
• Modifying the IndexAgent.xml file to map file stores, page 26
• Reviewing the installation log files, page 27
• Installing the index server in a multinode configuration, page 27
Overview
This chapter contains instructions for installing the full-text indexing software and creating
full-text indexes, whether you are upgrading from an earlier Documentum release or creating new
repositories.
The high-level procedure for installing the full-text indexing server and full-text indexing components
for a new installation is:
1. Install the index server and index agent configuration program.
Use the instructions in Installing the index server and the index agent configuration program,
page 17.
2. Configure the index agent.
Configuring the index agent, page 24 has instructions.
3. Start the index agent in normal mode.
To install a consolidated deployment, install the index agent and configure an index agent for each
repository, then index each repository.
To install a high availability configuration, you need to install the indexing software on the first host,
perform steps on the Content Server host, install the indexing software on the second host, and
perform additional steps on the Content Server host.
Install
Install a high-availability deployment

Follow these instructions to install full-text indexing in a high-availability configuration (whether you
are installing a new indexing system or adding high availability to an existing basic configuration).
Note: High-availability indexing is supported with consolidated configurations.
1. If you do not already have an existing full-text indexing system, install the full-text indexing
software on the first host and configure an index agent.
Note: On Windows, you need to log on as the same user, in the same domain, as the user who
installed the Content Server installation.
Use the instructions in Installing the index server and the index agent configuration program,
page 17 and Configuring the index agent, page 24.
2. Log on to the Content Server host as the installation owner.
3. Ensure that no users are connected to the repository.
4. Shut down the first index agent.
5. Navigate to the directory where the create_fulltext_objects_ha.ebs script is located:
• On Windows, the %DM_HOME%\install\admin folder
• On UNIX or Linux, the $DM_HOME/install/admin directory
6. If you are upgrading the system, run the following command:
dmbasic -f create_fulltext_objects_ha.ebs
-e HACleanupBeforeUpgradeStep --
repository_name
Superuser_name Superuser_password
where repository_name is the name of the repository, Superuser_name is the user name of a user
with superuser privileges in the repository, and Superuser_password is the superuser’s password
7. Run the create_fulltext_objects_ha.ebs script using this syntax, where repository_name is the name
of the repository, Superuser_name is the user name of a user with Superuser privileges in the
repository, and Superuser_password is the Superuser’s password:
-e HAPreInstallStep -- repository_name
8. Install the full-text indexing software on the second indexing host and configure an index agent,
using the instructions in Installing the index server and the index agent configuration program,
page 17 and Configuring the index agent, page 24.
Do not start the new index agent. The repository now contains two full-text index objects, two
ft index agent config objects, and two ft engine config objects.
9. Log on to the Content Server host as the Content Server installation owner.
10. Navigate to the directory where the create_fulltext_objects_ha.ebs script is located:
• On Windows, the %DM_HOME%\install\admin folder
• On UNIX or Linux, the $DM_HOME/install/admin directory
Install
11. Run the create_fulltext_objects_ha.ebs script using this syntax, where repository_name is the name
of the repository, Superuser_name is the user name of a user with superuser privileges in the
repository, and Superuser_password is the superuser’s password:
-e HAPostInstallStep -- repository_name
12. Restart the Content Server.

Note: The index agent restarts only if the index agent’s application server instance is running.
13. Confirm that the required objects have been created and updated:
a. In Documentum Administrator, connect to the repository as a user with superuser privileges.
b. Execute the following DQL statement to verify that there are two fulltext index objects, each
associated with one of the two indexes and that each has an associated ftengine config object:
SELECT r_object_id,index_name,ft_engine_id,is_standby
from dm_fulltext_index
The query returns two rows, one with an index name ending in 00, which represents the
primary index, and one with an index name ending in 01, which represents the standby index.
c. Execute the following query to verify that correct ftengine config object is associated with
the primary index:
SELECT r_object_id,object_name FROM dm_ftengine_config
The object ID in the returned row with the object name that ends in 00 matches the
ft_engine_id value returned in the previous step for the primary index.
d. Execute the following DQL statement to verify that there is an ftindex agent config object for
each index and that the queue user is correctly set for the second index:
select r_object_id,object_name,index_name,queue_user
from dm_ftindex_agent_config
The object_name records the name of the index agent and index_name is the name of the
index. The name of the primary index ends in 00. The name of the standby index ends in 01.
The queue user for the primary index is dm_fulltext_index_user, and for the standby index,
the queue user is dm_fulltext_index_user_01.
14. Start the index agents on both hosts.
Starting the index agents will create the indexes.
15. Verify the indexes on both hosts.
Use ftintegrity or the State of the Index job to verify the indexes. See the Documentum Content
Server Full-text Indexing Administration Guide.
Installing the index server and the index agent

configuration program
Use these instructions to install the index agent or the index server software. The same installation
program is used for both components. You can install either or both of the components on a
particular host.
Install
Installing the index server also installs Java on the index server host. The Java version level is the
same as the version level of Java installed with Content Server.
The installer installs the index agent configuration program, which you use to configure an index
agent instance. If you do not configure the index agent immediately after installing the configuration
program, you can do so at a later time.
To install the index server and the index agent configuration program:
1. On HPUX-IA11.23, use these commands to unset the SHLIB_PATH variable:
• csh: unsetenv SHLIB_PATH
• sh: unset SHLIB_PATH
Otherwise, you might get the following error message:
Error occurred during initialization of VM. Unable to load native library: some symbol required
This is a known issue. (CS-14260)
After installation completes, you can user these commands to reset the SHLIB_PATH variable:
• csh: setenv SHLIB_PATH
• sh: set SHLIB_PATH
2. On HP-UX, you must set the following parameter values:
• Set maxdsiz or data seg size at 2 GB (0x80000000)
• Enable Largefiles
• Set maxusers to 256 or higher
• Set max_thread_proc to 256 or higher
• Set maxfiles to 1024 or higher
3. Ensure that the repository (for which you are installing the index server and index agent)
is running.
4. Log on to the index server and index agent host as the Content Server installation owner.
On Windows, this means you need to log on as the same user, in the same domain, as the user
who installed the Content Server installation.
5. Copy the installation files from the EMC Documentum download site or distribution CDs to
a temporary location on the host.
6. Start the installation program.
• On Windows, double-click fulltextWinSuiteSetup.exe.
• On UNIX and Linux, type
% fulltextoperatingsystemSuiteSetup.bin
and press Enter, where operatingsystem is the operating system on which you are installing.
A Welcome dialog box is displayed.
7. Click Next.
The license agreement dialog box is displayed.
8. Click I accept the terms of the license agreement and click Next.
A dialog box is displayed that lists the products you can install.
Install
9. Choose the products to install.

• To install the index agent, check Documentum Index Agent Configuration Program.
• To install the index server, check Index Server.
10. Click Next.
11. Indicate whether to install the developer documentation and click Next.
12. If required, install DFC.
a. On Windows, accept the default installation directory or type a different directory name
and click Next.
This is typically C:\Program Files\Documentum. On UNIX and Linux, the DFC directories
are determined by environment variables set before installation.
b. On Windows, accept the default user directory or type the name of a different directory
and click Next.
This is typically C:\Documentum.
Note: If the DOCUMENTUM environment variable is set on the host, you need to accept the
default directories. The installation program uses the value of the DOCUMENTUM variable to
generate the default directories and will not allow you to change the directories.
13. If a dfc.properties file does not exist on the host, provide connection information.
Note: If you are installing the software to create an index for a repository prior to version
5.3 for migration purposes, the connection information is in a dmcl.ini file on the host, not
a dfc.properties file.
a. Type the name of a host where a connection broker is running.
b. Type the port number used by the connection broker.
c. Click Next.
14. Read the explanatory information about full-text indexing, then click OK.
15. To install the index server, complete these steps.
a. Accept the default index server installation directory or type the name of a new directory,
then click Next.
default directory. The installation program uses the value of the DOCUMENTUM variable to
generate the default directory and will not allow you to change the directory.
b. On Windows, type the password for the account you used to log on, then click Next.
The installer verifies the password.
c. Type the base port number for the index server, then click Next.
The index server requires 4,000 available ports in sequence; for example, if the base port
you designate is 3000, the index server uses ports 3000 through 7000. Do not use a port
in ephemeral range.
The default base port is 13000.
Note: You cannot change the chosen ports unless you remove and reinstall the index server.
d. Check the check box to enable support for grammatical normalization.
Install
Choosing the parts of speech to be indexed can reduce the size of the indexes and the disk
space required for maintaining the indexes. You can enable grammatical normalization only
for the languages listed on the dialog box. If you enable grammatical normalization, it is
enabled by default for Japanese and Korean and you cannot disable it.
Note: Content files in languages that are not chosen or that are not available for normalization
are still indexed.
e. Choose the languages for which to perform grammatical normalization and the parts of
speech to be indexed by selecting the appropriate check boxes.
The recommended choice is to normalize only nouns.
f. Accept the default directory for the full-text indexes or type the name of a different directory,
then click Next.
The default on Windows is %DOCUMENTUM%. The default on UNIX or Linux is
$DOCUMENTUM. If you choose another directory, the name cannot contain any blank
spaces. The installer creates the directory \data\fulltext (/data/fulltext on UNIX or Linux)
under the location you designate.
On HP-UX (B.11.23 U 9000/800), you cannot install the Index Server in a directory that
contains an “_d” in the directory path.
default directory. The installation program uses the value of the DOCUMENTUM variable to
generate the default directory and will not allow you to change the directory.
A summary dialog box is displayed, listing the products that will be installed.
16. Click Next.
The products are installed and a panel is displayed indicating success when the installation is
completed.
17. Ensure that the index server starts.
• On Windows, select Yes, restart my computer., then click Next.
— If the computer does not restart automatically, click Start > Shutdown > Restart and restart
the computer manually.
— If the index server does not automatically start, click Start > Programs > Administrative
Tools > Services and start the FAST InStream service.
— If the system restarts, the index server starts automatically as a Windows service.
• On UNIX and Linux, navigate to the $DOCUMENTUM/fulltext/IndexServer/bin directory
(the installation location), type startup.sh, and press Enter.
The index server is started.
18. On HPUX-IA11.23, after installation completes, you can user these commands to reset the
SHLIB_PATH variable (that you unset in Step 1):
• csh: setenv SHLIB_PATH
• sh: set SHLIB_PATH
Caution: Do not run backup utilities while the index server is running, because they may lock
indexing processes.
Install
Configure indexing and querying

This section describes how to configure indexing and querying behaviors, to help ensure that users’
searches find the objects they want.
Enabling synonym searches

Perform the following procedure if you want to execute synonym searches against the index.
Note: You also need to generate the synonyms to be searched. This procedure only enables searching
after the synonyms are generated.
To enable synonym searches:

1. Log on to the index server host as the installation owner.
2. Navigate to %FASTSEARCH%\etc\config_data\QRServer\webcluster\etc\qrserver
($FASTSEARCH/etc/config_data/QRServer/webcluster/etc/qrserver).
3. Open the qtf-config.xml file in an editor.
4. Insert the following entry after the <instance-re name=”tokenize”/> entry:
<instance-ref name="synonymy"/>
5. Save the file.
Disabling indexing of specific object types

By default, all instances of dm_sysobject or its subtypes are indexed. However, you can disable
indexing of instances of specific object types in repositories at version 5.3 SP5 or later.
A type is registered for indexing if any of its supertypes are registered for indexing. You cannot turn
off indexing for an object type if any of its supertypes are indexed. Because dm_sysobject and all of its
subtypes are indexed (registered for indexing) by default, if you want to disable indexing for one or
more subtypes, you need to turn off indexing for dm_sysobject and then enable indexing specifically
for those subtypes that you want indexed, leaving those you do not want to index unregistered.
Use Documentum Administrator to disable or enable indexing. You need to connect as a superuser.
The Properties page for each object type capable of being indexed has a check box named Registered
for indexing. That check box indicates whether the object type is currently registered for indexing.
The field is enabled or disabled depending on whether you can change the type’s indexing status.
To remove or add registration for indexing for an object type:

1. Start Documentum Administrator as a superuser.
2. Select the Types node.
3. Navigate to the object type whose registration you want to change and open its Properties page.
This needs to be dm_sysobject or one of its subtypes.
Install
4. To stop indexing of instances of the type, clear Register for indexing.

5. To resume indexing of instances of the type, select Register for indexing.
Rendition formats to index

Documents have content files in many formats. Some documents have primary content that is not
indexable, but also have indexable renditions of that content. Other documents have indexable
primary content and indexable renditions. By setting properties within the format objects for the
various formats, you can direct Content Server to index all indexable renditions of a document or
only preferred renditions. For instructions on setting format object properties to configure which
renditions are indexed, refer to Configuring format objects to specify which renditions are indexed,
page 22.
Configuring format objects to specify which renditions

are indexed
Objects can have multiple content files in different formats; also known as renditions. Some of the
renditions may not be indexable. By setting properties within the format objects for the various
formats, you can direct Content Server to index all indexable renditions of an object or the preferred
renditions only. See Configuring format objects to specify which renditions are indexed, page 22.
Properties of the format object determine which formats are indexable and which content files in
indexable formats are indexed. If the value of the can_index property of a content file’s format object
is set to TRUE, the content file is indexable. If the primary content of an object is not in an indexable
format, you can ensure that the content file is indexed by creating a rendition in an indexable format.
The format_class property of the format object may be set to values that determine which formats
are indexed:
• ft_always
All renditions in formats whose format_class property is set to ft_always are indexed. For
example, if a document has renditions in Microsoft Word and PDF formats and the format_class
property for both formats is set to ft_always, both renditions are indexed.
• ft_preferred
If a document has multiple renditions in indexable formats and one is in a format whose
format_class property is set to ft_preferred, the rendition in that format is indexed rather than any
renditions in other formats, with the exception that any formats whose format_class property is
set to ft_always are also indexed. If a document has more than one rendition whose format_class
property is set to ft_preferred, the first rendition processed for indexing is indexed and the other
renditions are not. You cannot determine in advance which rendition is processed for indexing.
EMC Documentum recommends that for any document, only one rendition is in a format whose
format_class property is set to ft_preferred.
If a document has renditions in four different formats, of which the format_class of one is set
to ft_preferred and the format_class of the other three is set to ft_always, all four renditions
are indexed.
Install
No default value for the format_class property exists. You need to set it manually to designate
whether a format is always indexed or is the preferred format for indexing.
By default, the first content file in a format whose can_index property is set to true is indexed. Other
renditions of the object are not indexed. If the primary content of an object is not in an indexable
format, create a rendition in an indexable format. The Full-text Indexing Administration Guide,
“Supported and Unsupported Formats” appendix, contains a complete list of indexable formats.
If the content file associated with a SysObject exists in a no-indexable format, its properties are
still indexed. To index the content, create a rendition of the SysObject in an indexable format. Use
Documentum Content Transformation Services or third-party client applications to create the
rendition.
Supported formats and mime_types
See the Full-text Indexing Administration Guide, “Supported and Unsupported Formats” appendix,
for a list of the formats considered indexable by the index server.
Some formats in the appendix are not represented in the repository by a format object. The
formats.cvs file, which is located in $DM_HOME/install/tools, contains a complete list of supported
mime_types and the formats with which they are associated. If a supported mime_type is not
represented by a format object, create a format object in the repository and map the supported
mime_type to the format.
Configuring TRY_FTDQL_FIRST query retries on failure

In DQL, users can include the TRY_FTDQL_FIRST hint to queries, which instructs Content Server
to first execute a query as an FTDQL query and, if the query fails with certain full-text error codes,
re-execute the query as a standard query.
By default, only three error codes, 1105, 1012, and 1017, are caught by Content Server, and cause the
server to re-execute the query as a standard query. You can add additional error codes to the list
of recognized error codes if you want queries with this hint to be retried as standard queries for a
larger number of errors.
To add additional error codes:

1. Set the param_name property in the dm_ftengine_config object to:
ftquery_retry_on_queryserver_errorcodes
2. Set the param_value property at the corresponding index position to the list of error codes
representing the additional errors you wish to catch.
The error codes are the four-digit codes returned in the error message. For example, here is an
error message with the four-digit error code highlighted in bold:
[DM_FULLTEXT_E_SEARCH_NEW_FAIL]error:"dmFTSearchnew
failed with error: QRServer Error (1012):
Resource limit exceeded, Error from QRServer, error code: -2"
Separate multiple errors codes with commas.
Install
Forcing permissions checks against the repository

properties
When a search is conducted, the returned results are filtered so that users receives only those results
for which they have the appropriate permissions. By default, the permission checking is against the
acl_name and acl_domain values stored in the index. However, you might want to conduct the
permission checking against the values stored in the repository for these properties, to ensure that the
values are the most current values.
To force the index server to check permissions against the ACL specified by the acl_name and
acl_domain properties in the repository, set the acl_check_db parameter to TRUE (or true) in the
dm_ftengine_config object. Set the parameter name in the param_name property and the value (true)
in the param_value property. The name and value need to be set at the same index position within
these repeating properties.
Configuring batched returns for non-FTDQL queries

Queries that contain a SEARCH clause but are not FTDQL queries are processed using a temporary
table. Content Server populates a temporary table with the results returned by the SEARCH clause
and then filters the results for security and matches to any other conditions specified in the query.
Because the full-text engine may return duplicate hits for an object, Content Server also processes
the full-text results within each batch to remove duplicates. (However, if there are duplicate rows
across batches, those duplicates are not removed.)
If the SEARCH clause has returned a large number of results, processing them might take some time.
To improve performance, the results are populated into the temporary table and are processed in
batches except when the query contains any of the following:
• An aggregate function, such as count() or sum().
• A UNION, IN DOCUMENT, IN ASSEMBLY, or ORDER BY clause
• A SEARCH clause in a subquery
In these cases, all results are populated into the temporary table for processing as a single batch.
To set the batch size, use the dm_ftengine_config object’s temp_table_batch_size parameter. The
default batch size is 20000. To disable the batching feature, set this parameter to 0 (zero). The
parameter name is set in param_name property and the value is set in the param_value property.
These are repeating properties, so you must set the name and value at the same index position within
the property. The value is an integer number representing the number of results in each batch.
You must reinitialize Content Server after setting the parameter.
Configuring the index agent

The index agent configuration program configures the index agent to process documents for a
particular repository and to pass the documents to the correct index server instance for indexing. Use
these instructions to run the index agent configuration program.
Install
To configure the index agent:

1. Ensure that the index server associated with the index agent is running.
To check that the index server is running, check the index server log file for a message that says:
fnet: engine up
2. Start the index agent configuration program.

• On Windows, after the host reboots and you log on as the installation owner, click Start >
Programs > Documentum > Index Agent Configuration Program.
• On UNIX and Linux, navigate to $DOCUMENTUM_SHARED/IndexAgents and start the
dm_launch_indexagent_config_program.sh script.
3. Click Next.
4. On Windows, type the installation owner’s password, then click Next.
5. Specify the port used to communicate with the application server for administration purposes,
then click Next.
The default port, 9020, is for the first index agent on the host. If the index agent is on the Content
Server host, the port number cannot be the port number used by the Java method server or
Site Caching Services.
6. Select the repository for which the index agent will prepare documents, then click Next.
The dropdown list contains the repositories that project to the connection brokers listed in the
dfc.properties file on the host.
7. Specify the user name and password for the superuser account that the index agent will use to
connect to the repository.
Use this user name and password later to access the Index Agent Admin Tool.
8. Indicate whether to run the index agent in normal mode or migration mode.
If the index agent is installed to run against a pre-5.3 repository for migration purposes, choose to
run the index agent in migration mode. Otherwise, choose normal mode.
9. Type the name of the host where the index server for this index agent is running and the base
port number for the index server, then click Next.
If you are configuring the index agent for the second indexing installation in a high-availability
deployment, ensuring that you point the index agent to the second index server host, not the first
index server host. The installer defaults to the first index server host.
A summary dialog box is displayed.
10. Click Next.
On Windows, the index agent is created and the application server is started.
11. If you are on UNIX or Linux, navigate to $DOCUMENTUM/jboss4.2.0/server and type
startupIndexAgentN.sh, where N is the number corresponding to the new index agent instance,
to start the index agent and its application server instance.
12. To create additional index agents, select the check box and click Next, then complete steps 4–10
again.
13. To exit from the configuration program, click Finish.
Install
14. To complete the installation process:

• If you are mapping the file stores, complete the instructions in Modifying the IndexAgent.xml
file to map file stores, page 26.
• If you are installing a high-availability configuration and you have installed the index
server and configured the index agent on the first host, return to Install a high-availability
deployment, page 16 and continue from Step 2.
• If you are installing a high-availability configuration and you have installed the index server
and configured the index agent on the second host, return to Install a high-availability
deployment, page 16 and continue from Step 9.
Do not start the index agent on the second host.
Modifying the IndexAgent.xml file to map file

stores
If you have shared or mounted the drives containing the repository’s file stores and installed the
indexing software, you need to edit the index agent configuration file manually to indicate that the
drives are shared. The changes depend on whether the file system paths to the content are identical
on the Content Server host and index server host.
In a distributed configuration, all content located in distributed stores is moved to the primary
site, using the Surrogate Get method, and indexed at the primary site. You cannot map the remote
components of a distributed store. Similarly, you cannot map an encrypted store or an external store.
To modify the IndexAgent.xml file and map the file stores:

1. On the index agent host, navigate to C:\Documentum\jboss4.2.
0\domains\DctmDomain\upload\IndexAgent1\IndexAgent1.war\WEB-INF\classes
(on Windows) or $DOCUMENTUM_SHARED/jboss4.2.0/domains/DctmDomain/upload/
IndexAgent1/IndexAgent1.war/WEB-INF/classes (on UNIX).
If you installed multiple index agents on this host, replace the number 1 in these paths with the
appropriate index agent number.
2. Open the IndexAgent.xml file in a text editor.
3. If the paths to the content files are identical on the Content Server host and index server host,
locate the <exporter></exporter> element and change the value of the <all_filestores_local>
element to true:
<all_filestores_local>true</all_filestores_local>
If the paths to the content files are different, do not modify the value of <all_filestores_local>, but
instead, create a file store map within the <exporter> element.
For example, if Content Server is on a host called Dandelion where filestore_01 is physically
located in the directory /Dandelion/Documentum/data/repository_name/content_storage_01 and
the index agent and index server on a host from which the drive on the Content Server host is
shared as /mappingtoDandelion/repository_name/content_storage_01, create an alias as follows:
<local_filestore_map>
<local_filestore>
Install
<store_name>filestore_01</store_name>
<local_mount>/mappingtoDandelion/
repository_name
/content_storage_01</local_mount>
</local_filestore>
<!-- and so on for each filestore --!>
</local_filestore_map>
If you are indexing content stored on a NAS device or a Windows 2003 Server host, you may see
the following error message in the dmi_queue_item’s message attribute:
DocumentRetriever :ERROR Retrieval error: Couldn’t open file
<file path/name> ERROR Processor error status:
DataNotAvailable Not read permission
To resolve this error, edit the <local_mount> element or elements in the IndexAgent.xml file that
reference the storage area or areas on the NAS device. Add two back slashes immediately after
the opening <local_mount> element. For example, assume the following references a storage
are on an NAS device:
<local_mount>\\100.2.4.32\share3\c\data_for_example
\content_storage_1</local_mount>
After editing, it is now:
<local_mount>\\\\100.2.4.32\share3\c\data_for_example
4. Save the IndexAgent.xml file.

5. Restart the index agent.
Reviewing the installation log files

On any host where you installed the full-text indexing components, an installer log is generated.
Navigate to the directory from which you ran the installation and examine install.log for errors and
warnings.
Installing the index server in a multinode

configuration
You install the index server in a multinode configuration by running the index server installation
program on the host machine for each node. The installation program refers to a configuration file
named InstallProfile.xml to determine which index server processes to install on the current host.
The major steps required to install the index server in a multinode configuration are:
1. Create a single, global copy of the InstallProfile.xml configuration file that defines the complete
configuration.
Install
The InstallProfile.xml file lists the host machines for each node and specifies which index server
processes to install on each host. See Creating the InstallProfile.xml Configuration File, page 28.
2. Run the index server installation program on each host machine, as described in Installing a
multinode configuration, page 36.
3. Install an index agent to provide communication with Content Server.
The index agent is usually installed on the host machine where the index server’s administrative
processes are running, or on the Content Server host. See Configuring the index agent, page 37.
4. If you plan to use directed routing, configure the index agent and index server to provide the
desired mapping of documents to index columns.
See Configuring directed routing, page 40.
Creating the InstallProfile.xml Configuration File

The InstallProfile.xml configuration file is an XML file that controls which index server components
are installed on each node of a multinode deployment. Before beginning the installation, you create
a single, global copy of InstallProfile.xml that defines the complete configuration. The index server
installation program refers to the file as it installs each node.
To create the InstallProfile.xml file for your implementation:

1. Copy the sample InstallProfile.xml file for the platform on which you plan to install the index
server.
Refer to Support Note esg90092 for the sample InstallProfile.xml files. The sample files are named
for each platform: InstallProfileWindows.xml, InstallProfileSolaris.xml, InstallProfileLinux.xml.
Save the file for your platform as InstallProfile.xml, and modify the saved copy of the file. Ensure
that you retain a backup copy of the modified file.
2. Open the file in a text editor and make the changes described in this chapter.
The file contains separate sections, several of which contain parameters defining the particulars of
the configuration. This chapter covers each of the sections separately, describing the purpose
of the section and identifying the values you need to update.
Note: Do not change the property names or IDs found in the file. The sections below discuss
which parameter values you may change; leave the remaining content unchanged.
3. Save the file with the name InstallProfile.xml.
You will make an exact copy of this file for each index server node you install, as described in
Installing a multinode configuration, page 36.
Host section
The host section of the InstallProfile.xml configuration file identifies the hosts in the multinode
deployment and defines some basic configuration parameters for each host. To complete this section,
you need the following information:
• The fully-qualified domain name for each host computer
Install
For example, tristan.documentum.com, not tristan.

• The platform on which the indexing software will be installed
There is a sample IndexProfile.xml file for Windows, Linux, and Solaris (= Sun OS).
• The installation owner’s user name
This is the same user as the Content Server installation owner. Ensure that you use the same
domain or NIS user account for installing each index server node as you used for installing
Content Server. The user IDs need to match.
• The installation directory
The defaults are drive\Documentum\fulltext\IndexServer\ on Windows and
/fulltext/IndexServer/ (under $DOCUMENTUM) on Linux and UNIX. Since all host computers
use the same InstallProfile.xml file, ensure that you use the same drive letter or mount-point
specification on all index server nodes.
• The host’s temporary directory
The defaults are C:\temp on Windows and /tmp/ on Linux and UNIX.
• The base index server port
The default is 13000. Use the same base port on all nodes in the multinode deployment.
Below is a sample of the host section for a Windows installation in which there are two hosts
(norway1.performance.documentum.com and norway2.performance.documentum.com), with
user name dmadmin, installation directory of F:\Documentum\fulltext\IndexServer\, temporary
directory of : C:\Temp\, remote command of SSH2, and base port of 13000:
<host-set>
<host id="norway1.performance.documentum.com">
<property name="hostname" value="norway1.performance.
documentum.com"/>
<property name="platform" value="Windows"/>
<property name="username" value=".\dmadmin"/>
<property name="install-dir" value="F:\Documentum\
fulltext\IndexServer\"/>
<property name="temp-dir" value="C:\Temp\"/>
<property name="remote-cmd" value="SSH2"/>
<property name="baseport" value="13000"/>
</host>
<host id="norway2.performance.documentum.com">
<property name="hostname" value="norway2.
performance.documentum.com"/>
<property name="platform" value="Windows"/>
<property name="username" value=".\dmadmin"/>
<property name="install-dir" value="F:\Documentum
\fulltext\IndexServer\"/>
<property name="temp-dir" value="C:\Temp\"/>
<property name="baseport" value="13000"/>
</host>
</host-set>
The items you should update with the details for your configuration are shown below in italic font.
Do not change any other values, such as the remote-cmd property or its value.
Add an additional <host> section for each host in the configuration, following the pattern shown
below. All <host> sections need to appear inside the <host-set> element.
Install
Note: On Windows hosts, the value of the property username needs to start with a period and
backslash, for example, .\dmadmin. On UNIX hosts, the value would be dmadmin.
<host-set>
<host id="Fully_qualified_host_name">
<property name="hostname" value=
"Fully_qualified_host_name"/>
<property name="platform" value=
"platform"/>
<property name="username" value=
"installation_owner_name"/>
<property name="install-dir" value=
"installation_directory"/>
<property name="temp-dir" value=
"temporary_directory"/>
<property name="baseport" value=
"base_port_number"/>
</host> </host-set>
Administrative services section
The administrative services section identifies which host will server as the administrative node
and the index server components that are installed on the administrative node of the multinode
deployment. To complete this section, you need the fully-qualified name of the host where the
administrative node will be installed.
Below is a sample of the administration section of the InstallProfile.xml file, in which
norway1.performance.documentum.com is identified as the host where the administrative services
are installed:
<administration-set>
<configuration-service id="CS1" host-ref="norway1.
performance.documentum.com">
</configuration-service>
<log-service id="LGS1" host-ref="norway1.performance.
documentum.com"></log-service>
<administration-gui id="ADM1" host-ref="norway1.
performance.documentum.com"></administration-gui>
<vespa id="VSP1" host-ref="norway1.performance.
documentum.com"></vespa>
<storage-service id="STOR1" host-ref="norway1.
performance.documentum.com" admin="root" adminpassword=
"d4tAs34rch" user=“dmadmin" userpassword=“d3v3l0p">
</storage-service>
<name-service id="NAME1" host-ref="norway1.
</name-service>
</administration-set>
Do not change any other values; for example, do not change the admin user name and admin
password in the <storage-service> element.
Note: The user attribute value cannot contain a period. On Windows hosts, the user attribute
value cannot start with a period and backslash (.\). You are not required to use the Documentum
installation owner user name and password for the user and userpassword attributes.
<administration-set>
Install
<configuration-service id="CS1" host-ref=

"Fully_qualified_host_name">
</configuration-service>
<log-service id="LGS1" host-ref=
</log-service>
<administration-gui id="ADM1" host-ref=
</administration-gui>
<vespa id="VSP1" host-ref=
</vespa>
<storage-service id="STOR1" host-ref=
"Fully_qualified_host_name"
admin="root"
adminpassword="d4tAs34rch"
user="user_name"
userpassword="user_password">
</storage-service>
<name-service id="NAME1" host-ref=
</name-service>
</administration-set>
Content distributor section
The content distributor section of the InstallProfile.xml file identifies the host on which the content
distributor service runs. This is typically the administrative node, which is the node you identified
in the Administrative services section, page 30. To complete this section, you need to know the
fully-qualified name of the computer where the administrative services are installed.
Below is a sample of this section, in which the content distributor is running on a host called
norway1.performance.documentum.com:
<content-distributor-set>
<content-distributor id="CD1" host-ref="norway1.
</content-distributor-set>
The item you should update with the details for your configuration is shown below in italic font.
<content-distributor-set>
<content-distributor id="CD1" host-ref=
"Fully_qualified_host_name"/>
</content-distributor-set>
Status server section
The status server section identifies the host where the status server is installed. This is typically the
administrative node, which is the node you identified in the Administrative services section, page
30. To complete this section, you need to know the fully-qualified name of the computer where the
administrative services are installed.
Install
Below is an example of this section, in which the status server is running on a host called
norway1.performance.documentum.com:
<status-service>
<status-server id="STATUS1" host-ref="norway1.
</status-server>
</status-service>
The item you should update with the details for your configuration is shown below in italic font.
<status-service>
<status-server id="STATUS1" host-ref=
</status-server>
</status-service>
Search engine section
The search engine section identifies the hosts on which the indexers and search servers are installed.
Install both components on each host in the multinode deployment.
To complete this section, you need to know the fully-qualified names of the computers in the
deployment. You provided these names in the Host section, page 28.
Below is a sample of this section, in which the indexer and search server are running on hosts called
norway1.performance.documentum.com and norway2.performance.documentum.com:
<search-engine-set>
<search-engine id="RTS1" host-ref="norway1.
<property name="search" value="true"/>
<property name="index" value="true"/>
</search-engine>
<search-engine id="RTS2" host-ref="norway2.
</search-engine>
</search-engine-set>
Do not change any other values. Do not change the property names indicating that the search server
and indexer are installed or change the value true.
Add an additional <search-engine> section for each host in the configuration, following the pattern
shown below. All <search-engine> sections need to appear inside the <search-engine-set> element.
<search-engine-set>
<search-engine id="RTS1" host-ref=
"Fully_qualified_host_name1">
</search-engine>
<search-engine id="RTS2" host-ref=
"Fully_qualified_host_name2">
</search-engine>
Install
<search-engine id="RTSN" host-ref=

"Fully_qualified_host_nameN">
</search-engine>
Document processor section
The document processor section of the InstallProfile.xml file defines the hosts on which document
processors are installed. To complete this section, you need to know the fully-qualified names of the
computers in the deployment. You provided these names in the Host section, page 28.
Below is a sample in which the document processors are running on hosts called
norway1.performance.documentum.com and norway2.performance.documentum.com:
<document-processor-set>
<document-processor id="DP1" host-ref="norway1.
<document-processor id="DP2" host-ref="norway2.
</document-processor-set>
A common configuration has one document processor on each host. However, you can install
multiple document processors on the same host or install one or more document processors on host
separate from the nodes where the indexers and columns reside. When the Content Distributor
routes a document, it routes it to the first non-busy document processor, regardless of which host
the document processor is running on. The document processor passes the document to the proper
indexer.
Figure 1. The first available document processor handles each incoming document
Do not change any other values.
Add an additional <document-processor> section for each document processor you want to create,
following the pattern shown below. All <document-processor> sections need to appear inside the
<document-processor-set> element. All host names need to match hosts listed in the Host section,
page 28.
<document-processor-set>
<document-processor id="DP1" host-ref=
Install
"Fully_qualified_host_name1"/>
<document-processor id="DP2" host-ref=
"Fully_qualified_host_name2"/>
<document-processor id="DPN" host-ref=
"Fully_qualified_host_nameN"/>
</document-processor-set>
Query server section
The query server section of the InstallProfile.xml file defines the host on which the Query and Results
Server is installed. This is typically the administrative node, which is the node you identified in the
Administrative services section, page 30. of the multinode deployment. Do not install more than one
Query and Results Server.
The section also specifies which linguistic rules are used to process search queries and which
language dictionaries are installed. The default-language property sets the (single) language whose
linguistic rules are used to perform grammatical normalization, spell-checking, and so on. The
languages property sets the list of languages whose dictionaries are installed.
To complete this section, you need to know the fully-qualified name of the computer where the
administrative services are installed and the two-character language codes for the languages you
want to enable. For a list of the available language codes, see the Content Server Fulltext Indexing
Installation and Administration Guide.
Below is an example in which the Query and Results Server is running on a host called
norway1.performance.documentum.com, the default language is English (en), and the English and
French (fr) dictionaries are installed:
<query-result-processor-set>
<query-result-processor id="QRP1" host-ref="norway1.
<property name="default-language" value="en"/>
<property name="languages" value="en,fr"/>
</query-result-processor>
</query-result-processor-set>
The items you should update with the details for your configuration are shown below in italic font. If
you include multiple language codes for the language property, separate them with commas.
<query-result-processor-set>
<query-result-processor id="QRP1" host-ref=
<property name="default-language" value=
"language_code"/>
<property name="languages" value=
"language codes"/>
</query-result-processor>
</query-result-processor-set>
Webcluster section
The webcluster section defines which index columns are associated with which search engines.
Install
The Search engine section, page 32 provides an ID for the search engine running on each host (as
the value of the id parameter of the <search-engine> element). They have sequential names based
on which node they are running on: RTS1 for node 1, RTS2 for node 2, and so on. The webcluster
section identifies the index columns and associates each column with the search engine running on
the same node. The IDs for the columns are also sequential, however the numbering starts at zero.
Therefore, as shown in the sample below, column 0 is associated with search engine RTS1, column 1
is associated with search engine RTS2, and so on.
<search-engine-cluster-set>
<search-engine-cluster id="webcluster">
<property name="use-memsearch" value="false"/>
<property name="index-profile-type" value="custom"/>
<property name="index-profile-filename"
value="..\config\datasearch\index-profiles
\index-profile-dctm.xml"/>
<search-engine-column id="col0">
<search-engine id-ref="RTS1"/>
</search-engine-column>
<search-engine id-ref="RTS2"/>
<query-result-processors>
<query-result-processor id-ref="QRP1"/>
</query-result-processors>
</search-engine-cluster>
</search-engine-cluster-set>
The items you should update with the details for your configuration are shown below in italic font. Do
not modify anything else in the webcluster section. Do not change the value of the index-profile-type.
It needs to remain “custom.”
Add an additional <search-engine-column> section for each host in the configuration, following
the pattern shown below. All <search-engine-column> sections need to appear inside the
<search-engine-cluster> element. The value of the <search-engine-column id> needs to be the string
“col” followed by the next sequential number after the previous column. The number needs to match
the partition_id for the column as specified in the CSConfig.xml file; see Adding a node, page 45.
The value of the <search-engine id-ref> property for each node needs to match the value specified for
that host in the Search engine section, page 32. Similarly, the value of <query-result-processor id-ref>
needs to match the ID provided in the Query server section, page 34.
<search-engine-cluster-set>
<search-engine-cluster id="webcluster">
<property name="use-memsearch" value="false"/>
<property name="index-profile-type" value="custom"/>
<property name="index-profile-filename"
value="..\config\datasearch\index-profiles
\index-profile-dctm.xml"/>
<search-engine id-ref=
"search-engine ID for node 1"/>
<search-engine id-ref=
"search-engine ID for node 2"/>
<query-result-processors>
<query-result-processor id-ref="QR Server ID"/>
</query-result-processors>
</search-engine-cluster>
Install
</search-engine-cluster-set>
Other sections
The configuration file also contains data-source, anchor-service, status-service, and license-services
sections. Do not modify the data-source section. In the anchor-service, status-service, and
license-service sections, provide the fully-qualified name of the administrative node, which is the
node you identified in the Administrative services section, page 30. Do not modify any other values.
<anchor-service>
<anchor-server id="anch1" host-ref="Fully_qualified_host_name">
<property name="dispatcher" value="true"/>
</anchor-server>
</anchor-service>
<status-service>
<status-server id="STATUS1" host-ref="Fully_qualified_host_name">
</status-server>
</status-service>
<license-services>
<license-service id="LCS1" host-ref="Fully_qualified_host_name">
</license-service>
</license-services>
Installing a multinode configuration

Before installing the software for a multinode configuration, review the information in Creating the
InstallProfile.xml Configuration File, page 28 and create an InstallProfile.xml configuration file
suitable for your deployment.
To install a multinode configuration:

1. Log on as the Content Server installation owner to the host machine that will serve as the
administrative node.
The administrative node is identified in the Administrative services section, page 30 of the
InstallProfile.xml file. It is the host identified by the <configuration-service> element.
2. Copy the InstallProfile.xml configuration file you created to the index server installation program
directory.
3. Run the index server installation program.
• On Windows, double-click fulltextWinSuiteSetup.exe.
• On UNIX and Linux, type
% fulltextoperatingsystemSuiteSetup.bin
and press Enter, where operatingsystem is the operating system on which you are installing.
4. Select index server installation only.
Install
The installation program detects the InstallProfile.xml file and asks you to confirm that you
require multinode installation.
5. Click Yes.
The correct index server processes are installed and configured on the host.
6. After the installation is completed, ensure that the index server starts.
• On Windows, select Yes, restart my computer., then click Next.
— If the computer does not restart automatically, click Start > Shutdown > Restart and restart
the computer manually.
— If the index server does not automatically start, click Start > Programs > Administrative
Tools > Services and start the FAST InStream service.
— If the system restarts, the index server starts automatically as a Windows service.
• On UNIX and Linux, run $DOCUMENTUM/fulltext/jboss4.2.0/IndexServer/bin/startup.sh.
The index server is started.
7. Install and configure an index agent as described in Configuring the index agent, page 37.
8. To configure directed routing, perform the steps described in Configuring directed routing,
page 40 on the administrative host.
9. Repeat Step 1 through Step 6 on each additional node.
10. Confirm that the index server processes are running correctly.
• On the administrative node, type dsadmin listmodules at a command prompt.
The running processes, their version numbers, host name, and port numbers are displayed.
• On each nonadministration node, use the nctrl command to verify that the processes are
running correctly:
$ cd $FASTSEARCH/bin
$ ../setupenv.sh
$ nctrl sysstatus
Each running module name is listed, as well as the process name, process ID, and status.
Configuring the index agent

The index agent configuration program configures the index agent to process documents for a
particular repository and to pass the documents to the correct index server instance for indexing.
By default, the index agent automatically starts when the configuration program completes. You do
not want the index agent to start automatically when installing a multinode implementation, because
there may be additional configuration steps that need to be completed before the index agent starts.
(See Modifying the IndexAgent.xml file to map file stores, page 26 and Configuring directed routing,
page 40.) The procedure below includes steps to prevent the index agent from starting automatically.
To configure the index agent:

1. Log on to the host machine as the Content Server installation owner.
Install
2. Ensure that the index server is running.
3. Navigate to the directory %DOCUMENTUM_SHARED\IndexAgents (on Windows) or
$DOCUMENTUM_SHARED/IndexAgents (on UNIX).
4. Use a text editor to create a file named setup.ini with these two lines as its content:
[INDEX_AGENT]
AUTO_START_INDEX_AGENT=false
5. Start the index agent configuration program using the appropriate command for your platform.
• Windows: IndexAgent_Configuration_Program.exe –config setup.ini
• AIX: IndexAgent_Configuration_Program.aix –config setup.ini
• Solaris: IndexAgent_Configuration_Program.bin –config setup.ini
• HP-UX: IndexAgent_Configuration_Program.hp –config setup.ini
• On Linux, IndexAgent_Configuration_Program.linux –config setup.ini
6. Click Next.
7. On Windows, type in the installation owner’s password, then click Next.
8. Type in the port used to communicate with application server for administration purposes,
then click Next.
The default port, 9200, is for the first index agent on the host. The default port for any other index
agents are 9220 for index agent 2, 9240 for index agent 3, and so on.
9. Select the repository for which the index agent will prepare documents, then click Next.
The drop-down list contains the repositories that project to the connection brokers listed in
the dfc.properties file on the host.
10. Type in the user name and password for the Superuser account that the index agent will use to
connect to the repository.
11. Indicate whether to run the index agent in normal mode or migration mode.
12. Type in the host where the index server for this index agent is running and the base port number
for the index server, then click Next.
A summary dialog box is displayed.
13. Click Next.
14. To exit from the configuration program, click Finish.
15. To complete the installation process:
• If you are mapping the file stores, complete the instructions in Modifying the IndexAgent.xml
file to map file stores, page 26.
• If you are using directed routing, complete the instructions in Configuring directed routing,
page 40.
16. On Windows, to start the index agent manually, start the IndexAgent service to start IndexAgent
instance.
Install
On Linux, to start the index agent manually, run $DOCUMENTUM_SHARED/jboss4.2.0/server/

startIndexAgent1.sh.
Modifying the indexagent.xml file to map file stores
If you have shared or mounted the drives containing the repository’s file stores and installed the
indexing software, the index agent configuration file needs to be manually edited to indicate that the
drives are shared. The changes depend on whether the file system paths to the content are identical
on the Content Server host and index server host.
Using shared or mounted drives improves performance, because the index agent does not need to
copy documents from Content Server to a staging area. See the Documentum System Planning Guide
for more information about sharing file store drives.
To modify the indexagent.xml file and map the file stores:

1. On the index agent host, navigate to C:\Documentum\jboss4.2.0\server\DctmServer_
IndexAgent1\deploy\IndexAgent1.war\WEB-INF\classes (on Windows) or
$DOCUMENTUM_SHARED/jboss4.2.0/server/DctmServer_IndexAgent1/deploy/
IndexAgent1.war/WEB-INF/classes (on UNIX).
2. Open the indexagent.xml file in a text editor.
3. If the paths to the content files are identical on the Content Server host and index server host,
locate the <exporter></exporter> element and change the value of the <all_filestores_local>
element to true:
<all_filestores_local>true</all_filestores_local>
4. If the paths to the content files are different, do not modify the value of <all_filestores_local>, but
instead, create a file store map within the <exporter> element.
For example, if Content Server is on a host called Dandelion where filestore_01 is physically
located in the directory /Dandelion/Documentum/data/repository_name/content_storage_01 and
the index agent and index server on a host from which the drive on the Content Server host is
shared as /mappingtoDandelion/repository_name/content_storage_01, create an alias as follows:
<local_filestore_map>
<local_filestore>
<store_name>filestore_01</store_name>
<local_mount>/mappingtoDandelion/
repository_name
/content_storage_01</local_mount>
</local_filestore>
<!-- and so on for each filestore --!>
</local_filestore_map>
If you are indexing content stored on a NAS device or a Windows 2003 Server host, you may see
the following error message in the dmi_queue_item’s message attribute:
DocumentRetriever :ERROR Retrieval error: Couldn’t open file
<file path/name> ERROR Processor error status:
DataNotAvailable Not read permission
Install
To resolve this error, edit the <local_mount> element or elements in the IndexAgent.xml file that
reference the storage area or areas on the NAS device. Add two backslashes immediately after
the opening <local_mount> element. For example, assume the following references a storage
are on an NAS device:
<local_mount>\\100.2.4.32\share3\c\data_for_example
After editing, it is now:
<local_mount>\\\\100.2.4.32\share3\c\data_for_example
5. Save the indexagent.xml file.

Configuring directed routing

Directed routing is a means of distributing documents to specific index server nodes based on which
Content Server file store contains their content files; see the Documentum System Planning Guide
for a conceptual overview.
There are four major steps involved in configuring directed routing:
1. Configure Content Server to direct documents to specific file stores based on business rules. See
“Allocating content to storage areas” in the Content Server Administration Guide for information
about creating content assignment policies.
2. Create a full-text collection corresponding to each index server node. See Creating full-text
collections, page 41.
3. Update the index agent configuration file (indexagent.xml) to associate particular file stores with
particular full-text collections. See Mapping file stores to collections, page 42.
4. Create a routing configuration file on the index server administrative node to associate each
collection with an index column. See Mapping collections to index columns, page 43.
Install
Figure 2. Mapping file stores to collections to index columns
Creating full-text collections
All documents submitted for indexing are assigned to a collection, which is a logical set of data to
which the index server applies the same indexing rules. In a basic implementation, all documents
are typically assigned to a single default collection that is created automatically as part of the index
server installation process.
With directed routing, you want the index server to treat documents differently depending on which
file stores contain their content files — specifically, you want the index server to route them to
different nodes for inclusion in different columns. To enable the index server to route documents to
different nodes, you need to assign the documents to different collections.
The first step is to create additional collections. You create one collection for each node.
To create a full-text collection:

1. Log on to the administrative node as the Content Server installation owner.
2. Enable access to the FAST InStream administration tool.
• On Windows, start the Fast InStream Web Server service.
• On UNIX, navigate to the directory $DOCUMENTUM/fulltext/IndexServer/bin and enter
these commands:
source setupenv.sh
httpd -f $DOCUMENTUM/fulltext/IndexServer/etc/httpd/httpd.conf
Install
3. Launch the FAST InStream administration tool by entering this URL:

http://localhost:port+3000
In this URL, port is the base port number assigned to the index server during installation. The
default base port is 13000, in which case the URL would be http://localhost:16000.
The FAST InStream administration tool appears.
4. Click the Create Collection link.
5. Enter a name and description for the collection. Note the name for future reference. You will
need it in later steps when you update the indexagent.xml file and the routing.cfg file. The
name is case sensitive.
6. Click Next. The page for selecting a cluster appears. The value webcluster is automatically
selected, since it is the only option.
7. Click Next.
8. Select DFTXML (webcluster) from the Available Pipelines drop-down list, then click the add
selected button that appears to the right of the drop-down list.
9. Click Next.
A message appears informing you that no data sources exist.
10. Click OK.
11. Repeat steps 4 to 10 to create additional collections.
In most cases, you want to create one collection for each index server node.
Mapping file stores to collections
Once you have created the necessary full-text collections, you associate them with file stores in the
indexagent.xml configuration file, which resides on the index agent host machine.
To configure the index agent for directed routing:

1. Shut down the index agent if it is running.
2. On the index agent host, navigate to C:\Documentum\jboss4.2.0\server\DctmServer_
IndexAgent1\deploy\IndexAgent1.war\WEB-INF\classes (on Windows) or
$DOCUMENTUM_SHARED/jboss4.2.0/server/DctmServer_IndexAgent1
/deploy/IndexAgent1.war/WEB-INF/classes (on UNIX).
3. Open the indexagent.xml file in a text editor.
4. Locate the closing tag of the <indexer> element.
Place the cursor just before the </indexer> tag.
5. Insert an element with this format.
<partition_config>
<default_partition>
<collection_name>name_of_default_collection</collection_name>
</default_partition>
Install
<partition>
<storage_name>name_of_file_store</storage_name>
<collection_name>name_of_collection</collection_name>
</partition>
</partition_config>
The name_of_default_collection needs to match the value of the <fds_collection> element that
appears later in the indexagent.xml file. It is the name of the collection created during installation.
Include a <partition> element for each file store whose documents you want to assign to a specific
collection. The name_of_file_store needs to match the file store name from the repository, and
the name_of_collection needs to match the collection name you specified when you created the
collection in Creating full-text collections, page 41.
For example, the <partition_config> element below assigns documents from filestore_01,
filestore_02, filestore_03, and filestore_04 to three collections (repb01, repb02, and repb03).
Documents from other file stores are assigned to repb01, which is designated as the default
partition. Notice also that filestore_03 and filestore_04 are assigned to the same collection.
<partition_config>
<default_partition>
<collection_name>repb01</collection_name>
</default_partition>
<partition>
<storage_name>filestore_01</storage_name>
</partition>
<partition>
</partition>
<partition>
</partition>
<partition>
</partition>
</partition_config>
</indexer>
6. Save and close the indexagent.xml file.

Mapping collections to index columns
When using directed routing, the index agent assigns documents to collections based on which file
store contains their content files. The index server needs to route the documents to different nodes
based on which collection they belong to. To configure the index server to do this, you create a routing
configuration file (routing.cfg) and update the Status Server configuration file (NodeConf.xml) so
that it refers to the routing configuration file.
To configure the index server for directed routing:

1. Log on to the index server administrative node as the Content Server installation owner.
The administrative node is the node on which the Status Server process is running.
Install
2. Shut down the index server if it is running.

3. Navigate to the directory %DOCUMENTUM%\fulltext\IndexServer\etc (on Windows) or
$DOCUMENTUM/fulltext/IndexServer/etc (on UNIX).
4. Open the CSConfig.xml file in a text editor.
The CSConfig.xml file defines the configuration of the index server nodes, including the
definitions of the index columns on each node.
5. Record the partition_id value for each index column.
The file includes a <column> element for each index column. The <column> element identifies
the machine hosting the column and also sets a numerical ID value for the column. Note the
numerical ID, which is the value of the partition_id parameter. You will need it in Step 8.
For example, this <column> element sets the partition_id for host1 to 0:
<column hostname="host1.emc.com" port="15674" mode="NORMAL"
partition_id="0"
ft_mode="0" docapiport="15500">
</column>
6. Close the CSConfig.xml file.

7. Use a text editor to create a file named routing.cfg in the current directory.
8. Enter the collection to column mapping in the following format:
collection_name=partition_id
On each line, collection_name is the name of a collection you created in Creating full-text
collections, page 41, and partition_id is the ID of the index column to which you want to route
documents from this collection. For example:
repb01=0
repb02=1
repb03=2
9. Save the routing.cfg file.

10. Open the NodeConf.xml file in a text editor.
11. Add a parameter to the Status Server configuration entry, providing the name and location of
the routing.cfg file.
Add the text shown in bold below:
<executable>statusserver</executable>
<parameters>>--type=single --db-dir=$FASTSEARCH/data/status
--db-mem=1 -ORBendPointNoListen giop:tcp:host1:$PORT
-ORBendPointNoPublish
giop:tcp::$PORT --collection-routing-file=
$FASTSEARCH/etc/routing.cfg
12. Save the NodeConf.xml file.

13. Restart all index server processes on all nodes.
14. Use the nctrl command on each node to verify that the processes are running correctly:
$ cd $FASTSEARCH/bin
$ . .setupenv.sh
$ nctrl sysstatus
A list of index server processes and their status is displayed.
Install
Adding a node
Use these instructions to add an additional node to an existing multinode configuration.
To add a node to a multinode configuration:

1. Edit a copy of the existing InstallProfile.xml file to include information about the additional node.
See Creating the InstallProfile.xml Configuration File, page 28 for information about editing
this file.
2. Shut down all running index server nodes and the index agent.
3. Log in to the host machine for the new node as the Content Server installation owner.
4. Install the new index server node.
a. Download the software distribution package for the correct platform to a temporary area
on the host machine.
b. Unzip or untar the software distribution package.
c. Copy the InstallProfile.xml configuration file you created at step 1 to the same temporary area.
d. Run the index server installation program, fulltextoperatingsystemSuiteSetup.
e. Select index server installation only. The installation program detects the InstallProfile.xml
file and asks you to confirm that you require multinode installation.
f. Click Yes. The correct index server processes are installed and configured on the host.
5. Log on to the administrative node host as the Content Server installation owner.
6. Edit the CSConfig.xml file on the administration node to add information defining the new node.
a. Navigate to the directory %DOCUMENTUM%\fulltext\IndexServer\etc (on Windows) or
$DOCUMENTUM/fulltext/IndexServer/etc (on UNIX).
b. Open the CSConfig.xml file in a text editor.
c. Within the <modules> element, add a new <module> element for the new host machine. The
<module> element has this format:
<module hostname="host_name" port=
"base_port_number" />
For example:
<module host="hostnew.emc.com" port="15674" />
d. Within the <search_clusters><cluster> element, add a new <column> element for the new
node. The <column> element has this format:
<column host="fully_qualified_host_name"
port="base_port_number" mode="NORMAL"
partition_id="partition_number"
ft_mode="0" docapiport="15500">
The partition_number should be the integer specified as part of the <search-engine-column>
ID in the Webcluster section, page 34 of the IndexProfile.xml file; if the IndexProfile.xml file
Install
includes <search-engine-column id="col4">, the partition_number for the column is

4. For example:
<column host="host0.emc.com" port="15674"
mode="NORMAL" partition_id="4" ft_mode="0" docapiport=
"15500>
e. Save and close the CSConfig.xml file.

7. If you are using directed routing, update the routing rules as necessary.
Updating the rules may require changes to routing.cfg, to indexagent.xml, or both. You may also
need to create additional collections. See Configuring directed routing, page 40 for details.
8. If you are using round-robin routing, rebalance the index across the newly expanded set of nodes.
With round-robin routing, each index column should have approximately the same number of
index entries. When you add a node, you need to redistribute the existing entries.
a. Backup the FIXML files on each node to a local temporary directory. The FIXML
files are in the directory %DOCUMENTUM%\data\fulltext\fixml on Windows and
$DOCUMENTUM/data/fulltext/fixml on UNIX.
b. Delete the FIXML files and the index columns on each node.
c. Restart the index server nodes, beginning with the administrative node.
d. Configure each defined full-text collection to use the migration pipeline. To do so, launch the
FAST InStream administration tool by entering this URL:
http://localhost:base_port+3000
The base_port is the index server’s base port number; if the index server is using the default
base port 13000, then the value for the URL is 16000. From the Collection Overview screen,
click the edit button that appears to the right of the collection information row, choose Edit
Pipeline, and select Migration from the Available Pipelines drop-down list. Repeat this
step for each defined collection.
e. Suspend indexing on each node. Enter this command to suspend indexing:
rtsadmin localhost port webcluster
partition_id 0 suspendindexing
The port is the index server’s base port number plus the constant 3099. If the index server
is using the default base port 13000, then the port value is 16099. The first integer after
’webcluster’ is the partition_id of the column hosted on the node.
f. Rebuild the index by running the FIXML feeder on each node. Enter this command:
cobra fixmlfeeder.py -i path_to_temp_dir
The path_to_temp_dir is the path to the directory where you backed up the FIXML files
at step a.
g. When the feeding is complete, use the FAST InStream administration tool to reset all
collections to use the DFTXML (webcluster) pipeline (see step d above).
h. Resume indexing on each node. Enter this command to resume indexing:
rtsadmin localhost port webcluster
partition_id 0 resetindex
9. Restart the index server on each node and restart the index agent.
Install
Removing a node
Use these instructions to remove a node from an existing multinode configuration.
To remove a node from a multinode configuration:

1. Shut down all nodes, and shut down the administration node last.
2. Update the CSConfig.xml file on the administration to remove the node.
3. Update routing.cfg on the administration node to remove the node from the collection.
4. Remove the NameService files from the omniorb log directory $FASTSEARCH/var/log/omniorb/
5. Update the $FASTSEARCH/etc/searchrc-1.xml file on each search node adjoining the node being
removed.
6. Update the following two directories that contain references to the node being removed:
$FAST_SEARCG/var/searchctrl/etc/enginesrc_[portNumber] and engine/data_[portNumber]
7. On Windows, run the uninstaller on the node being removed. On UNIX, manually remove the
$FASTSEARCH installation.
8. Restart the remaining node, first the administration node, then the other nodes.
Install
Chapter 3
Upgrade
This chapter contains the following topics:

• Overview, page 49
• Adding the full-text indexing system after upgrading from a 5.3 repository , page 49
• Upgrading a full-text system on Content Server upgraded from 6.5 or later, page 50
• Upgrading a full-text system on Content Server upgraded from 5.3 SP6, 6.0, or 6.0 SP1, page 51
Overview
This chapter provides the instructions for upgrading the full-text indexing components.
Depending on the version from which you are upgrading, you may need to reindex:
• If you are upgrading from 5.3 SP6, 6.0, or 6.0 SP1, you must reindex.
• If you are upgrading from 6.5 or later, you are not required to reindex.
In a consolidated deployment, a single index server provides indexing services to multiple
repositories. In any indexing configuration, the indexing software and Content Servers must have the
same version number. Therefore, to upgrade a consolidated deployment, the indexing software and
all repositories must be upgraded simultaneously.
Adding the full-text indexing system after

upgrading from a 5.3 repository
This section contains general guidelines on adding the full-text indexing system after upgrading
from a 5.3 repository.
To add a full-text indexing system after upgrading from a 5.3 repository:

1. Install the full-text indexing software.
2. Configure an index agent in migration mode.
3. Create the full-text index.
Upgrade
4. Use the Index Agent Configuration program to remove your existing Index Agent and configure
a new one in the new mode that you want (Migration to Normal mode or vice versa).
Upgrading a full-text system on Content Server

upgraded from 6.5 or later
Use this procedure if you previously installed 6.5 or later.
Caution: Do not use this procedure if the deployment is a multinode deployment. Contact
Professional Services (or qualified third-party integrators) for instructions on upgrading a
multinode deployment.
To upgrade the full-text indexing components:

1. Log on as the Content Server installation owner.
Note: On Windows, this means that you need to log on as the same user, in the same domain, as
the user who installed Content Server and the full-text indexing software.
2. Stop the index agents and index server.
If you did not stop these processes when you upgraded Content Server, stop them now. Make
sure all index server processes are stopped.
3. Delete all index agent instances.
Use the Index Agent Configuration Program to delete the index agents. Refer to Deleting an
index agent, page 53, for instructions.
4. Uninstall the Index Agent Configuration Program.
Refer to Deleting the index agent configuration program, page 54, for instructions.
5. Uninstall the index server while preserving the index itself.
The uninstaller will present a panel that asks if you want to delete the existing index. The default
is “no”, which preserves the index. Accept the default to avoid having to rebuild the index.
6. Manually delete the IndexServer directory.
Note: This step is only necessary if the index server is on a different host than Content Server. If
the index server is on the same host as Content Server, uninstalling the index server will also
remove the IndexServer directory in the following location:
• On Windows: C:\Documentum\fulltext\IndexServer
• On UNIX: $DOCUMENTUM/fulltext/IndexServer
7. Install the index server and the index agent configuration program.
Follow the instructions in Installing the index server and the index agent configuration program,
page 17 .
8. Shut down and restart Content Server.
9. Start the index server.
Upgrade
10. Configure the index agents.

Use the instructions in the Configuring the index agent, page 24.
Upgrading a full-text system on Content Server

upgraded from 5.3 SP6, 6.0, or 6.0 SP1
This section contains general guidelines on upgrading from a 5.3 SP6, 6.0, or 6.0 SP1 release.
Caution: Do not use this procedure if the deployment is a multinode deployment. Contact
Professional Services (or qualified third-party integrators) for instructions on upgrading a
multinode deployment.
To upgrade the full-text indexing components:

1. Log on as the Content Server installation owner.
Note: On Windows, this means that you must log on as the same user, in the same domain, as the
user who installed Content Server and the full-text indexing software.
2. Stop the index agents and index server.
If you did not stop these processes when you upgraded Content Server, stop them now. Make
sure all index server processes are stopped.
3. Delete all index agent instances.
Use the Index Agent Configuration Program to delete the index agents. See Deleting an index
agent, page 53.
4. Uninstall the Index Agent Configuration Program.
See Deleting the index agent configuration program, page 54.
5. Uninstall the index server while preserving the index itself.
The uninstaller will present a panel that asks if you wish to delete the existing index. The default
is “no”, which preserves the index. Accept the default.
Note: This step asks you to preserve the index so that the FIXML files are not deleted. Removing
the index at this stage removes the FIXML files also. In subsequent steps, you will remove the
actual index entries and regenerate the index using the FIXML files.
6. Manually delete the IndexServer directory.
Note: This step is only necessary if the index server is on a different host than Content Server. If
the index server is on the same host as Content Server, uninstalling the index server will also
remove the IndexServer directory in the following location:
• On Windows: C:\Documentum\fulltext\IndexServer
• On UNIX: $DOCUMENTUM/fulltext/IndexServer
7. Manually delete the following directory:

• On Windows: C:\Documentum\data\fulltext\index
• On UNIX: $DOCUMENTUM/data/fulltext/index
Upgrade
Caution: Do not delete the fixml directory.

8. Install the index server and the index agent configuration program.
Follow the instructions in Installing the index server and the index agent configuration program,
page 17 .
9. Shut down and restart Content Server.
10. Start the index server.
After you start the index server, it will recreate the index using the FIXML files in
C:\Documentum\data\fulltext\index ($DOCUMENTUM/data/fulltext/index). To determine the
status of the index server, check the all.log file for the entry: fnet: engine up. When that entry is
present, the server has completed reindexing.
Note: On a moderately powered host and assuming there is FIXML representing approximately 1
million documents to reindex, the process can take up to 10 hours.
The all.log file is in C:\Documentum\fulltext\IndexServer\var\log\all.log (Windows) or
$DOCUMENTUM/fulltext/IndexServer/var/log/all.log (UNIX).
11. After the reindexing is complete configure the index agents.
Use the instructions in the Configuring the index agent, page 24.
Chapter 4
Uninstall

• Uninstall order, page 53
• Deleting an index agent, page 53
• Deleting the index agent configuration program, page 54
• Deleting an index server, page 55
• Deleting a full-text Index, page 55
.
Uninstall order
Use a particular order to uninstall Content Server, a repository, the index agent, and the index server.
To uninstall an index agent, the repository its servers need to be running. To uninstall an index server,
the repository needs to be shut down. If the index server is on the Content Server host, additional
issues arise because of shared libraries in the software installations.
To uninstall a multinode configuration, stop all running processes on all hosts.
Uninstall the software components in this order:
1. Shut down and uninstall the index agent.
2. Shut down the repository.
3. Shut down and uninstall the index server.
4. Delete the repository, if required.
5. Uninstall the Content Server software, if required.
6. Uninstall the Index Agent Configuration Program, if required.
Deleting an index agent

1. Log on to the index agent host as the user who installed the index agent.
2. Stop the index agent.
Uninstall
Use the instructions in the Full-text Indexing Administration Guide, “Starting and stopping
the Index Agent” topic, or in Documentum Administrator online help, depending on which
repository version the index agent is running against.
3. Start the Index Agent Configuration Program.
• On Windows, click Start > Programs > Documentum > Index Agent Configuration Program.
• On UNIX and Linux, navigate to $DOCUMENTUM_SHARED/IndexAgents and start the
configuration program for your operating system:
— On AIX, IndexAgent_Configuration_Program.aix
— On Solaris, IndexAgent_Configuration_Program.bin
— On HP-UX, IndexAgent_Configuration_Program.hp
— On Linux, IndexAgent_Configuration_Program.linux
4. Click Next.
5. Select Delete index agent and click Next.
6. Read the information and click Next.
The index agent is deleted.
7. To run the configuration program again, check the check box.
8. Click Next.
9. If you checked the check box to run the configuration program again, skip to Step 5; otherwise,
the program exits.
The index agent software and configuration program are still on the host.
Deleting the index agent configuration program

1. Log on to the host as the user who installed the software.
2. If you are on Windows:
a. Click Start > Settings > Add/Remove Programs.
b. Select Documentum Index Agent Configuration Program.
c. Click Change/Remove.
The uninstaller starts.
3. If you are on UNIX or Linux, navigate to $DOCUMENTUM_SHARED/_uninst/IndexAgents
and type uninstall.bin.
The uninstaller starts.
4. Read the information screen and click Next.
An information screen displays the location where the index agent software is installed.
5. Click Next.
The software is uninstalled.
Uninstall
6. Click Finish.
Deleting an index server

1. Ensure that the repository served by the index server is stopped.
Refer to the Content Server Installation Guide for information on stopping repositories.
2. Log on to the host where the index server is installed as the installation owner.
3. Use the instructions in the Full-text Indexing Administration Guide, “Starting and stopping the
Index Agent” topic or in Documentum Administrator online Help to stop the index server.
4. If you are on Windows:
a. Click Start > Settings > Control Panel > Add/Remove Programs.
b. Select Documentum Index Server.
c. Click Change/Remove.
The uninstaller starts and a welcome dialog box is displayed.
5. If you are on UNIX or Linux, navigate to $DOCUMENTUM/_uninst/IndexServer and type
uninstall.bin.
The uninstaller starts and a welcome dialog box is displayed.
6. Click Next.
An information dialog box is displayed with information about where the index server is installed.
7. Click Next.
The software is uninstalled and a summary dialog box is displayed.
8. Click Finish.
Deleting a full-text Index

To delete a full-text index, run the uninstaller and delete the index agent and index server. A dialog
box provides the option to delete the index as well.
Uninstall
Index
/3GB switch constraint, 10 ftquery_retry_on_queryserver_errorcodes

configuration parameter, 23
full-text index, 9
A See also pre-installation requirements
acl_check_db configuration parameter, 24 VMware constraint, 10
antivirus software, 10 full-text indexes
acl_check_db parameter, 24
C batched returns, 24
collections, 41
collections, defined, 41
deleting, 55
consolidated deployments
full-text indexing
installing, 15
antivirus software, 10
upgrading, 49
consolidated deployments, 49
cscript.exe file, 12
controlling by format, 22
deleting an index, 55
D DFC_DATA environment variable
deleting an index, 55 (deprecated), 12
DFC_DATA variable (deprecated), 12 directed routing, configuring, 40
directed routing disabling by object types, 21
configuring, 40 environment variables, 11 to 12
directory constraint for HP-UX, 20 file store mapping, 26, 39
disabling indexing for object types, 21 format_class property, 22
DNS entries, 10 formats, 23
drives, sharing, 26, 39 host names, 9
host requirements, 10
indexable formats, 22
E installation account, 11
environment variables, 11 to 12 installation order, 15
installing the index agent configuration
F program, 17
installing the index server, 17
format objects
log files, 27
format_class property, 22
network configuration, 10
using to control indexing, 22
new repository, 15
format_class property, 22
performance, 26, 39
formats
required ports for index agent, 9
indexable, 23
required ports for index server, 9
ft engine config parameters
sharing drives, 26, 39
temp_table_batch_size, 24
software installation, 15
ftengine config
upgrading, 49
Index
H new repositories, 15
high-availability deployments
installing, 16 L
host names, 9 log files, 27
host requirements, 10
HP-UX directory constraint, 20
HP-UX parameter values required to N
install, 18 network configuration, 10
I O
index agent object types, disabling indexing of, 21
configuring, 24, 37
DFC_DATA environment variable
(deprecated), 12
P
installing configuration program, 17 permissions, checking against
required ports, 9 repository, 24
uninstalling, 53 ports
uninstalling components, 53 index agent, 9
index agent configuration program index server, 9
deleting, 54 preinstallation requirements
index routing environment variables, 11 to 12
index server configuration full-text indexing, 9
requirements, 43 host names, 9
index server HP-UX parameter values, 18
antivirus software, 10 index agent, 9
constraints on Windows hosts, 10 index server, 9
deleting, 55 operating system and host, 9
disk partition requirement, 10 upgrading, 49
host time zone settings, 10 user accounts, 11
installing, 17
Java installation, 9 Q
query retries, configuring, 23
qtf-config.xnl file, modifying, 21
required ports, 9
query processing
indexable formats, 22 to 23
batches, configuring use of, 24
indexagent.xml file, 26, 39
query results
install directory constraint for HP-UX, 20
installation
query retries, configuring, 23
basic deployments, 15
querying
consolidated deployments, 15
configuring permission checking, 24
constraints on Windows hosts, 10
synonym searches, enabling, 21
high-availability deployments, 16
index agent configuration program, 17
index server, 17 R
log files, 27 repositories
upgrading 5.3 full-text system, 51 full-text indexing installation, 15
VMware constraint, 10
installation accounts, 11
installation logs, 27
S
installation order synonym searches, enabling, 21
Index
T UNIX and Linux installation, 11 to 12

temp_table_batch_size (ft engine config upgrading
parameter), 24 consolidated deployments, 49
temporary table for query results, 24 upgrading 5.3 full-text system, 51
time zone settings on host, 10
TRY_FTDQL_FIRST DQL hint, configuring W
retries, 23 Windows host requirement, 10
U
uninstalling full-text indexing software, 53

Docu10450 - Documentum Content Server 6.6 Full Text Indexing Deployment Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Docu10450 - Documentum Content Server 6.6 Full Text Indexing Deployment Guide

Uploaded by

Copyright:

Available Formats

EMC ® Documentum ®

Full-text Indexing Deployment Guide

Chapter 1 Prepare for Installation ................................................................................. 9

Chapter 2 Install ........................................................................................................... 15

Chapter 3 Upgrade ....................................................................................................... 49

Chapter 4 Uninstall ...................................................................................................... 53

Table 1. Required environment variables ............................................................................ 11

Purpose of the manual

Fixed these issues:

Caution: Do not install the index server on VMware in a production environment.

b. Use the first IP address returned in step 1 for a reverse lookup:

Table 1. Required environment variables

Environment Variable Description Required Values

Environment Variable Description Required Values

12. Installing the index server on Windows hosts

Table 2. Checklist for Full-text Indexing

Task For More Information Completed?

For a Content Server upgrade, Chapter 3, Upgrade

Task For More Information Completed?

These topics are included:

Install a high-availability deployment

12. Restart the Content Server.

Installing the index server and the index agent

9. Choose the products to install.

Configure indexing and querying

Enabling synonym searches

To enable synonym searches:

5. Save the file.

Disabling indexing of specific object types

To remove or add registration for indexing for an object type:

4. To stop indexing of instances of the type, clear Register for indexing.

Rendition formats to index

Configuring format objects to specify which renditions

Supported formats and mime_types

Configuring TRY_FTDQL_FIRST query retries on failure

To add additional error codes:

Forcing permissions checks against the repository

Configuring batched returns for non-FTDQL queries

Configuring the index agent

To configure the index agent:

2. Start the index agent configuration program.

14. To complete the installation process:

Modifying the IndexAgent.xml file to map file

To modify the IndexAgent.xml file and map the file stores:

4. Save the IndexAgent.xml file.

Reviewing the installation log files

Installing the index server in a multinode

Creating the InstallProfile.xml Configuration File

To create the InstallProfile.xml file for your implementation:

For example, tristan.documentum.com, not tristan.

Administrative services section

<configuration-service id="CS1" host-ref=

Content distributor section

Status server section

Search engine section

<search-engine id="RTSN" host-ref=

Document processor section

Query server section

Installing a multinode configuration

To install a multinode configuration:

Configuring the index agent

To configure the index agent:

On Linux, to start the index agent manually, run $DOCUMENTUM_SHARED/jboss4.2.0/server/