HP Man PPM7.5 DocMgmt PDF
HP Man PPM7.5 DocMgmt PDF
HP Man PPM7.5 DocMgmt PDF
Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such
products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be
liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR
12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for
Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.
Copyright Notices
Trademark Notices
2
Documentation Updates
This manual’s title page contains the following identifying information:
z Software version number, which indicates the software version
z Document release date, which changes each time the document is updated
z Software release date, which indicates the release date of this version of the software
To check for recent updates, or to verify that you are using the most recent edition of a document, go to:
h20230.www2.hp.com/selfsolve/manuals.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact
your HP sales representative for details.
3
Support
You can visit the HP Software Support Web site at hp.com/go/hpsoftwaresupport.
HP Software Support Online provides an efficient way to access interactive technical support tools. As a valued
support customer, you can benefit by using the support site to:
z Search for knowledge documents of interest
z Submit and track support cases and enhancement requests
z Download software patches
z Manage support contracts
z Look up HP support contacts
z Review information about available services
z Enter into discussions with other software customers
z Research and register for software training
Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support
contract.
To find more information about access levels, go to: h20230.www2.hp.com/new_access_levels.jsp.
To register for an HP Passport ID, go to: h20229.www2.hp.com/passport-registration.html.
4
Contents
5
Installation Owner User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Repository Owner Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Setting Up the UNIX Services File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Content Server Installation Directories for UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Default Operating System Permissions on UNIX Directories and Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
UNIX Graphical Installer Set Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Preparing the Database for Content Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Preparing to install the Content Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Preparing to install the Content Server on a UNIX System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
UNIX Installation Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Installing Content Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring Content Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Post-Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Starting and Stopping the Connection Broker and Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Methods to Start and Stop the Connection Broker and Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
If You Cannot Start the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6
DFC Program Root Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
DFC User Root Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Directory for Shared Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Directory for the DFC Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Locations of the DFC Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Installing the DFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Troubleshooting the DFC Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7
8
1 Getting Started with HP Document
Management
9
The HP document management module is supported on English-only Oracle
databases.
Functional Capabilities
Key functional capabilities of the HP document management module include
the following:
z Searching the contents of documents associated with groups of entities to
locate a particular entity in the group
z Check-in and check-out functionality, including check-out override
capabilities
z Version control of attached documents
z History of document versions is maintained
z Users can retrieve older document versions
z Full-text indexing
For information about how to use the HP document management module, see
Chapter 6, What Document Management Users Need to Know, on page 103.
10 Chapter 1
Use-Case Scenario
A large national insurance company, XYZ Corporation, has just installed PPM
Center and the HP document management module. A business analyst working
with the IT organization at XYZ is preparing a proposal for new software to be
used by insurance investigators across the corporation. Before submitting the
proposal for review, the analyst must complete a business case document.
The PPM Center workflow associated with the proposal enforces this
requirement. If the business case document is not attached to the proposal, the
analyst cannot move to the next workflow step.
As the analyst checks out the business case document, and later checks in new
drafts, document versions are created and stored. If necessary, users can access
earlier versions of the business case document.
Documents managed using the HP document management module follow the
same security rules (including field-level security rules) that apply to all PPM
Center entities. This means that application users view only information that
applies to their current roles and tasks.
The business analyst can use the document management module to search for
entities based on the contents and metadata of documents attached to the
entities. The analyst can use key words to locate relevant proposals, assets,
requests, and other entities related to a business case, regardless of where the
details about the entities reside.
Figure 1-1 shows the Search Requests page in a system without document
management. You can type request key words to use to search the contents of
12 Chapter 1
request Notes and Description fields, but this search will not include the
contents of documents attached to requests.
Figure 1-2. Searching a request with document management installed
Figure 1-2 shows the Search Requests page in a system with document
management. You can still use the Request Key Words field to search request
notes and descriptions.
14 Chapter 1
If You Already Use Document Management in PPM Center
The document management module in this release of PPM Center uses the 5.3
SP5 versions of Documentum:
z Content Server
z Indexing Server
z Documentation Foundation Classes (DFC)
If you are on the 5.3 SP2 versions, then you must upgrade all Documentum
components to 5.3 SP5. Installing the 5.3 SP5 versions over your existing
installed components should achieve the upgrade. However, for detailed
instructions, see the Documentum documentation.
HP recommends that you install DFC 5.3 SP5 (on PPM Server machines that are not
Content Server hosts) before you install PPM Center 7.5.
16 Chapter 1
Performance and Attaching Documents
With document management enabled, attaching a document to a PPM Center
entity results in the following:
1. The attached document is uploaded to the PPM Server for temporary
storage.
While attaching a document, the time required to upload that document
with document management in place is the same as the time required if
document management is not enabled. This is the key performance
consideration for client users. The network quality between the client and
the PPM Server directly affects the time it takes to upload documents,
independent of whether document management is enabled.
2. The user saves the entity (for example, a request) to which the document is
attached, the document is copied to the content server, and the temporary
copy is removed.
When the entity is saved, the save time is increased by 50 to 100 percent
over the save time for the same entity without an attached document. The
time it takes to save an entity increases for each additional document
attached, or for each new version of an existing document uploaded.
18 Chapter 1
Installation Sequence
If you are installing the document management components for the first time,
you can perform the installation either before or after you install or upgrade
PPM Center.
Install Documentum 5.3 SP5 products in the following order:
1. On the Content Server host machine, install Content Server and configure a
repository.
For information about how to install and configure Content Server, see
Chapter 2, Installing and Configuring Content Server, on page 23.
Documentum Foundation Classes is automatically installed with Content
Server.
2. On PPM Servers on which Content Server is not installed, install the DFC.
For information about full-text indexing and the steps you perform to
install it on Windows or UNIX systems, see Chapter 3, Installing Content
Server Full-Text Indexing Software, on page 57.
For instructions on how to enable the HP Document Management Module
after you install the required components, see Chapter 5, Enabling
Document Management, on page 83.
For information about how to use the HP document management module,
see Chapter 6, What Document Management Users Need to Know,
on page 103.
To supplement the information provided in this document, you will need a set
of guides from EMC Documentum that contains complete details on how to
install and administer the Documentum components of the document
management module.
20 Chapter 1
The following EMC Documentum guides contain content that is relevant to the
HP document management module:
z Content Server Installation Guide provides information about installing
Content Server. This manual contains the information you need to install or
upgrade Content Server on Windows, UNIX, or Linux systems with the
Oracle database. It describes decisions you must make and requirements
that must be met before you install the server.
z Documentum Foundation Classes Installation Guide contains information
and instructions on how to install and upgrade to DFC.
z Content Server Full-Text Indexing System Installation and Administration
Guide contains information and instructions you need to install or upgrade
the full-text indexing system used with Content Server on Windows,
UNIX, or Linux. It describes the decisions you must make and
requirements that must be meet before you install the full-text indexing
software. Use this guide with the Content Server Installation Guide.
z Content Server DQL Reference Manual is the reference manual for
Documentum’s Document Query Language, supported by Content Server.
z Content Server Administrator’s Guide contains the following:
o Information, instructions, and procedures for the system administration
tasks for a Content Server installation.
o An overview of the system configuration and guidelines for making
configuration decisions.
o Information on how to configure repositories, Content Servers, clients,
and sessions.
o Information about how to perform routine maintenance.
o Information about connection brokers, full-text indexing
administration, managing the content storage area, and repository
security.
Although the PPM Server uses only a subset of the features that the standard
Content Server application provides, Content Server installation includes more
than what is required for HP document management. For example, the
installation procedure installs Apache Tomcat and a version of the JDK that
PPM Server does not support. Although this does not affect the PPM Server,
you may notice some information displayed during installation that does not
apply to HP document management.
23
Content Server Components
To understand Content Server functionality, it is useful to know something
about its components and structure. This section contains information on the
connection broker application, the document repositories, and the
Documentum Foundation Classes, and how these components interact with
one another and with PPM Center.
Connection Broker
The connection broker is part of Content Server, and is created during Content
Server installation. It runs in the background and provides connection
information to client applications. PPM Server is a client application to the
connection broker.
The connection broker listens for incoming requests on a port you specify.
During Content Server installation, you provide the machine hostname and
port number. The PPM Server requires this information to communicate with
Content Server.
The default port number is 1489. You can specify any unused port on the
machine, but HP recommends keeping the default setting.
Repository
Managed documents are stored on Content Server in a repository. This virtual
storehouse consists of content and index files and object metadata. Metadata
includes properties that describe file characteristics such as creation date,
author, and version number.
The repository has a file system component and a database component. For this
reason, you must ensure that the Content Server host has access to an Oracle
database.
File content and indexes are stored on the file system, while the object
metadata are stored in an Oracle database. PPM Center stores documents in the
repository that you specify during Content Server installation.
24 Chapter 2
A single connection broker can route requests to multiple repositories. You can
create a separate repository for each PPM Server instance, and then point each
PPM Server instance to its own repository. This separates the storage areas
(physical disk and database schema) and gives you more control over your
hardware. You can create multiple repositories on the same Content Server.
You must create a repository for every PPM Server in your configuration, the
configuration wizard helps you do this. This section describes some of the
items that should be done before running the wizard and provides some tips for
troubleshooting issues with the wizard. For usage of the wizard, see
Configuring Content Server Components on page 49.
Every repository you create requires:
z A service listed in the /etc/services directory.
z A unique database schema created in an Oracle database.
Multiple repositories cannot share a schema.
HP recommends that you use the same string for the user name of the
Documentum installation owner and for the name of the Oracle database
schema created for the repository.
z As you create a repository using the configuration wizard, you are
prompted to specify an ID for it.
Type a number between 0 and 16,777,215 that is unique to the repository.
z The configuration wizard parses your tnsnames.ora file to list database
SID information, and prompts you to select the database to use. If the
database that contains your schema is not listed, the problem might be in
the tnsnames.ora file.
After the information is collected, the installation program creates and
configures the repository.
26 Chapter 2
The DFC is automatically installed with Content Server. If you install the
Content Server on the same machine as the PPM Server, there is no need install
the DFC separately. However, if Content Server and the PPM Server are on
separate machines, you must install the DFC separately on the PPM Server.
For information about how to install the DFC, see Chapter 4, Installing
Documentum Foundation Classes, on page 75.
For information on what to read before you install and configure Content
Server, see Prerequisite Documents on page 20.
5. Install and configure the document management module, including
Content Server and full-text indexing software.
a. On the Content Server host machine, install the Content Server and
configure a repository. Dependent products such as the DFC are
automatically installed with Content Server.
b. On PPM Servers on which Content Server is not installed, install the
DFC.
c. Install the index server and index agent.
You can specify an invalid SMTP server, but you must complete the field.
28 Chapter 2
For more information about using document management in PPM Center,
see Chapter 6, What Document Management Users Need to Know,
on page 103.
server.ini File
The server.ini file, contains information that Content Server uses at startup
including:
z Repository name
z Connectivity
z Password
z Owner
z Connection broker connectivity
z Other parameters, such as the number of maximum concurrent sessions
The server.ini file is similar to the server.conf file in PPM Center.
Depending on your operating system, you can find the file in the following
location.
UNIX $DOCUMENTUM/dba/config/<Repository>
After you update the server.ini file, restart Content Server to apply your
changes.
For more information about the IDQL utility, see the EMC Documentum
Content Server Administrator’s Guide.
To run a DQL query against a repository, you must first start an IDQL session,
as follows:
1. At the command prompt, navigate to the $DM_HOME/bin directory.
4. Press Enter.
5. At the prompt, type the account name for a user with at least System
Administrator privileges in the repository.
6. Press Enter.
8. Press Enter.
An interactive document query interface session starts. You can type your
query at the prompt. The following example DQL query returns one row
for each repository on Content Server.
30 Chapter 2
Example query:
1> select "object_name"
2> from "dm_server_config"
3> go
After you run this statement, you can interact with a particular repository
server configuration by updating that repository server config object. For
example, to see the configuration parameters for a repository named
“PPMdocs,” run the following DQL statement:
1> select * from "dm_server_config"
2> where "object_name" = 'PPMdocs'
3> go
To close an IDQL session, type the quit command at the IDQL prompt.
For information on what to read before you install and configure Content
Server, see Prerequisite Documents on page 20.
4. Continue with and complete the required preparation steps for your
configuration, as detailed in the following sections.
z The installation owner account must not be the same account as the
Windows administrator.
32 Chapter 2
z The installation owner account must have the following rights, which are
granted during installation:
o Act as part of the operating system
o Create a token object
o Increase quotas
o Log on as a service
o Log on locally
o Replace a process-level token
z The user name is restricted to alphanumeric, hyphen (-), and
underscore (_) characters.
The user name you specify when you install the Content Server must match
this Windows user name including case, even though Windows user
accounts are not case-sensitive.
z The password is restricted to alphanumeric characters, hyphens (-),
underscores (_), and periods (.).
Create a UNIX user account (referred to in this document as dctm) that you can
use to install, execute, and administer Content Server.
The installation owner is the user whose account is used to install the Content
Server and create a repository. The server runs under the installation owner
account.
The installation owner must have an operating system account. The installation
owner user name must consist of ASCII alphanumeric characters, dashes (-)
and underscores (_). The first character must be a letter. The installation owner
password must consist of letters, numbers, dashes, underscores, and periods.
The installation owner account must have read, write, and execute permission
on the /var/tmp directory and on the installation directory ($DM_Install and
its subdirectories).
You can create an operating system account to use exclusively for server
installation and repository maintenance. You can use a single user account as
installation owner for multiple Documentum installations on your network.
On Linux, you can create multiple server installations on a single host
computer. You can have separate installation owners for each installation or
you can use separate environment files to enable a single installation owner to
own all of the installations.
34 Chapter 2
Repository Owner Account
The repository owner is the user whose account is used to connect to the
database. The repository owner owns all objects in the database. Each
repository must have a unique repository owner.
The repository owner user name and password must consist of letters,
numbers, dashes (-) and underscores (_). The first character in the name must
be a letter, and all characters must be ASCII characters. The corresponding
password must consist of a combination of letters, numbers, dashes,
underscores, and periods.
During server installation, you can specify an existing database account for
database access. If you designate an existing account to use for database
access, that user becomes the repository owner. Alternatively, the installer can
create a database user during installation. The new user then becomes the
repository owner. If the installer creates the database user, the database user
name defaults to the repository name.
Assign the following privileges to the database user account of the repository
owner:
z Connect to the database
z Create tables, views, and indexes in the database
z Insert records (rows) into tables
z Drop tables, views, and indexes
z Unlimited tablespace
If you allow the Content Server installer to create a database account for the
repository owner, the required privileges are automatically granted to the
repository owner. If you create the account before you run the installer, assign
the CONNECT and RESOURCE privileges to the account.
or
<Repository> <Repository_Port>/tcp # RepositoryForPPM
36 Chapter 2
The port number can be any unused port number greater than 1024. (Linux
reserves port numbers up to 1024 for system use.) For example, if the
repository service were named mugwort, the services file entry might be:
mugwort 1497/tcp # repository
The environment variables and installation directories must contain only ASCII
characters. The directory in which you install the Content Server cannot contain
spaces or the following characters:
38 Chapter 2
Preparing the Database for Content Server Installation
Every repository must have a correctly configured Oracle database. The
requirements are as follows:
z If you install the database on the Content Server host with a Linux system,
verify that the system path includes the directory for the database.
z If you install the database on the Content Server host with a Windows
operating system, ensure that the database service is set to start
automatically. Server installation sometimes requires a restart of the
computer. After the restart, installation does not proceed correctly unless
the database starts automatically.
z If you create a remote Content Server for a distributed content
environment, the server.ini file from the primary Content Server host is
copied from the primary host to the remote host. To ensure that the
database_conn key on the primary Content Server host is valid on the
remote hosts, ensure that the values used on the primary and remote hosts
for database connectivity are identical.
z You must install the database client on remote Content Server hosts. The
remote Content Server configuration program must connect to the database
to create the server config object, acs config object, file store storage
object, and location objects for the remote server.
z Content Server uses the repository owner account to connect to the
database. The sections on the repository owner in the Content Server
Installation Guide provide more information.The server runs as the
installation owner, but a separate account must exist to give the server
access to the database tables underlying the repository. Each repository
must have a unique repository owner and each repository owner must have
a unique database account.
40 Chapter 2
To install and configure your Oracle database for document management:
1. Install and configure the Oracle client software on the machine on which
you plan to install the Content Server.
2. Add an entry in tnsnames.ora for the repository database. Or use the Oracle
client software to do the same.
3. Use the tnsping command and SQL*Plus to verify that the Oracle client
software is correctly installed.
For information on the tsnping command, see oracleutilities.com/OSUtil/
ping.html. For information on SQL*Plus, see your Oracle documentation.
4. Ensure that SQL*Plus is installed on the Content Server host.
6. Verify that you can connect to the Oracle database by using SQL*Plus
from the system where you intend to install the Content Server.
7. Start the Oracle Listener process and configure it to start automatically on
the machine where the Oracle database resides.
For Windows:
Edit the PATH variable to include:
<DFC_Install_Location>\<Java_Version>
42 Chapter 2
For UNIX:
To configure the runtime environment of the dctm user, in one of the
*.rc files, set the following environment variables:
i. Before you begin to install the Content Server, check to make sure
that this install directory exists. Set these variables in the
installation owner’s .cshrc file (C shell) or .profile file (Bourne
or Korn shells). Alternatively, set the variables in a file called by
the .cshrc file or .profile file.
setenv DM_HOME $DOCUMENTUM/product/<Version>
setenv DOCUMENTUM_SHARED $DOCUMENTUM/shared
setenv LD_LIBRARY_PATH $DM_HOME/bin:$JAVA_HOME/lib
LD_LIBRARY_PATH is a Solaris-specific shared library environment variable.
This variable name and value varies, depending on the UNIX operating system
and version. For descriptions of all required environment variables, see the EMC
Documentum Content Server Installation Guide.
4. Obtain the Content Server bundle for your operating system and copy it to
a temporary directory from which to run the installation.
5. Use an extraction utility such as UnZip or use the Java jar xvf command
to extract the installation bundle and extract the installation files.
For example:
ContentServer_<Operating_System>.bin
consistency_checker.ebs
dfcSetup.jar
jdkSetup.jar
server.jar
suite.jar
tomcat 4127Setup.jar
setupError.log
z %DM_HOME%
44 Chapter 2
Preparing to install the Content Server on a UNIX System
Before you install the Content Server on a UNIX system, ensure that the
following are complete:
1. Content Server Installation Directories for UNIX on page 37
5. Content Server uses a semaphore. Check to make sure that semaphores are
enabled on the host machine.
6. If you plan to install on an AIX host, check to make sure that AIX is
running in 32-bit mode.
Before you install the Content Server on Linux, consider the following:
z Because Content Server is not a Java application, there are
version-dependent installers.
z Content Server installation requires root access to the host machine.
Unlike the PPM Server installation, the Content Server installation and the
stand-alone DFC installation programs run only in graphical mode. On Linux hosts,
this may require that you have the X Window System emulation software installed.
You do not need a special license to install the HP version of Content Server.
UNIX ContentServer_<Operating_System>.bin
The Content Server installer program starts and displays the Welcome
page.
2. Click Next.
The installer verifies your system requirements and prompts you to type
the installation directory.
3. If prompted, select I accept the terms of the license agreement, and then
click Next.
4. (Windows only) Type the full path of the directory in which you want to
install the Content Server. For example:
C:\Documentum
The installer prompts you to indicate whether you want to install optional
components for the DFC.
46 Chapter 2
6. Leave Developer Documentation (18 MB) and any other checkboxes
unselected and click Next.
7. (Windows only) Accept the default DFC installation directory (C:\
Program Files\Documentum) or type the full path of the directory in
which you want to install the DFC.
This directory name can contain spaces.
8. Click Next.
9. (Windows only) Accept the default DFC user directory (the %DM_HOME%
directory) or type the full path of a different directory to use as the DFC
user directory. Click Next.
10. Type the information for your primary connection broker.
12. Leave the Enable Trusted Content Services unselected and click Next.
The installer prompts you to specify the Java port numbers for Apache
Tomcat. Content Server uses Tomcat internally to run required Java
programs.
PPM Center does not make use of this Content Server feature.
14. Accept the default port, or type the number of any unused port above 1024
on which Apache Tomcat can listen for requests.
15. Accept the default port, or type the number of any unused port above 1024
to use to stop the Tomcat server. Click Next.
16. On the confirmation page, verify your installation parameters, and then
click Next.
17. (UNIX only) If you have the root user password, select the Run dm_root_
task now checkbox, and then click Next to run the script. Otherwise, leave
the checkbox unselected and click Next.
The installer installs the products and components, and then displays its
final page. Click Finish.
If you choose not to supply the root password during the procedure, you must run
the $DOCUMENTUM/dba/dm_root_task script or the sudo command after
installation and before you continue as root. Otherwise, the connection broker
cannot start, and you cannot create a repository.
Navigate to the $DM_Install directory (as root), and run the script as follows:
./dm_root_task
The installer prompts you to indicate whether you want to configure the
server now or later.
18. (Windows only) Select Configure server now, and then click Next.
The installer prompts you to indicate whether you want to restart your
computer.
48 Chapter 2
19. Select Yes.
3. Click Next.
5. Click Next.
The configuration prompts you to choose between the express and custom
configuration methods.
If your organization has an external storage solution such as network attached
storage (NAS) or storage area network (SAN) in place, do not use the
Documentum express configuration procedure. You must use the custom
configuration instead.
For information about custom and express methods for configuring Content
Server components, see “Express or Custom Configuration” in the EMC
Documentum Content Server Installation Guide.
9. If you are not using an external storage solution such as NAS or SAN,
select Express Configuration. If you are using an external storage solution,
select Custom Configuration, and then follow the instructions provided.
The custom configuration wizard may prompt you for additional information. For
advanced information on how to perform a custom configuration, see the EMC
Documentum Content Server Installation Guide.
50 Chapter 2
13. In the Repository size list, select one of the following.
z Manual
If other services must start before Content Server can start, then specify a
manual startup. For example, start the Oracle database that contains the
repository, if it resides on the same machine.
16. (UNIX only) In the Service Name field, type the services name for the
repository.
This is the service name you specified in the services file.
The configuration wizard prompts you to indicate whether you want to
create an Oracle database user account or use an existing account.
17. Select Create new Oracle user account and tablespaces.
Database User
The password for the Oracle schema.
Password
19. To send email notifications for some system events, Content Server
requires an SMTP server.
a. In the SMTP Server Name field, type the name of an SMTP server on
your network.
b. In the Installation Owner’s Email Address field, type the email address
of the person you want to receive Content Server email notifications.
Email traffic is minimal. Under normal operating conditions, this
account receives no email messages.
20. If you are running the PPM Server on a machine other than the Content
Server host, install the DFC on the PPM Server.
For information about how to install the DFC, see Chapter 4, Installing
Documentum Foundation Classes, on page 75.
52 Chapter 2
The server configuration wizard displays a progress bar. Configuration
takes several minutes.
21. After configuration finishes, review the information displayed on the
summary page.
22. On the confirmation page, click Finish.
23. Run the wizard again if you have more than one PPM Server in your
configuration.
Post-Installation Tasks
After you complete Content Server installation and configuration, do the
following:
1. Use the Interactive DQL editor (IDQL) tool to test the installation.
For information about IDQL and how to use it, see Appendix B, “IAPI and
IDQL” in the EMC Documentum Content Server Administrator’s Guide.
For information on how to execute an idql statement, see Example query:
on page 31.
2. Restart the machine.
To stop the connection broker and repository, use the reverse process, stopping
the repository first, and then the connection broker.
54 Chapter 2
Methods to Start and Stop the Connection Broker and Repository
Depending on the operating system that your Content Server is running, you
can start and stop the connection broker and repository using one of the
following methods.
Table 2-1. Starting and stopping the connection broker and repository
On UNIX
> cd $Documentum/dba
> ./dm_start_<Repository>
> ./dm_shutdown_<Repository>
> cd log
> ls <Repository>.log*
PPMdocs.log
PPMdocs.log.save.09.12.2004.18.05.14
PPMdocs.log.save.11.11.2004.15.21.25
For more information about Content Server log files, see the EMC
Documentum Content Server Administrator’s Guide.
56 Chapter 2
3 Installing Content Server Full-Text Indexing
Software
57
Content Server manages the objects in a repository, generates the events that
trigger full-text indexing operations, queries the full-text indexes, and returns
query results. For a complete description of the full-text indexing process, the
chapter “Full-Text Indexing” in the EMC Documentum Content Server
Administrator’s Guide.
Index Agent
The index agent exports documents from a repository and prepares them for
indexing. It is a Web application than runs in an instance of the Apache
Tomcat servlet container. Tomcat is automatically installed during index agent
installation. Each index agent runs in its own Tomcat instance.
A given index agent runs against only one repository. Typically, you install the
index agent on the Content Server host, but you can install it on a different
machine.
58 Chapter 3
If you install the index agent on a machine other than the Content Server host,
that machine must be running a supported operating system. For a list of the
supported operating systems, see the System Requirements and Compatibility
Matrix.
An index agent running in normal mode and an index agent in migration mode cannot
simultaneously update the same index.
Index Server
The index server creates full-text indexes and responds to full-text queries
from Content Server. Depending on the configuration, a single index server
instance can serve one or multiple repositories.
Because the index server operations are processor- and memory-intensive, HP
recommends that you install the index server on a machine other than the Content
Server host. You must install the index server on the same operating system that is
running on the Content Server host.
nslookup <FQDN_of_Content_Server_Host>
The correct return value is the FQDN you typed in step a on page 60.
60 Chapter 3
c. If the nslookup commands do not return the correct values, update the
DNS servers used by the hosts to reflect the correct FQDNs.
d. If necessary, on a Windows system 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 it
responds and to ensure that the IP address that responds to the ping is
the IP address defined in the ftengine config object.
2. Disable any antivirus software running on the system.
To install the index agent and index server, you must be logged on to the
system as the same user who installed Content Server (the Content Server
installation owner).
3. If you plan to install the index agent and index server on a machine other
than the Content Server host, ensure that the Content Server installation
owner user account exists on that machine.
4. If you plan to install the index agent and index server on a UNIX system,
set the environment variables (listed in the following table) in the
installation owner environment.
Environment
Description Required Values
Variable
The directory in
Any directory in the installation
DOCUMENTUM which the indexing
owner’s environment
software is installed
The directory in
DOCUMENTUM_ Any directory in the installation
which DFC is
SHARED owner’s environment
installed
LC_ALL C
62 Chapter 3
Sharing the Drives where Content Files Reside
The index server requires access to the content files in a repository. If you
install the index server on the Content Server host, then the index server has
direct access to the file store storage areas.
Because the index server operations are processor- and memory-intensive, HP
recommends that you install the index server on a machine other than the Content
Server host. You must install the index server on the same operating system that is
running on the Content Server host.
If the index server is not installed on the Content Server host, the default
behavior of the index agent is to use the Getfile method to retrieve a
temporary copy of a file, store it in a temporary location, and pass that location
to the index server. After indexing the file, the index server deletes the
temporary copy.
For performance reasons, HP recommends that you mount or share the drives
where the repository file store storage areas reside with the index server host.
When the drives are shared or mounted, the index agent uses the Getpath
method to pass to the index server the direct path to a file that must be indexed.
Mount or share the drives before you install the indexing software. After you
install the software, edit the indexagent.xml file to map the file stores for the
index agent and use the index agent administrative interface to indicate that the
file stores are mapped. For instructions on how to edit the indexagent.xml
file, see Modifying the indexagent.xml File to Map File Stores on page 71.
You can share or mount the drives so that the content files are read-only. HP
strongly recommends that you mount or share drives so that the paths are
logically identical on the Content Server and index server hosts.
On Windows hosts, use UNC paths. On UNIX, use NFS and, if necessary,
symbolic links. If you must mount from a Windows platform to a UNIX
platform, use third-party utilities to mount or share the drives. The changes to
the indexagent.xml file depend on whether the paths are logically identical.
For instructions on how to share or mount drives, see the documentation for
your operating system.
To install the index server and the index agent configuration program:
1. Ensure that the repository for which you are installing the index server and
index agent is running.
2. Log in to the index server and index agent host as the Content Server
installation owner.
3. Obtain the installation files and save them to a temporary location on the
host.
4. Start the full text installer.
HP-UX fulltextHpuxSuiteSetup.bin
64 Chapter 3
Operating System Executable Filename
AIX fulltextAixSuiteSetup.bin
Solaris fulltextSolSuiteSetup.bin
Linux fulltextLinuxSuiteSetup.bin
For Windows:
a. Accept the default installation directory (C:\Program Files\
Documentum) or specify a different directory.
b. Accept the default user directory (C:\Documentum) or specify a
different directory.
On UNIX, the DFC directories are determined by environment variables
set before installation.
11. Click Next.
12. If a dmcl.ini file does not exist on the machine, provide the following
connection information:
66 Chapter 3
If you specify a different directory, ensure that its name contains no
spaces. The installer creates the \data\fulltext directory in the
location you specify.
The installer program displays a list of the products to be installed.
15. Click Next.
The installation program displays a progress bar so that you can follow the
progress of the software installation.
16. Click Finish.
17. After you install the full-text indexing software, ensure that the index
server starts, as follows.
z (Windows only) Select Yes, restart my computer, and then click Next.
z (UNIX only) Navigate to the $DOCUMENTUM/fulltext/IndexServer/
bin directory, type startup.sh, and then press Enter.
3. (Windows only) Type the installation owner password, and then click Next.
4. Leave Create & Configure Index Agent selected and click Next.
a. In the top Port Number field, accept the default value specified for
Apache Tomcat (9082), or type a different port number for the index
agent to use to communicate with Tomcat.
(Windows only) The default ports for the first index agent on the host
are 9081 and 9008.
68 Chapter 3
b. In the bottom Port Number field, accept the default value specified for
the index agent (9009), or type a different port number for the index
agent to use to stop Tomcat.
If the index agent is on the Content Server host, do not specify port numbers
used by the Java method server or Site Caching Services.
Type the port numbers for the index agent to use to communicate with, and
to stop, Tomcat.The index agent runs in the Apache Tomcat servlet
container. You must designate two ports for the index agent and Tomcat to
use.
6. Click Next.
7. In the Repository Name list, select the repository for which the index agent
is to prepare documents.
The list displays the repositories that project to the connection brokers
listed in the dmcl.ini file on the host. The dmcl.ini file was created
during installation if a dmcl.ini file was not already on the host.
8. Click Next.
9. Type the user name and password for the Superuser account for the index
agent to use to connect to the repository.
Use this user name and password later to access the Index Agent Admin
Tool.
The machine where the index server and index agent are installed must be
identified using a fully-qualified domain name. For example, you could use a host
name such as isolde.documentum.com, but not an IP address such as
172.04.8.275.
The index agent configuration program validates the user name and
password you typed.
10. Click Next.
11. Select the Normal Mode for running the index agent.
The index server requires a contiguous range of four thousand free ports. The
default range is from 13000 to 17000.
z (UNIX only) To start the index agent and its Tomcat instance, navigate
to <DOCUMENTUM_SHARED>/IndexAgents/<IndexAgentN>/, where
<IndexAgentN> is the number corresponding to the new index agent
instance, and then type startupIndexAgent.sh.
z (Windows only) The index agent is created and Tomcat is started.
16. Click Finish.
70 Chapter 3
Modifying the indexagent.xml File to Map File Stores
If you have shared or mounted the drives that contain the repository file stores
and installed the indexing software, you must manually edit the index agent
configuration file 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.
To modify the indexagent.xml file and map the file stores:
1. On the index agent host, navigate to the following directory:
$DOCUMENTUM_SHARED/IndexAgents/IndexAgent1/webapps/
IndexAgent1/WEB-INF/classes/
3. If the paths to the content files are identical on the Content Server host and
index server host, locate the <exporter> element and change the value of
the <all_filestores_local> element to true, as follows:
<all_filestores_local>true</all_filestores_local>
4. If the paths to the content files are different, create a file store map within
the <exporter> element.
Do not modify the value of <all_filestores_local>. 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 are 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>
/content_storage_01</local_mount>
</local_filestore>
<!-- and so on for each filestore --!>
</local_filestore_map>
6. Start a browser and open the Index Agent Admin Tool at the following
URL:
<Host_Name>:<Port_Number>/<IndexAgentN>/login.jsp
where <Host_Name> is the name of the host where the index agent is
running, <Port_Number> is the port where the index agent is listening, and
<IndexAgentN> is the number assigned to the index agent instance. If the
browser is on the index agent host, replace hostname with localhost.
7. Stop the index agent.
For information on how to stop and start the index agent, see Starting and
Stopping the Index Agent on page 73.
72 Chapter 3
Starting and Stopping the Index Agent
If the index agent is running in migration mode, use the Index Agent Admin
Tool to start or stop it.
Note that stopping the index agent does not stop or start the Tomcat process in which
the index agent runs.
<Host_Name>:<Port_Number>/<IndexAgentN>/login.jsp
where <Host_Name> is the name of the host where the index agent is
running, <Port_Number> is the port where the index agent is listening, and
<IndexAgentN> is the number assigned to the index agent instance. If the
browser is on the index agent host, replace <Host_Name> with <Local_
Host>.
3. To start the index agent, in the index agent status line, click Start.
4. Click OK.
5. To stop the index agent, in the index agent status line, click Stop.
6. Click OK.
where <Host_Name> is the name of the machine on which the index agent is
running, <Port_Number> is the port that the index agent uses to listen, and
<IndexAgentN> is a number that designates an index agent instance.
74 Chapter 3
4 Installing Documentum Foundation Classes
75
Before You Install Documentum Foundation Classes
This section describes the steps to take before you install the DFC.
The DFC installs program files under the program root directory.
On Windows, the installation program asks for a program root directory and
uses the C:\Program Files\Documentum directory if you do not specify a
location.
On UNIX, the installation program uses the environment variable
DOCUMENTUM_SHARED to determine the program root directory. If this variable
is undefined, the installation fails.
76 Chapter 4
DFC User Root Directory
On UNIX systems the installation program uses the dfc subdirectory of the
program root directory. You must place the full path of this directory onto the
library path. The library path environment variable has different names in
different operating system versions, as follows:
z LD_LIBRARY_PATH in Solaris or Linux
z SHLIB_PATH in HP-UX
z LIBPATH in AIX
78 Chapter 4
Installing the DFC
To install the DFC:
1. Ensure that you have set the environment variables (DOCUMENTUM_SHARED,
PATH, and Library path).
For information about the environment variables to set, see Setting the
Environment Variables for the DFC on page 76.
2. Log on to the machine that is hosting the PPM Server as a user with
administrator privileges.
3. Depending on your operating system version, run one of the following
installation programs.
Solaris dfcSolSuiteSetup.bin
Linux dfcLinuxSuiteSetup.bin
AIX dfcAixSuiteSetup.bin
HP-UX dfcHpux11SuiteSetup.bin
5. Read the license agreement, select I accept the terms of the license
agreement, and then click Next.
6. (Windows only) Accept the default DFC installation directory displayed in
the Destination Directory field (C:\Program Files\Documentum), or type
the full path to a different directory.
In this guide, this DFC installation directory is referred to as $DFC_HOME.
The DFC installer prompts you to indicate whether you want to install
optional features.
8. Leave the checkboxes unselected and click Next.
9. (Windows only) Accept the default shown in the User Directory field, or
specify a different directory. The default directory is:
C:\Documentum
The DFC installer prompts you to type the location (host name) and port
number of the connection broker to which you want to connect.
11. In the Primary Connection Broker Host Name field, type the name of the
machine that hosts the connection broker.
12. Accept the default port number (1489) displayed in the Port Number field,
or type a different port number for the machine that hosts the connection
broker.
Type the information for the connection broker created during Content
Server installation.
You can use an IP address or a symbolic address such as
MyHost.MyCompany.com. The installation program skips this step if it
finds a dmcl.ini file that contains the required information.
13. Click Next.
The installer program prompts you to indicate whether you want to specify
a global registry for this DFC to use.
15. Leave the checkbox unselected and click Next.
80 Chapter 4
17. Ensure that the version of the DMCL shared library just installed is the one
that the DFC always uses.
The shared library has filename dmcl40 or libdmcl40. The filename
extension varies with the operating system. To determine the location
where the installation program places the shared library, see Directory for
Shared Libraries on page 77.
The installation program replaces copies of the shared library that it finds,
but other copies may exist on the machine. It is safe to replace all of them
with the current version, but if you do not wish to do so, you must ensure
that the old version does not precede the current version in any path
environment variable that the current DFC might use.
18. If a machine hosts Content Server, manually replace the DMCL shared
library that is in the server’s bin directory.
83
Configuring Document Management in PPM Center
To configure PPM Center to work with the document management module:
1. Make the DFC native libraries available to the PPM Server by setting the
shared library path environment variable on the PPM Center host.
The shared library path varies with the operating environment, as follows:
z On Microsoft Windows, use %PATH.
z On Sun Solaris, use $LD_LIBRARY_PATH.
z On HP-UX, use $SHLIB_PATH.
z On IBM AIX, use $LIBPATH.
z On Linux, use $LD_LIBRARY_PATH.
The shared library path must include the location of the native libraries (the
*.dll files on Windows and the UNIX native files on UNIX) installed
with the DFC. The location of the native library depends on the operating
environment, as follows:
z (Windows only) The location is %DOCUMENTUM%/shared, where
%DOCUMENTUM% is the Content Server installation directory.
84 Chapter 5
4. Set your display options so that the configuration tool can run in graphic
(swing) mode.
Before you perform the next step, check to make sure that the account under
which you are to run the kConfig.sh script has read, write, and execute
permissions to the directories for PPM Center and for the Content Server.
If the kConfig.sh script fails at any point, you can rerun it.
7. Select the Integrate the PPM server with a Documentum Content Server
version 5.3 checkbox, and then click Next.
86 Chapter 5
The configuration wizard lists the Documentum components for which you
must supply information.
8. Click Next.
9. In the File field, type the full path to the dfc.properties file.
In typical installations this file is in the DFC User directory, under the
config subdirectory.
a. In the Connection Broker Server Name field, type the name of the
connection broker server (the machine that hosts Content Server).
b. In the Connection Broker Server Port field, type a port number for the
connection broker.
c. In the Repository Name field, type the name of the repository.
d. In the Repository Username field, type the username for the account of
the user who installed Content Server.
e. In the Repository Password field, type the password for the account of
the user who installed Content Server.
This is the “installation owner” operating system account on the computer that
hosts Content Server, and not the database user account of the repository
schema.
88 Chapter 5
f. In the Document Cabinet field, type the relative directory in which to
store PPM Center attachments.
Repository objects are organized into folders. The cabinet is a top-level folder
in which PPM Server instance stores attached documents.
In <PPM_Home>/conf/dms.conf, the property
dms.documentum.cabinetName specifies the cabinet name to use. HP
recommends using the default value.
The configuration utility configures the server and copies any existing
document attachments into Content Server.
13. After the setup is complete, on the last configuration page, click Finish.
After you successfully install the Content Server and integrate it with PPM
Center, the PPM Center instance fails to come up during a kStart.sh script
run and the error DM_USER_E_NOT_DOCUMENTUM_USER is displayed. The user
referenced in the server log is CustomerKintana. However, the actual user is
Customer\Kintana (Kintana under the Customer domain). The PPM Center
instance was started successfully before you installed Content Server.
Solution
Test the repository user name and password by logging in to Content Server
using the IDQL button in the Content Server Manager application. You are not
required to specify the domain for user names. User names are case-sensitive.
Problem
The password for the connection between PPM Center and Content Server is
set when you first configure the connection between PPM Center and Content
Server. Later, you change the operating system name and password for
Content Server. Running the kConfig.sh script triggers a warning message
that indicates that you can only run the configuration for Content Server during
the initial installation.
Solution
90 Chapter 5
2. In the <PPM_Home>/conf directory, open the dms.conf file:
Problem
During Content Server installation on UNIX, you see the following error
message displayed:
Could not create the PPM Folder in the Documentum Content Server
Exception: FATAL ERROR: Permission denied Failed to instantiate
exclusively - lock.
Source
This can happen if the permissions for the DFC directories are not set up
correctly.
Solution
Make sure the permissions on the DFC directories are set up correctly.
Check to make sure that the user has the required permission for the DFC
directories. On Linux, the PPM Center owner must have read, write, and
execute permissions. On Windows, the user must have administrator-level
rights (or group rights) to the local machine.
PPM Center cannot connect to the repository. Content Sever was correctly
installed, and the connection broker and repository were correctly configured.
However, a PPM Center error message (DM_SESSION_E_AUTH_FAIL) indicates
that the username and password provided for the repository are invalid.
Verification through SQL*Plus and Toad shows that the repository user name
and password supplied for Documentum are correct.
Source
Two user accounts are related to Content Server; one is the Documentum
Oracle user name and schema owner. The second is the Content Server user
account, to which PPM Center connects to access document management
functionality. This user is listed in the Documentum server.ini file. To
verify that the correct user name and password are being used, run the IDQL
query tool from the Documentum Server Manager application.
Solution
Verify that the correct user name and password are being used, by running the
IDQL query tool from the Documentum Server Manager application.
Problem
The Content Server configuration utility cannot locate the dmcl.ini file.
Source
The dmcl.ini file is a configuration file that Content Server clients use to
locate a connection broker and repository. Content Server tries to create this
file in the standard WINDOWS or WINNT directory (for example, C:\
WINDOWS) on the host computer, but cannot if the home directory of the
operating system user is different than the standard directory.
Solution
92 Chapter 5
Disabling Document Management
After you migrate existing attachments to the Content Server repository and
add attachments to it through the PPM Center standard interface, you cannot
revert to storing attachments in the PPM Center file system. However, until
you have performed these tasks, you can disable document management and
revert to storing attachments on the PPM Center file system. This section
describes how.
To disable document management functionality after you have enabled it, but
before attachments are migrated to the repository and added to the repository
through the PPM Center standard interface, do the following:
1. Update the <PPM_Home>/conf/dms.conf file content to include the
following two lines:
dms.filesys.attachmentDir=C\:\\PPM\\product\\attachments
dms.driverName=com.kintana.dms.filesys.DMSFileSystemDriver
This example is for a PPM Server running on Windows. On Linux, use single
forward slashes (/) as directory delimiters.
2. To implement the configuration change, stop, and then restart the PPM
Server.
For information about how to uninstall the Content Server, see the EMC
Documentum Content Server Installation Guide.
94 Chapter 5
Copying a Repository
You can clone a repository by copying all server-side files and the
corresponding Oracle database schema. The following procedure provides the
steps you use to clone a repository. The term source in these steps refers to the
repository you are copying, and target refers to the Content Server that is to
receive the copy.
To clone a repository, your system must meet the following requirements:
z The source Content Server and target Content Server must be running the
same operating system.
z On the target Content Server, the operating system user to own the copied
repository must have the same user name and password as the operating
system user on the source Content Server.
HP recommends that you use a clean, unused Content Server as the target. You
must change the security keys to match the source Content Server, which affects
any existing repositories on the target.
To clone a repository:
1. Stop the source repository.
To determine the repository ID, use a text editor such as Notepad to open
the server.ini file on the source ($DOCUMENTUM/dba/config/
<Repository>/server.ini), and then check the value of the
repository_id parameter.
a. Log on as the same operating system user who owns the repository on
the source Content Server.
b. Create a new repository and give it the same name and ID as the source
repository.
If you are creating the repository database schema manually, HP
recommends that you specify the same data and index tablespace
names as the source repository database schema uses. This facilitates
data importation later.
6. Stop the target repository.
7. On the source, use the zip or tar utility to unpack the entire repository
directory ($DOCUMENTUM/data/<Repository>).
8. Export the repository schema from the source database.
9. Connect as SYSTEM to the target database, and then drop the new target
repository schema.
10. Re-create an empty target schema and specify the same name and
password used for the source target schema, as follows:
SQL> create user <Repository_Schema_Name>
2 identified by <Repository_Schema_Password>
3 default tablespace <Data_Tablespace>
4 temporary tablespace <Temp_Tablespace>
5 quota unlimited on <Data_Tablespace>
6 quota unlimited on <Index_Tablespace>
If you are using Oracle 10g, do not include the next line (7 quota unlimited on
<Temp_Tablespace>;).
7 quota unlimited on <Temp_Tablespace>;
SQL> grant connect to <Repository_Schema_Name>;
SQL> grant create session to <Repository_Schema_Name>;
SQL> grant create sequence to <Repository_Schema_Name>;
SQL> grant create table to <Repository_Schema_Name>;
SQL> grant create view to <Repository_Schema_Name>;
11. Import the source repository schema export file into the target schema that
you re-created in step 10.
96 Chapter 5
12. Connect to the new target repository database schema, check the following,
and make updates to refer to the new target repository location rather than
the original source repository:
select r_install_domain, web_server_loc from dm_server_
config_s;
select host_name from dm_mount_point_s
select target_server from dm_job_s;
select projection_targets in dm_server_config_r;
13. To ensure that all views are rebuilt, run the following SQL statement in the
target database schema:
update dm_type_s set views_valid=0;
14. Copy the zip or tar of the source repository file system to the target Content
Server, and extract it into the corresponding target folder $DOCUMENTUM/
data/<Repository>.
preserve_existing_types=T
Creating the dump file may take a while. For a system with thousands of
documents, expect this to take a couple of hours.
3. After the dump is completed, use a binary transfer protocol to move the
output file to the target system.
98 Chapter 5
4. On the target repository, use DQL to run the following command:
The dump is loaded into the target repository. This process takes about the
same amount of time taken to create the dump file.
5. To update the full-text indexes, after the load is complete, in the target
repository, run the following command:
1> execute "update_ftindex"
2> with "name" = 'filestore_01'
3> go
6. To update the PPM Server to reference the new target repository, do one of
the following:
z Run the <PPM_Home>/bin/kConfig.sh script, and choose the Integrate
the PPM server with a Documentum Content Server option.
to
\#\!\#the\:encrypted\=string\#\!\#
z Check to make sure that you can start the PPM Server.
z If your PPM Center instance from an earlier release contained
attachments, make sure that you can still access those attachments.
z Attach new documents, modify them, and then check to make sure that
the documents are accessible and correctly versioned.
HP recommends that, after you verify that you can access the expected objects,
you destroy the load object. This frees up some space and ensures that the load
object does not interfere with future load operations in the target repository.
For information about how to destroy a load object, see the EMC Documentum
Content Server Administrator’s Guide.
For information about how to install the DFC, see Chapter 4, Installing
Documentum Foundation Classes, on page 75.
3. Copy the dbpasswd.txt file to the new machine.
You can copy the dfc.properties file to the PPM Server without editing it.
100 Chapter 5
Security Considerations
Security in the HP document management module follows the standard PPM
Center model for document attachments. Using requests as an example:
z As is true for document attachments under the control of standard PPM
Center functionality (without document management), users must have the
Demand Mgmt: Edit Requests access grant to add, check out, or check in
documents related to requests.
For requests in particular, attachment fields can be subject to additional
field-level security if configured in the associated request type.
z Users who have permission to view the contents of an attachment field can
view the attached document, the descriptive fields, and the version history.
The document management module provides a System: Override Document
Check Out access grant that lets the user delegate document control to another
person in the organization.
For more information, see the Security Model Guide and Reference and
“Protecting Repository Objects,” in the EMC Documentum Content Server
Administrator’s Guide.
Table 5-1 lists the RML entities that are related to document management in
PPM Center.
Table 5-1. RML entities associated with document management
Token Description
MPKG_REFERENCES.RML Used to relate transaction entities.
MPRJ_PROJECT_
Used to view the references of projects.
REFERENCES.RML
For more information about the RML entities listed in Table 5-1, see the
Reporting Meta Layer Guide and Reference.
102 Chapter 5
6 What Document Management Users Need
to Know
103
Adding a Document as a Reference
To attach a document to an entity that supports references:
1. From the standard interface, open the entity to which you want to attach a
document.
You can also attach a document to an entity that you are creating and have not
yet submitted.
4. Click Add.
104 Chapter 6
5. In the File field, type the full directory path of the file to attach.
The file you specify must reside in a directory on the HP Project and Portfolio
Management Center server.
z In the Initial Version Comment field, type notes on the initial version of
the document you are attaching.
z In the Author field, type the name of the document author or authors.
z In the Description field, type a description of the document and its
purpose.
z In the Key Words field, type keywords to add to an index of document
contents.
The keywords you add to attachments help users search for entities
with attachments that contain those words.
Because the Content Server automatically indexes the contents of text-based
files, there is no need to specify keywords for text-based documents. However,
users cannot search non-text attachments such as image files unless you specify
keywords.
For information about the full-text indexing feature, see the EMC Documentum
Content Server Administrator’s Guide.
7. Click Add.
The References to be added on Save field lists the document file you
specified.
The document, which was loaded into the document management system
after you clicked Save, is now listed in the Attached Documents section of
the entity page.
The information displayed for the attached document also includes:
z Document version, size, and author
z Who (if anyone) has the document checked out
z When and by whom the document was last checked in
If PPM Center is running, and the Content Server stops, users can continue to
use PPM Center, but cannot add or access attachments until the Content Server
is up and running again.
Any errors that occur while the PPM Server communicates with the Content Server
are recorded in a log file. Server log files are stored in the <PPM_Home>/server/
kintana/log directory. Server log files are named serverLog.txt and
serverLog_timestamp.txt.
Active PPM Servers log their output to the serverLog.txt file. The serverLog_
timestamp files are archived versions of the serverLog.txt file. For more
information about PPM Server log files, see “Getting Information from Log Files,” in
“Maintaining the System,” in the System Administration Guide and Reference.
106 Chapter 6
Editing Document Attachment Information
To edit document attachment information from the References section of an
entity page:
1. In the standard interface, on an entity page, expand the References section.
2. Under Attached Documents, to the left of the name of the document that
has associated attachment information you want to edit, click Actions.
The Document Actions window opens. From this window, you can view
document information, open the Edit Details window, check out the
document, or remove the document from the Attached Documents section.
The Edit Details of Document window opens. You can use this window to
change descriptive information about the document.
4. Make the required changes to the document information.
5. Click Done.
108 Chapter 6
Checking Attached Documents Out and In
To check an attached document in or out, use one of the following methods:
z If the entity has a custom attachment field, use that field to check the
document in or out.
z Use the References section of the entity page.
Note that, in the References Added section of the entity page, the document
version number displayed is now incremented by one.
110 Chapter 6
Searching for Entities by Document Key Word
In the PPM Center standard interface, you can search for entities based on key
words in referenced documents. The Content Server searches the descriptive
fields for the document (author, description, title, and key words) and
document content. The descriptive field searches are relevant to all text and
binary documents. Content searches are relevant only to text-based documents.
To search for an entity using document key words:
1. Open a page for an entity that supports document management.
The search returns a list of all entities (of the selected type) that have one or
more attached documents containing key words that match your search terms.
A document that you just attached may not show up on the Search Results page
for several minutes. Before a content search can find a document, the
document content must first be indexed. Although indexing is automatic, the
process is periodic, and so may require several minutes to complete.
Searching by Phrase
To search for an exact phrase, type double quotation marks (“key words”) at
either end of the phrase. The content server returns a list of entities with
attached documents that include all of the words inside the quotation marks, in
the same order as you typed them.
112 Chapter 6
Excluding Documents that Contain a Specific Text String
Combination Queries
You can use any of the search formats described in the previous section in
combination.
OR queries take precedence over AND queries. For example, if you search for
finance development OR test, the search first finds documents that contain
either the word “development” or the word “test,” and then finds documents
from that list that also contain the word “finance.”
Token Description
Resolves to a URL that, when clicked, opens the
latest version of the document.
DOC_LINK
Forces user authentication before delivering the
document.
For more information about tokens and how to use them, see Commands,
Tokens, and Validations Guide and Reference.
114 Chapter 6
Index
A document management, 84
index agent on Windows systems for
access grants full-text indexing, 68
Edit Requests, 101 options for full-text indexing, 60
Override Document Check Out, 101
connection broker, 24
administering starting and stopping, 54
full-text indexing, 74 starting and stopping on UNIX, 55
Apache Tomcat starting and stopping on Windows systems,
port for communicating with, 68 55
port used to stop, 69 Content Server
attaching documents, 17 about configuration, 29
author information for attached documents, configuring on a Windows system, 49
106 configuring on UNIX systems, 49
considerations for installing on Linux, 45
AUTHOR token, 114 default operating system permissions for
files and directories, 38
C installation directories, 37
Checked In By information for attached installing on UNIX, 46
documents, 106 installing on Windows systems, 46
migrating a repository to, 94
Checked Out By information for attached preparing to install on UNIX, 45
documents, 106 preparing to install on Windows Systems,
checking document attachments in or out, 109 42
CLASSPATH environment variable required accounts for installation on a
and DFC classes, 78 Linux system, 33
combination queries, 113 copying
document management repositories, 95
configuration files
for the DFC, 78
D
configuring
Content Server on a Windows system, 49 database
Content Server on UNIX systems, 49 remote installation, 40
115
DESCRIPTION token, 114 about, 75
descriptions of document attachments, editing, defined, 26
107 separate installations, 27
DFC DQL queries
about, 75 running, 30
CLASSPATH environment variable, 78
configuration files, 78 E
defined, 26 Edit Requests access grant, 101
file system locations for components, 76
installing on a UNIX system, 79 editing document attachment descriptions, 107
installing on Windows systems, 79 EMC Documentum documents, 20
program root directory, 76 enabling
setting environment variables for, 76 document management, 83
shared libraries directory, 77
user root directory, 77 entities
attaching documents to, 103
DFC classes
locations of, 78 environment variables
setting for the DFC, 76
directories
DFC program root directory, 76 exporting
DFC shared libraries, 77 document management repositories, 98
DFC user root directory, 77
disabling F
document management, 93 file stores
dm_server_config, 29 mapping, 71
DOC_HISTORY token, 114 full-text indexing
about the process, 58
DOC_LINK token, 114 administering, 74
document management configuration options, 60
and security, 101 configuring the index agent on Windows
capabilities, 10 systems, 68
components, 9 installing on UNIX, 64
configuring, 84 overview, 57
disabling, 93 preparing to install, 60
enabling, 83 software, 58
impact on PPM Center performance, 16
overview, 9 I
RML entities related to, 102
tokens associated with, 114 IDQL
closing a session, 31
documents starting a session, 30
attaching to entities, 17, 103
importing
DOCUMENTUM environment variable, 77 document management repositories, 98
Documentum Foundation Classes
116
index agent Linux
configuring on Windows systems, 68 considerations for installing Content
described, 58 Server, 45
run modes, 59 installation owner group, 33
specifying ports for, 68 required accounts for Content Server, 33
starting and stopping, 73 load object
Index Agent Admin Tool, 74 destroying, 100
starting and stopping the index agent, 73
index server M
sharing drives containing content files, 63 migrating
indexagent.xml file document management repositories, 94
editing to map file stores, 71 MPKG_REFERENCES.RML, 102
installation directories MPRJ_PROJECT_REFERENCES.RML, 102
Content Server, 37
MPRJ_TASK_REFERENCES.RML, 102
installation owner account, on UNIX, 34
MREL_REFERENCES.RML, 102
installation owner group, on UNIX and Linux,
33 MREQ_REFERENCES.RML, 102
installing
Content Server on UNIX, 46 O
Content Server on Windows systems, 46 Override Document Check Out access grant,
DFC on Windows systems, 79 101
Documentum Foundation Classes without
Content Server, 27 P
preparing for on UNIX, 45
preparing for on Windows systems, 42 PATH environment variable
tasks to perform after, 53 setting on Windows systems, 42
performance impact
K on PPM Center, 16
key word search, 111 phrase, searching by, 112
key words ports
combination searches, 113 specifying for the index agent, 68
excluding entities from a search, 113 program root directory
searching by phrase, 112 DFC, 76
L Q
LAST_CHECK_IN_DATE token, 114 queries
LAST_CHECKED_IN_BY token, 114 combination, 113
LAST_CHECKED_IN_BY_NAME token,
114 R
licensing, 10 remote database installation, 40
117
repositories T
copying, 95 tnsnames.ora, 41
described, 24
exporting and importing, 98 tokens, 114
migrating to a new Content Server instance, AUTHOR, 114
94 DESCRIPTION, 114
starting and stopping, 54 DOC_HISTORY, 114
starting and stopping on UNIX, 55 DOC_LINK, 114
starting and stopping on Windows systems, LAST_CHECK_IN_DATE, 114
55 LAST_CHECKED_IN_BY, 114
repository owner account, on UNIX, 35 LAST_CHECKED_IN_BY_NAME, 114
required individual accounts, on UNIX, 33 U
RML entities, 102
MPKG_REFERENCES, 102 UNIX
MPRJ_PROJECT_REFERENCES, 102 configuring Content Server on, 49
MPRJ_TASK_REFERENCES, 102 installation owner group, 33
MREL_REFERENCES, 102 installing Content Server on, 46
MREQ_REFERENCES, 102 installing full-text indexing on, 64
installing the DFC, 79
preparing to install Content Server, 45
S required individual accounts, 33
searching required installation owner account, 34
key words by phrase, 112 required repository owner account, 35
searching for documents based on key words, setting environment variables for the DFC,
111 76
stopping the connection broker on, 55
server.ini file, 29
use-case scenario, 11
services file
setting up, 36 V
shared libraries directory
for DFC, 77 version information for attached documents,
106
sharing drives
containing content files, 63 W
size information for attached documents, 106
Windows
starting installing DFC on, 79
connection broker, 54 setting the PATH environment variable, 42
index agent, 73
repository, 54
stopping
index agent, 73
118