+ All Categories
Home > Documents > DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile....

DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile....

Date post: 08-Nov-2018
Category:
Upload: hoangdiep
View: 226 times
Download: 0 times
Share this document with a friend
28
Documentum Foundation Classes Installation Guide Version 5.3 SP1 September 2005
Transcript
Page 1: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Documentum Foundation ClassesInstallation Guide

Version 5.3 SP1September 2005

Page 2: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Copyright © 1994-2005 EMC Corporation

Page 3: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Table of Contents

Preface .......................................................................................................................... 5

Chapter 1 Before You Install DFC .......................................................................... 7Where to install DFC .................................................................................. 7Whether to remove old programs first.......................................................... 8Whether to remove the old DFC .............................................................. 8Whether to upgrade client programs........................................................ 8

Establishing the environment for DFC ......................................................... 9Defining file system locations for DFC components .................................. 9DFC program root directory................................................................ 10DFC user root directory ...................................................................... 10Directory for shared libraries............................................................... 10Directory for DFC configuration files ................................................... 11Locations of DFC classes ..................................................................... 11

Setting environment variables ................................................................. 12Avoiding Xerces and Xalan Conflicts........................................................ 13AIX only: correcting the jaxp.properties file.............................................. 14

Using the DFC config directory ................................................................... 14Uninstalling DFC........................................................................................ 15Uninstalling on Windows........................................................................ 16Uninstalling on UNIX ............................................................................. 16

Chapter 2 Installing DFC ........................................................................................ 19Installation requirements ............................................................................ 19Installing DFC on a Windows system........................................................... 20Installing on a UNIX system........................................................................ 21

Chapter 3 Installing Silently ................................................................................... 25Creating the configuration file ..................................................................... 25Running the installation program silently .................................................... 25Encrypting passwords ................................................................................ 26

Chapter 4 Troubleshooting Installer Problems ...................................................... 27

Documentum Foundation Classes Installation Guide 3

Page 4: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Table of Contents

List of Tables

Table 1–1. Environment variables that DFC uses .............................................................. 12Table 1–2. Configuration files for DFC ............................................................................. 15

4 Documentum Foundation Classes Installation Guide

Page 5: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Preface

This manual describes how to install EMC Documentum Foundation Classes (DFC).

Intended audienceThis manual is for programmers or system administrators who must install DFC. ForWindows systems, it assumes general familiarity with Windows operation. For UNIXsystems it assumes general familiarity with shells, permissions, and environmentvariables.

Documentum Foundation Classes Installation Guide 5

Page 6: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Preface

6 Documentum Foundation Classes Installation Guide

Page 7: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Chapter 1Before You Install DFC

This chapter describes the steps you must take before installing DFC. Any EMC Documentum clientproduct that uses DFC installs DFC. However, you can upgrade DFC without upgrading the clientprogram that installed DFC. You might do so to incorporate the bug fixes or other improvements thatwe provide in a service pack.

DFC relies upon certain environment variables. Whether you install DFC directly or rely on aclient program to do so, you must ensure that these variables have correct values. Establishing theenvironment for DFC, page 9 explains how to set the environment variables that DFC relies upon.

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 14• Uninstalling DFC, page 15

Where to install DFCYou can install DFC on:• A middle-tier system.

For example, to support WDK or Content Server methods.• An end user’s computer.

For example, to support Desktop.DFC runs on a Java virtual machine (JVM) on the machine from which you call it.

Note: Refer to the DFC release notes for the supported versions of the JVM. These canchange from one minor release to the next. Using DFC with an application server mayfurther restrict the supported versions.

Documentum Foundation Classes Installation Guide 7

Page 8: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

Whether to remove old programs rstThis section explains the situations in which you must remove an older version of DFC,and possibly other programs as well, before installing this version of DFC. It contains thefollowing sections:• Whether to remove the old DFC, page 8• Whether to upgrade client programs, page 8

Whether to remove the old DFC

This section provides information to help you decide whether you must uninstall anexisting DFC installation before installing the current version.

