Documentum Foundation Classes 67 Installation Guide
Documentum Foundation Classes 67 Installation Guide
Foundation Classes
Version 6.7
Installation Guide
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind
with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness
for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an
applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks
used herein are the property of their respective owners.
© Copyright 2011 EMC Corporation. All rights reserved.
Table of Contents
Preface ................................................................................................................................ 5
List of Tables
This manual describes how to install EMC Documentum Foundation Classes (DFC).
Intended audience
This manual is for programmers or system administrators who must install DFC. For Windows
systems, it assumes general familiarity with Windows operation. For UNIX systems it assumes
general familiarity with shells, permissions, and environment variables.
Document Scope
This document addresses the rare case where you would install DFC as a standalone product. This
would be useful primarily to customers who have created their own interface to the Documentum
system. Documentum applications each install their own instance of DFC. For information on
updating and maintaining DFC with client applications, see the deployment guide for the particular
application you’re using.
Revision History
The following changes have been made to this document.
Revision History
This chapter describes the steps you must take before installing DFC. Any EMC Documentum client
product that uses DFC installs DFC. However, you can upgrade DFC without upgrading the client
program that installed DFC. You might do so to incorporate the bug fixes or other improvements that
we provide in a service pack.
Caution: If you previously installed additional classes on top of DFC under the DFC program
root directory, check whether those classes are still in place after you upgrade DFC. For example,
some InputAccel use cases required that you install bpmutil.jar and bpm_infra.jar after you
installed DFC. Another example, you may have customized your system and created custom
classes and installed them in the DFC shared directory after installing DFC.
Whenever you upgrade DFC, you will need to check if your additional classes need to be
reinstalled after the upgrade.
DFC relies upon certain environment variables. Whether you install DFC directly or rely on a
client program to do so, you must ensure that these variables have correct values. Establishing the
environment for DFC, page 9 explains how to set the environment variables that DFC relies upon.
DFC requires administrator privileges to run. At installation, the installer verifies that the installation
account has those privileges.
This chapter contains the following sections:
• Where to install DFC, page 7
• Whether to remove old programs first, page 8
• Establishing the environment for DFC, page 9
• Using the DFC config directory, page 13
• Uninstalling DFC, page 14
Java 2 Security
If you plan to use the Java 2 security architecture for your installation, you will need to create
security policy files to specify the permissions allowed to the classes in your installation. To help
you develop your own security policy files, an example policy template file is included in the DFC
installation. The file specifies the permissions required for the DFC classes. You will need to merge
these permissions to your policy file, and replace the variables in the file with the values in your
installation to allow the DFC classes to function. You will specify the policy file that you create at
the startup of your Java Virtual Machine (JVM). For a stand-alone installation, you will specify the
file in the command line startup arguments for your JVM. If you are deploying on an application
server, refer to the application server documentation for the specifics of specifying Java 2 security
policies. The DFC example policy template file is named dfc.example.java.policy, and is found in the
dfc.jar file installed in the DOCUMENTUM_SHARED directory (by default, in Windows systems,
C:\Program Files\Documentum\Shared).
On Windows systems, the installation program asks for a program root directory. It uses C:\Program
Files\Documentum if you do not specify a location.
On UNIX systems, the installation program uses the environment variable DOCUMENTUM_SHARED
to determine the program root directory. The installation program terminates the installation if it
finds this variable undefined.
DFC creates client-oriented directories (for example, checkout and export) in the user root directory.
On Windows systems, the installation program asks for a user directory root and uses
C:\Documentum if you do not specify a location.
On UNIX systems, the installation program uses the environment variable DOCUMENTUM to
determine the user directory root. The installation program terminates the installation if it finds
this variable undefined.
The installation program places shared libraries at specific locations relative to the program root
directory.
On Windows systems, the installation program uses the shared subdirectory of the program root
directory. It attaches the full path of this directory (followed by a separator character) in front of the
value of the PATH system environment variable.
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 versions of UNIX:
• LD_LIBRARY_PATH in Solaris or Linux
• SHLIB_PATH in HP-UX
• LIBPATH in AIX
Environment variables can be set on UNIX systems using the setenv script. The script can be found at
$DOCUMENTUM_SHARED/dfc/set_dctm_env.sh (.csh). You can source this file to properly set the
environment variables from Table 1, page 11.
The installation program creates the config directory to store configuration files. Using the DFC
config directory, page 13 provides information about DFC configuration files. The installation
program creates the config directory under the program root directory on UNIX systems and under
the user root directory on Windows systems. For DFC to operate properly, the full path to the config
directory must appear in the classpath.
On Windows systems, the installation program attaches the full path of the config directory (followed
by a separator character) in front of the value of the CLASSPATH system environment variable.
On UNIX systems, you must place the full path of the config directory onto the classpath. For
example, in the syntax of the csh shell, attach $DOCUMENTUM_SHARED\config: to the value of the
CLASSPATH environment variable. You can do this before or after running the installation program,
because the installation program does not use this setting.
The Java runtime environment uses the CLASSPATH environment variable to find DFC classes and
the config directory.
On a Windows system, the installation program places the full paths to dctm.jar and the config
directory (with appropriate separators) at the front of the classpath.
On a UNIX system the installation program does not modify the classpath. You must place the full
paths of dctm.jar and the config directory onto the classpath.
For both Windows and UNIX systems, you must perform an additional step if you want the javac
compiler to have access to DFC classes. The javac compiler does not recognize the jars specified in
the manifest contained in dctm.jar.
Variable How DFC uses it Windows value UNIX value (you set)
(installation
program sets)
DOCUMENTUM_ Determine the full path Not used by Specify a value before
SHARED to the program root Windows systems installing DFC
directory for UNIX
PATH Find the directory Attach the full Not used by UNIX
containing DFC shared path (followed by a systems
libraries (DLLs) on separator character)
Windows in front of the shared
subdirectory of
the Documentum
program root
Variable How DFC uses it Windows value UNIX value (you set)
(installation
program sets)
Library path Find the directory Not used by Add $DOCUMENTUM_
(Directory for shared containing DFC shared Windows systems SHARED/dfc
libraries, page 10 lists libraries on UNIX
the different names
for this variable
on different UNIX
systems)
DFC_DATA Documentum has Directory for DFC configuration files, page 10
deprecated this variable. provides information about what you should do
instead of using this variable.
DOCUMENTUM Determine the full Not used by Specify a value before
path to the user root Windows systems installing DFC
directory
CLASSPATH Allow Java runtime to Attach (with ap- Add $DOCUMENTUM_
find dctm.jar and, the propriate separator SHARED/dctm.jar and
DFC config directory. characters) the full $DOCUMENTUM_
See Locations of DFC paths of dctm.jar SHARED/config
classes, page 11 for and the config di-
information about rectory (for exam-
making DFC classes ple, C:\Program
available to the javac Files\Documen-
compiler tum\Shared\dctm.
jar and C:\Docu-
mentum\config)
AIX Only
The following sections apply only to AIX installations.
On AIX, DFC is not able to store the registry file on an NFS drive
DFC uses the registry to store/retrieve information for checked out files, viewed files and so on. DFC
uses a file-based registry on non-Windows OSs. For a file-based registry, the location of the file
is specified explicitly by setting the value of “dfc.registry.file” property in the dfc.properties file.
However, if the location is not set, then DFC tries to create the registry file (that is, documentum.ini)
in your HOME directory. On AIX machines, if the HOME directory is NFS mounted, DFC cannot
access the registry location.
Workaround:
• Specify the registry location in “dfc.properties”. The directory location for the registry file should
point to the non-NFS directory. For example:
• If the registry location is not explicitly specified, DFC tries to create the registry file in your HOME
directory. If you prefer this option, your home directory should not be mounted via NFS.
If you use the IBM J2RE Java runtime environment, you must correct the entries in the jaxp.properties
file that pertain to the parser transformation engine. The default location of the jaxp.properties file
is in $JAVA_HOME/jre/lib.
The file includes the following property entries:
javax.xml.transform.TransformerFactory=
org.apache.xalan.processor.TransformerFactoryImpl
javax.xml.parsers.SAXParserFactory=
org.apache.xerces.jaxp.SAXParserFactoryImpl
javax.xml.parsers.DocumentBuilderFactory=
org.apache.xerces.jaxp.DocumentBuilderFactoryImpl
com.documentum.xml.jaxp.DfDocumentBuilderFactory=
com.documentum.xerces_2_8_0.xerces.jaxp.DocumentBuilderFactoryImpl
javax.xml.transform.DfTransformerFactory=
org.apache.xalan.processor.TransformerFactoryImpl
javax.xml.parsers.DocumentBuilderFactory=
com.documentum.xerces_2_8_0.xerces.jaxp.DocumentBuilderFactoryImpl
javax.xml.parser.SAXParserFactory=
com.documentum.xerces_2_8_0.xerces.jaxp.SAXParserFactoryImpl
javax.xml.transform.TransformerFactory=
org.apache.xalan.processor.TransformerFactoryImpl
File Description
dfc.properties Current configuration options for DFC.
dfcfull.properties Template containing all possible configuration options. Do not modify this
file. Copy sections into dfc.properties as necessary.
log4j.properties Current configuration options for the log4j instance that underlies the
unified logging system. DFC Development Guide explains the logging system.
dbor.properties Registry for pre-5.3 business objects. Do not edit this file. DFC Development
Guide contains information about how to use this file.
Each line of a Java properties file is either a comment (begins with #) or contains a statement of the
form key=value, where key and value are character strings that comply with ISO 8859–1 encoding.
For characters that do not comply with ISO 8859–1, use Unicode escapes. These are of the form
\u followed by the four hexadecimal digits that represent the character’s Unicode encoding (for
example, \u2297).
The key cannot contain white space. The value can contain spaces and other special characters,
but you must precede each with a backslash ( \ ) character. For example, to indicate that the DFC
configuration files are in C:\Documentum User Files\config, you can include the line:
dfc.data.dir=C\:\\Documentum\ User\ Files
Uninstalling DFC
This section explains how to remove DFC. Whether to remove the old DFC, page 8 lists the situations
in which you must remove an old version of DFC before installing the current version.
Regardless of which operating system you use, you cannot uninstall DFC if any program has locked
any portion of it. You must stop any program that uses the DFC that you want to uninstall. In
particular, this means that you must stop any application server that uses the DFC that you want
to uninstall. Stopping an application server terminates any web applications running on it, even
those that do not use DFC.
This chapter describes the process of installing DFC. It contains the following main sections:
• Installation requirements, page 17
• Installing DFC on a Windows system, page 17
• Installing on a UNIX system, page 19
Installation requirements
The DFC installation program assumes a video capability of at least 256 colors and at least 800 by 600
screen resolution. For UNIX systems you must also ensure that:
• /usr/dt/bin and /usr/openwin/bin are on the path
• DISPLAY is set to localhost:0.0
Because the installation program provides a graphical interface, you cannot use a telnet session to
install DFC. Install from the system console, or use an X server to perform the installation remotely.
However, be careful when you install remotely with a DISPLAY setting to localhost:0.0, as the output
will be sent to that terminal rather than the one at which you are working.
The default value for this directory is C:\Program Files\Documentum. Refer to Defining file
system locations for DFC components, page 9 for information about how DFC uses the value
you supply.
The installation program skips this step if it finds a registry entry that contains the required
information.
5. Specify whether to install optional components for developers, and click Next.
Select the Developer Documentation checkbox to request installation of Javadocs, or leave
it unselected if you do not want to have Javadocs installed. The installation program places
Javadocs into the help/dfc subdirectory of the DFC program root directory. Open index.html
from that subdirectory to view the Javadocs.
6. Specify the root directory for Documentum user information and click Next.
The default value for this directory is C:\Documentum. Refer to Defining file system locations for
DFC components, page 9 for information about how DFC uses the value you supply.
The installation program skips this step if it finds a registry entry that contains the required
information.
7. Specify the host and port number for the machine that hosts the connection broker, and click Next.
You can use an IP address or a symbolic address (for example, MyHost.MyCompany.com).
The installation program skips this step if it finds a dmcl.ini file containing the required
information when an upgrade from a Pre-D6 DFC is done. When an upgrade is done from D6 ,
then it picks the IP from the dfc.properties file from the config directory.
8. Review the summary.
The installation program summarizes what it plans to install and where it plans to install it. Make
a note of anything you want to keep a record of. Use the Back button if you want to change
anything. Otherwise, click Next.
9. Use the checkbox to tell the installation program whether you want to identify the global registry
for this DFC to use.
The installation program skips this step if it finds the required information in the dfc.properties
file.
It is safe to leave the checkbox unselected if you do not have the necessary information. You can
set the information manually in the dfc.properties file after the installation program has finished
installing DFC.
If you select the checkbox, the installation program requests the repository and connection
credentials, and provides a checkbox you can use to disable validation. Use that checkbox if the
repository does not exist or is unavailable. Otherwise, the installation program checks to see if it
can use the credentials you provide.
10. Observe the progress of the installation, and click Finish when the installation program reports
that it has successfully installed DFC.
The installation program displays progress bars as it completes the installation.
If the installation program needs to initiate a reboot, it asks before doing so.
The installation program skips this step if it finds the required information in the dfc.properties
file.
9. Observe the progress of the installation, and click Finish when the installation program reports
that it has successfully installed DFC.
The installation program displays progress bars as it completes the installation.
10. 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
want 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.
If the machine has a Content Server installation, you must manually replace the DMCL shared
library that is in the server’s bin directory.
The DFC installation program provides capabilities to support installing silently, that is, invoking
the installation program from a command line and giving it a configuration file that allows the
installation to proceed without further interaction. This chapter explains how to do this. It contains
the following main sections:
• Creating the configuration file, page 21
• Running the installation program silently, page 21
• Encrypting passwords, page 22
This is the command for Windows. For other operating systems, use the appropriate executable file
rather than dfcWinSuiteSetup.exe. See Step 2 of the installation procedure in Installing on a UNIX
system, page 19.
You can replace C:\myFile.properties with any file you choose. Give the full path, not a path relative
to the current directory.
Running this command creates myFile.properties as an installer configuration file. It does this by
running the installation program interactively and saving your inputs.
Caution: This process records the information during a real-time installation. If you use this
method to create your configuration file, it will perform an actual installation during the process.
Use the same executable file and configuration file as in the previous section.
Because the silent installation program cannot say whether a reboot is required, we recommend
always rebooting after a silent installation.
Encrypting passwords
For installation procedures that require users to supply passwords, the installation program provides
a rudimentary encryption facility. You can invoke it by using the –x option in the previous sections,
as in the following example:
dfcWinSuiteSetup.exe –record C:\myFile.properties –x
The following applies when a dual stack client host connects to a connection broker running on a
dual stack machine:
• When you specify an IP address in the dfc.properties file, the client DFC uses that IP address and
connects without any further processing. For example, if you specify an IPv4 address, the client
DFC uses IPv4 for communication.
• When you specify a host name in the dfc.properties, the client DFC resolves all available IP
addresses for that host name before determining the connection protocol. When the connection
broker runs on a dual stack machine, the client DFC resolves both IPv4 and IPv6 addresses. The
client DFC keeps track of the IPv4 address and chooses the best available IPv6 address for the host
from Unicast Global, Site Local, and Link Local, in the order specified.
To configure DFC installed on a dual-stack machine for native IPv4 operation, perform the following:
• Specify an IPv4 address in the dfc.properties file.
• Disable the dual-stack operation for Java Virtual Machine.