Install the new DFC without uninstalling the old one if the following conditions are true:• The DFC installation you wish to upgrade has a version number of 5.1 or later.• The DFC installation is on a Content Server host.In all other cases, uninstall the old DFC before installing the new one.

Uninstalling DFC, page 15 explains how to remove DFC.

Whether to upgrade client programs

Programs that use DFC are called client programs. Upgrading DFC does not affect clientprograms that use DFC version 5.1 or later. For example, replacing DFC 5.1 with thecurrent DFC has no effect on a Desktop version that is running successfully with DFC 5.1.

Caution: Any client that runs with a version 4.x of DFC fails if you replace its DFC withthe current DFC. This fact has slightly different consequences on Windows systems andon UNIX systems:• Windows: if you replace a 4.x version of DFC with the current version, you must

first upgrade all client programs to versions that use version 5.1 or later of DFC.

The reason that you must do so is that only one instance of DFC can run on aWindows system.

• UNIX: a client that uses a 4.x version of DFC can continue to do so, even if you installthe current version of DFC for a different client program to use.

In order to run more than one version of DFC on a UNIX system, you must arrangeto run the different DFC versions in different processes. Thus, you must install thedifferent versions of DFC in locations that you can distinguish from one another

8 Documentum Foundation Classes Installation Guide

Page 9: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

by setting the environment variables described in Establishing the environmentfor DFC, page 9 .

Caution: Some client products (for example, WDK or Webtop) with version number 5.1test for a specific version of DFC. Those programs do not work properly with the currentversion of DFC. We provide patched versions of these programs that do not test for aspecific DFC version. The patched versions work with the current version of DFC.

Establishing the environment for DFCThis section explains how to set the environment variables that DFC relies upon.

Table 1–1, page 12 lists the environment variables that DFC relies upon. What you haveto do to set the variables is different for Windows and UNIX:• Windows: Installation program sets the environment variables.

The DFC installation program for Windows sets environment variables. The onlyadditional setting you need to make is to add jars to the classpath if you need to referto DFC classes and interfaces in your Java programs.Locations of DFC classes, page11 provides more details about what to place on the classpath.

• UNIX: You set environment variables.

For UNIX systems, the installation program does not set environment variables. Ifthe installation program does not find the needed environment variables, it abortsthe installation.

For UNIX systems, the way to set environment variables depends on the shell thatyou use. Be sure to set the variables in such a way that a process launched in adifferent shell has the same values defined. This means using setenv or export(depending on the shell). Do not use set, which defines variables only for the currentshell, but not for any child shell.

The following topics describe the considerations in setting up the DFC environmentfor Windows or UNIX:• Defining file system locations for DFC components, page 9• Setting environment variables, page 12• Avoiding Xerces and Xalan Conflicts, page 13• AIX only: correcting the jaxp.properties file, page 14

Dening le system locations for DFC components

DFC maintains components at different file system locations. The following sectionsprovide details about the locations DFC uses.

Documentum Foundation Classes Installation Guide 9

Page 10: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

DFC program root directory

DFC installs program files under the program root directory.

On Windows systems, the installation program asks for a program root directory anduses C:\Program Files\Documentum if you do not specify a location.

On UNIX systems, the installation program uses the environment variableDOCUMENTUM_SHARED to determine the program root directory. The installationprogram terminates the installation if it finds this variable undefined.

DFC user root directory

DFC creates client oriented directories (for example, checkout and export) in the userroot directory.

On Windows systems, the installation program asks for a user directory root and usesC:\Documentum if you do not specify a location.

On UNIX systems, the installation program uses the environment variableDOCUMENTUM to determine the user directory root. The installation programterminates the installation if it finds this variable undefined.

Directory for shared libraries

The installation program places shared libraries at specific locations relative to theprogram root directory.

On Windows systems, the installation program uses the shared subdirectory of theprogram root directory. It prepends the full path of this directory (followed by aseparator character) to the value of the PATH system environment variable.

On UNIX systems the installation program uses the dfc subdirectory of the program rootdirectory. You must place the full path of this directory onto the library path. The librarypath 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

10 Documentum Foundation Classes Installation Guide

Page 11: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

Directory for DFC conguration les

The installation program creates the config directory to store configuration files (Usingthe DFC config directory, page 14 provides information about DFC configuration files).The installation program creates the config directory under the program root directoryon UNIX systems and under the user root directory on Windows systems. For DFC tooperate properly, the full path to the config directory must appear in the classpath.

On Windows systems, the installation program prepends the full path of the configdirectory (followed by a separator character) to the value of the CLASSPATH systemenvironment 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, prepend $DOCUMENTUM_SHARED\config:to the value of the CLASSPATH environment variable. You can do this before or afterrunning the installation program, because the installation program does not use thissetting.

Caution: We have deprecated the DFC_DATA environment variable. If the installationprogram finds DFC_DATA set to the full path of a directory, it uses the configsubdirectory of that directory as the location of configuration files. This behavior willchange after no more EMC Documentum client programs use DFC_DATA. If you needto specify a directory to contain the config directory, do not use DFC_DATA to do so.Use the dfc.data.dir property in the dfc.properties file instead. Using the DFC configdirectory, page 14 provides information about how to set properties in the dfc.propertiesfile.

Locations of DFC classes

The Java runtime environment uses the CLASSPATH environment variable to find DFCclasses and the config directory.

On a Windows system, the installation program places the full paths to dctm.jar and theconfig directory (with appropriate separators) at the front of the classpath.

On a UNIX system the installation program does not modify the classpath. You mustplace 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 wishthe javac compiler to have access to DFC classes. The javac compiler does not recognizethe jars specified in the manifest contained in dctm.jar. You must explicitly place jars thatcontain classes you wish to use onto the classpath. In particular, you must place dfc.jaron the classpath if you install DFC for use by an application server.

Documentum Foundation Classes Installation Guide 11

Page 12: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

Setting environment variables

DFC uses several environment variables to find its components. Defining file systemlocations for DFC components, page 9 describes the file system locations that theenvironment variables point to. On Windows systems, the installation program asks youfor the information that it uses to set these variables. On UNIX systems, you must setthese variables before you run the installation program. Table 1–1, page 12 lists theseenvironment variables and summarizes the ways that DFC uses them.

Table 1-1. Environment variables that DFC uses

Variable How DFC uses it Windows value(installationprogram sets)

UNIX value (you set)

DOCUMENTUM_SHARED

Determine the fullpath to the programroot directory forUNIX

Not usedby Windowssystems

Specify a value beforeinstalling DFC

PATH Find the directorycontaining DFCshared libraries(DLLs) on Windows

Prepend the fullpath (followedby a separatorcharacter) ofthe sharedsubdirectory ofthe Documentumprogram root

Not used by UNIXsystems

Library path(Directory forshared libraries,page 10 lists thedifferent namesfor this variableon different UNIXsystems)

Find the directorycontaining DFCshared libraries onUNIX

Not usedby Windowssystems

Add $DOCUMEN-TUM_SHARED/dfc

DFC_DATA Documentum hasdeprecated thisvariable.

Directory for DFC configuration files, page11 provides information about what youshould do instead of using this variable.

12 Documentum Foundation Classes Installation Guide

Page 13: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

Variable How DFC uses it Windows value(installationprogram sets)

UNIX value (you set)

DOCUMENTUM Determine the fullpath to the user rootdirectory

Not usedby Windowssystems

Specify a value beforeinstalling DFC

CLASSPATH Allow Java runtimeto find dctm.jarand, the DFC configdirectory. SeeLocations of DFCclasses, page 11 forinformation aboutmaking DFC classesavailable to the javaccompiler

Prepend (withappropriateseparatorcharacters) thefull paths ofdctm.jar and theconfig directory(for example,C:\ProgramFiles\Documen-tum\Shared\dctm.jar and C:\Docu-mentum\config)

Add $DOCUMEN-TUM_SHARED/dctm.jar and $DOCUMEN-TUM/config

Avoiding Xerces and Xalan Conicts

DFC avoids Xerces conflicts by packaging a specific version of the Apache Xerces XMLparser within the DFC address space.

DFC also supplies a modified version of the Apache Xalan XSLT engine. The versionstring of the xalan.jar indicates that we have modified it. Refer to the DFC release notesfor specific versions.

If your stylesheets use the same version of Xalan that we package with DFC, you mustensure that dctm.jar (which contains the modified xalan.jar in its manifest) precedes yourxalan.jar in the classpath. On Windows systems the installation program places dctm.jarat the front of the classpath, so you need only ensure that you do not change the order ofthese two jars. On UNIX systems, you must place dctm.jar on the classpath yourself.

An additional problem arises if you use Java 1.4 and you wish to use arecent version of Xalan. Sun packages Xalan version 2.2.D11 in the Java 1.4distribution. This does not affect Documentum’s XML processing, but if you useXalan from stylesheets, Sun uses its versions of the Xalan classes. You cannotoverride this behavior using classpath or the -jar option. You can use the SunEndorsed Standards mechanism to accomplish this. Refer to the Apache orSun website for details (http://xml.apache.org/xalan-j/faq.html#faq-N100CB orhttp://java.sun.com/j2se/1.4.2/docs/guide/standards).

Documentum Foundation Classes Installation Guide 13

Page 14: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

AIX only: correcting the jaxp.properties le

If you use the IBM J2RE Java runtime environment, you must correct the entries in thejaxp.properties file that pertain to the parser transformation engine. The default locationof 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

Change these entries to the following:com.documentum.xml.jaxp.DfSAXParserFactory=com.documentum.xerces_2_6_2.xerces.jaxp.SAXParserFactoryImpl

com.documentum.xml.jaxp.DfDocumentBuilderFactory=com.documentum.xerces_2_6_2.xerces.jaxp.DocumentBuilderFactoryImpl

javax.xml.transform.DfTransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl

javax.xml.parsers.DocumentBuilderFactory=com.documentum.xerces_2_6_2.xerces.jaxp.DocumentBuilderFactoryImpl

javax.xml.parser.SAXParserFactory=com.documentum.xerces_2_6_2.xerces.jaxp.SAXParserFactoryImpl

javax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl

Using the DFC cong directoryThe DFC config directory contains Java properties files that control the behavior of DFC.The installation program creates the config directory if it does not already exist. Table1–2, page 15 describes the files in the config directory.

14 Documentum Foundation Classes Installation Guide

Page 15: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

Table 1-2. Conguration les for DFC

File Description

dfc.properties Current configuration options for DFC

dfcfull.properties Template containing all possible configuration options. Do notmodify this file. Copy sections into dfc.properties as necessary.

log4j.properties Current configuration options for the log4j instance that underliesthe unified logging system. DFC Development Guide explains thelogging system.

dbor.properties Registry for pre-5.3 business objects. Do not edit this file. DFCDevelopment Guide contains information about how to use this file.

Each line of a Java properties file is either a comment (begins with #) or contains astatement of the form key=value, where key and value are character strings that complywith ISO 8859–1 encoding. For characters that do not comply with ISO 8859–1, useUnicode escapes. These are of the form \u followed by the four hexadecimal digits thatrepresent the character’s Unicode encoding (for example, \u2297).

The key cannot contain white space. The value can contain spaces and other specialcharacters, but you must precede each with a backslash ( \ ) character. For example, toindicate that the DFC configuration files are in C:\Documentum User Files\config,you can include the linedfc.data.dir=C\:\\Documentum\ User\ Files

A backslash precedes each colon, backslash, or space.

The Java convention for expressing file paths allows you to write the same line asdfc.data.dir=C\:/Documentum\ User\ Files

You do not need to precede a forward slash with an escape character.

After installation, the dfc.properties file contains at least one key: dfc.data.dir. Thecorresponding value is the full path to the config directory. Directory for DFCconfiguration files, page 11 provides information about how DFC finds the configdirectory.

Uninstalling DFCWhether to remove the old DFC, page 8 lists the situations in which you must removean old version of DFC before installing the current version. This section explains how toremove DFC.

Documentum Foundation Classes Installation Guide 15

Page 16: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

Regardless of which operating system you use, you cannot uninstall DFC if any programhas locked any portion of it. Thus, you must stop any program that uses the DFC thatyou wish to uninstall. In particular, this means that you must stop any application serverthat uses the DFC that you wish to uninstall. Stopping an application server terminatesany web applications running on it, even those that do not use DFC.

The following sections explain how to uninstall on different operating systems:• Uninstalling on Windows, page 16• Uninstalling on UNIX, page 16

Uninstalling on Windows

This section explains how to remove a DFC installation from a Windows system.

If you are uninstalling a DFC version prior to 5.1, refer to Whether to upgrade clientprograms, page 8 for information about the effect on client programs of upgrading tothe current version of DFC.

To uninstall DFC on a Windows system:

1. Change the startup setting to manual for each service that uses DFC.This prevents such services (for example, an application server) from restartingthemselves after you reboot and locking DFC again before you can uninstall it.

2. Reboot the system.

3. Use the control panel’s Add/Remove Programs facility to remove Documentum DFCRuntime Environment.

4. Reboot the system.

5. Restore any startup settings you changed in the first step.

Uninstalling on UNIX

This section explains how to remove a DFC installation from a UNIX system.

If you are uninstalling a DFC version prior to 5.1, refer to Whether to upgrade clientprograms, page 8 for information about the effect on client programs of upgrading tothe current version of DFC.

To uninstall DFC on a Solaris system:

1. Remove all EMC Documentum installation program entries from the /var/sadm/pkgdirectory.

16 Documentum Foundation Classes Installation Guide

Page 17: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

You need to do this only if the owner of the prior DFC installation is root,If only the EMC Documentum files in that directory match the IS* wildcardexpression, you can remove the files by running the following command:rm -rf /var/sadm/pkg/IS*

If other files match the IS* wildcard expression, enumerate the EMC Documentumfiles in the rm command.

2. Run the uninstall.bin program.For older versions of DFC, this program resides in the _uninst subdirectory ofthe EMC Documentum program root directory. For recent versions, it resides in_uninst/dfc.

To uninstall DFC on a UNIX system other than Solaris, simply run the uninstall.binprogram.

For older versions of DFC, this program resides in the _uninst subdirectory of the EMCDocumentum program root directory. For recent versions, it resides in _uninst/dfc.

Documentum Foundation Classes Installation Guide 17

Page 18: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Before You Install DFC

18 Documentum Foundation Classes Installation Guide

Page 19: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Chapter 2Installing DFC

This chapter describes the process of installing DFC. It contains the following main sections:• Installation requirements, page 19• Installing DFC on a Windows system, page 20• Installing on a UNIX system, page 21

Installation requirementsCaution: Any EMC Documentum program that depends on a 4.x version of DFC willnot run with this version of DFC. Before installing this version, be sure that you haveread Whether to remove old programs first, page 8 . Do not upgrade from a 4.x versionto this version on a Windows system unless you are also prepared to upgrade allprograms that use DFC.

Caution: Prior versions of DFC were difficult to uninstall after being installed as root.This is not true of the current version, but Documentum still recommends not installingas root unnecessarily. If you are installing DFC for a WebSphere or SunOne applicationserver, however, where the application server installation owner is root, you mustinstall DFC as root.

The DFC installation program assumes a video capability of at least 256 colors and atleast 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.0Because the installation program provides a graphical interface, you cannot use a telnetsession to install DFC. Install from the system console, or use an X server to performthe installation remotely.

Documentum Foundation Classes Installation Guide 19

Page 20: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Installing DFC

Installing DFC on a Windows systemThis section explains how to install DFC on a Windows system

To install DFC on a Windows system:

1. Run the installation program, dfcWinSuiteSetup.exe.The installation program proceeds through a series of dialog boxes and informationwindows. When necessary, it asks for input.

2. View the Welcome window, and proceed to the next window.

3. Specify the directory into which the installation program should place the DFCprograms and click Next.The default value for this directory is C:\Program Files\Documentum. Refer toDefining file system locations for DFC components, page 9 for information abouthow DFC uses the value you supply.The installation program skips this step if it finds a registry entry that contains therequired information.

4. Specify whether to install optional components for developers, and click Next.Check the Developer Documentation checkbox to request installation of Javadocs,or leave the box unchecked if you do not wish to have Javadocs installed. Theinstallation program places Javadocs into the help/dfc subdirectory of the DFCprogram root directory. Open index.html from that subdirectory to view theJavadocs.Check the Primary Interop Assembly Installer checkbox to request installation ofa Microsoft installation program package (.msi file) for the DFC primary interopassembly (PIA), or leave the box unchecked if you do not wish to have the packageinstalled. The DFC installation program places the Microsoft installer package forthe DFC PIA into the setup subdirectory of the DFC program root directory.

5. Specify the root directory for Documentum user information and click Next.The default value for this directory is C:\Documentum. Refer to Defining file systemlocations for DFC components, page 9 for information about how DFC uses thevalue you supply.The installation program skips this step if it finds a registry entry that contains therequired information.

6. 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 therequired information.

20 Documentum Foundation Classes Installation Guide

Page 21: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Installing DFC

7. Review the summary.The installation program summarizes what it plans to install and where it plans toinstall it. Make a note of anything you wish to keep a record of. Use the Back buttonif you wish to change anything. Otherwise, click Next.

8. Use the checkbox to tell the installation program whether you wish to identify theglobal registry for this DFC to use.The installation program skips this step if it finds the required information in thedfc.properties file.It is safe to leave the checkbox unchecked if you do not have the necessaryinformation. You can set the information manually in the dfc.properties file afterthe installation program has finished installing DFC.If you check the checkbox, the installation program requests the repository andconnection credentials, and provides a checkbox you can use to disable validation.Use that checkbox if the repository does not exist or is unavailable. Otherwise, theinstallation program checks to see if it can use the credentials you provide.

9. Observe the progress of the installation, and click Finish when the installationprogram 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.

10. Ensure that the version of the DMCL shared library just installed is the one thatDFC always uses.The shared library has filename dmcl40 or libdmcl40. The filename extension varieswith the operating system. Refer to Directory for shared libraries, page 10 for thelocation in which the installation program places the shared library.The installation program replaces copies of the shared library that it finds, but othercopies may exist on the machine. It is safe to replace all of them with the currentversion, but if you do not wish to do so, you must ensure that the old version doesnot precede the current version in any path environment variable that the currentDFC might use.If the machine has a Content Server installation, you must manually replace theDMCL shared library that is in the server’s bin directory.

11. Log off from Windows and log on again before trying to use DFC.If the installation program initiates a reboot, this step is unnecessary.

Installing on a UNIX systemThis section explains how to install DFC on a UNIX system

Documentum Foundation Classes Installation Guide 21

Page 22: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Installing DFC

To install DFC on a UNIX system:

1. Set environment variables, as described in Establishing the environment for DFC,page 9 and Table 1–1, page 12

2. Run the installation program.The name of the installation program is different for different UNIX systems:• dfcSolSuiteSetup.bin for Solaris• dfcLinuxSuiteSetup.bin for Linux• dfcAixSuiteSetup.bin for AIX• dfcHpux11SuiteSetup.bin for HP-UX (32 bit)• dfcHpuxia64SuiteSetup.bin for HP-UX (64 bit)The installation program proceeds through a series of dialog boxes and informationwindows. When necessary, it asks for input.

3. View the Welcome window, and proceed to the next window.

4. Specify whether to install optional components for developers, and click Next.Check the Developer Documentation checkbox to request installation of Javadocs,or leave the box unchecked if you do not wish to have Javadocs installed. Theinstallation program places Javadocs into the help/dfc subdirectory of the DFCprogram root directory. Open index.html from that subdirectory to view theJavadocs.

5. 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 therequired information.

6. Review the summary and click Next when you are ready to proceed.The installation program summarizes what it plans to install and where it plans toinstall it. Make a note of anything you wish to keep a record of. Use the Back buttonif you wish to change anything.

7. Use the checkbox to tell the installation program whether you wish to identify theglobal registry for this DFC to use.It is safe to leave the checkbox unchecked if you do not have the necessaryinformation. You can set the information manually in the dfc.properties file afterthe installation program has finished installing DFC.If you check the checkbox, the installation program requests the repository andconnection credentials, and provides a checkbox you can use to disable validation.Use that checkbox if the repository does not exist or is unavailable. Otherwise, theinstallation program checks to see if it can use the credentials you provide.

22 Documentum Foundation Classes Installation Guide

Page 23: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Installing DFC

The installation program skips this step if it finds the required information in thedfc.properties file.

8. Observe the progress of the installation, and click Finish when the installationprogram reports that it has successfully installed DFC.The installation program displays progress bars as it completes the installation.

9. Ensure that the version of the DMCL shared library just installed is the one thatDFC always uses.The shared library has filename dmcl40 or libdmcl40. The filename extension varieswith the operating system. Refer to Directory for shared libraries, page 10 for thelocation in which the installation program places the shared library.The installation program replaces copies of the shared library that it finds, but othercopies may exist on the machine. It is safe to replace all of them with the currentversion, but if you do not wish to do so, you must ensure that the old version doesnot precede the current version in any path environment variable that the currentDFC might use.If the machine has a Content Server installation, you must manually replace theDMCL shared library that is in the server’s bin directory.

Documentum Foundation Classes Installation Guide 23

Page 24: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Installing DFC

24 Documentum Foundation Classes Installation Guide

Page 25: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Chapter 3Installing Silently

The DFC installation program provides capabilities to support installing silently, that is, invokingthe installation program from a command line and giving it a configuration file that allows theinstallation to proceed without further interaction. This chapter explains how to do this. It containsthe following main sections:• Creating the configuration file, page 25• Running the installation program silently, page 25• Encrypting passwords, page 26

Creating the conguration leTo install silently, you must first create a configuration file. To do this, use a commandsuch as the following at a command prompt:dfcWinSuiteSetup.exe –record C:\myFile.properties

This is the command for Windows. For other operating systems, use the appropriateexecutable file (see Step 2 of the installation procedure in Installing on a UNIX system,page 21) rather than dfcWinSuiteSetup.exe.

You can replace C:\myFile.properties with any file you choose. Give the full path, nota path relative to the current directory.

Running this command creates myFile.properties as an installer configuration file. Itdoes this by running an the installation program interactively and saving your inputs.

Running the installation program silentlyTo run the installation program silently, use a command such as the following at acommand prompt:

Documentum Foundation Classes Installation Guide 25

Page 26: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Installing Silently

dfcWinSuiteSetup.exe –config C:\myFile.properties –silent

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, werecommend always rebooting after a silent installation.

Encrypting passwordsFor installation procedures that require users to supply passwords, the installationprogram provides a rudimentary encryption facility. You can invoke it by using the –xoption in the previous sections, as in the following example:dfcWinSuiteSetup.exe –record C:\myFile.properties –x

dfcWinSuiteSetup.exe –config C:\myFile.properties –silent –x

26 Documentum Foundation Classes Installation Guide

Page 27: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

Chapter 4Troubleshooting Installer Problems

We implement this installation program using InstallShield Multiplatform (ISMP).

The installation program maintains an error log, which it writes to a file called setupError.log in thecurrent working directory. If it cannot write into the working directory, it writes to the home directoryof the user who initiated the installation. Reading this file may help you see what went wrong. If not,it can help Documentum Technical Support to help you. Everything in this file is important. Sendthe entire file, unedited, to Documentum if you need make a support call. The file does not containpasswords or other secure information.

Documentum Foundation Classes Installation Guide 27

Page 28: DFC Installation Guide - Data Storage, Converged, Cloud ... · dfc.propertiesfile. Itissafetoleavethecheckboxuncheckedifyoudonothavethenecessary information.Youcansettheinformationmanuallyinthedfc.propertiesfileafter

© 2011 - 2013 EMC Corporation. All Rights Reserved. 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.

EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United State and other

countries.

All other trademarks used herein are the property of their respective owners.


Recommended