Download as pdf or txt
Download as pdf or txt
You are on page 1of 114

Web Development Kit and

Applications Installation Guide

Version 5.2.5 SP1


Windows, UNIX, and Linux
March, 2004
WDK Applications
Administrator
Copyright © 1994-2003 Documentum, a division of EMC. All Rights Reserved.

DOCUMENTUM, NOW YOU KNOW, UNITING THE WORLD THROUGH CONTENT and the Corporate Logo are trademarks or registered trademarks of
Documentum, a division of EMC, in the United States and throughout the world. All other company and product names are used for identification purposes
only and may be trademarks of their respective owners.
Table of Contents

Preface ......................................................................................................................... 9

Chapter 1 WDK and WDK Applications Installation Quick Start ............ 11


All New Installations And Upgrades ................................................................. 11
Upgrading an Existing Installation ................................................................... 12
Installing Web Publisher ................................................................................. 12
Installing Documentum Compliance Manager .................................................... 12
Uninstalling WDK or a WDK Application ......................................................... 12

Chapter 2 About WDK and WDK Applications ............................................ 13


What is WDK? ............................................................................................. 13
Role of the Application Server ..................................................................... 13
What is a WDK Application? .......................................................................... 13
Out-of-the-Box Applications ....................................................................... 14
Webtop ............................................................................................... 14
Web Publisher ...................................................................................... 14
Documentum Administrator .................................................................... 14
Digital Asset Manager ........................................................................... 15
Documentum Compliance Manager .......................................................... 15
Customized Applications ............................................................................ 16

Chapter 3 Planning for Installation ................................................................. 17


Typical Configurations ................................................................................... 17
BEA WebLogic 8.1 Managed Server Environments ......................................... 18
IBM WebSphere 5 Managed Network Deployment Environments ...................... 19
Distributed and Federated Environments ....................................................... 19
Deciding What to Install ................................................................................. 19
Installing Multiple Applications ................................................................... 20
Installing WDK to Customize an Application ................................................. 20
Supporting Software Requirements .................................................................. 21
Content Server and Database ....................................................................... 21
DocBrokers and the dmcl.ini File ................................................................. 22
Documentum Foundation Classes................................................................. 22
Documentum Site Caching Services ............................................................. 22
Documentum Application Builder ................................................................ 23
Documentum Application Installer ............................................................... 23
J2EE Application Server ............................................................................ 23
JDK ....................................................................................................... 23
Electronic Signature Support for Documentum Compliance Manager ................. 23
Application Server Host Requirements .............................................................. 24
Where to Install the Application Server Software ............................................ 24
Application Server Host Operating System .................................................... 24
Installation Accounts ................................................................................. 24
Installation Accounts on the Content Server Host ........................................ 25

Web Development Kit and Applications Installation Guide 3


Table of Contents

Installation Accounts on UNIX and Linux Hosts ......................................... 25


Required Docbase Account ......................................................................... 25
Required Directories .................................................................................. 26
DFC Installation Directories.................................................................... 26
Virtual Directory for the Application ........................................................ 26
Content Transfer Directory ..................................................................... 27
Default Port Numbers ................................................................................ 27
Additional Requirements for UNIX and Linux Installations .............................. 27
Application Server Performance Tuning ........................................................ 28
Installing Virtual Link Support ........................................................................ 28
Installing Language Packs .............................................................................. 29

Chapter 4 Preparing the Content Server and Client Hosts ...................... 31


Preparing the Content Server Host.................................................................... 31
Installing or Upgrading Content Server ......................................................... 31
Preparing the Content Server Host for Web Publisher....................................... 31
Installing the Site Caching Services Source Software ....................................... 32
Enabling Macintosh Access in the Docbase .................................................... 32
Preparing Client Hosts ................................................................................... 33
Setting the JVM on Windows Clients ............................................................ 33
Verifying Which JVM Internet Explorer Uses ............................................. 33
Enabling or Disabling the Sun Java Plug-in on Internet Explorer .................... 33
Using a Macintosh with Netscape to Access DAM .......................................... 34
Internet Explorer Caching on DCM .............................................................. 34

Chapter 5 Preparing the Application Server Host ...................................... 35


Ensuring Sufficient Temporary Disk Space on the Host ........................................ 35
Nvidia Video Adapter on Windows .................................................................. 35
Antivirus Software and Virtual Link Support on Windows .................................... 36
Firewall Software.......................................................................................... 36
Installing the Correct JDK for Documentum Compliance Manager ......................... 36
Setting Environment Variables on UNIX and Linux Hosts .................................... 36
Preparing the Application Server Software ......................................................... 38
Preparing Apache Tomcat ........................................................................... 38
Verifying Apache Tomcat ....................................................................... 39
Preparing BEA WebLogic .......................................................................... 39
Preparing IBM WebSphere ......................................................................... 41
Preparing Oracle 9i Application Server ......................................................... 41
Preparing the Sun ONE Application Server .................................................... 41
Installing the Site Caching Services Target Software ............................................ 42

Chapter 6 Preparing to Upgrade WDK or WDK Applications .................. 43


Backing Up Customizations ............................................................................ 43
Backing Up Customized DocApps ................................................................... 44
Backing Up the Application Server Startup File .................................................. 44
Migrating WDK/Webtop 5.2 Customizations to WDK/Webtop 5.2.5 ....................... 44
Uninstalling Older Software Versions on Windows .............................................. 45
Upgrading WDK Applications on BEA WebLogic 7 ............................................ 46
Removing the DFC_DATA Environment Variable in Older UNIX
Installations ................................................................................................. 46
Upgrading a WDK Product Installed as Root on Older UNIX Installations ............... 46

4 Web Development Kit and Applications Installation Guide


Table of Contents

Preparing Client Hosts for an Upgrade .............................................................. 47


Checking In Checked Out Objects on Client Machines ..................................... 47
Removing Previous Versions of Content Transfer Applets on Client
Machines................................................................................................. 47
Removing the Client Applets on Internet Explorer ....................................... 48
Removing the Client Applets on Netscape ................................................. 48

Chapter 7 Installing WDK and WDK Applications ...................................... 51


Overview of the Installation Process in Stand-Alone Environments ........................ 51
Overview of the Installation Process in Managed Server Environments ................... 53
Installing on Windows in Stand-Alone Configuration ........................................... 53
Installing on UNIX and Linux in Stand-Alone Environments ................................ 56
Installing on WebLogic in a Managed Server Environment ................................... 60
Installing the Application on the WebLogic Administration Server ..................... 60
Installing the Application on Remote Managed Servers .................................... 62
Installing on WebSphere in a Managed Network Deployment ................................ 63
Installing the war File to Deployment Manager ............................................... 64
Installing Support on Each Target Host ......................................................... 65

Chapter 8 Completing the Installation Process .......................................... 69


Configuring Digital Asset Manager .................................................................. 69
Completing the Documentum Compliance Manager Installation Process ................. 70
Installing the DCM DocApp and Server Files on Windows ............................... 70
Installing the DCM DocApp and Server Files on Solaris Hosts .......................... 72
Modifying the dm_event_sender Method ....................................................... 73
Creating DCM Sample Objects .................................................................... 74
Completing the Installation Process on BEA WebLogic ........................................ 74
BEA WebLogic on AIX ............................................................................. 74
Setting Cookies Correctly When Multiple Applications Run on
WebLogic ................................................................................................ 75
Starting the WDK Application ......................................................................... 76
Starting the Application on WebLogic From the Host....................................... 76
Starting the Application on UNIX/WebLogic From a Telnet Session ................... 76
Accessing the Application .............................................................................. 77
Viewing WDK Samples ................................................................................. 77
Installing on IBM WebSphere with Global Security Enabled ................................. 78
Macintosh Content Transfer on IBM WebSphere ................................................. 79
Designating the Client-Side Content Transfer Directory ....................................... 79

Chapter 9 Completing the Web Publisher Installation Process ............. 81


Enabling Additional Locales in the Docbase....................................................... 81
Installing the Web Publisher Server Files and DocApp ......................................... 82
Where the DocApp and Server Files are Installed ............................................ 83
About the Web Publisher Server Files ........................................................... 88
About the Web Publisher DocApp ................................................................ 88
About the Accelera DocApp ....................................................................... 89
Installing the DocApp and Server Files on Windows Hosts ............................... 89
Installing the DocApp and Server Files on UNIX Hosts .................................... 90
Installing the Files ................................................................................. 91
Installing the DocApp ............................................................................ 91
Updating the Data Dictionary After Installation .............................................. 93
Output of the Data Dictionary Script ............................................................. 94

Web Development Kit and Applications Installation Guide 5


Table of Contents

Installing the Accelera DocApp ....................................................................... 95


Accelera Preinstallation Requirements .......................................................... 95
Setting the Regional Options on Windows Hosts ......................................... 95
Installing the Accelera DocApp ................................................................... 96
Creating a Site Publishing Configuration ....................................................... 97
Testing the Accelera DocApp Installation ...................................................... 98
Publishing Documents to the Sample Web Site ............................................... 99
Using eWebEditPro .................................................................................... 100
Obtaining eWebEditPro ............................................................................ 100
Before You Install eWebEditPro ................................................................ 100
Installing eWebEditPro ............................................................................ 101

Chapter 10 Uninstalling WDK, WDK Applications, and DFC ................... 103


Uninstalling WDK or a WDK Application ....................................................... 103
When to Uninstall ................................................................................... 103
Uninstalling the Documentum Compliance Manager Beta Software .................. 104
Uninstalling WDK or a WDK Application from Windows Systems .................. 104
Uninstalling WDK or a WDK Application from UNIX and Linux
Systems ................................................................................................ 106
Uninstalling the Web Publisher Server Files ..................................................... 107
Uninstalling DFC ........................................................................................ 107
Uninstalling DFC from Windows Hosts ...................................................... 107
Uninstalling DFC from UNIX and Linux Hosts ............................................ 108

Chapter 11 Troubleshooting Installation ....................................................... 109


All WDK Applications ................................................................................. 109
Generating a Log File to Debug Installations ................................................ 109
Slow Browser Display ............................................................................. 110
Network Bandwidth ................................................................................ 110
BEA WebLogic Error Message When Starting in Development Mode ............... 110
Troubleshooting Web Publisher Only .............................................................. 110
Web Publisher Server-Side Installer Errors................................................... 110
exception NoClassDefFounderror... com.documentum.wcm.
servermethod.WcmExpireNowActionHandler .......................................... 111
Server Side Tracing for Web Publisher ........................................................ 111
DocApp Installation Fails ......................................................................... 112
Text Unaligned ....................................................................................... 113
Users Cannot Access Functions That Their Roles Should Allow ...................... 113
Troubleshooting Webtop Only ....................................................................... 113
Invalid class file format ............................................................................ 113

6 Web Development Kit and Applications Installation Guide


Table of Contents

List of Figures

Figure 3–1. WDK Host Configuration in Stand-Alone Mode ..................................................... 18


Figure 7–1. Installation Process ........................................................................................... 52

Web Development Kit and Applications Installation Guide 7


Table of Contents

List of Tables

Table 3–1. Installation Choices and Consequences ................................................................. 21


Table 5–1. Required Environment Variables .......................................................................... 37
Table 8–1. Output Directories and JVM Custom Properties .................................................... 78
Table 9–1. Location of DocApp and Web Publisher Server Files on UNIX Hosts ......................... 83
Table 9–2. Location of DocApp and Web Publisher Server Files on Windows Hosts ..................... 86

8 Web Development Kit and Applications Installation Guide


Preface

This guide describes how to install, configure, and uninstall Documentum Web Development Kit
(WDK) and WDK applications such as Webtop, Web Publisher, Documentum Administrator, Digital
Asset Manager, and Documentum Compliance Manager. This guide also describes how to set up and
install any application-specific third-party integrations and Web site samples.
This manual may include instructions for application servers, or combinations of operating systems
and applications servers, that are not supported for your products. For the list of supported platforms,
see the release notes for the product that you are installing.

Intended Audience
This manual is intended primarily for administrators who are installing WDK or an
application based on WDK:
• Webtop
• Web Publisher
• Documentum Administrator
• Digital Asset Manager
• Documentum Compliance Manager
Readers should be familiar with the Windows, UNIX, or Linux operating system and
be able to install and configure a J2EE application server.

Revision History
The following changes have been made to this document:

Revision History

Revision Date Description

June 2003 Initial version.

June 30, 2003 Modified section on Sun ONE application server.

August 2003 Added information for release of Digital Asset Manager.


Added documentation for Solaris/WebSphere platforms. Minor
clarifications and corrections.

Web Development Kit and Applications Installation Guide 9


Preface

Revision Date Description

August 8, 2003 Added information for Windows/WebSphere and


AIX/WebSphere.

August 29, 2003 Modified BEA WebLogic Application Server details to stated
whether or not the application server needs to be running. Added
information for HP-UX. Added installer screen.

September 2003 Added information for Oracle 9i AS

December, 2003 Updated for 5.2.5 release. Added many clarifications and
corrections.

March, 2004 Updated for 5.2.5 SP1 release. Added information for Documentum
Compliance Manager. Some reorganization and incorporation of
copy-edits.

Related Documentation
The following documentation is available for configuring and customizing WDK and
WDK applications:
• Web Development Kit Troubleshooting Guide
• Web Development Kit and Applications Tutorial
• Web Development Kit Applications Configuration Guide
• Web Development Kit Development Guide
• Web Development Kit and Applications Reference Guide
• JavaDoc API reference documentation
WDK end user documentation for WDK applications is installed in the help subdirectory
of each virtual directory. WDK documentation is installed in the /help/wdk
subdirectory of the DFC program root.
If you select the Developer Documentation option during installation, the DFC Javadocs
are also installed.

10 Web Development Kit and Applications Installation Guide


Chapter 1
WDK and WDK Applications Installation
Quick Start

This chapter discusses which sections of this manual you must read in order to install or upgrade
WDK or a WDK application successfully. Before you read them, review the WDK and Webtop Release
Notes. If you are upgrading, review the sections of the System Migration Guide that discuss changes
and migration issues in WDK and WDK applications.

All New Installations And Upgrades


Read the following sections of the manual regardless of whether you are installing
WDK or an application and whether you are creating a new installation or upgrading
an existing installation:
• Chapter 2, About WDK and WDK Applications
• Chapter 3, Planning for Installation
• Chapter 4, Preparing the Content Server and Client Hosts
• Chapter 5, Preparing the Application Server Host
Ensure that in this chapter you read the general sections and the section that applies
to the application server on which you are installing WDK or a WDK application.
These are:
— Preparing Apache Tomcat, page 38
— Preparing BEA WebLogic, page 39
— Preparing IBM WebSphere, page 41
— Preparing Oracle 9i Application Server, page 41
— Preparing the Sun ONE Application Server, page 41
• Chapter 7, Installing WDK and WDK Applications, which contains an overview
and separate sections on Windows and UNIX installations and managed server
environments:
— Overview of the Installation Process in Stand-Alone Environments, page 51
— Overview of the Installation Process in Managed Server Environments, page 53
— Installing on Windows in Stand-Alone Configuration, page 53

Web Development Kit and Applications Installation Guide 11


WDK and WDK Applications Installation Quick Start

— Installing on UNIX and Linux in Stand-Alone Environments, page 56


— Installing on WebLogic in a Managed Server Environment, page 60
— Installing on WebSphere in a Managed Network Deployment, page 63
• Chapter 8, Completing the Installation Process
• If you encounter difficulties, review Chapter 11, Troubleshooting Installation.

Upgrading an Existing Installation


If you are upgrading WDK or a WDK installation, review Chapter 6, Preparing to
Upgrade WDK or WDK Applications and review Chapter 10, Uninstalling WDK, WDK
Applications, and DFC. (Documentum recommends uninstalling an existing application
before installing a new or upgraded version.)

Installing Web Publisher


After Web Publisher is installed on the application server host, some functionality must
be installed on the Content Server host. For complete information, review Chapter 9,
Completing the Web Publisher Installation Process.

Installing Documentum Compliance Manager


If you are installing Documentum Compliance Manager (DCM), ensure that you perform
the tasks described in Completing the Documentum Compliance Manager Installation
Process, page 70. If you participated in the DCM Beta, use the instructions in Uninstalling
the Documentum Compliance Manager Beta Software, page 104 to uninstall the beta
version of the product before installing the general release version.

Uninstalling WDK or a WDK Application


If you are uninstalling WDK or a WDK application, review Chapter 10, Uninstalling
WDK, WDK Applications, and DFC.

12 Web Development Kit and Applications Installation Guide


Chapter 2
About WDK and WDK Applications

This chapter contains an overview of WDK and its associated applications. It contains the following
topics:
• What is WDK?, page 13
• What is a WDK Application?, page 13

What is WDK?
Web Development Kit (WDK) is a developer’s toolkit, based on industry standards,
which facilitates the development of complex Web-based applications that connect to
Documentum Content Server. WDK provides a J2EE development platform and contains
a large library of reusable components and controls that perform common Documentum
content management functions and provide a uniform user interface to applications built
with WDK. The Documentum Web client applications described below were developed
using WDK. These applications can be customized using WDK.

Role of the Application Server


WDK follows the Java technology standards for the J2EE platform. A J2EE application
server provides the runtime environment required for deploying a J2EE application. It is
required for the Java Server Pages and servlets that are used by WDK components.
Documentum supports particular J2EE application servers and the Apache Tomcat
servlet container. See the release notes for your product for the list of supported
application servers.

What is a WDK Application?


WDK applications have four application layers: the WDK layer, the webcomponent layer,
the webtop layer, and the custom layer. A customized WDK application is a Web client
that configures and extends the components in the WDK and webcomponent layers.

Web Development Kit and Applications Installation Guide 13


About WDK and WDK Applications

Several out-of-the-box applications are available from Documentum, as described in the


following sections. To create a custom Web client, start with Webtop and customize it or
use WDK to build a complete application.

Out-of-the-Box Applications
All Documentum 5 Web clients, including Webtop, Web Publisher, Documentum
Administrator, Digital Asset Manager, and Documentum Compliance Manager, are
developed on the Documentum WDK 5 platform.

Webtop

Webtop is a browser-based, general-purpose client that communicates with Content


Server and provides access to a Docbase, a content repository. Webtop allows you
to perform many document management tasks, from a document’s creation to its
archiving, and everything in between. Content Server automates numerous document
management tasks and provides automatic routing, renditioning, versioning, security,
and many other functions.

Web Publisher

Web Publisher is a browser-based application that simplifies and automates the creation
of content for Web sites. Authors create and modify content without having to know how
to construct Web pages. Content is automatically published to multiple sites in multiple
languages and formats. Developers use Web Publisher to maintain Web page templates
and site structures. Administrators maintain the Web Publisher system settings.
Web Publisher uses Content Server to store content in a Docbase and perform content
management functions. Documentum Site Caching Services (SCS) is used to publish
content from a Docbase to a designated location on a Web site.

Documentum Administrator

Documentum Administrator is a Content Server and Docbase administration tool.


Use Documentum Administrator to create users, groups, permission sets, Docbase
federations, configuration objects (LDAP and server, for example), site publishing
configurations, types, formats, storage areas, and alias sets. You can also use
Documentum Administrator to stop and start servers, run jobs, methods, and
administration methods, create new jobs and methods, and administer full-text indexing.

14 Web Development Kit and Applications Installation Guide


About WDK and WDK Applications

Digital Asset Manager

Digital Asset Manager (DAM) is a Webtop-based application that provides powerful


media management capabilities such as on-demand file transformation, thumbnail
viewing, and storyboard support. It extends Documentum’s powerful content
management functionality to rich media, enabling content management capabilities for
images, audio, and video.
DAM and the application server run on a host that is referred to as the DAM Server.
DAM uses Media Services to provide robust media management capabilities. Media
Services is a multi-component product that functions and communicates with both
Content Server and the application server.
Media Services has two components:
• Media Server, which connects to Content Server and provides services to DAM
through Content Server
• Thumbnail Server, which typically runs on the same host as Content Server
This manual provides information on installing and configuring DAM. For information
on installing Media Services, see the Media Services documentation.

Documentum Compliance Manager

Documentum Compliance Manager integrates with Webtop to help you manage large
volumes of documents that must comply with regulatory and quality standards.
Documentum Compliance Manager assists you in the following ways:
• Distributes current documents to the right people for you in a timely, consistent
manner.
• Helps you manage document changes:
— Uses a defined process that incorporates change requests, change notices, and
supporting documents to record and track changes.
— Assures that documents are reviewed and approved by the appropriate people
in a consistent, controlled process.
— Allows consumers to read documents and issue change requests.
— Allows coordinators to create and edit documents and issue change notices, as
well as route documents for review and approval.
• Provides automated control over who may view, print, or change electronic
documents.
• Provides built-in reports to help you track your documents.
• Automatically generates audit trails for events such as the creation, modification and
approval or sign-off of controlled documents.
• Uses an optional module to add custom headers, footers and watermarks to
published documents when they are viewed or printed.
• Uses an optional module to restrict printing, track printed copies, and recall printed
copies for controlled documents.

Web Development Kit and Applications Installation Guide 15


About WDK and WDK Applications

Using the various configuration options included with DCM, the DCM Administrator
can configure a business application that defines automatic properties and processes for
specified document types.
Each DCM business application includes the following features:
• Controlled document creation, editing, viewing, and printing
• Auditing, authentication, and electonic sign-off
• Automatic document lifecycle management
• Automatic document naming, versioning, and other property settings
• Workflow management and automation
• Automated distribution and notification functionality
• Controlled central printing services

Customized Applications
Documentum encourages developers to use one of the existing WDK applications as
a starting point to build custom Web client applications. Both the user interface and
underlying behavior can be extensively modified. In many cases, starting with an
existing client can significantly shorten application development time.
If you prefer to build your own Web client, use WDK as a toolkit. For information on the
documentation available for customization, see Related Documentation.

16 Web Development Kit and Applications Installation Guide


Chapter 3
Planning for Installation

This chapter addresses software and hardware decisions you must make before preparing to install
WDK or a WDK application.
This chapter discusses the following topics:
• Typical Configurations, page 17
• Deciding What to Install, page 19
• Supporting Software Requirements, page 21
• Application Server Host Requirements, page 24
• Related Documentation
• Installing Virtual Link Support, page 28
• Installing Language Packs, page 29

Typical Configurations
In stand-alone mode, a typical WDK application requires the following hosts:
• An application server host, where the application server is installed
• A Content Server host, where a Docbase is installed and where one or more Content
Servers run
Content Server requires a relational database management system, which can be
installed on the Content Server host or a remote host. WDK applications can access
Docbases on any operating system on which Content Server runs.
• Client hosts running a supported Web browser
End users access the WDK application with the Web browser.
You can install WDK applications on all supported application servers in stand-alone
mode.

Web Development Kit and Applications Installation Guide 17


Planning for Installation

Figure 3–1. WDK Host Configuration in Stand-Alone Mode

BEA WebLogic and IBM WebSphere can be configured, respectively, in managed server
and managed network deployment modes. See below for more information on these
configurations.
If Content Server and a WDK application use the same version of DFC, you can install
both on a single machine. However, for security and performance reasons, Documentum
strongly recommends installing on separate machines. For more information on security,
see Where to Install the Application Server Software, page 24 and Installation Accounts,
page 24.

BEA WebLogic 8.1 Managed Server Environments


The 5.2.5 Service Pack 1 release introduces installation support for BEA WebLogic
Managed Server environments. This new installation support allows Documentum
WDK-based applications to be uploaded to the Administration Server machine in a
WebLogic domain, and subsequently deployed through the WebLogic Administrative
Console to any number of managed server instances across any number of physical
machines. This supports higher availability in production environments. Please note
that:
• The WDK-based application installer must be run on each physical server machine
that will host one or more managed server instances that belong to the domain.

18 Web Development Kit and Applications Installation Guide


Planning for Installation

This process installs the Documentum Foundation Classes, including native


modules, and configures the WebLogic installation on each machine so that the
application instances have access to these external system-level resources.
• WDK-based applications do not support session replication and failover.

IBM WebSphere 5 Managed Network Deployment


Environments
The 5.2.5 Service Pack 1 release introduces installation support for IBM Websphere
Managed Network Deployment environments. This new installation support allows
Documentum WDK-based applications to be uploaded to the Network Deployment
Manager server machine, and subsequently deployed to any number of server instances
across any number of Nodes and physical machines that belong to Deployment Manager
Cell. This supports higher availability in production environments. Please note that:
• The WDK-based application installer must be run on each physical server machine
that will host one or more managed server instances that belong to the domain.
This process installs the Documentum Foundation Classes, including native
modules, and configures the WebLogic installation on each machine so that the
application instances have access to these external system-level resources.
• WDK-based applications do not support session replication and failover.

Distributed and Federated Environments


Some WDK applications are not supported in distributed and federated Docbase
environments:
• Web Publisher is not supported with federated Docbases or distributed environments.
• Documentum Compliance Manager is not supported with federated Docbases.
• Webtop provides limited support for distributed content environments, but has no
support for replica or reference objects and does not provide cross-Docbase search
functionality.
• Documentum Administrator can accesses Docbases in each of these configurations
and is used to create federations and distributed file stores and to create replication
jobs.

Deciding What to Install


Depending on your business requirements, you can install one or more WDK
applications, only WDK, or WDK and one or more WDK applications on a single host.
WDK applications install a WDK layer as part of the product installation. If you plan to
run an application out of the box, installing the application is sufficient.

Web Development Kit and Applications Installation Guide 19


Planning for Installation

Unless you are running the BEA WebLogic application server, installing WDK itself is
not required for customizing a WDK application, but it is recommended. The source
files for behavior classes, JSP comment lines, and other tools provided by WDK are only
available when you install WDK.

Installing Multiple Applications


You can install more than one WDK application, or multiple instances of the same
application, on a single J2EE application server. Each instance of an application must be
installed to a different virtual directory. You are asked to provide the name of a virtual
directory during installation. For more information on virtual directories, see Virtual
Directory for the Application, page 26. You can also install applications to separate
instances of the application server.
Documentum recommends creating a different domain in BEA WebLogic for each WDK
application or instance of an application. For more information, see Preparing BEA
WebLogic, page 39.
If you install more than one application on a single application server, the last to be
installed is the default application for resolving virtual links. For more information on
virtual links, refer to Installing Virtual Link Support, page 28.

Installing WDK to Customize an Application


You can install WDK either as a stand-alone application or to customize an existing
application such as Webtop or Web Publisher. To customize an application, install the
application first, then install WDK using the option to customize an existing application.
You must use the correct version of WDK to customize an application. Use WDK 5.2
to customize a 5.2 application and use WDK 5.2.5 to customize a 5.2.5 application. You
cannot use WDK 5.2.5 on a 5.2 application or WDK 5.2 on a 5.2.5 application.
A developer license is required to develop custom applications. See your Documentum
account representative to obtain a developer license.
To obtain the complete set of WDK documentation, you can install WDK stand-alone
and once for each existing application that you are customizing.
When you install WDK to customize an existing application, you are asked to provide
the name of a WAR file or a directory location where the application is installed.
Documentum recommends that you install into a different virtual directory from the one
where the application was installed. If you want to install WDK into the same virtual
directory as an existing application, we recommend that you first make a backup copy of
all files that exist in the virtual directory.
The application files are copied to the new virtual directory you created, and the
unstripped .jar file is extracted to the application. This provides the comments that
were stripped out of the WAR file files when you installed the WDK application as
a stand-alone application. Ensure that the customized application resides in the same
domain as WDK, not in a different domain.

20 Web Development Kit and Applications Installation Guide


Planning for Installation

The following table shows the differences in various types of WDK and application
installations. If you are planning to customize an existing application on a BEA
application server, you must install both the application and then WDK to customize
it, in order to expand the WAR file for the WDK application. If you are customizing
an existing application on another application server, it is possible to customize the
application without installing WDK. However, Documentum recommends you install
WDK before customizing an existing application so that you get the complete set of
source files and documentation.

Table 3–1. Installation Choices and Consequences

Installation BEA application


choice servers Source files JSP Documentation

Install WDK Expands WDK Installs source JSP pages appear Installs WDK
as stand-alone WAR file files for with comments documentation
product WDK and
webcomponent
classes

Install Webtop Expands the Installs source JSP pages Installs


or Web Publisher WAR file files for Webtop appear without application-
as stand-alone classes comments specific user and
application configuration
guides

Install WDK Expands the Installs source Modifies JSP Adds WDK
to customize Webtop or Web files for pages to appear documentation
Webtop or Web Publisher WAR Webtop classes with comments
Publisher file. and source
files for the
WDK/Webtop
components

Supporting Software Requirements


Additional software products are required for WDK and WDK applications, including
Content Server and its associated database, a DocBroker, and a J2EE application server.

Content Server and Database


Before you install WDK and WDK applications, install the Content Server software and a
database and configure a Docbase. (For information on the supported operating system
and database combinations, refer to the Content Server release notes.) Content Server
provides content management services, including check in and check out, versioning,
and archiving, and provides client access to the content in a Docbase.

Web Development Kit and Applications Installation Guide 21


Planning for Installation

Some of the installers contain scripts that install object types for the specific application.
Web Publisher and DCM include DocApps to be installed in the Docbase.
For complete information on installing Content Server, refer to the Content Server
Installation Guide. If you are upgrading an existing Content Server and Docbase, review
the section on upgrading in the chapters of the installing manual on planning for an
upgrade, preparing for an upgrade, and upgrading Content Server.

DocBrokers and the dmcl.ini File


DocBrokers provide Docbase connection information to client applications. Before you
install WDK or a WDK application, obtain the names of the DocBrokers to which the
appropriate Docbases project and the port numbers on which the DocBrokers listen.
The DocBrokers used by WDK applications are defined in the dmcl.ini file on the
application server host. All Documentum applications installed on a Windows machine
share the same dmcl.ini file. On Windows, this file is located in C:\WINNT. On UNIX,
the dmcl.ini file is located in $DOCUMENTUM.
If a dmcl.ini file does not already exist on the application server host, the installer asks
for the DocBroker name and the port number on which it listens and then creates the
dmcl.ini file. The default DocBroker port is 1489.
If you need to change the DocBroker information after installation, edit the dmcl.ini file
on the application server host. For more information on the dmcl.ini file and DocBrokers,
refer to the Content Server Administrator’s Guide.

Documentum Foundation Classes


Installing WDK or a WDK application also installs Documentum Foundation Classes
(DFC) on the application server host. DFC is required by WDK and WDK applications.
DFC is an object-oriented application programming interface (API) and framework for
accessing, customizing, and extending Documentum functionality, implemented as a
set of Java interfaces and implementation classes. For more information on DFC, refer
to the Documentum Foundation Classes Development Guide and Documentum Foundation
Classes Installation Guide.

Documentum Site Caching Services


Documentum Site Caching Services (SCS) publishes documents from a Documentum
Docbase directly to a Web site. SCS allows you to identify groups of documents to
publish to the Web site, which version and format to publish, and when to publish the
documents. This ensures that content on your Web site is accurate and timely.
Site Caching Services is required by Web Publisher.

22 Web Development Kit and Applications Installation Guide


Planning for Installation

Documentum Application Builder


Documentum Application Builder (DAB) is required for Documentum Compliance
Manager installation. DAB is a Windows product only. It can be used to install DocApps
in Windows or UNIX Docbases.

Documentum Application Installer


Installing Web Publisher or DCM also requires installing a DocApp in each Docbase you
access with the application. Documentum Application Installer (DAI) is required for
installing DocApps. DAI is part of DAB; if you install DAB, DAI is included.

J2EE Application Server


WDK is implemented on both Java 2 SDK and Java 2 EE. More specifically, this version
of WDK uses the Java Server Pages (JSP) and Java Servlet services of an enterprise
edition implementation.

JDK
Whether or not the Sun JDK is installed on the application server host, Documentum
installs the Sun JDK to the /jdk subdirectory of the DFC program root. It is used only by
the installer and uninstaller. The application server uses the version of the JDK that is
specified in the release notes for your product.

Electronic Signature Support for Documentum


Compliance Manager
If you are using Documentum Compliance Manager’s electronic signature feature, the
following programs are required:
• PDF Aqua
• Content Rendition Services, for creating PDF documents
• Documentum Administrator 5.2.5, for managing auditing
Refer to the documentation for PDF Aqua and Content Rendition Services for
information on installing and configuring the applications.

Web Development Kit and Applications Installation Guide 23


Planning for Installation

Application Server Host Requirements


The application server host used for WDK or a WDK application has the requirements
described in the following sections.
• Where to Install the Application Server Software, page 24
• Application Server Host Operating System, page 24
• Installation Accounts, page 24
• Required Docbase Account, page 25
• Required Directories, page 26
• Default Port Numbers, page 27
• Additional Requirements for UNIX and Linux Installations, page 27
• Application Server Performance Tuning, page 28

Where to Install the Application Server Software


For security and performance reasons, Documentum strongly recommends installing the
application server software on a host other than the Content Server host. Installing the
application server on the Content Server host carries certain risks:
• If the application server installation owner is a Documentum user, serious security
problems are created.
• If the application server installation owner is not the Content Server installation
owner, the versioning and interoperability of the Documentum applications on the
host is not maintained properly.
For complete information on the security and other implications of installing the
application server software on the Content Server host, refer to Installation Accounts on
the Content Server Host, page 25 below.

Application Server Host Operating System


The application server host can run any operating system supported by the application
server. The operating system does not need to be the same as the Content Server host
operating system. For example, if Content Server is running on Solaris, the application
server can be installed on a remote host running Windows.

Installation Accounts
Documentum recommends using a single user account to install and run the application
server software and all WDK-based applications on the application server host. (This
account is the installation owner account. The version control mechanism used by all
Documentum installers is based on the ISMP per-user vital product registry. It cannot

24 Web Development Kit and Applications Installation Guide


Planning for Installation

validate or enforce version control and guarantee product interoperability unless all
products are installed using the same system account.
The installation owner’s user name must consist of letters, numbers, dashes (-) and
underscores (_). The first character must be a letter. All characters must be ASCII
characters.
The installation owner’s password must consist of letters, numbers, dashes, underscores,
and periods.
The user who installs WDK or a WDK application must have Write permission on the
content transfer directory. For more information on the content transfer directory, refer
to Content Transfer Directory, page 27.

Installation Accounts on the Content Server Host

Documentum strongly recommends installing the application server on a host remote


from the Content Server host.
However, if you must install the application server on the Content Server host, use an
account other than a Documentum user as the application server (and WDK application)
installation owner. If a Documentum user is the application server installation owner, a
security problem is created because trusted login allows a Documentum user who has
successfully connected to a host to connect to any Content Server on that host without
providing a password.
Using different installation owners for Documentum products on the same host creates a
different problem. It undermines Documentum version control and interoperability.
Some application servers must be installed on UNIX hosts using the root account. If you
must install such an application server on the Content Server host, the application server
and WDK applications should have different installation owners from Content Server.
Content Server must not be installed using the root account.

Installation Accounts on UNIX and Linux Hosts

On UNIX and Linux systems, Documentum recommends that you do not install as root
unless the application server requires it. See Preparing the Application Server Software,
page 38, for any requirements specific to the application server you use.

Required Docbase Account


Completing the installation process for Web Publisher, Documentum Compliance
Manager, and Digital Asset Manager requires the ability to connect to a Docbase as a
user who has Superuser privileges in that Docbase and, in the case of Web Publisher, the
ability to install files on the Content Server host.

Web Development Kit and Applications Installation Guide 25


Planning for Installation

Before you complete the installation process, determine which Docbases must be
configured for Web Publisher, Documentum Compliance Manager, or Digital Asset
Manager and obtain a Superuser user name and password for each Docbase. For Web
Publisher, we recommend using the Content Server installation owner account, which
has appropriate rights on the host and in the Docbase. For the other applications, any
Superuser account is sufficient.

Required Directories
During installation, you asked to provide directories or paths for DFC, the WDK
application, and the content transfer directory.
Java does not allow directories containing the following characters, which must not
appear in the directory names or paths of Documentum applications:
! \/ : * ? " < > |

DFC Installation Directories

If DFC is not already installed on the application server host, it is installed with WDK or
any WDK application. You must select the following directories during installation:
• DFC program root directory
— On Windows, the default DFC program root directory is C:\Program
Files\Documentum
— On UNIX and Linux, the DFC program root directory is the directory designated
by the $DOCUMENTUM_SHARED environment variable
• On Windows, a Documentum user directory
This directory contains subdirectories that are used for content transfer operations
and for trace logging. These include the Checkout, config, and contentXfer
subdirectories.
• On UNIX and Linux, the DOCUMENTUM environment variable is used by the
installer to create the DFC user directory.
For more details, see Setting Environment Variables on UNIX and Linux Hosts,
page 36

Virtual Directory for the Application

During installation, you enter the name of the virtual directory where WDK or the WDK
application are to be installed. The virtual directory is also called the context root or the
alias. It is used in URLs for accessing the application. For example, if Webtop is installed
in a virtual directory called wt, the resulting URL is http://host_name:port_number/wt/ .

26 Web Development Kit and Applications Installation Guide


Planning for Installation

You must install each application, or each instance of an application, in a separate


virtual directory. You can accept the default offered by the installer or choose another
virtual directory name.

Content Transfer Directory

During installation, you designate a content transfer directory on the application server
host. This directory is used to store files temporarily when they are uploaded to or
downloaded from the Docbase. The default content transfer directory is:
• On Windows, C:\Documentum\contentXfer
• On UNIX and Linux, $DOCUMENTUM_SHARED/contentXfer
If you designate a directory that already exists on the application server host, the installer
displays a warning that the directory will be deleted if the product is uninstalled. If two
applications share a single content transfer directory, uninstalling one of the applications
removes the shared content transfer directory.
The user who installs the product must have Write permission on the content transfer
directory.

Default Port Numbers


Each application server uses default port numbers for communications. Before you
install, determine the default port number or numbers used by the application server
and ensure that the port numbers are not in use. If the default port numbers are in
use, select other port numbers.
• On Apache Tomcat, the default port number is 8080.
• On BEA WebLogic, the default port numbers are 7001 and 7002.
• On Sun ONE, the default port numbers are 4848 for the application server’s
administration console and 80 for Documentum applications.
• On IBM WebSphere, the default port numbers are 9090 for the application server’s
administration console and 9080 for Documentum applications.
• On Oracle, the default port numbers are 1810 for the application server’s
administration console and 7777 for Documentum applications.

Additional Requirements for UNIX and Linux Installations


UNIX and Linux installations have two additional requirements:
• XWindows™ must be installed on the UNIX or Linux host to run the graphical
installer, and the Xterm program must be in the path.
You cannot install Documentum applications in console mode.
• Several environment variables must be set up before installation.

Web Development Kit and Applications Installation Guide 27


Planning for Installation

For more information, refer to Setting Environment Variables on UNIX and Linux
Hosts, page 36.

Application Server Performance Tuning


When WDK or a WDK application is installed, the following Sun Java memory allocation
values are assigned in the application server startup file. They overwrite any previous
values in the startup file.
-Xms256m
-Xmx256m

These are the minimum recommended values for very small systems. Increase the values
to meet the demands of the expected user load.
The installer makes backup copies of the original startup files. The backups are in the
original directory with .bak.n appended to the original file name.
If you are upgrading from an earlier version of WDK or a WDK application and the
startup file contains different values, re-enter the previous values after installation.
For more information on these settings, see Java documentation at the Sun Web site
(http://java.sun.com). More information on application server performance tuning
and benchmarking under Documentum is available from your Documentum SE or
Documentum Consulting.

Installing Virtual Link Support


A virtual link is a URL that resolves to a document in a Docbase. A virtual link may
be typed directly in a browser address bar by a user or it may be issued by a custom
application. You must install virtual link support if you use Web Publisher with
eWebEditPro.
If virtual link support is installed, the virtual link error handler becomes the HTTP 404
handler for the root Web application. It handles all Page Not Found errors for all Web
applications in the server instance. When a 404 error is thrown, the Web application that
provides virtual link support connects to the Docbase and attempts to retrieve the object
to which the virtual link points.
The last WDK application that is installed with virtual link support is the default
application for resolving virtual link URLs. For example, if you install Webtop and Web
Publisher with virtual link support enabled, Web Publisher resolves virtual link URLs for
users who are not logged in to a particular application. Which application provides the
default virtual link support can be reconfigured by editing the web.xml file. For more
information on virtual link support installation and use, refer to the Web Development Kit
Development Guide or the Web Development Kit Applications Configuration Guide.
If you are installing virtual link support:
• Ensure that a root Web application exists.

28 Web Development Kit and Applications Installation Guide


Planning for Installation

When the virtual link handling service is installed, the WDK and WDK application
installers modify the root Web application web.xml file and the virtual link handler
is installed to the root Web application. Some application servers automatically
create a root Web application. Others require you to create a root Web application
manually or during application server installation. Refer to the documentation for
the application server for information on the root Web application.
• Disable any firewall software on the application server host.
If you are installing with BEA WebLogic 8.1 and you require virtual link support, you
must extend the domain to include defaultWebApp, or virtual links do not work
correctly in the WDK applications. Extend the domain when the application server is
not running. For more information on extending domains and on defaultWebApp, refer
to the documentation for WebLogic 8.1.

Installing Language Packs


Localized WDK-based applications are provided with language packs. A language pack
is a language-specific archive file containing a graphical user interface (GUI) and user
documentation that have been localized (translated) into a language other than the
default application language, U.S. English. Before you install any language packs, install
the English product. For more information on language packs, see the Web Development
Kit Applications Language Pack Installation and Release Notes.

Web Development Kit and Applications Installation Guide 29


Planning for Installation

30 Web Development Kit and Applications Installation Guide


Chapter 4
Preparing the Content Server and
Client Hosts

Read this chapter and perform the tasks described whether you are creating a new installation
or upgrading an existing installation.
This chapter contains the following information:
• Preparing the Content Server Host, page 31
• Preparing Client Hosts, page 33

Preparing the Content Server Host


Before you install WDK or a WDK application, you must prepare the Documentum
Content Server host and install Content Server, if it is not already installed.
See the following sections for installing or upgrading Content Server and any required
product-specific preparation.
• Installing or Upgrading Content Server, page 31
• Preparing the Content Server Host for Web Publisher, page 31
• Installing the Site Caching Services Source Software, page 32
• Enabling Macintosh Access in the Docbase, page 32

Installing or Upgrading Content Server


All WDK applications require a Docbase and Content Server. For complete information
on installing or upgrading Content Server, refer to Content Server Installation Guide.

Preparing the Content Server Host for Web Publisher


This section provides a general description of how to prepare the Content Server host for
Web Publisher. Complete these tasks after installing Web Publisher on the application
server host. For complete instructions for the tasks listed below, refer to Chapter 9,
Completing the Web Publisher Installation Process.

Web Development Kit and Applications Installation Guide 31


Preparing the Content Server and Client Hosts

• You must first install the Site Caching Services source software.
For more information, refer to Installing the Site Caching Services Source Software,
page 32 and to documentation for Site Caching Services.
• You must install the Web Publisher server files on the Content Server host.
The server files prepare Content Server for Web Publisher DocApp installation.
• You must install the Web Publisher DocApp.
The DocApp installs cabinets, folders, object types, lifecycles, workflow templates,
permission set templates, alias sets, jobs, procedures, and methods required by Web
Publisher. The Web Publisher DocApp also creates the dm_relation objects used by
Web Publisher, sets lifecycles to execute as Superuser, creates the four Web Publisher
user roles (administrator, Web developer, content manager, and content author), and
creates the Web Publisher default ACL.
For details on setting up users, refer to the Web Publisher Administration Guide.
• You can optionally install the DocApp for the Web Publisher sample Web site, called
Accelera.

Installing the Site Caching Services Source Software


If you use Web Publisher, install or upgrade to the required version of the Site Caching
Services source software on the Content Server host. For complete information on
installing or upgrading SCS, refer to the Site Caching Services Installation Guide.

Enabling Macintosh Access in the Docbase


When Macintosh computers use Documentum WDK applications to access a Docbase,
the mac_access_protocol attribute of the docbase config object must be set correctly to
preserve the Mac Resource Fork in the Docbase. The DAM Configurator automatically
updates this attribute to the correct value. If you are using other WDK applications, you
must set the mac_access_protocol attribute manually.

To set the mac_access_protocol attribute of the docbase config object:

1. Start IDQL and log in to the Docbase as a Superuser.


2. If the value of mac_access_protocol is current set to ’none’, run the following
command:
UPDATE dm_docbase_config objects SET "mac_access_protocol" = ’nt’

3. Restart the Docbase.

32 Web Development Kit and Applications Installation Guide


Preparing the Content Server and Client Hosts

Preparing Client Hosts


This section contains instructions for preparing Windows and Macintosh client hosts to
use WDK applications. It contains the following information:
• Setting the JVM on Windows Clients, page 33
• Using a Macintosh with Netscape to Access DAM, page 34
• Internet Explorer Caching on DCM, page 34

Setting the JVM on Windows Clients


Windows client hosts running Internet Explorer can use either the Sun JVM plug-in or
the Microsoft VM plug-in to accomplish content transfer in a WDK application.
When a client first performs a content transfer operation in a WDK application, the
content transfer applet is installed. During installation the installer detects which virtual
machine the browser is using.
To use an HTML editing application in Web Publisher, such as Web Publisher Editor or
Rules Editor, you must have the Sun JVM installed and enabled. The Microsoft VM is not
supported with Web Publisher Editor and Rules Editor. The Sun JVM is installed with
Netscape, but not with Internet Explorer.
Use one of the following procedures if you want to verify which JVM a particular
browser is using, or if you want to enable or disable the Sun JVM.

Verifying Which JVM Internet Explorer Uses

Use this procedure to verify which JVM Internet Explorer uses.

To verify which JVM is used by Internet Explorer:

1. Open Internet Explorer and select ToolsoInternet Options.


2. Click the Advanced tab, ensure that all three options under Microsoft VM are
checked, and click OK.
3. Click StartoProgramsoAccessoriesoSystem ToolsoSystem Information.
4. Open Internet Explorer\Summary in the navigation tree.
5. Ensure that Java VM Version 5.0 or higher is listed in the right-hand pane.
If the Java VM is not listed, it may have been replaced by the Sun Java plug-in.

Enabling or Disabling the Sun Java Plug-in on Internet Explorer

Use this procedure to enable or disable the Sun Java plug-in on Internet Explorer.

Web Development Kit and Applications Installation Guide 33


Preparing the Content Server and Client Hosts

To enable or disable the Sun Java plug-in on Internet Explorer:

1. From the Start menu, select SettingsoControl Panel.


2. Select the Java Plug-in
3. On the Basic tab, uncheck Enable Java Plug-In to disable the plug-in. Check to
enable it.
4. If there is a Browser tab (some versions of the plug-in) uncheck Microsoft Internet
Explorer to disable the browser plug-in. Check Microsoft Internet Explorer to
enable the plug-in.
Note: Some users have reported that they had to reinstall the Microsoft JVM. Contact
Microsoft technical support for a JVM installer.

Using a Macintosh with Netscape to Access DAM


Netscape 6.2.3 on Macintosh OX 9.x requires the correct Netscape plug-in for the applets
to function correctly. To obtain the most recent version of the MRJ plug-in, go to the
Netscape download page and download MRJPlugin-1.0b5.sit.

To install the plug-in:

1. Download the MRJ plug–in from the Netscape download page.


The browser automatically unstuffs the file to a directory called MRJPlugin.
2. If the file does not automatically expand, expand the file manually using a utility
such as Stuffit.
After the file is expanded, the directory MRJPlugin contain files called MRJPlugin
and MRJPlugin.jar.
3. Move the files to the Netscape/Plugin folder.

Internet Explorer Caching on DCM


On Internet Explorer’s Tools-oInternet Options-oTemporary FilesoSettings dialog
box, the default setting is Every visit to the page. Do not change this setting to None.
On clients where the value of the setting is None, the user sees old, cached menus while
navigating the DCM application.

34 Web Development Kit and Applications Installation Guide


Chapter 5
Preparing the Application Server Host

This chapter describes the tasks you must complete to prepare the application server host for
installation. Read the chapter and complete the tasks whether you are creating a new installation
or upgrading an existing installation.
This chapter contains the following sections:
• Ensuring Sufficient Temporary Disk Space on the Host, page 35
• Nvidia Video Adapter on Windows, page 35
• Firewall Software, page 36
• Installing the Correct JDK for Documentum Compliance Manager, page 36
• Setting Environment Variables on UNIX and Linux Hosts, page 36
• Preparing the Application Server Software, page 38
• Installing the Site Caching Services Target Software, page 42
Ensure that you review the release notes to confirm the software requirements for the products you
are installing.

Ensuring Sufficient Temporary Disk Space on


the Host
Application servers vary as to how much temporary disk space they require when an
application is installed. Allow at least half a gigabyte of free disk space on the application
server host for installing WDK or a WDK application.
• On Windows hosts, ensure that the free space is on the drive to which the TEMP
environment variable points.
• On UNIX hosts, ensure that the free space is in $TEMP.
• On AIX with WebSphere, the temporary directory used by WebSphere is /tmp.

Nvidia Video Adapter on Windows


If the application server host runs Windows and an Nvidia video display adapter is
installed, ensure that the current Nvidia driver in also installed, or the installer may fail.

Web Development Kit and Applications Installation Guide 35


Preparing the Application Server Host

Antivirus Software and Virtual Link Support on


Windows
If you have antivirus software installed on the application server host and it is enabled
when you install WDK or a WDK application, the antivirus software may ask whether
you want to allow access to Java on your computer. You must allow access for virtual
link support to be installed successfully.

Firewall Software
Before you install, disable any firewall software on the application server host. Firewall
software may prevent proper installation of virtual link support.

Installing the Correct JDK for Documentum


Compliance Manager
Documentum Compliance Manager requires the Java 2 SDK version 1.4.1_02.

Setting Environment Variables on UNIX and


Linux Hosts
On UNIX and Linux hosts, the DFC program root and other path names are designated
in environment variables that you set up before installation.
Some of these environment variables may already exist, and if you have other
Documentum products installed on your system, some of the values may exist as well.
Perform as many of the steps as you can. For information on how these variables are
used by DFC, see the Documentum Foundation Classes (DFC) Installation Guide.
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 or in other fashions permitted by UNIX and Linux.
Documentum recommends that you do not manually change the classpath. If you do
manually change the classpath, any WDK application re-install may fail to update the
classpath correctly.
If the DFC_DATA environment variable is set in the installation owner’s environment,
remove it. It is no longer used.

36 Web Development Kit and Applications Installation Guide


Preparing the Application Server Host

Table 5–1. Required Environment Variables

Environment Variable Description Required Values

DOCUMENTUM The full path of the DFC user Any directory in the
root (and Content Server installation owner’s
root, if it is installed on the environment
application server host).

DOCUMENTUM_SHARED The full path to the DFC Any directory in the


program root. installation owner’s
environment

CLASSPATH • $DOCUMENTUM_
SHARED/dctm.jar
• $DOCUMENTUM_
SHARED/config

DISPLAY Controls the display


localhost:0.0

LD_LIBRARY_PATH Solaris shared library path • The DFC location,


$DOCUMENTUM_
SHARED/dfc
• If you are installing DAM,
the Java lib directory

SHLIB_PATH HP-UX shared library path • The DFC location,


$DOCUMENTUM_
SHARED/dfc
• If you are installing DAM,
the Java lib directory

LIBPATH AIX shared library path • The DFC location,


$DOCUMENTUM_
SHARED/dfc
• If you are installing DAM,
the Java lib directory

LC_ALL This setting is required C


for all installations that
run on a localized OS. If
your installation is on a
Documentum Content Server
host machine, do not change
this setting. If your installation
is not on a Content Server
host machine, then after
installation is completed, you
may revert this setting.

BEA_HOME, if you are The full path to the WebLogic


installing on BEA WebLogic home directory

Web Development Kit and Applications Installation Guide 37


Preparing the Application Server Host

Environment Variable Description Required Values

WAS_HOME, if you are The default value,


installing on IBM WebSphere /opt/WebSphere/AppServer.

SUNONE_HOME, if you are The full path to the directory


installing on Sun ONE where you are installing the
application. For example:

/opt/SUNWappserver7

Preparing the Application Server Software


Before you run the installer for WDK or a WDK application, install a supported J2EE
application server or the Apache Tomcat servlet container on the application server
host and ensure that it can successfully serve sample JSP pages. See the release notes
for your Documentum product for information about supported application servers
and platforms.
This section contains information on preparing the application server software before
installing WDK or a WDK application. See Chapter 8, Completing the Installation
Process, for more information about verifying WDK or a WDK application on each
type of application server.
• Preparing Apache Tomcat, page 38
• Preparing BEA WebLogic, page 39
• Preparing IBM WebSphere, page 41
• Preparing Oracle 9i Application Server, page 41
• Preparing the Sun ONE Application Server, page 41
Documentum does not provide support for installing or running application servers.
Refer to the documentation for each application server for instructions on installing,
stopping, starting, and running the application server. Contact the application server
vendor for technical support.

Preparing Apache Tomcat


An Apache Tomcat installation must meet the following requirements before WDK or
a WDK application is installed:
• Tomcat must be stopped before installing or uninstalling WDK or a WDK
application.
• WDK or the WDK application must be installed as the same user who installed
the application server.
• The JAVA_HOME environment variable must be set correctly before you install
Tomcat.
For complete information on setting JAVA_HOME, refer to Apache’s documentation
for Tomcat.

38 Web Development Kit and Applications Installation Guide


Preparing the Application Server Host

• If Tomcat is installed to run from the command line, the CATALINA_HOME


environment variable must be set properly.
For complete information on setting CATALINA_HOME, refer to Apache’s
documentation for Tomcat.
• If you are installing Documentum Compliance Manager:
— JAVA_HOME must point to the Java 2 SDK installation.
In a default installation of JDK 1.4.1_02 on Windows, this is C:\j2sdk1.4.1_02.
— If any version of the Documentum Compliance Manager Beta software was
on the host, uninstall it before you install the general release version of the
software on the host.
In addition, clean out all files in the Tomcat work directory.
On Windows, Tomcat can be run as a service or from a command line. If you run Tomcat
as a service, it can be started automatically when the Windows host is rebooted. For
details on installing Apache Tomcat as a Windows service, see the Apache Tomcat
documentation. You must manually start Tomcat after installing the WDK application.
On UNIX, Tomcat is always started from a command line.

Verifying Apache Tomcat

After you install Tomcat, use these instructions to verify that Tomcat is running correctly.

To verify Apache Tomcat:

1. Open the default server home page in a browser:


http://host_name:port_number
where host_name is the computer where Tomcat is installed and port_number is the
port on which it listens. Substitute localhost for host_name if the browser is on
the Tomcat host.
2. Click JSP Examples on the left side of the Tomcat home page.
3. Execute one of the examples.

Preparing BEA WebLogic


A BEA WebLogic installation must meet the following requirements before WDK or
a WDK application is installed:
• WebLogic must be correctly installed in either stand-alone or managed server
configuration.
Refer to BEA’s documentation for instructions. This manual only provides
instructions for installing Documentum applications in the two modes.
• Set up a server alias and domain for the application.
Ensure that the domain name does not contain any spaces.

Web Development Kit and Applications Installation Guide 39


Preparing the Application Server Host

If you are installing multiple applications, you must decide whether to install them
in the same domain or not. When multiple applications are installed in the same
domain, all applications are started and stopped at the same time. If the applications
are installed in different domains, they can be started and stopped separately and
each application runs as a separate Java process.
• Determine two unused ports on which WebLogic can listen.
The default port for HTTP requests is 7001. The default port for HTTPS requests
is 7002.
• On Windows, decide whether to run WebLogic as a service or from the command line.
This is determined when you configure WebLogic, not when the Documentum
application is installed.
If you start WebLogic from the command line, to stop it you must kill the process.
• Install WDK or the WDK application as the same user who installed the application
server.
• WebLogic must be running when you install WDK or a WDK application.
• On BEA WebLogic 8.1, if virtual link support is required, you must extend the
domain to include defaultWebApp, or virtual links do not work correctly in the
WDK applications.
eWebEditPro, which is used with Web Publisher, requires virtual link support.
For more information on extending domains and on defaultWebApp, refer to the
documentation for WebLogic 8.1.
• If you upgrade from WebLogic 7 to WebLogic 8, or install to a new domain and
server instance on WebLogic 7, the application is be installed in a different location,
and you must migrate any customizations. See Backing Up Customizations, page 43.
• If you upgrade to a new version of your WDK applications on WebLogic 7, and you
want to install to the same domain and server instance, back up your customizations
and uninstall any previous WDK application installations before installing the
new WDK application. For more information, see Upgrading WDK Applications
on BEA WebLogic 7, page 46.
• Documentum recommends creating a different domain in BEA WebLogic for each
WDK application or instance of an application.
• Install to an instance of the server running in development mode.
See the BEA WebLogic documentation for the correct procedure when you are ready
to deploy an application in production mode.
• Set the performance tuning option Use Native I/O correction on WebLogic 7 with
Solaris.
— Turn the setting off OR
— After installing the WDK application, edit the startDocumentum.sh file and
add $BEA_HOME/weblogic81/server/lib/solaris to the -Djava.library.path
option.

40 Web Development Kit and Applications Installation Guide


Preparing the Application Server Host

Preparing IBM WebSphere


Ensure that the following requirements are fulfilled before you install WDK or a WDK
application:
• Install IBM WebSphere, the latest FixPaks, and hot fixes.
• Install WebSphere as the root user.
• Test the IBM samples to ensure that WebSphere is running properly. For
documentation and information about the Samples Gallery, refer to the WebSphere
Information Center Library at http://www-3.ibm.com/software/webservers/
appserv/infocenter.html.
• The WebSphere instance on which you are installing or uninstalling WDK or a WDK
application must be running during installation.
• Install WDK or the WDK application as the root user (the same user who installed
the application server).
• Determine whether you are configuring WebSphere in stand-alone or in network
deployment mode.
Different installation instructions are provided for installing the Documentum
application in each mode.

Preparing Oracle 9i Application Server


The following requirements must be met before installing WDK or a WDK application
on an Oracle AS application server:
• The Oracle AS server must be stopped while installing or uninstalling WDK or a
WDK application.
• Install WDK or the WDK application as the same user who installed the application
server.
• Under Oracle AS, time stamps in log files are not formatted correctly unless you
modify the Oracle AS installation.
For instructions on how to do this, refer to Oracle Note 230524.1, which can be read
on the Oracle Web site.

Preparing the Sun ONE Application Server


The following requirements must be met before installing WDK or a WDK application
on the Sun ONE application server:
• Install WDK or WDK applications on Sun ONE as the root user.
• Install WDK or WDK applications in the default domain and default instance.
• The administration server must be running when you install or uninstall WDK or a
WDK application.

Web Development Kit and Applications Installation Guide 41


Preparing the Application Server Host

• The application server must be stopped before starting to install or uninstall WDK
or a WDK application.
• Install WDK or WDK applications in the default domain and default instance.
• Install WDK or the WDK application as the same user who installed the application
server.

Installing the Site Caching Services Target


Software
If you are running Web Publisher, install the Documentum Site Caching Services (SCS)
target software on the application server host. For information on installing SCS, refer to
the Site Caching Services Installation Guide.

42 Web Development Kit and Applications Installation Guide


Chapter 6
Preparing to Upgrade WDK or WDK
Applications

Review this chapter and perform the tasks described in it before upgrading WDK or any WDK
application. This chapter contains the following information:
• Backing Up Customizations, page 43
• Backing Up the Application Server Startup File, page 44
• Migrating WDK/Webtop 5.2 Customizations to WDK/Webtop 5.2.5, page 44
• Uninstalling Older Software Versions on Windows, page 45
• Upgrading WDK Applications on BEA WebLogic 7, page 46
• Removing the DFC_DATA Environment Variable in Older UNIX Installations, page 46
• Upgrading a WDK Product Installed as Root on Older UNIX Installations, page 46
• Preparing Client Hosts for an Upgrade, page 47

Backing Up Customizations
If you customized an earlier version of WDK or a 5.x WDK application and you are
upgrading, back up the following directories and files on the application server host:
• JSP files in the custom directories
• Configuration files in the custom directories
• Changed strings in the /wdk/strings, /webcomponent/strings, and
/webtop/strings directories
• Branding files in the custom /theme directory
• Compiled custom Java classes (for example, on Tomcat these are located in the
/WEB-INF/classes directory and subdirectories)
After upgrading, recompile custom classes to ensure that the custom code still works.
• Configured properties files (for example, on Tomcat in the
/WEB-INF/classes/com/documentum subdirectories)
• Customizations to web.xml
• Customized files in the WEB-INF/tlds directory
Documentum Compliance Manager supports new installations only. You cannot migrate
customizations from existing DCM installations.

Web Development Kit and Applications Installation Guide 43


Preparing to Upgrade WDK or WDK Applications

Backing Up Customized DocApps


Installing Web Publisher and other WDK applications requires installing a DocApp into
each Docbase you access with those applications. Installing a new DocApp overwrites
customizations to the existing DocApp. If you customized any of the following objects
that are installed by a DocApp, document the customizations so that you can recreate
them after the upgrade:
• Procedure objects (including the Web Publisher procedure wcmlifecyclescript)
• Jobs
• Object types
• Methods

Backing Up the Application Server Startup File


If you modified any values in the application server startup file, back the file up before
upgrading. Upgrading WDK or a WDK application overwrites some values with
minimum default values. For more information, refer to Application Server Performance
Tuning, page 28.

Migrating WDK/Webtop 5.2 Customizations to


WDK/Webtop 5.2.5
Upgrading WDK or a WDK application from 5.2 to 5.2.5 requires uninstalling the
existing 5.2 application and installing the new 5.2.5 application. You cannot upgrade in
place and uninstalling removes existing customizations.
To migrate customizations, use the procedure below.

To migrate customizations from 5.2 to 5.2.5:

1. If the development environment for the existing custom application is not available,
use the Customize an existing application option of the WDK 5.2 installer to create
a development environment for the deployed 5.2 application.
The process expands the deployed application’s WAR file if one exists.
2. Copy the custom folder from the development environment to another location.
The custom folder is in the application’s virtual root folder.
3. Deploy the 5.2.5 version of the application (for example, Webtop) to a new folder.
Deploying to the old folder overwrites the existing customizations. The installer
automatically maps the virtual root of the application to the new folder.
4. Install WDK 5.2.5, using the installer’s Customize an existing application option to
create a development environment for the 5.2.5 application.

44 Web Development Kit and Applications Installation Guide


Preparing to Upgrade WDK or WDK Applications

5. Copy the 5.2 custom folder from the location in step 2 to the 5.2.5 application’s
development environment, replacing the empty 5.2.5 custom folder.
6. Copy into the 5.2.5 application changed strings, branding files in the /theme
directory, compiled custom Java classes, configured properties files, customized files
in the WEB-INF/tlds directory, and customized web.xml files.
Refer to the previous section, Backing Up Customizations, page 43, for a complete
list of items to back up before an upgrade.
7. Recompile the customizations on WDK 5.2.5.
8. Test the migrated customizations to verify that they work correctly.
9. Redeploy the 5.2.5 application.

Uninstalling Older Software Versions on


Windows
Before installing WDK 5.2.x or any WDK 5.2.x application, uninstall the following
Documentum software if it is installed on the application server host:
• Any previous versions of WDK or Webtop
For information on uninstalling 5.x applications, see Chapter 10, Uninstalling WDK,
WDK Applications, and DFC.
Reboot the host after you uninstall.
• Any version of the DCM Beta software.
Use the instructions in Uninstalling the Documentum Compliance Manager Beta
Software, page 104.
• Any applications using DFC 4.x
You must uninstall all Documentum applications that use DFC 4.x and then uninstall
DFC 4.x itself from the application server host.
• DFC 4.x
Documentum 5 applications cannot use DFC 4.x and there can be only one version of
DFC on a Windows host.
• Applications using Documentum RightSite
These include Intranet Client 4.x, Documentum Administrator 4.x and WebPublisher
4.x.
• Documentum RightSite

Web Development Kit and Applications Installation Guide 45


Preparing to Upgrade WDK or WDK Applications

Upgrading WDK Applications on BEA WebLogic


7
If you are upgrading from one version of 5.x to another for WDK or any WDK
applications, and you want to install to the same domain and server instance on BEA
WebLogic 7.x, you must uninstall the old WDK applications first, using the following
procedure.
If you create a new domain to install the new version of WDK or a WDK application, this
procedure is not required. If you upgrade from BEA WebLogic 7 to BEA WebLogic 8
when you upgrade WDK or any WDK application, this procedure is not required.

To upgrade WDK applications using the same domain and server instance on BEA
WebLogic 7:

1. Back up your customizations.


For more information, refer to Backing Up Customizations, page 43.
2. Uninstall WDK and any WDK applications using the appropriate product
uninstallers.
Refer to the section on uninstalling in the installation guide for that product version.
3. Manually remove startDocumentum.cmd (on Windows) or startDocumentum.sh (on
UNIX and Linux) from the appropriate server directory.
4. Install the new 5.2.x WDK applications, following the installation instructions for
that product version.
5. Migrate customizations to the application, located in the admin server’s upload
directory.
6. Redeploy the application using the administrative console or restart the server.

Removing the DFC_DATA Environment Variable


in Older UNIX Installations
Earlier versions of WDK and Webtop required an environment variable called
DFC_DATA. If you are upgrading on a machine that had a 5.1 installation, remove this
environment variable.

Upgrading a WDK Product Installed as Root on


Older UNIX Installations
If a version of WDK or a WDK application prior to 5.2 was installed on UNIX as root, you
cannot uninstall the product using the uninstaller. Before you upgrade a 5.1 product,
you must determine whether you installed the existing version as root. If so, you must

46 Web Development Kit and Applications Installation Guide


Preparing to Upgrade WDK or WDK Applications

remove all Documentum installer entries from the /var/sadm/pkg directory. These are
files whose names begin with IS.
Use the following command to list all files in the directory beginning with IS:
ls -rf /var/sadm/pkg/IS*
If there are no non-Documentum files returned by the list command, you can remove
all of the Documentum installer files with this command:
rm -rf /var/sadm/pkg/IS*

If you know that there are no non-Documentum files in that directory that match the IS*
wildcard expression, you can run the following command:

Caution If there are non-Documentum files that match the IS* wildcard expression, you
must enumerate the Documentum files in the rm command.

You do not need to follow the usual procedure for removing the product if you run
this command.
To uninstall WDK or a WDK application Version 5.2 or higher, use the regular procedure
in Chapter 10, Uninstalling WDK, WDK Applications, and DFC.

Preparing Client Hosts for an Upgrade


Use the information in these sections to prepare clients host to use an upgraded version
of a WDK application.

Checking In Checked Out Objects on Client Machines


Before you upgrade to this release, check in any objects checked out with Documentum
clients that used DFC version 4.2 or lower. DFC 5 cannot locate objects checked out
using earlier DFC versions.
Documentum began using the HKEY_CURRENT_USER registry hive recommended by
Microsoft with version 4.3 of Documentum products. If your clients have such objects
checked out when they connect to a WDK-5 based application, they can manually check
in those objects by selecting Checkin from File.

Removing Previous Versions of Content Transfer Applets


on Client Machines
Some versions of WDK and Webtop, including WDK 5 Early Access and Webtop Early
Access, installed applets that must be removed from clients because they use a different
version of DFC.

Web Development Kit and Applications Installation Guide 47


Preparing to Upgrade WDK or WDK Applications

Removing the Client Applets on Internet Explorer

Use this procedure with Internet Explorer.

To remove previous versions of client applets in Internet Explorer:

1. Log in to the client host.


2. Start Internet Explorer and choose ToolsoInternet Options.
The Internet Options dialog box is displayed.
3. On the General tab, in the Temporary Internet Files pane, click Delete Files.
The Delete Files dialog box is displayed.
4. Check Delete all offline content and click OK.
5. Click Settings.
The Settings dialog box is displayed.
6. Click View Files.
The Temporary Internet Files dialog box is displayed.
7. Select and delete all the cookies.
8. Close the Temporary Internet Files dialog box.
9. In the Settings dialog box, click View Objects.
The Downloaded Program Files dialog box is displayed.
10. If they are displayed, select and delete the Documentum Content Transfer Applets
and Documentum Content Transfer Applets 5.0 files.
11. Close the Settings and Internet Options dialog boxes.
12. Close and restart all instances of the browser.

Removing the Client Applets on Netscape

Use this procedure with Netscape.

To remove previous versions of client applets in Netscape:

1. Log in to the client host.


2. Start Netscape and choose EditoPreferences.
The Preferences dialog box is displayed.
3. In the Category navigation tree, select AdvancedoCache.
The Cache dialog box is displayed.
4. Click Clear Memory Cache and Clear Disk Cache.
5. Click OK.
6. On the main menu, choose TasksoPrivacy & SecurityoCookie ManageroView
Stored Cookies.

48 Web Development Kit and Applications Installation Guide


Preparing to Upgrade WDK or WDK Applications

The Cookie Manager dialog box is displayed.


7. Click Remove All Cookies and click OK.
8. Click StartoSettingsoControl PaneloJava Plug-in.
9. Select the Cache tab.
10. Select Clear JAR Cache and click Apply.
11. Close the Java Plug-in Dialog box and the Control Panel.

Web Development Kit and Applications Installation Guide 49


Preparing to Upgrade WDK or WDK Applications

50 Web Development Kit and Applications Installation Guide


Chapter 7
Installing WDK and WDK Applications

After you complete planning the WDK or WDK application installation and performt he required
preinstallation tasks, install WDK or a WDK application on Windows or UNIX.
This chapter contains the following sections:
• Overview of the Installation Process in Stand-Alone Environments, page 51
• Overview of the Installation Process in Managed Server Environments, page 53
• Installing on Windows in Stand-Alone Configuration, page 53
• Installing on UNIX and Linux in Stand-Alone Environments, page 56
• Installing on WebLogic in a Managed Server Environment, page 60
• Installing on WebSphere in a Managed Network Deployment, page 63

Overview of the Installation Process in


Stand-Alone Environments
The following figure illustrates the installation process. Use this as a summary of the
procedures described in the sections on installation. The figure does not apply to
installing on WebSphere or WebLogic in high-availability or network-managed mode.

Web Development Kit and Applications Installation Guide 51


Installing WDK and WDK Applications

Figure 7–1. Installation Process

52 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

Overview of the Installation Process in


Managed Server Environments
This section applies to installations of WDK and WDK applications on BEA WebLogic
in a managed server environment and on IBM WebLogic in a managed network
deployment environment.
Installation in managed server environments is divided into four main processes:
• Creating the managed server environment.
• Installing the Documentum application war file to the Deployment Manager
(WebSphere) or administration server (WebLogic).
• Deploying the application to the application server instances.
• Configuring each computer where an application server instances is hosted to
support the Documentum application.

Installing on Windows in Stand-Alone


Configuration
This section provides the Windows installation instructions for Tomcat, SunONE,
and Oracle, and for WebLogic and WebSphere in a stand-alone configuration. (For
instructions for installing on WebLogic and WebSphere in a high-availability or
managed network configuration, refer to Installing on WebLogic in a Managed Server
Environment, page 60 and Installing on WebSphere in a Managed Network Deployment,
page 63. )Replace WDKAppName with WDK or the initials of the WDK application (WT,
WP, DA, DAM) you are installing. Install WDK or the WDK application as the user who
installed the application server.

To install on Windows:

1. Log in to the application server host as the application server installation owner
2. Ensure that the application server is in the correct state for installing WDK or a
WDK application.
• Apache Tomcat must be stopped.
• BEA WebLogic must be running.
• IBM WebSphere must be running.
• Oracle 9i AS must be stopped.
• The Sun ONE administration server must be running; the Sun ONE application
server must be stopped.
3. Download the WDK application installer auto-extracting compressed file from the
Documentum download site to a temporary directory on the application server host.
The file is called ProductName_VersionNumber_platform[_rdbms][_appserver].exe.
appserver is part of the file name only when the installer is limited to a single
application server.
For example:

Web Development Kit and Applications Installation Guide 53


Installing WDK and WDK Applications

Webtop_5.2.1_windows.exe
Webtop_5.2.1_windows_websphere.exe

4. Expand the installer to the temporary directory.


5. Double-click the product_nameWinSetup.exe file.
The InstallShield Wizard welcome dialog box is displayed, listing the products that
will be installed.
6. Click Next.
The License Agreement dialog box is displayed.
7. To continue with installation, click I accept the terms of the license agreement
and click Next.
8. To install the DFC developer documentation, check the checkbox.
9. To install the Primary Interop Assembly, check the checkbox.
Check the Primary Interop Assembly Installer checkbox to request installation of a
Microsoft installer package (.msi file) for the DFC primary interop assembly (PIA),
or leave the box unchecked if you do not wish to have the package installed. The
installer places the installer package for the DFC PIA into the setup subdirectory of
the program root.
The PIA is not required bv WDK or any WDK application.
10. Click Next.
11. Install DFC if it is not already on the host.
a. Accept the default DFC program root or enter a different directory and click
Next.
The default is C:\Program Files\Documentum.
b. Accept the default user directory or enter a different directory and click Next.
The default is C:\Documentum.
12. If you are prompted, enter a DocBroker host name and port number or accept the
default and click Next.
13. If you are installing Web Development Kit, choose the setup type for the installation:
• Customize an existing Web application
• Create a new Web application
For more information, see Installing WDK to Customize an Application, page 20.
14. Select an application server and click Next.
15. If the installer provides information about whether the application server should be
running, follow the instructions and click Next.
16. If you are installing on WebLogic or WebSphere, click Stand-Alone Configuration .
17. If you are installing WDK to customize an existing application, specify the WAR file
for the application or the folder in which the application is installed and click Next.
18. Enter application server information.
a. To install on Apache Tomcat:

54 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

i. Enter the application server home directory or browse to that location


ii. Enter the virtual directory for this WDK or WDK application installation.
iii. Click Next.
b. To install on BEA WebLogic:
i. Enter the application server location or accept the default, if one is provided.
This is the full path to the BEA WebLogic root directory.
ii. Enter the application server user projects location, or accept the default, if
one is provided.
Enter the correct server location and an existing domain. The entries are
case sensitive.
iii. Click Next.
iv. Enter the domain name.
v. Enter the server name.
vi. Enter the virtual directory for this installation.Do not use a directory in
the application path.
vii. Click Next.
viii. If required, provide the following information:
• Admin user ID
• Admin password
• Admin port (or accept the default)
c. To install on IBM WebSphere:
i. Enter the application server home directory.
ii. Enter the virtual directory for this installation.
iii. Click Next.
A WAS Server status bar is displayed.
iv. Enter or confirm the IBM WAS node name.
This must correspond to a node in the administration console.
v. Enter the IBM WAS application server that is specified under the node
selected in the previous step.
vi. Enter the WAS virtual host name.
This must correspond to a virtual host that is defined for the selected node
and server name; for example, default_host. This information is in the
Virtual Host field on the General tab of the administration console.
vii. Click Next.
viii. If Global Security is turned on, provide the Admin user ID and Admin
password and click Next.
A status bar is displayed while the user ID and password are authenticated.
19. To install virtual link support, check the checkbox and then click Next.

Web Development Kit and Applications Installation Guide 55


Installing WDK and WDK Applications

20. If you are installing virtual link support and antivirus software installed on the host
asks if you want to allow access to Java, click Yes or Ok.
Access to Java is required for installing virtual link support.
21. Select the location of the content transfer directory or accept the default and click
Next.
If the content transfer directory already exists, a warning is displayed. For more
information, see Content Transfer Directory, page 27.
22. Confirm the final installation settings and click Next.
23. If you are installing on BEA WebLogic, read the information panel about starting
the application and click Next.
24. Click Finish and restart the host if the installer says it is required.
25. If the installer does not require you to restart the host, restart the application server.

Installing on UNIX and Linux in Stand-Alone


Environments
Use the following procedure to install WDK or a WDK application on UNIX and Linux
in a stand-alone application server configuration.
Because of a Java limitation, using the Browse button to select directories may be
extremely slow under some network configurations.

To install on UNIX or Linux:

1. Log in as the application server instance owner.


2. Ensure that the application server is in the correct state for installing WDK or a
WDK application.
• Apache Tomcat must be stopped.
• BEA WebLogic must be running.
• IBM WebSphere must be running.
• Oracle 9i AS must be stopped.
• The Sun ONE administration server must be running; the Sun ONE application
server must be stopped.
3. If you are installing on HP-UX, stop all Documentum products on the host.
HP-UX locks native libraries when they are mapped to shared segments and the
installer displays an error if any Documentum products are running.
4. Download the WDK application installer for the correct operating system from the
Documentum download site to a temporary directory on the application server host.
The compressed distribution file is called ProductName_VersionNumber_platform[_
rdbms][_appserver].tar. The appserver portion of the file name appears only when the
installer is limited to a single application server.
For example:

56 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

Web_Development_Kit_5.2.1_solaris.tar
Web_Publisher_5.2.1_solaris.tar
Administrator_5.2.1_solaris.tar
Web_Development_Kit_5.2.2.38_hpux_weblogic8.1_oracle9ias.tar
Your email address is the user name. If you cannot locate the password for the
download site, use the password finder on the bottom of the download page.
5. Expand the installer to the temporary directory.
6. Locate the WDK application installer binary file (with a .bin extension) in the
temporary directory and change the access mode by typing in the following
command
chmod +x filename.bin
where filename is the name of the WDK application installer binary file.
7. Start the installer.
For example:
./wdkSolSetup.bin
./webtopSolSetup.bin
./damAixSetup.bin
./daAixSetup.bin
./wdkHpuxSetup.bin
./wpHpuxSetup.bin

The Installation Wizard welcome dialog box is displayed, listing the products that
will be installed.
8. Click Next.
The License Agreement dialog box is displayed.
9. Select the appropriate radio button if you agree with the licensing terms, then click
Next.
10. To install the DFC Javadocs, select the Developer Documentation checkbox and
click Next.
11. If required, enter a DocBroker host name and port number or accept the defaults
and click Next.
12. If you are installing WDK, choose the setup type:
• Customize an existing Web application
• Create a new Web application
See Installing WDK to Customize an Application, page 20, for more information.
13. Select an application server and click Next.
14. If the installer indicates whether the server should be stopped or running, follow
the instructions and click Next.
Depending on which 5.2.x version of WDK or a WDK application you are installing,
you may be required to stop or start the BEA WebLogic server.
15. If you are installing WDK and you chose to customize an existing Web application,
specify the WAR file for that application or the folder in which the application is
installed and click Next.
16. Enter application server information.

Web Development Kit and Applications Installation Guide 57


Installing WDK and WDK Applications

a. To install on Apache Tomcat:


i. Enter the application server location, which is the full path to the Apache
Tomcat root directory on the host machine, or browse to the correct location.
ii. Enter the virtual directory for this installation.
iii. Click Next.
b. To install on BEA WebLogic:
i. Enter the application server location, which is the full path to the BEA
WebLogic root directory on the host machine, or accept the default.
ii. Enter the application server user projects location, or accept the default..
Ensure you enter the correct server location and an existing domain. The
entries are case-sensitive.
iii. Click Next.
iv. Enter the domain name.
v. Enter the server name.
vi. Enter the virtual directory for this installation.
Do not use a directory in the application path.
vii. Click Next.
viii. If required, provide the following information:
• Admin user ID
• Admin password
• Admin port (or accept the default)
c. To install on IBM WebSphere:
i. Enter the application server home directory, or accept the $WAS_HOME
default.
For example:
/opt/WebSphere/AppServer
If you manually enter the home directory, ensure that it ends with AppServer.
ii. Enter the virtual directory for this installation.
iii. Click Next.
A WAS Server status bar is displayed.
iv. Enter or confirm the IBM WAS node name.
This must correspond to a node in the administration console.
v. Enter the IBM WAS application server that is specified under the node
selected in the previous step; for example, Default Server.
vi. Enter the WAS virtual host name.
This must correspond to a virtual host that is defined for the selected node
and server name; for example, default_host. Open the administration
console to view virtual hosts. Virtual hosts are displayed in the Virtual
Host field on the General tab.

58 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

vii. Click Next.


viii. If Global Security is turned on, provide the Admin user ID and Admin
password and click Next.
A status bar is displayed while the user ID and password are authenticated.
d. To install on Oracle AS:
i. Enter the Oracle AS home directory, or browse to it, and click Next.
ii. Enter the Target Component, or accept the default.
iii. Enter the virtual directory name or accept the default and click Next.
e. To install on Sun ONE:
i. Enter the Sun ONE home directory, or accept the default and click Next.
ii. Enter the Admin port, or accept the default.
iii. Enter the Admin user ID, or accept the default.
iv. Enter the Admin password, or accept the default. and click Next.
v. Enter the domain location or accept the default.
vi. Enter the domain name or accept the default.
vii. Enter the server instance name or accept the default.
viii. Enter the virtual directory name or accept the default and click Next.
17. To install virtual link support, check the checkbox and click Next.
18. Select the location of the content transfer directory or accept the default, then click
Next.
If the content transfer directory already exists, a warning is displayed. For more
information, see Content Transfer Directory, page 27.
19. Review and confirm the final installation settings, then click Next.
20. If you are installing on BEA WebLogic, read the information dialog box about
starting the application and click Next.
The application is installed.
21. When the installation is complete, click Finish.
The Installation Wizard closes.
22. If you are installing on Sun ONE, edit the server.xml file.
a. Navigate to the $DOMAINS_HOME/domains/domain_name/server_name/
config directory, where domain_name is the domain in which you are installing
and server_name is the application server instance.
b. Open the server.xml file in a text editor.
c. Locate the entries for dfc.data.
For example:
<jvm-options>-Ddfc.data=/export/host/documentum/Shared/
config</jvm-options>
<jvm-options>-Ddfc.data=/export/host/documentum/config</jvm-options>

Web Development Kit and Applications Installation Guide 59


Installing WDK and WDK Applications

d. Replace the two entries with one entry:


<jvm-options>-Ddfc.data=/export/host/documentum</jvm-options>

23. Restart the application server.

Installing on WebLogic in a Managed Server


Environment
Use the following procedures to install on BEA WebLogic where the application server
is in a managed server environment. You must install properly-configured WebLogic
instances before you install the WDK application.
The instructions below apply to Windows and UNIX hosts.
Complete both of these procedures:
• Installing the Application on the WebLogic Administration Server, page 60
• Installing the Application on Remote Managed Servers, page 62

Installing the Application on the WebLogic


Administration Server
Use these instructions to install the WDK application on the administrative server host.

To install the application to the Administration Server:

1. Log in to the application server host on which the Administration Server is installed
as the application server installation owner
2. Ensure that WebLogic is running.
3. Download the WDK application installer auto-extracting compressed file from the
Documentum download site to a temporary directory on the application server host.
The file is called ProductName_VersionNumber_platform[_rdbms][_appserver].exe.
appserver is part of the file name only when the installer is limited to a single
application server.
For example:
Webtop_5.2.5.SP1_windows.exe
Webtop_5.2.5_windows_weblogic.exe
Web_Publisher_5.2.1_solaris.tar

4. Uncompress the installer to the temporary directory.


5. Start the installer.
• On Windows, double-click the product_nameWinSetup.exe file.
• On UNIX, start the executable.

60 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

For example, type./webtopSolSetup.bin.


The InstallShield Wizard welcome dialog box is displayed, listing the products that
will be installed.
6. Click Next.
The License Agreement dialog box is displayed.
7. To continue with installation, click I accept the terms of the license agreement
and click Next.
8. To install the DFC developer documentation, check the checkbox.
9. On Windows, to install the Primary Interop Assembly, check the checkbox.
Check the Primary Interop Assembly Installer checkbox to request installation of a
Microsoft installer package (.msi file) for the DFC primary interop assembly (PIA),
or leave the box unchecked if you do not wish to have the package installed. The
installer places the installer package for the DFC PIA into the setup subdirectory of
the program root.
The PIA is not required bv WDK or any WDK application.
10. Click Next.
11. Install DFC.
If this is a new installation, you are prompted for the DFC program root and user
directories. If DFC is already present on the host, it is reinstalled or upgraded in
place, and you are not prompted for the two directories.
a. Accept the default DFC program root or enter a different directory and click
Next.
The default is C:\Program Files\Documentum.
b. Accept the default user directory or enter a different directory and click Next.
The default is C:\Documentum.
12. If you are prompted, enter a DocBroker host name and port number or accept the
default and click Next.
13. Select WebLogic and click Next.
14. Click Managed Server Configuration and click Next.
15. Check Upload application to admin server instance and click Next.
16. Provide information about the target host.
a. Select the correct target domain.
b. Select the target server name.
c. Type in the application name and click Next.
17. To configure domains on the host for the WDK application,Configure one or more
domains and click Next.
18. Check the name of the domains to configure and click Next.
19. To install virtual link support, check Install virtual link support and click Next.
20. Select a content transfer folder and click Next.

Web Development Kit and Applications Installation Guide 61


Installing WDK and WDK Applications

21. Read the informational dialog box and click Next.


The software is installed.
22. Stop all servers and restart the node manager and administration server.
After you restart the node manager and administration server, you must run the
Documentum installer on each remote managed server.

Installing the Application on Remote Managed Servers


Use these instructions to install application support on the remote managed server hosts.

To install the application remote managed servers:

1. Log in to a remote managed server.


2. Ensure that WebLogic is running.
3. Download the WDK application installer auto-extracting compressed file from the
Documentum download site to a temporary directory on the application server host.
The file is called ProductName_VersionNumber_platform[_rdbms][_appserver].exe.
appserver is part of the file name only when the installer is limited to a single
application server.
For example:
Webtop_5.2.5.SP1_windows.exe
Webtop_5.2.5_windows_weblogic.exe
Web_Publisher_5.2.1_solaris.tar

4. Uncompress the installer to the temporary directory.


5. Start the installer.
• On Windows, double-click the product_nameWinSetup.exe file.
• On UNIX, start the executable.
For example, type./webtopSolSetup.bin.
The InstallShield Wizard welcome dialog box is displayed, listing the products that
will be installed.
6. Click Next.
The License Agreement dialog box is displayed.
7. To continue with installation, click I accept the terms of the license agreement
and click Next.
8. To install the DFC developer documentation, check the checkbox.
9. On Windows, to install the Primary Interop Assembly, check the checkbox.
Check the Primary Interop Assembly Installer checkbox to request installation of a
Microsoft installer package (.msi file) for the DFC primary interop assembly (PIA),
or leave the box unchecked if you do not wish to have the package installed. The
installer places the installer package for the DFC PIA into the setup subdirectory of
the program root.

62 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

The PIA is not required bv WDK or any WDK application.


10. Click Next.
11. Install DFC.
If this is a new installation, you are prompted for the DFC program root and user
directories. If DFC is already present on the host, it is reinstalled or upgraded in
place, and you are not prompted for the two directories.
a. Accept the default DFC program root or enter a different directory and click
Next.
The default is C:\Program Files\Documentum.
b. Accept the default user directory or enter a different directory and click Next.
The default is C:\Documentum.
12. If you are prompted, enter a DocBroker host name and port number or accept the
default and click Next.
13. Select WebLogic and click Next.
14. Click Managed Server Configuration.
15. Click Next.
16. Uncheck Upload application to admin server instance and click Next.
17. Select the name of the administration server as the Target Server and click Next.
18. Check Configure one or more domains and click Next.
19. Check the name of the domain for the WebLogic Configuration you created when
you configured WebLogic and click Next.
20. If you require it, check Install virtual link support and click Next.
21. Click Finish.
22. Stop and restart the node manager.
23. Repeat steps 1 to 22 on each remote managed server.
24. Deploy the application from the administration console on the administration server.
25. If you installed virtual link support, redeploy the default Web application to all
managed servers.
a. In the administration console, select DeploymentsoWeb Application Modules.
b. Select DefaultWebApp.
c. Click Redeploy All.

Installing on WebSphere in a Managed


Network Deployment
Use the following procedures to install on IBM WebSphere where the application server
is in a managed network configuration. You must install on properly-configured

Web Development Kit and Applications Installation Guide 63


Installing WDK and WDK Applications

WebSphere instances and the WebSphere Deployment Manager must be installed on one
of the hosts. The application is then deployed, and the Documentum installer is run on
each target host to complete the installation process.
The instructions below apply to Windows and UNIX hosts.
Complete both of these procedures:
• Installing the war File to Deployment Manager, page 64
• Installing Support on Each Target Host, page 65

Installing the war File to Deployment Manager


Use these instructions to install the war file to WebSphere Deployment Manager.

To install the application war file to Deployment Manager:

1. Log in to the application server host on which Deployment Manager is installed as


the application server installation owner
2. Ensure that WebSphere is running.
3. Download the WDK application installer auto-extracting compressed file from the
Documentum download site to a temporary directory on the application server host.
The file is called ProductName_VersionNumber_platform[_rdbms][_appserver].exe.
appserver is part of the file name only when the installer is limited to a single
application server.
For example:
Webtop_5.2.5.SP1_windows.exe
Webtop_5.2.5_windows_websphere.exe
Web_Publisher_5.2.1_solaris.tar

4. Uncompress the installer to the temporary directory.


5. Start the installer.
• On Windows, double-click the product_nameWinSetup.exe file.
• On UNIX, start the executable.
For example, type./webtopSolSetup.bin.
The InstallShield Wizard welcome dialog box is displayed, listing the products that
will be installed.
6. Click Next.
The License Agreement dialog box is displayed.
7. To continue with installation, click I accept the terms of the license agreement
and click Next.
8. To install the DFC developer documentation, check the checkbox.
9. On Windows, to install the Primary Interop Assembly, check the checkbox.
Check the Primary Interop Assembly Installer checkbox to request installation of a
Microsoft installer package (.msi file) for the DFC primary interop assembly (PIA),

64 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

or leave the box unchecked if you do not wish to have the package installed. The
installer places the installer package for the DFC PIA into the setup subdirectory of
the program root.
The PIA is not required bv WDK or any WDK application.
10. Click Next.
11. Install DFC.
If this is a new installation, you are prompted for the DFC program root and user
directories. If DFC is already present on the host, it is reinstalled or upgraded in
place, and you are not prompted for the two directories.
a. Accept the default DFC program root or enter a different directory and click
Next.
The default is C:\Program Files\Documentum.
b. Accept the default user directory or enter a different directory and click Next.
The default is C:\Documentum.
12. If you are prompted, enter a DocBroker host name and port number or accept the
default and click Next.
13. Select WebSphere and click Next.
14. Click Managed Network Configuration .
15. Enter the application server home directory or accept the default and click Next.
16. Read the text on the dialog box, click Download application war file (step 2), and
click Next.
17. Select a download location for the application war file and click Next.
This is a temporary location and can be any arbitrary directory. A summary dialog
box is displayed, listing the software components to be installed.
18. Click Next.
19. When the software is copied, exit the Documentum application installer.
20. From the WebSphere Administration Console, deploy the application from the
application server’s administration console to each network-managed application
server.
After the application is deployed, you must run the Documentum installer on each
host to which you deployed the application. If any of the target application server
instances are on the same host as Deployment Manager, ensure that you perform
these steps on that host as well. Use the instructions in Installing Support on Each
Target Host, page 65.

Installing Support on Each Target Host


Use these instructions to install DFC and other support on each application server host
to which the application is deployed. Complete the procedure in Installing the war
File to Deployment Manager, page 64 first.

Web Development Kit and Applications Installation Guide 65


Installing WDK and WDK Applications

To install DFC and other supporting software on the application server hosts:

1. Connect to a host to which the application was deployed as the application server
installation owner.
2. Copy the compressed distribution file to the host.
3. Unzip the file to a temporary directory and start the application installer.
4. Click Next.
The License Agreement dialog box is displayed.
5. To continue with installation, click I accept the terms of the license agreement
and click Next.
6. To install the DFC developer documentation, check the checkbox.
7. To install the Primary Interop Assembly, check the checkbox.
Check the Primary Interop Assembly Installer checkbox to request installation of a
Microsoft installer package (.msi file) for the DFC primary interop assembly (PIA),
or leave the box unchecked if you do not wish to have the package installed. The
installer places the installer package for the DFC PIA into the setup subdirectory of
the program root.
The PIA is not required bv WDK or any WDK application.
8. Click Next.
9. Install DFC.DFC is required by the application. If DFC is not present on the host, you
are prompted for DFC program root and user directories. If DFC is already installed,
it is upgraded in place or reinstalled, and you are not prompted for the directories.
a. Accept the default DFC program root or enter a different directory and click
Next.
The default is C:\Program Files\Documentum.
b. Accept the default user directory or enter a different directory and click Next.
The default is C:\Documentum.
10. If you are prompted, enter DocBroker information or click Next to accept the defaults.
a. Type the DocBroker host name.
b. Type the port number on which the DocBroker listens.
c. Click Next.
11. Select WebSphere and click Next.
12. Click Managed Network Configuration and click Next.
13. Enter the application server home directory or accept the default and click Next.
14. Click Configure server instances on this computer (step 4) and click Next.
15. Select the server instances to configure and click Next.
16. To install virtual link support, check the checkbox and then click Next.
If you are installing virtual link support and antivirus software is installed on the
host, you are asked to permit access to Java.

66 Web Development Kit and Applications Installation Guide


Installing WDK and WDK Applications

17. Click Yes or Ok.


Access to Java is required for installing virtual link support.
18. Select the location of the content transfer directory or accept the default and click
Next.
If the content transfer directory already exists, a warning is displayed. For more
information, see Content Transfer Directory, page 27.
19. If Global Security is turned on, provide the Admin user ID and Admin password
and click Next.
A status bar is displayed while the user ID and password are authenticated.
20. Confirm the final installation settings and click Next.
21. If the installer does not require you to restart the host, restart the application server.
22. Repeat steps 1 to 21 on each target host.

Web Development Kit and Applications Installation Guide 67


Installing WDK and WDK Applications

68 Web Development Kit and Applications Installation Guide


Chapter 8
Completing the Installation Process

After you install WDK or a WDK application, there are additional procedures that you may need to
perform in order to finish and verify the installation. These procedures are described in the following
sections:
• Configuring Digital Asset Manager, page 69
• Completing the Documentum Compliance Manager Installation Process, page 70
• Completing the Installation Process on BEA WebLogic, page 74
• Starting the WDK Application, page 76
• Accessing the Application, page 77
• Viewing WDK Samples, page 77
• Installing on IBM WebSphere with Global Security Enabled, page 78
• Macintosh Content Transfer on IBM WebSphere, page 79
• Designating the Client-Side Content Transfer Directory, page 79
If you are installing Web Publisher, review any applicable sections in this chapter and then complete
the tasks in Chapter 9, Completing the Web Publisher Installation Process.

Configuring Digital Asset Manager


You must configure Digital Asset Manager after installation is complete by running the
DAM Configurator. Before running the DAM Configurator on UNIX hosts, ensure that
the shared library path contains the correct Java lib directory.

To run the DAM Configurator:

1. Start the Digital Asset Manager Configurator.


• On Solaris, navigate to the $DOCUMENTUM_SHARED/damServices
subdirectory and run this command:
./damSolarisConfigurator.bin
• On HP-UX, navigate to the $DOCUMENTUM_SHARED/damServices
subdirectory and run this command:
./damHPUXConfigurator.bin
• On AIX, navigate to the $DOCUMENTUM/damServices subdirectory and run
this command:
./damAixConfigurator.bin

Web Development Kit and Applications Installation Guide 69


Completing the Installation Process

• On Windows, click StartoProgramsoDocumentumoApply DAM support


to docbase.
The DAM Configurator starts and the Welcome panel is displayed.
2. Click Next.
The License Agreement dialog box is displayed.
3. Select the appropriate radio button if you agree with the licensing terms, then click
Next.
A list of available Docbases is displayed.
4. Select a Docbase and click Next.
5. Enter a Superuser name.
The DAM Configurator uses this to connect to the Docbase.
6. Enter the password for the Superuser account, and then re-enter it.
7. Click Next.
The Docbase is configured to support Digital Asset Manager. When it is finished,
a success dialog is displayed.
If you cannot continue, verify with the Docbase administrator that the Superuser
exists and the password is correct.
8. Click Finish to close the Configurator.

Completing the Documentum Compliance


Manager Installation Process
To complete the DCM installation, a DocApp must be installed in each DCM Docbase
and some modifications must be made using DAB after the DocApp is installed. Some
Java methods are also added to the Content Server installation. You must stop the Java
method server on the Content Server host before you run the server files installer.
In addition, set the dm_event_sender method in each DCM Docbase to launch
asynchronously. This improves DCM performance. You can optionally install sample
DCM objects as well.
• Installing the DCM DocApp and Server Files on Windows, page 70
• Installing the DCM DocApp and Server Files on Solaris Hosts, page 72
• Modifying the dm_event_sender Method, page 73
• Creating DCM Sample Objects, page 74

Installing the DCM DocApp and Server Files on


Windows
Use these instructions to install the DCM DocApp in each Windows DCM Docbase.

70 Web Development Kit and Applications Installation Guide


Completing the Installation Process

To complete the DCM installation on a Windows host:

1. Log in to the Content Server host as the Content Server installation owner.
2. Ensure that DAB is installed.
3. From the Services dialog box, stop the Documentum Java method server.
4. Copy the DCM server files program, Compliance_Manager_Server_Files_version_
number_window.zip, to a temporary directory on the Content Server host.
5. Unzip the file.
6. Double-click dcMServerWinSetup.exe.
A Welcome dialog box is displayed.
7. Click Next.
8. Choose I agree to the license terms and click Next.
9. Select the Docbase in which to install the DocApp.
10. Type in the user name and password of the Content Server installation owner.
11. Click Next.
12. Check DcmDocApp and click Next.
13. Read the informational dialog box and click Next.
The Java methods and DocApp are installed.
14. Click Next.
15. Restart the Documentum Java method server.
16. Click StartoProgramsoDocumentumoApplication Builder.
17. Connect to the Docbase as the installation owner.
18. On the New Application dialog box, select Open existing DocApp from Docbase.
19. On the Open Application dialog box, double-click the DcmDocapp folder.
20. Select the DcmDocapp application and click Open.
21. Click InsertoObject from DocbaseoGroup.
22. Select dynamic_approvers and required_approvers and click Insert.
23. Click InsertoObject from DocbaseoRole.
24. Select all of the roles and click Insert.
25. Click InsertoObject from DocbaseoRelation Types.
26. Select all of the relation types prefaced with dcm and click Insert.
Nine relation types are added.
27. If you have installed the OOTB (out of the box) object types, add the Affects, Against,
Closes, and Supports relation types.
28. Right-click DcmDocapp and select Check In DocApp from the menu.
29. Ensure that you check in the DocApp as the same version, 1.0.

Web Development Kit and Applications Installation Guide 71


Completing the Installation Process

30. If a dialog box is displayed warning you that changes to the application might be
lost, click No and perform step 28.

Installing the DCM DocApp and Server Files on Solaris


Hosts
To complete the DCM installation on a Solaris host:

1. Log in to the Content Server host as the Content Server installation owner.
2. Ensure that DAB is installed.
3. Stop the Documentum Java method server.
4. Copy the DCM server files program, Compliance_Manager_Server_Files_version_
number_solaris.tar, to a temporary directory on the Content Server host.
5. Unzip the file.
6. Run the dcMServerSolSetup.bin program.
The files are installed on the Content Server host.
7. Disconnect from the Content Server host.
8. Connect to a Windows host where DAB is installed.
9. Ensure that the dmcl.ini file on the host points to a DocBroker to which the DCM
Docbase projects.
10. On the Windows host, click StartoProgramsoDocumentumoApplication
Installer.
The Documentum Login dialog box is displayed.
11. In the Docbase field, select the Docbase where you are installing the DCM DocApp.
12. Enter the user name and password of a user who has Superuser privileges in the
Docbase.
13. Click OK.
The Select DocApp Archive dialog box is displayed.
14. Browse to $DM_HOME/product/5.2.5/install/DocApps/DcmDocApp/
DcmDocApp.
Do not change the name of the DocApp archive.
15. Click OK.
16. Click OK.
The DocApp Installer dialog box is displayed.
17. Verify that the information on the dialog box is correct.
18. Click Start Installation.
A prompt is displayed.
19. Click OK.

72 Web Development Kit and Applications Installation Guide


Completing the Installation Process

20. If the Connected Users dialog box is displayed, click Yes.


21. Click Quit Installer.
22. Click StartoProgramsoDocumentumoApplication Builder.
23. Connect to the Docbase as the installation owner.
24. On the New Application dialog box, select Open existing DocApp from Docbase.
25. On the Open Application dialog box, double-click the DcmDocapp folder.
26. Select the DcmDocapp application and click Open.
27. Click InsertoObject from DocbaseoGroup.
28. Select dynamic_approvers and required_approvers and click Insert.
29. Click InsertoObject from DocbaseoRole.
30. Select all of the roles and click Insert.
31. Click InsertoObject from DocbaseoRelation Types.
32. Select all of the relation types prefaced with dcmand click Insert.
Nine relation types are added.
33. If you have installed the OOTB (out of the box) object types, add the Affects, Against,
Closes, and Supports relation types.
34. Right-click DcmDocapp and select Check In DocApp from the menu.
35. Ensure that you check in the DocApp as the same version, 1.0.
36. If a dialog box is displayed warning you that changes to the application might be
lost, click No and perform step 28.
37. Repeat this procedure in each DCM Docbase.

Modifying the dm_event_sender Method


Use these instructions to modify the dm_event_sender method to launch asynchronously
in each DCM Docbase. For more information, refer to Documentum Administrator
online Help.

To modify dm_event_sender:

1. Start a browser and connect to Documentum Administrator.


2. Connect to a DCM Docbase as a user with Superuser privileges.
3. In the Administration node, click Job ManagementoMethods.
4. Locate the dm_event_sender method.
5. Click the Info icon.
6. Check Launch Async.
7. Click Ok.

Web Development Kit and Applications Installation Guide 73


Completing the Installation Process

8. Repeat these instructions for each DCM Docbase.


9. Click Logout.

Creating DCM Sample Objects


After the DCM DocApp and server files are installed, you can optionally create sample
DCM objects and begin submitting and tracking documents in the Docbase.
In addition to the Java methods and DocApp, running the server files installer installs a
Docbasic script on the Content Server host. Running the script creates sample objects in
the Docbase.

To create the sample objects:

1. Connect to the Content Server host as the Content Server installation owner.
2. Navigate to $DM_HOME/bin/DcmDocapp/install (Solaris) or
%DM_HOME%\bin\DcmDocapp\install (Windows).
DM_HOME is typically DOCUMENTUM/product/version_number.
3. On Windows, open a command prompt.
4. Issue the following Docbasic command:
dmbasic -f DcmSample.ebs -e CreateObjects -- DOCBASE_NAME
USER_NAME PASSWORD

where DOCBASE_NAME is the name of the Docbase where the DocApp is


installed, USER_NAME is the user name of the user who installed the DocApp,
and PASSWORD is the user’s password.

Completing the Installation Process on BEA


WebLogic
If you are installing on BEA WebLogic on AIX or you run more than one WDK
application on a particular application server, read these sections and complete the
procedures required:
• BEA WebLogic on AIX, page 74
• Setting Cookies Correctly When Multiple Applications Run on WebLogic, page 75

BEA WebLogic on AIX


Content transfer operations such as check-in, check-out, and XML import fail on BEA
WebLogic 8.1 SP2 installed on AIX. If you are using this platform, use the following
procedure to work around the problem.

74 Web Development Kit and Applications Installation Guide


Completing the Installation Process

To complete the installation process on WebLogic/AIX:

1. Navigate to BEA_DOMAIN_HOME.
2. Open the startDocumentum.sh file in a text editor.
3. Locate the JAVA_OPTIONS section of the file.
4. Add these options:
-Dcom.documentum.xml.jaxp.DfDocumentBuilderFactory=com.documentum.
xml.jaxp.DfDocumentBuilderFactoryImpl
-Dcom.documentum.xml.jaxp.DfSAXParserFactory=com.documentum.xml.jaxp.
DfSAXParserFactoryImpl
-Djavax.xml.parsers.DocumentBuilderFactory=com.documentum.xerces_2_3_0.
xerces.jaxp.DocumentBuilderFactoryImpl
-Djavax.xml.parsers.SAXParserFactory=com.documentum.xerces_2_3_0.xerces.
jaxp.SAXParserFactoryImpl

5. Save the file.


6. Restart the application server.

Setting Cookies Correctly When Multiple Applications


Run on WebLogic
When multiple Web applications are running on a single WebLogic server and a user who
is logged in to an application accesses a URL that issues a new cookie, the JSESSIONID
for the original application is overwritten and the user must log in again when he returns
to the first application. For example, if a Web Publisher user previews a Web site in
the template editor where the Web site corresponds to a web application using JSPs or
Servlets, then returns to Web Publisher, the user must log in to Web Publisher again.
This problem occurs because by default, WebLogic does not scope cookies by application
name. To change this behavior, add the CookiePath parameter to the session-descriptor
section of weblogic.xml file for the WDK application. For example, if the WDK
application name is installed in the virtual directory (context path) myWebtop, the
session-descriptor section of the weblogic.xml file includes the following:
<session-descriptor>
<session-param>
<param-name>
CookiePath
</param-name>
<param-value>
/myWebtop
</param-value>
</session-param>
</session-descriptor>

Add the CookiePath parameter to the weblogic.xml file for each application running
on a particular WebLogic Server.
If you rename the Web application, update the value in the CookiePath parameter
to reflect the new name.

Web Development Kit and Applications Installation Guide 75


Completing the Installation Process

Starting the WDK Application


After installing WDK or a WDK application, you must start it in the application server.
• To run WDK or a WDK application on Tomcat, IBM WebSphere, Oracle AS, or Sun
ONE, start and stop the application server in the normal fashion.
• To start WDK or a WDK application on BEA WebLogic, use the following procedure.

Starting the Application on WebLogic From the Host


Use these instructions when you are logged in from the application server host’s console.
Do not use these instructions if you start the application from a telnet session.

To start WDK or a WDK application on WebLogic:

1. Navigate to the domain directory in which WDK or the WDK application is installed.
2. Start the Documentum application.
• On Windows, double-click startDocumentum.cmd, or start the service using the
Windows Service Manager.
• On UNIX, enter this command:
./startDocumentum.sh
You may see error messages regarding the DTD.

Starting the Application on UNIX/WebLogic From a


Telnet Session
Use these instructions to start the application on WebLogic on any UNIX platform when
you are connected to the application server host by a telnet session. This procedure
allows the application to keep running after you to log off the telnet session.

To use nohup:

1. Open a telnet session and log in to the application server host.


2. Navigate to $BEA_HOME/user_projects/your_domain/.
3. Start the application:
nohup startDocumentum.sh

4. Log out and close the telnet session.


Do not use Ctrl + C to kill the process. For details on the nohup utility see
http://www.unidata.ucar.edu/cgi-bin/man-cgi?nohup+1

76 Web Development Kit and Applications Installation Guide


Completing the Installation Process

Accessing the Application


This section provides you with information on accessing and testing the installation of
WDK or a WDK application by connecting through a browser client. Before you test the
installation, ensure the application is started in the application server. (For information
on starting the application, refer to Starting the WDK Application, page 76.)
If the application requires additional configuration or setup, such as installing a DocApp,
perform those steps before you test the application. For example, if you are installing
Web Publisher, review Chapter 9, Completing the Web Publisher Installation Process,
and complete the tasks described in that chapter.

To verify the installation of WDK or a WDK application:

1. Open a browser window and enter this URL


http://host_name:port_number/virtual_directory
where host_name is the host where the application server is installed, port_number
is the port where the application server listens for connections, andvirtual_directory
is the virtual directory created during installation. For example, if the application
server host is named iris, the port is 8080, and the application virtual directory is
webtop, the URL is http://iris:8080/webtop.
If the browser is on the application server machine, substitute localhost for host_name;
for example, http://localhost:8080/webtop.
2. Log in to a Docbase through the WDK application.
If the log in succeeds, the application is correctly installed.

Viewing WDK Samples


After installing WDK, view some of the sample pages. Connect to a test Docbase as user
who has at least Create Cabinet privileges.

To view the WDK samples:

1. If it is not running, start the application server.


2. Open a browser and type this URL
http://host_name:port_number/virtual_directory/component/login
where host_name is the host where the application server is installed, port_number is
the port where the application server listens for connections, andvirtual_directory is
the virtual directory created during installation.
A login dialog box is displayed.
3. Log in to a test Docbase.
The login dialog box is redisplayed with the status message Login Successful.
4. Type this URL:
http://host_name:port_number/virtual_dir/wdk/samples/index.jsp
This page displays a list of the available samples.

Web Development Kit and Applications Installation Guide 77


Completing the Installation Process

5. Click Session Zoo and enter a valid Docbase user name, password, Docbase name,
and domain (if required), then click Create Connection.
The Docbase is listed in the All Connected Docbases section of the page, and the
Status message line starts with “Successfully connected to Docbase Docbase_name”
6. Continue to experiment with other samples, especially Menu Zoo, Tree Control,
and FX Control Pens.
Some samples have Create Test Cab and Destroy Test Cab buttons. These create
and delete a test cabinet in the Docbase.
7. Type this URL:
http://server_name:port_number/virtual_dir/component/componentlist
This page displays a list of WDK components specific to the application whose
virtual directory you entered in the URL, with links to more information about
the components.

Installing on IBM WebSphere with Global


Security Enabled
When all of the following conditions are met, you must make changes to the WebSphere
installation after deploying a WDK application:
• WebSphere global security is enabled
• At least one output directory defined in the dfc.properties file is manually modified
(dfc.data.dir, dfc.user.dir, dfc.checkout.dir, dfc.registry.file, and dfc.export.dir)
• An output directory you specify is not in the Documentum installation directory
structure (not located under C:Documentum or C:\Program Files\Documentum on
Windows; DOCUMENTUM or DOCUMENTUM_SHARED on UNIX and Linux)
If you modified the dfc.data.dir directory location, use the WebSphere Admin Console
to modify the JVM custom property named dfc.data ,to reflect the path to the new
location. Refer to the documentation for WebSphere for information on modifying JVM
custom properties.
If you modified the dfc.user.dir, drc.checkout.dir, dfc.export.dir, or dfc.registry.file
directory location, use the WebSphere Admin Console to create JVM custom properties
as follows:

Table 8–1. Output Directories and JVM Custom Properties

Output Directory JVM Custom Property Name

dfc.user.dir dfc.user

dfc.checkout.dir dfc.checkout

dfc.export.dir dfc.export

dfc.registry.file dfc.registry

Enter the path to the correct directory location. For dfc.registry, enter the path to the
parent directory of the file.

78 Web Development Kit and Applications Installation Guide


Completing the Installation Process

After you set up the required JVM custom properties, restart the WebSphere Application
Server to enable the changes.

Macintosh Content Transfer on IBM WebSphere


After installing WDK or the WDK application, special configuration of WebSphere is
required to enable content transfer to Macintosh computers.

To enable content transfer for Macintosh computers on WebSphere:

1. Log on to the WebSphere Administration Console.


2. Expand the Applications node.
3. Select Enterprise Applications.
4. On the right side of the console, select the WDK application (for example, dam or
webtop).
5. On the right side of the console, in the Additional Properties section, select Session
Management.
6. Check Overwrite and Enable URL Rewriting.
7. Click Apply.
8. In the Messages area, click the Save link.
9. Click the Save button.
10. Restart the application from within the Administration Console.

Designating the Client-Side Content Transfer


Directory
For client machines accessing a WDK application, if there is no Documentum user
directory, the client-side content transfer location recorded in the app.xml file associated
with that application determines where the user directories will be created. The locations
designated in the app.xml file are always the locations used on Macintosh computers.
Refer to the Web Development Kit and Applications Development Guide for more information
on customizing the app.xml file.

Web Development Kit and Applications Installation Guide 79


Completing the Installation Process

80 Web Development Kit and Applications Installation Guide


Chapter 9
Completing the Web Publisher
Installation Process

This chapter contains instructions for installing the Web Publisher server files, DocApp, sample Web
site, and eWebEditPro. If you use multiple locales, enable additional locales in the Docbase before
you complete the installation process.
This chapter contains the following sections:
• Enabling Additional Locales in the Docbase, page 81
• Installing the Web Publisher Server Files and DocApp, page 82
• Installing the Accelera DocApp, page 95
• Using eWebEditPro , page 100

Enabling Additional Locales in the Docbase


Documentum Docbases are created with support for the language of the operating
system of the host computer on which the Docbase is installed. For example, if the
operating system is Japanese, the Docbase contains Documentum object type and
attribute names for the Japanese locale. This information is stored in the data dictionary.
You can add support for additional locales to the Docbase.
The Web Publisher DocApp installs data dictionary information for all locales enabled
in the Docbase, including user interface labels in the languages installed. Before
you install the Web Publisher DocApp, update the list of supported locales in the
Docbase configuration with any additional locales you need supported. For example,
if a particular Docbase was created with only the English locale enabled and you
need support for the French and German locales, use the procedure that follows to
enable French. When you install the Web Publisher DocApp, the data dictionary is
automatically updated with French and German information.
The following locales are supported:
• English (en)
• French (fr)
• German (de)
• Italian (it)
• Japanese (ja)

Web Development Kit and Applications Installation Guide 81


Completing the Web Publisher Installation Process

• Korean (ko)
• Spanish (es)
To add locale support, you populate the data dictionary. Use the instructions in
Appendix D of the Content Server Administrator’s Guide to add the locales you need.
During installation of the Web Publisher DocApp, the data dictionary is automatically
updated with the correct Web Publisher labels in the additional locales.

Installing the Web Publisher Server Files and


DocApp
Completing the installation of Web Publisher requires installing the Web Publisher
server files on the Content Server host and installing the Web Publisher DocApp in all
Web Publisher Docbases.
If you are installing Web Publisher on a UNIX Content Server host, ensure that the correct
environment variables are set in the Content Server installation owner’s environment.
For complete information, refer to the Content Server Installation Guide.
The Web Publisher server files and Web Publisher DocApp are installed using a separate
installer called the Documentum Web Publisher version_numberServer Files Installer.
Run this installer on the Content Server host. (The Docbase where you are installing the
DocApp must be running when the DocApp is installed.) In a multiserver environment,
run the installer on the primary Content Server host.
On Windows Content Server hosts, the DocApp is installed automatically by a
command-line version of Documentum Application Installer. If the DocApp does not
install successfully, install it using the graphical version of DAI. Transfer the DocApp to a
Windows host where DAI is installed, then install it in the Web Publisher Docbase.
On a UNIX host, the installer places the Web Publisher DocApp on the Content Server
host, but the installer cannot install the DocApp into the Docbase. You must transfer
the DocApp to a Windows host and use Documentum Application Installer to install
the DocApp.
If you transfer the DocApp, do not change the name of the archive (WebPublisher, with
no spaces and two capital letters) and do not transfer it to a directory where there are
spaces in the path name.
Documentum recommends that you install the server files and DocApp as the Content
Server installation owner. This user has sufficient rights on the host and in the Docbase
to perform the installation.
The installer creates a DocApp log file called WebPublisher_installerLog.html when you
install the Web Publisher default DocApp. The log file is displayed after the DocApp
installation is complete. Create a backup of the log file to track any changes you make to
the DocApp. The log file can be used as a reference for the default DocApp installation.
The log file is saved in $DOCUMENTUM/dba/config/docbase_nameon (UNIX or Linux)
or %DOCUMENTUM%\dba\config\docbase_name on Windows.
For additional information, refer to Chapter 11, Troubleshooting Installation.

82 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

Caution Installing a new Web Publisher DocApp overwrites existing Web Publisher
objects. Document any customizations to the objects and recreate the customizations
after the upgrade. All 5.x customizations are supported in 5.2.5 and 5.2.5 SP1. For
additional information, refer to the System Migration Guide.

You can optionally install a sample Web Publisher Web site, called Accelera, which is
contained in its own DocApp. Installing the Web Publisher DocApp is a prerequisite
for installing the Accelera DocApp. The Accelera DocApp can be installed when you
install the Web Publisher DocApp or at a later time. If you install it at a later time, we
recommend that you install it in a clean Docbase and install the Web Publisher and
Accelera DocApps at the same time. Installing the Accelera DocApp in a Docbase where
Web Publisher is already installed overwrites the FolderMap.xml file and destroyed
existing settings.

Where the DocApp and Server Files are Installed


The tables that follow contain the installation locations of the server files and
Web Publisher DocApp on UNIX and Windows hosts. $DM_HOME (UNIX)
or %DM_HOME% (Windows) is the Content Server installation directory.
$DOCUMENTUM_SHARED (UNIX) or %DOCUMENTUM_SHARED% (Windows) is
the DFC program root directory. For more information on environment variables on the
Content Server host, refer to the Content Server Installation Guide.

Table 9–1. Location of DocApp and Web Publisher Server Files on UNIX Hosts

Installation Locations Files Description

$DOCUMENTUM_ Wcm.jar Web Publisher job and method


SHARED/wpserverfiles Java classes
WcmMethods.jar

$DM_HOME/install/ Web Publisher DocApp archive folders


DocApps/WebPublisher
Accelera

$DM_HOME/bin/ DocApp Installer files; for


webPublisher /install internal use only.

$DM_HOME/dfc/config WcmDQL.properties Properties files used by


WebPublisher and DFC to log
WcmTraceProp.properties or trace the application.

WcmApplicationConfig.
properties

dfc.properties

dfcfull.properties

log4j.properties

dbor.properties

Web Development Kit and Applications Installation Guide 83


Completing the Web Publisher Installation Process

Installation Locations Files Description

$DM_HOME/dfc/logs log4j.log If tracing is enabled


through log4j.properties and
trace.log WcmTraceProp.properties
properties file, then log files
wcm_log.txt
are created in this directory

$DM_HOME/bin dm_wp_sender.ebs Docbasic scripts for email


notifications and properties
dm_wp_mailwrapper.ebs file for Engagement Server
integration
dm_wp_sender_41.ebs
dm_wp_sender_41.ebs may
WcmMethodsResource.
be in this directory from an old
properties
installation on a 4.1 Content
Server.

dm_wp_mailwrapper.ebs
enables Web Publisher to send
HTML mail notifications.

84 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

Installation Locations Files Description

$DM_HOME/bin/ data_dictionary_wcm.ini Web Publisher data dictionary


webPublisher/Utils/ files
DataDictionary data_dictionary_wcm_de_DE.
txt

data_dictionary_wcm_en.txt

data_dictionary_wcm_es_ES.
txt

data_dictionary_wcm_fr_FR.
txt

data_dictionary_wcm_it_IT.
txt

data_dictionary_wcm_ja_JP.
txt

data_dictionary_wcm_ko_KR.
txt

datadictionaryoutput.txt

dd_populate_wcm.bat

dd_populate_wcm.sh

$DM_HOME/bin/ wcmAttachLifecycle.ebs Utility files used for


webPublisher/Utils reconfiguring or debugging
wcmConfigure.ebs Docbase operations

wcmLifecyclePostProcedure.
ebs

wcmMethodServerUpdate.
ebs

wcmMethodStandaloneUp-
date.ebs

wcmMigration.ebs

wcmPostConfigure.ebs

wcmUpdate.ebs

Web Development Kit and Applications Installation Guide 85


Completing the Web Publisher Installation Process

Table 9–2. Location of DocApp and Web Publisher Server Files on Windows Hosts

Installation Locations Files Description

Program Files\Documen- Wcm.jar Web Publisher job and method


tum\Shared Java classes
WcmMethods.jar

%DM_HOME%\install\Do- Web Publisher DocApp archive folders


cApps\WebPublisher
Accelera

%DM_ DocApp Installer files; for


HOME%\bin\webPub- internal use only.
lisher \install

%DOCUMENTUM%\config WcmDQL.properties Properties files used by


WebPublisher and DFC to log
WcmTraceProp.properties or trace the application.

WcmApplicationConfig.
properties

dfc.properties

dfcfull.properties

log4j.properties

dbor.properties

%DOCUMENTUM%\logs log4j.log If tracing is enabled


through log4j.properties and
trace.log WcmTraceProp.properties
properties file, then log files
wcm_log.txt
are created in this directory

%DM_HOME%\bin dm_wp_sender.ebs Docbasic scripts for email


notifications and properties
dm_wp_mailwrapper.ebs file for Engagement Server
integration
dm_wp_sender_41.ebs
dm_wp_sender_41.ebs may
WcmMethodsResource.
be in this directory from an old
properties
installation on a 4.1 Content
Server.

dm_wp_mailwrapper.ebs
enables Web Publisher to send
HTML mail notifications.

86 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

Installation Locations Files Description

%DM_HOME%\bin\ data_dictionary_wcm.ini Web Publisher data dictionary


webPublisher\Utils\ files
DataDictionary data_dictionary_wcm_de_DE.
txt

data_dictionary_wcm_en.txt

data_dictionary_wcm_es_ES.
txt

data_dictionary_wcm_fr_FR.
txt

data_dictionary_wcm_it_IT.
txt

data_dictionary_wcm_ja_JP.
txt

data_dictionary_wcm_ko_KR.
txt

datadictionaryoutput.txt

dd_populate_wcm.bat

dd_populate_wcm.sh

%DM_ wcmAttachLifecycle.ebs Utility files used for


HOME%\bin\webPub- reconfiguring or debugging
lisher\Utils wcmConfigure.ebs Docbase operations

wcmLifecyclePostProcedure.
ebs

wcmMethodServerUpdate.
ebs

wcmMethodStandaloneUp-
date.ebs

wcmMigration.ebs

wcmPostConfigure.ebs

wcmUpdate.ebs

Web Development Kit and Applications Installation Guide 87


Completing the Web Publisher Installation Process

About the Web Publisher Server Files


The Web Publisher server files consist of two jar files, wcm.jar and WcmMethods.jar.
These files contain Java methods that are executed on the Content Server host by the Java
method server. The Java methods contain classes that are invoked by automatic activities
in the default Web Publisher workflow. The classes change permissions and execute jobs
as required. For more information on Java methods and the Java method server, refer to
the Content Server Administrator’s Guide and the Content Server Installation Guide.
The wcm.jar and WcmMethods.jar files are installed to the shared directory. On
Windows, this is C:\Program Files\Documentum\Shared. On UNIX or Linux, this
is $DOCUMENTUM_SHARED.

About the Web Publisher DocApp


To install the Web Publisher DocApp, you must have Superuser privileges in the Docbase.
Installing the Web Publisher DocApp provides support for the English, German,
French, Italian, Spanish, Korean, and Japanese languages by installing data dictionary
information for Web Publisher type and attribute labels, provided you created the data
dictionary locales in the Docbase before the DocApp is installed. Installing the DocApp
also adds objects to the Docbase that are required by Web Publisher:
• Cabinets
• Folders
• Object types
• Lifecycles
• Workflow templates
• Permission set templates
• Alias sets
• Jobs
• Methods
• Procedures
Additionally, installing the Web Publisher DocApp
• Creates dm_relation objects used by Web Publisher
• Creates the four Web Publisher user groups:
— Administrator
— Web developer
— Content manager
— Content author
• Creates the four Web Publisher user roles:
— wcm_administrator_role
— wcm_web_developer_role

88 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

— wcm_content_manager_role
— wcm_content_author_role
• Creates the Web Publisher User Default ACL

About the Accelera DocApp


The Accelera DocApp installs Docbase components for the Accelera.com sample Web
site, which is discussed in the Web Publisher Administration Guide. Documentum provides
the sample Web site for administrators and Web developers to use as a starting point
for Web site customization. The Accelera DocApp contains object types, lifecycles,
workflow templates, permission set templates, Web Publisher Editor templates, alias
sets, procedures, methods, cabinets and content for the Web site. You are not required to
install the Accelera DocApp. It is a sample only.
Installing the WebPublisher DocApp is a prerequisite for installing the Accelera DocApp.
If you plan to install the Web Publisher and Accelera DocApps in the same Docbase,
Documentum strongly recommends installing the two DocApps at the same time.
Installing the Accelera DocApp at a later time overwrites the FolderMap.xml file, which
Web Publisher requires, with Acceler-specific information. If you decide to use the
Accelera sample Web site after installing the Web Publisher DocApp, you can either:
• Install the WebPublisher and Accelera DocApps in a clean Docbase.
• In the Docbase where WebPublisher is already installed, record any customizations
to FolderMap.xml.
After the Accelera DocApp is installed and FolderMap.xml is versioned, open
FolderMap.xml, restore the customizations, and save FolderMap.XML as a new
version.

Installing the DocApp and Server Files on Windows


Hosts
After you add any required locales to the Docbase, install the Web Publisher server files
and DocApp. (To add required locales to the Docbase, use the procedure in Enabling
Additional Locales in the Docbase, page 81.) The DocApp installs the data dictionary
information for the locales to the Docbase. The installer (WPServerWinSetup.exe)
includes an embedded instance of the Documentum Application Installer (DAI, formerly
DocApp Installer) that runs in command-line mode.

To install the Web Publisher server files and DocApp on Windows hosts:

1. Log in to the Content Server host as the Content Server installation owner.
2. Copy WPServerWinSetup.exe from the distribution package to a temporary directory
on the Content Server host.
3. In the temporary directory, double-click WPServerWinSetup.exe.
The Welcome dialog box is displayed.

Web Development Kit and Applications Installation Guide 89


Completing the Web Publisher Installation Process

4. Click Next.
The License Agreement dialog box is displayed.
5. Click I agree to the licensing terms and click Next.
The Install Preview dialog box is displayed.
6. Click Next.
The Web Publisher server files are installed to drive:\Program
Files\Documentum\Shared. The %DM_HOME%\bin\webpublisher folder is
created. The %DOCUMENTUM%\dctm.jar file is modified.
7. Select a Docbase in which to install the Web Publisher Docapp.
8. Enter the user name and password of the Content Server installation owner, then
click Next.
The installer verifies that the Docbase is running and verifies that you are the
Content Server installation owner.
9. Select the Web Publisher DocApp and, optionally, the Accelera DocApp, then click
Next.
Installing the Web Publisher default DocApp is required. Installing the Accelera
DocApp is optional, but if you intend to install both DocApps in a particular
Docbase, it is strongly recommended that you do so at the same time.
The DocApps are installed and the Log File dialog box is displayed. The installer
creates a DocApp log file called WebPublisher_installerLog.html when you install
the Web Publisher default DocApp. The log file is displayed after DocApp
installation is complete.
10. Click Next.
The Installation Summary dialog box is displayed.
11. Click Finish.
12. Restart the Documentum Java method server.
a. Click StartoProgramsoAdministrative ToolsoServices.
b. On the Services dialog box, scroll to Documentum Java Method Server.
c. Right-click Documentum Java Method Server.
d. Click Stop.
e. Right-click Documentum Java Method Server.
f. Click Start.
g. Close the Services dialog box.
13. Repeat this procedure in each Docbase where you run Web Publisher.

Installing the DocApp and Server Files on UNIX Hosts


After you add any required locales to the Docbase, install the Web Publisher server files
and DocApp. (To add required locales to the Docbase, use the procedure in Enabling

90 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

Additional Locales in the Docbase, page 81.) The DocApp installs the data dictionary
information for the locales to the Docbase.
When you run the wPServerOSSetup.bin on the Content Server host, the server files
and DocApp are installed on the host. The DocApp must be installed from a Windows
computer that has Documentum Application Builder or Application Installer (former
DocApp Installer) installed.
There are different procedures for installing the server files and the DocApp. Complete
them both.

Installing the Files

Use these instructions to install the server files and DocApp on a UNIX host.

To install the Web Publisher server files on a UNIX host:

1. Copy the wPServerOSSetup.bin to the Content Server host.


2. In the directory to which you copied the file, type:
wPServerOSSetup.bin
where OS corresponds to the operating system on which you are installing.
The Welcome dialog box is displayed.
3. Click Next.
The License Agreement dialog box is displayed.
4. Click I agree to the licensing terms and click Next.
The Install Preview dialog box is displayed and the files are installed.
5. Navigate to the $DOCUMENTUM/dba/log/wcm directory.
6. Using a text editor, create a file called wcm_log.txt.
The wcm_log.txt file stores error messages about errors that occur while the
application is running.
7. Restart the Java method server.
a. Navigate to the $DM_HOME/tomcat/bin/ directory.
b. Run the shutdown.sh script.
c. Run the startup.sh script.

Installing the DocApp

Use these instructions to install the default Web Publisher DocApp on a UNIX host. The
instructions require that you use Documentum Application Installer on a Windows host.

To install the Web Publisher DocApp in a UNIX Docbase:

1. Log in to a Windows host where the Documentum Application Installer is installed.

Web Development Kit and Applications Installation Guide 91


Completing the Web Publisher Installation Process

2. Ensure that the dmcl.ini file on the host is pointing to a DocBroker to which the
UNIX Docbase projects.
For example, if the Docbase projects to a DocBroker called Troy, ensure that Troy is
listed in the dmcl.ini file. The dmcl.ini file is in the C:\WINNT folder.
3. Use FTP or another protocol to transfer the Web Publisher DocApp from the Content
Server host to a temporary folder on the Windows host.
4. On the Windows host, click StartoProgramsoDocumentumoApplication
Installer.
The Documentum Login dialog box is displayed.
5. In the Docbase field, select the Docbase where you are installing the Web Publisher
DocApp.
6. Enter the user name and password of a user who has Superuser privileges in the
Docbase.
7. Click OK.
The Select DocApp Archive dialog box is displayed.
8. Browse to $DM_HOME/product/5.2.5/install/DocApps/WebPublisher.
Do not change the name of the DocApp archive.
9. Click OK.
10. If required, specify a different Application Installer log file name and location.
Documentum recommends using the path to the Web Publisher DocApp as the
path name.
11. Click OK.
The DocApp Installer dialog box is displayed.
12. Verify that the information on the dialog box is correct.
13. Click Start Installation.
A prompt is displayed.
14. Click OK.
15. If the Connected Users dialog box is displayed, click Yes.
• If the DocApp Installer dialog box displays the following, the installation
succeeded:
<P>COMMIT TRANSACTION</P>.
xxxx INSTALLATION DONE xxxx.
• If the DocApp Installer dialog box displays the following, the installation failed:
<P>ABORT TRANSACTION</P>.
16. Click Quit Installer.
17. Repeat this procedure in r each Docbase where you run Web Publisher.
Documentum Application Installer creates a DocApp log file called Web
Publisher_installerLog.html when you install the Web Publisher default DocApp. The
log file is saved in $DOCUMENTUM/dba/config/docbase_nameon (UNIX or Linux) or
%DOCUMENTUM%\dba\config\docbase_name on Windows.

92 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

Also, see Chapter 11, Troubleshooting Installation.

Updating the Data Dictionary After Installation


Use these instructions to enable language support for additional locales. The sections
below contain instructions for:
• Adding supported locales to the Docbase
• Modifying the data_dictionary_wcm.ini file
• Running the data dictionary population script
To update the locales supported in the Docbase:

1. Use the instructions in Appendix D, “Populating and Publishing the Data


Dictionary,” in the Content Server Administrator’s Guide, to install additional locales in
the Docbase.
2. Log in to the Content Server host as the Content Server installation owner.
3. Navigate to the data_dictionary_wcm.ini file.
The default location is $DM_HOME/bin/webPublisher/Utils/DataDictionary
(UNIX) or %DM_HOME%\bin\webPublisher\Utils\DataDictionary (Windows).
4. Open the data_dictionary_wcm.ini file in a text editor.
The file lists the available locales. They are commented out.
5. Uncomment the line for each new language by removing the # at the beginning of
the line.
For example, if the line is
#data_dictionary_de_DE.txt
remove the #:
data_dictionary_de_DE.txt

6. Save and close the data_dictionary_wcm.ini file.


7. Open the dd_populate_wcm file in a text editor.
• On Windows, this is dd_populate_wcm.bat.
• On UNIX, this is dd_populate_wcm.sh.
8. Locate this line and substitute the appropriate Docbase name, user name, and
password:.
dmbasic -f%DM_HOME%\bin\dd_populate.ebs -eEntry_Point -- DOCBASE_NAME
USER_NAME PASSWORD data_dictionary_wcm.ini
The Docbase name is the name of the Docbase you installed the Web Publisher
DocApp to, the user name is the name of the Superuser, and the password is the
Superuser’s password. You can use the Content Server installation owner’s user
name and password.
9. Save and close the dd_populate_wcm or dd_populate_wcm.sh file.
10. Run the script.
• On Windows, double-click dd_populate_wcm.bat.
• On UNIX, type dd_populate_wcm.sh.

Web Development Kit and Applications Installation Guide 93


Completing the Web Publisher Installation Process

The new data dictionary locale information is installed in the Docbase. When the data
dictionary publishing job runs next, the information is available to Web Publisher.

Output of the Data Dictionary Script


The data dictionary population script, dd_populate_wcm.bat (Windows) or
dd_populate_wcm.sh (UNIX), populates the data dictionary with data specified in
the data_dictionary.ini file, for example, data_dictionary_wcm_de_DE.txt. This is the
output of the script.
Connected to the server as dmadmin.

Starting population for NLS files

Looking for data_dictionary_wcm_de_DE.txt in the current directory.

##########################################################################
## ##

## ##

## Population Data File: data_dictionary_wcm_de_DE.txt ##

## ##

## Start Time: 05-07-2003 12:34:15 ##

## ##

##########################################################################

Starting to read data file

Setting the data dictionary population locale to: de


Setting the data dictionary population codepage to: ISO-8859-1
SUCCESSFUL: type level Data Dictionary Population for type wcm_locale
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_locale
SUCCESSFUL: type level Data Dictionary Population for type wcm_auto_naming
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_auto_naming
SUCCESSFUL: type level Data Dictionary Population for type wcm_change_set
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_change_set
SUCCESSFUL: type level Data Dictionary Population for type wcm_channel
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_channel
SUCCESSFUL: type level Data Dictionary Population for type wcm_edition
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_edition
SUCCESSFUL: type level Data Dictionary Population for type wcm_edition_fld
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_edition_fld
SUCCESSFUL: type level Data Dictionary Population for type wcm_category
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_category
SUCCESSFUL: type level Data Dictionary Population for type wcm_channel_fld
SUCCESSFUL: type level Data Dictionary Population for type wcm_config
SUCCESSFUL: attribute level Data Dictionary Population for type wcm_config
Data Dictionary Population for file data_dictionary_wcm_de_DE.txt complete

Setting the session_locale to: en

Data Dictionary Population Complete

Disconnected from the server.

94 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

Installing the Accelera DocApp


The Accelera DocApp installs Docbase components for the Accelera.com sample Web
site. Documentum provides the sample Web site for administrators and Web developers
to use as a starting point for Web site customization. The Accelera DocApp contains,
object types, lifecycles, workflow templates, permission set templates, Web Publisher
Editor templates, alias sets, procedures, methods, cabinets and content for the Web site.
The Accelera DocApp is a sample Web site only. You are not required to install
it. Documentum is not responsible for the sample’s accuracy or completeness. The
Accelera DocApp and sample Web site are not supported.
This chapter discusses the topics:
• Accelera Preinstallation Requirements, page 95
• Installing the Accelera DocApp, page 96
• Creating a Site Publishing Configuration, page 97
• Testing the Accelera DocApp Installation, page 98
• Publishing Documents to the Sample Web Site, page 99

Accelera Preinstallation Requirements


You must do the following before you install the Accelera DocApp:
• On UNIX Content Server hosts, transfer the DocApp to a Windows machine where
Documentum Application Installer is located.
Running the server-side installer places the Accelera DocApp on the Content Server
host. Documentum Application Builder and Application Installer run on Windows
hosts only.
• Determine where to install the Accelera DocApp.
Installing the Accelera DocApp in a Docbase where the Web Publisher DocApp was
previously installed overwrites existing FolderMap.xml settings. To maintain the
existing settings, back up and then restore FolderMap.xml or simultaneously install
the Web Publisher DocApp and Accelera DocApp in a new Docbase.
• If you have Documentum Application Builder installed, ensure that the regional
setting is correct.
See Setting the Regional Options on Windows Hosts, page 95.

Setting the Regional Options on Windows Hosts

The Regional Options dialog box is where the locale, numerical display, time, and
currency parameters are set on Windows hosts. Ensure that each Content Server host
where the Accelera DocApp installed uses the correct settings during installation. After
installation is complete, the settings can revert to your normal settings.

Web Development Kit and Applications Installation Guide 95


Completing the Web Publisher Installation Process

To set regional settings:

1. Navigate to StartoControl PaneloRegional Settings or Regional Options,


depending on the Windows version.
2. On the General tab, select English (United States).
3. On the Date tab, select the date format dd/mm/yyyy in the Short date format and
Long date format fields.
4. Click OK.
5. When DocApp installation is complete, you can return the Regional Settings to
the previous settings.

Installing the Accelera DocApp


In this procedure, you install the Accelera DocApp to an existing Docbase. Do not install
the Accelera DocApp in a production Docbase.
You must already have the Web Publisher DocApp installed in the Docbase. If the Web
Publisher DocApp installation fails you cannot install the Accelera DocApp. No option
to install the Accelera DocApp is displayed by the installer.

To install the Accelera DocApp:

1. Connect to the Content Server host as the Content Server installation owner.
2. If the Content Server host is a UNIX machine, copy the Accelera DocApp from the
server host to a Windows host where Documentum Application Builder is installed.
The default location of the Accelera DocApp on the Content Server host is
$DM_HOME\product\5.2.5\install\DocApps.
3. Ensure that the Web Publisher DocApp is installed in the Docbase where you are
installing the Accelera DocApp.
4. Log in to a Windows host where Documentum Application Builder is installed.
5. Ensure that the dmcl.ini file on the Windows host is pointing to a DocBroker to
which the Docbase projects.
For example, if the Docbase projects to a DocBroker called Athens, ensure that
Athens is listed in the dmcl.ini file. The dmcl.ini file is in the C:\WINNT folder.
6. Click StartoProgramsoDocumentumoApplication Installer.
The Documentum Login dialog box is displayed.
7. In the Docbase field, select the Docbase where you are installing the Accelera
DocApp.
8. Enter the user name and password of a user who has Superuser privileges in the
Docbase.
9. Click OK.
The Select DocApp Archive dialog box is displayed.

96 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

10. In the top, unnamed field (which might be grayed out), enter the folder path of
the DocApp.
To navigate to the location, click Browse. On a Windows host, the default location of
the DocApp is C:\Documentum\product\5.2.5\install\DocApps.
11. To change the path and filename of the Documentum Application Installer log file,
edit the values in the appropriate fields and click OK.
12. Verify that the information displayed is correct.
13. Click Start Installation.
14. Click OK.
15. If the Connected Users dialog box is displayed, click Yes.
Web Publisher installs the DocApp. The installation takes up to 15 minutes,
depending upon the hardware and network.
16. If the Connected Users dialog box is displayed, click Yes.
• On UNIX, if the DocApp Installer dialog box displays the following, the
installation succeeded:
<P>COMMIT TRANSACTION</P>.
xxxx INSTALLATION DONE xxxx.
• On Windows, if the DocApp Installer dialog box displays the following, the
installation failed:
<P>ABORT TRANSACTION</P>.
17. Click Quit Installer.
18. If the installation failed, review the DocApp installer log file for information about
the process.
The log file’s default location is: $DOCUMENTUM/dba/config/docbase_name
(UNIX) or %DOCUMENTUM%\dba\config\docbase_name (Windows) and
the default name is WebPublisher_installerLog.html. Also, see Chapter 11,
Troubleshooting Installation.

Creating a Site Publishing Configuration


After installing the Accelera DocApp, edit the site publishing configuration that is installed
with the DocApp. Site publishing configurations determine which documents are
published by Site Caching Services from a Docbase to a Web site. Use Documentum
Administrator to edit the Accelera site publishing configuration. See online Help for
for Documentum Administrator for complete instructions on creating and modifying
site publishing configurations.
The following procedure assumes Site Caching Services and Documentum Administrator
are installed.

To modify the site publishing configuration:

1. Start Documentum Administrator and connect to the Accelera Docbase as a


Superuser.

Web Development Kit and Applications Installation Guide 97


Completing the Web Publisher Installation Process

You can use the Content Server installation owner account or another Superuser
account.
2. Click Site Publishing.
3. Choose the Accelera.com English (US)-Active publishing configuration.
4. Set values in the site publishing configuration:
Do not change any other values.
a. ClickActive.
b. In the Versionfield, type active.
c. Click Publishing Folder and browse the Docbase to the Accelera.com folder.
d. Type the target host name.
This is the host where the SCS target software is installed.
e. Type the target port for making connections to the target host.
The port you enter must match the port specified when you installed SCS or
the publishing job fails.
f. Type the target root directory to which you want to publish.
The default is:
c:\publishdir\active

Caution The contents of the target root directory are deleted during a full refresh
or initial publishing operation. Ensure that you specify the correct directory
as the target root directory.

g. Choose Non-secure as the connection type.


h. Click the Advanced tab.
i. Select a new export directory or leave the default unchanged.
j. Type the transfer user name, password, and domain.
These are the same transfer user name, password, and domain that you provided
during SCS target installation.
5. Click Ok.

Testing the Accelera DocApp Installation


After you have created the site publishing configurations, test them.

To test the site publishing configurations:

1. Confirm that SCS is running on the target Web site.


2. Login to Documentum Administrator.
3. Click Site Publishing.
4. Select the Accelera.com site publishing configuration.

98 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

5. Click ToolsoEnd-to-End Test.


6. Click ViewoLogs and examine the resulting log file.
The log file tells you whether a real publishing operation would have succeeded or
failed, and tells you when in the process the publishing operation would have failed.
7. If the test failed, correct any errors and run the test again.

Publishing Documents to the Sample Web Site


After you test the site publishing configuration, publish the Accelera Web site. Link test
documents to the source folder identified in the Web publishing configuration, and
publish them using Documentum Administrator. For information on linking documents
to the publishing folder, refer to the Site Caching Services User Guide,

To publish the documents:

1. Start Documentum Administrator and connect as a Superuser to the Accelera


Docbase.
2. Click Site Publishing.
3. Select the Accelera.com Web publishing configuration.
4. Click ToolsoPublish.
5. Check Publish Entire Site.
If you do not check Publish Entire Site, SCS defaults to an incremental refresh. A
full refresh deletes the entire contents of the target root directory and republishes
all items specified by the Web publishing configuration. It also deletes attribute
information from the database and republishes the attributes.
6. To specify asynchronous publication, check Launch Process Asynchronously.
If you check this, the screen is refreshes immediately before the publishing operation
is complete. If you do not check this, the screen does not refresh until the publishing
operation is complete. Your browser may time out.
7. Select a Method Trace Level of 5.
8. Click Ok.
9. Open a different browser window and enter the following URL
http://host_name:port/index.html
where host_name is the host to which you published and port is the port where the
Web server is listening.
10. Click Communications to view the sample Web site.

Web Development Kit and Applications Installation Guide 99


Completing the Web Publisher Installation Process

Using eWebEditPro
eWebEditPro, from Ektron, Inc., is Web Publisher’s Web-based HTML editor.
eWebEditPro is a WYSIWYG , browser-based HTML editor that enables authors to easily
create hyperlinks and Web content such as text and images. eWebEditPro can be installed
on either Windows or UNIX systems.
For information on supported eWebEditPro versions, refer to Web Publisher Release Notes.
Technical support for eWebEditPro is shared between Documentum and Ektron.
Documentum supports Web Publisher and eWebEditPro integration. Ektron supports
eWebEditPro installation, configuration, and use. Contact Ektron technical support on
the Web at http://www.ektron.com/support.cfm or by telephone at (603) 594-0249.
For information on obtaining eWebEditPro from the Documentum Download Center,
refer to Obtaining eWebEditPro, page 100.

Obtaining eWebEditPro
If you purchased licenses for eWebEditPro and you have a SubscribeNet account, access
the software through the Documentum Download Center using your existing login
ID and password.
If you purchased licenses for eWebEditPro, but you are not a registered
SubscribeNet user, request access by logging on to the Administration Assistant (at
http://support.documentum.com/support/administration/dmaa.asp) and clicking
Request a full-access account. You can also request access by sending email to
product_distribution@documentum.com.
If you have not purchased licenses for eWebEditPro, please contact your Documentum
Account Manager to inquire about pricing and licensing terms.
Your login ID and password are sent to you by Documentum. You cannot change your
password. If you lose your password use the password finder on the Documentum
Download Center login page.

Before You Install eWebEditPro


Before you install eWebEditPro, ensure that virtual link support is enabled. Virtual link
support is required to properly integrate eWebEditPro’s add image and add hyperlink
features.. For information on configuring the display and behavior of these components,
refer to the Web Publisher User Guide. For information on enabling virtual link support,
refer to Installing Virtual Link Support, page 28.
You must also determine the virtual directory in which Web Publisher is installed.
• On BEA WebLogic 7 the virtual directory might be:
/bea/user_projects/wp_domain/WP_Server/
upload/WP_virtual_directory

100 Web Development Kit and Applications Installation Guide


Completing the Web Publisher Installation Process

• On BEA WebLogic 8.1 the virtual directory might be:


/bea/user_projects/wp_domain/WP_Server/
upload/WP_virtual_directory/WP_virtual_directory
• On IBM WebSphere the virtual directory might be:
WebSphere Application Server Home/installedApps/WP_node name/
WP_virtual_directory.ear/WP_virtual_directory.war
• On Oracle 9iAS the virtual directory might be:
ORACLE_HOME/j2ee/home/applications/WP_virtual_directory/
WP_virtual_directory

Installing eWebEditPro
Use these instructions to install the eWebEditPro software on the application server host.

To download and modify eWebEditPro:

1. Log on to the application server host where Web Publisher is running as the
application server installation owner.
2. In a Web browser, navigate to the Documentum Download Center:
https://documentum.subscribenet.com
3. Log in to the Documentum Download Center.
4. Download a version of eWebEditPro.
• To download the software for a 90-day trial, click Ektron eWebEditPro 90 day
Evaluation.
• To download the fully-licensed version of the software, click Ektron
eWebEditPro.
5. Click I Agree.
You must accept the terms of the license agreement to download the software.
6. Click Download.
A single software package applies to UNIX and Windows installations.
7. On the application server host, create a temporary folder called ewebeditpro.
This directory is required for unzipping the software.
8. Extract either ewebeditproversiondctm.zip or ewebeditproversiondctm90.zip to the
ewebeditpro folder and preserve the directory structure.
9. Open the ewebeditpro.js file in a text editor.
10. Change the line
var eWebEditProPath = "/ewebeditpro3/";
to
var eWebEditProPath = "/WP_virtual_directory/ewebeditpro/";
and change the line
var WebImageFXPath = "/ewebeditpro3/";
to

Web Development Kit and Applications Installation Guide 101


Completing the Web Publisher Installation Process

var WebImageFXPath = "/WP_virtual_directory/ewebeditpro/";


where WP_virtual_directory is the virtual directory where Web Publisher is installed.
11. Copy the customevents.js, and config.xml files from WP_virtual_directory/wp/
ewebeditpro to the temporary folder ewebeditpro you created in Step 7.
12. Stop the application server.
This automatically stops the Web Publisher process.
13. Copy the ewebeditpro folder to WP_virtual_directory where WP_virtual_directory is
the virtual directory in which Web Publisher is installed.
14. Start the application server.
Starting the application server automatically starts Web Publisher.

102 Web Development Kit and Applications Installation Guide


Chapter 10
Uninstalling WDK, WDK Applications,
and DFC

This chapter provides instructions for uninstalling WDK, WDK applications, and DFC running on
Windows, UNIX, or Linux. It contains the following sections:
• Uninstalling WDK or a WDK Application, page 103
• Uninstalling the Web Publisher Server Files, page 107
• Uninstalling DFC, page 107

Uninstalling WDK or a WDK Application


Choose the appropriate procedure for uninstalling WDK or a WDK application:
• When to Uninstall, page 103
• Uninstalling WDK or a WDK Application from Windows Systems, page 104
• Uninstalling WDK or a WDK Application from UNIX and Linux Systems, page 106
• Uninstalling DFC, page 107

When to Uninstall
Uninstall a WDK application to remove the application or before you upgrade.
You must uninstall any installed version of the Documentum Compliance Manager
Beta software to install the general release version of the software on the same host. If
you install the DCM general release software on the same host, clean out all files in the
Tomcat work directory. For complete instructions, see Uninstalling the Documentum
Compliance Manager Beta Software, page 104.
If you reinstall a 5.2.x version of WDK or a WDK application, you are not required to
uninstall first, with the following exceptions:
• On BEA WebLogic application servers that utilize deployment
• On Sun ONE servers
On Sun ONE, you cannot use the –force option of asadmin to redeploy an
application; the attempt to redeploy fails.

Web Development Kit and Applications Installation Guide 103


Uninstalling WDK, WDK Applications, and DFC

• If you have a beta version of Documentum Compliance Manager installed on a host


where you are installing the 5.2.5 SP1 version of the software
If you are upgrading to a new version or WDK or a WDK applications, see Uninstalling
Older Software Versions on Windows, page 45.

Uninstalling the Documentum Compliance Manager


Beta Software
These instructions apply only to uninstalling the DCM Beta software.

To uninstall the DCM Beta software:

1. Connect to the application server host as the DCM installation owner.


2. Stop Tomcat.
3. Click StartoControl PaneloAdd/Remove Software.
4. Remove DFC Runtime Environment.
5. Remove Documentum Document Control Manager.
6. If DCM is the last Documentum product on the host, optionally click Clean when
that is one of the choices on the dialog box.
If DCM is not the last Documentum product on the host, do not clean
the host. Cleaning the host removes Documentum entries from the Path
and Classpath environment variables, private Java runtime files, the
HKEY_LOCAL_MACHINE\SOFTWARE\Documentum registry key, the folder
C:\Program Files\Documentum, the folder C:\Documentum, and the file
C:\WINNT\dmcl.ini.
7. Start Windows Explorer.
8. Delete the contents of the C:\Program Files\Apache Group\Tomcat 4.1\work\
folder.
9. Disconnect from the application server host.
10. Connect to the Content Server host where the DCM Docbase is located as the
Documentum installation owner.
11. Shut down the DCM Docbase.
12. Delete the DCM Docbase from the host.
Use the instructions in the Content Server Installation Guide.

Uninstalling WDK or a WDK Application from Windows


Systems
If only one instance of a product is installed on the application server host, use the
Add/Remove Programs feature of Windows to uninstall the software.

104 Web Development Kit and Applications Installation Guide


Uninstalling WDK, WDK Applications, and DFC

If multiple instances are installed or you are not sure how many instances are installed,
navigate to the uninstaller directory for each instance you are removing and use the
procedure below.
If you installed WDK to customize an existing WDK application, the uninstaller for that
application instance is located in the WDK folder, not the WDK application folder.
Before you uninstall, review Preparing the Application Server Software, page 38 and
determine whether the particular application server must be running during installation.
During uninstallation, the server must be in the same state.

To uninstall WDK or a WDK application from Windows hosts:

1. Connect to the host as the application server installation owner.


2. Ensure that the application server is in the correct state.
• Apache Tomcat must be stopped.
• BEA WebLogic must be running.
• IBM WebSphere must be running.
• Oracle 9i AS must be stopped.
• The Sun ONE administration server must be running; the Sun ONE application
server must be stopped.
3. Stop all other running programs.
4. Navigate to the appropriate uninstaller directory:
DFC_program_root\_uninst\product_name\app_server_name\virtual_dir
The default path for the DFC program root on Windows is C:\Program
Files\Documentum.
5. Double-click uninstall.exe.
The Welcome dialog box is displayed.
6. Click Next.
7. Ensure the information displayed in the uninstall confirmation window is correct
and click Next.
The uninstaller runs. If this product is the last Documentum product on
your machine, a dialog box is displayed that asks if you want to remove the
Documentum-installed JDK and other settings and directories.
8. Click Yes to remove Documentum from the machine completely or No to remove
DFC files and folders only.
If you click Yes, a confirmation dialog box is displayed.
9. Click Finish.
10. Restart Windows.

Web Development Kit and Applications Installation Guide 105


Uninstalling WDK, WDK Applications, and DFC

Uninstalling WDK or a WDK Application from UNIX and


Linux Systems
Use the following procedure to uninstall WDK or a WDK application from a UNIX or
Linux system.
Uninstalling on HP-UX with Oracle 9i Application Server does not remove all files from
the uninstaller directory. This does not affect subsequent installations.

To uninstall WDK or a WDK application from UNIX and Linux systems:

1. Connect to the application server host as the application server installation owner.
2. Ensure that the application server is in the correct state for installing WDK or a
WDK application.
• Apache Tomcat must be stopped.
• BEA WebLogic must be running.
• IBM WebSphere must be running.
• Oracle 9i AS must be stopped.
• The Sun ONE administration server must be running; the Sun ONE application
server must be stopped.
3. Stop all other running programs in the installation owner’s environment.
4. Navigate to the uninstaller directory:
$DOCUMENTUM_SHARED/_uninst/product_name/
app_server_name/virtual_dir

5. Type the following command:


./uninstall.bin
The uninstaller starts.
6. Click Next.
7. Ensure the information displayed in the uninstall confirmation window is correct
and click Next.
The uninstallation begins.
If the application is the last Documentum product on the host, a dialog box is
displayed that asks whether you want to remove the JDK installed by Documentum
and any remaining Documentum settings and directories.
8. Indicate which Documentum directories, settings, and products to remove.
• To completely remove Documentum from the machine, click Yes and then click
Yes again to confirm the choice.
• To remove DFC files and folders only, click No.
9. Click Finish.

106 Web Development Kit and Applications Installation Guide


Uninstalling WDK, WDK Applications, and DFC

Uninstalling the Web Publisher Server Files


After uninstalling Web Publisher, the Web Publisher server files directory
(webpublisher_server) and the install.ini file may still be installed. You must manually
delete these files to completely uninstall Web Publisher.
Use the following procedure to uninstall the Web Publisher files from the Content Server
host.

To uninstall the Web Publisher server files:

1. Uninstall Web Publisher from the application server host using the instructions for
uninstalling WDK applications in Uninstalling WDK or a WDK Application from
Windows Systems, page 104 or Uninstalling WDK or a WDK Application from UNIX
and Linux Systems, page 106.
2. Connect to the Content Server host as the Content Server installation owner.
3. Open a command prompt and start the server files uninstaller.
• On Windows, click StartoSettingsoAdd/Remove Programs, select
Documentum Web Publisher version_number Server Files, and click
Change/Remove, then follow the prompts.
• On UNIX, type:
$DOCUMENTUM/_uninst/webPublisher_serverFiles/uninstall.bin

The Web Publisher server files are removed from the Content Server host.

Uninstalling DFC
After all Documentum products are removed from the application server host, DFC can
be uninstalled and all remaining Documentum files, directories, and registry entries
(if applicable) can be removed. You can also remove DFC from client hosts that have
no Documentum applications installed.
Do not uninstall DFC if any Documentum products remain on the application server host.
If you have a 5.x version of DFC installed on the host and you plan to install or reinstall a
Documentum product, DFC is upgraded as part of that installation.
Use the procedure that applies to the operating system of the host from which you
are removing DFC.
• Uninstalling DFC from Windows Hosts, page 107
• Uninstalling DFC from UNIX and Linux Hosts, page 108

Uninstalling DFC from Windows Hosts


Use this procedure to remove DFC from Windows hosts.

Web Development Kit and Applications Installation Guide 107


Uninstalling WDK, WDK Applications, and DFC

To uninstall DFC 5.x from a Windows host:

1. Choose StartoSettingsoWindows Control PaneloAdd/Remove Programs.


2. Select Documentum DFC Runtime Environment.
3. Click Remove and complete any additional verifications that are required to
uninstall the product.
If this product is the last Documentum product on the host, a dialog box is displayed
that asks if you want to remove the JDK and other Documentum settings and
directories. This removes Documentum from your registry settings.
4. Indicate which components to remove.
• To remove Documentum completely, click Yes and click yes to confirm.
• To remove only DFC files and folders, click No.
5. Click Restart.

Uninstalling DFC from UNIX and Linux Hosts


Use this procedure to remove DFC from UNIX or Linux hosts.

To uninstall DFC 5.x from a UNIX or Linux system:

1. Navigate to $DOCUMENTUM_SHARED/_uninst/dfc.
2. Start the uninstaller:
./uninstall.bin

3. Indicate which components to remove.


• To remove Documentum completely, click Yes and click yes to confirm.
• To remove only DFC files and folders, click No.

108 Web Development Kit and Applications Installation Guide


Chapter 11
Troubleshooting Installation

This chapter provides information on troubleshooting a WDK application installation. In addition,


please consult the Web Development Kit Troubleshooting Guide and the release notes for your specific
WDK application for information regarding additional items that can affect installation, configuration
and usability.
This chapter is divided into sections according to product. Please refer to the section that discusses
your WDK application.

All WDK Applications


This section provides performance tuning information and troubleshooting information
that is applicable for all WDK applications. It includes the following sections:
• Generating a Log File to Debug Installations, page 109
• Slow Browser Display, page 110
• Network Bandwidth, page 110
• BEA WebLogic Error Message When Starting in Development Mode, page 110

Generating a Log File to Debug Installations


You can generate a log file of the installation by running the installer from a command
line with the -is:log option. Here is an example of generating a log file named logfile.txt
for a Webtop installation:
Windows:
webtopWinSetup.exe -is:log c:\temp\logfile.txt

UNIX and Linux:


webtopSolSetup.bin -is:log /var/tmp/logfile

Web Development Kit and Applications Installation Guide 109


Troubleshooting Installation

Slow Browser Display


The first time a JSP page is accessed, it must be compiled by the application server.
It is much faster on subsequent accesses.
If you have tracing turned on, or if you have a very large log file (of several megabytes),
the browser response time dramatically decreases.

Network Bandwidth
If you are having problems getting your WDK application to run, you may want to test
your network bandwidth. Here are some bandwidth guidelines:
• network at 16 kilobits — application not working (timed out, errors)
• network at 32 kilobits — slow performance
• network at 64 kilobits — good to great performance

BEA WebLogic Error Message When Starting in


Development Mode
If you start up BEA WebLogic in development mode, you may see a message such as the
following in the console or log:
<Caught exception deploying application:
_appsdir_webtop-config_dir>
You can ignore this message, or prevent the message from occurring while in
development mode by expanding the WAR file.

Troubleshooting Web Publisher Only


This section provides performance tuning information and troubleshooting information
specifically for Web Publisher. It includes the following sections:
• Web Publisher Server-Side Installer Errors, page 110
• Server Side Tracing for Web Publisher, page 111
• DocApp Installation Fails, page 112
• Text Unaligned, page 113
• Users Cannot Access Functions That Their Roles Should Allow, page 113

Web Publisher Server-Side Installer Errors


The Web Publisher server-side installer copies and installs files that are needed to
correctly run the Web Publisher java methods. If files are not correctly copied or installed

110 Web Development Kit and Applications Installation Guide


Troubleshooting Installation

you may see errors when you try to perform certain tasks. Following is a common error
you would see in the server log file and what you can do to remedy the error.

exception NoClassDefFounderror... com.documentum.wcm.


servermethod.WcmExpireNowActionHandler

This error indicates that when Content Server spawns a java process Content Server is
not able to find the classes because the dctm.jar and wcm.jar files are not in the user’s
classpath.
You may receive this error if:
• The Content Server environment is not correctly set up
• The Web Publisher server installer did not correctly add the dctm.jar and wcm.jar
files to the CLASSPATH environment variable
This error may manifest itself to the user if a user clicks Expire Now to expire a
document, in the Web Publisher user interface.
To correct this error, ensure that the Content Server environment is correctly set up by
checking the environment variables set in the installation owner’s environment. On
UNIX, the installation owner’s environment must set the environment variables. For
details, see the section Setting Environment Variables on UNIX and Linux Hosts, page 36
or refer to the Content Server Installation Guide.
You can also correct this error by checking the manifest file in the dctm.jar file for the
wcm.jar file entry. If you do not find the wcm.jar file entry then you will need to install it.
You install the files by copying the wcm.jar file from the installer to C:\Program
Files\Documentum\Shared.
If you do not discover the source of your error from the above steps you should turn
on the Web Publisher tracing for server side methods. For details on tracing see Web
Publisher Administrator Guide.

Server Side Tracing for Web Publisher


You may need to turn on server side tracing if you are having problems with your
application and cannot resolve them. Tracing captures information that will help you
and Documentum determine the source of the issue.

To turn on server side tracing:

1. Navigate to the log4j.properties file.


2. Add the location entry to the file, for example
log4j.appender.WcmAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.WcmAppender.File=C:\\DOCUMENTUM\\dba\\log\\wcm\\wcm_log.txt
log4j.appender.WcmAppender.Append=true
log4j.appender.WcmAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.WcmAppender.layout.ConversionPattern=%d{HH:mm:ss,SSS} %10r %5p [%10t
log4j.appender.WcmAppender.DatePattern=’.’yyyy-ww-dd

Web Development Kit and Applications Installation Guide 111


Troubleshooting Installation

3. Set the various trace parameters in the WcmTraceProp.properties file to true. These
parameters are very self-explanatory, for example
com.documentum.wcm.Trace.WCMSESSIONENABLEDBYDEFAULT=true
com.documentum.wcm.Trace.DMCLENABLEDBYDEFAULT=true

com.documentum.wcm.Trace.WCMDQLUTIL=false
com.documentum.wcm.Trace.WCMUTIL=true
com.documentum.wcm.Trace.WCMPARSERERROR=false
com.documentum.wcm.Trace.WCMLIFECYCLESRVC=true
com.documentum.wcm.Trace.WCMDELETEOBJECT=false
com.documentum.wcm.Trace.WCMCHECKINSRVC=false
com.documentum.wcm.Trace.WCMCHECKOUTSRVC=false
com.documentum.wcm.Trace.WCMCANCELCHECKOUTSRVC=false
com.documentum.wcm.Trace.WCMEDITSRVC=false
com.documentum.wcm.Trace.WCMSESSIONLIFECYCLEEVENT=true
com.documentum.wcm.Trace.WCMASYNCTASK=true
com.documentum.wcm.Trace.WCMPUBLISH=true
com.documentum.wcm.Trace.WCMCHANGESET=true
com.documentum.wcm.Trace.WCMAPPCONFIG=true
com.documentum.wcm.Trace.WCMSERVERMETHOD_SESSION=true
com.documentum.wcm.Trace.WCMCLIPBOARDSRVC=false
com.documentum.wcm.Trace.WCMTRACE=true
com.documentum.wcm.Trace.WCMMONITORJOB=true
com.documentum.wcm.Trace.WCMPROCESSWORKFLOW=true
com.documentum.wcm.Trace.WCMDYNAMICCONTENTJOB=true
com.documentum.wcm.Trace.WCMOBJECTBAGJOB=true
com.documentum.wcm.Trace.WCMOBJECTBAGJOB_DETAIL=true
com.documentum.wcm.Trace.WCMSTRATTRANSLATIONWF=true
com.documentum.wcm.Trace.WCMSERVERSIDEUTIL=true

# DMCL Trace
# Please note that you need to escape ’\’ when specifying a Window path;
# i.e.
# DMCLFILEPATH=c:\\dir1\\trace_dmcl.txt
#
DMCLFILEPATH=c:\\temp\\trace_dmcl.txt
DMCLTRACELEVEL=6

This will generate a dmcl trace and a WCM server-side trace.


You should also view the log statements in the server log file for error information.

DocApp Installation Fails


Were you logged in to the Docbase as a Superuser? If you tried to install the DocApp
without Superuser privileges, you might have rendered the Docbase unable to be used
for WebPublisher.
Did the data dictionary job dm_DataDictionaryPublisher successfully complete before
you installed the DocApp? If the job did not install correctly and you tried to install the
DocApp the DocApp Installer exits and displays a message similar to the following:
Please verify data dictionary publish happened correctly.
An error will also be logged to the WebPublisher_installerLog.html file located in
$DOCUMENTUM\dba\config\docbase_name.

112 Web Development Kit and Applications Installation Guide


Troubleshooting Installation

Please refer to the Content Server Administrator’s Guide for information on correcting any
dm_DataDictionaryPublisher installation issue.
For other reasons the DocApp might have failed, check the installer log file. The log
file’s location is specified in the procedure To install the Web Publisher server files and
DocApp on Windows hosts:, page 89.

Text Unaligned
Web Publisher is certified for use with 800x600 screen resolution (small fonts).

Users Cannot Access Functions That Their Roles Should


Allow
Use Documentum Administrator to check the Web Publisher User Default ACL. The Web
Publisher User Default ACL should have the following entries:
• content author: <Write> Run Procedure, Change Location, Change State, Change
Permit
• content manager: <Write> Run Procedure, Change Location, Change State, Change
Permit
• Web developer: <Delete> Run Procedure, Change Location, Change State, Change
Permit
• administrator: <Delete> Run Procedure, Change Location, Change State, Change
Permit
• dm_owner: <Delete> Run Procedure, Change Location, Change State, Change Permit
• dm_world: <None> Run Procedure, Change Location
If the ACL does not have these entries, use Documentum Administrator to fix the ACL.

Troubleshooting Webtop Only


This section provides performance tuning information and troubleshooting information
specifically for Webtop. It includes the following sections:
• Invalid class file format, page 113

Invalid class file format


Intelli-J 3.0 requires JDK 1.4 but Apache Tomcat 4.0 out of the box is not compatible
with JDK 1.4. You may encounter the following error for several Webtop functions like
document permissions or selecting an inbox item if you are using Tomcat 4.0.
Invalid class file format in C:\j2sdk1.4.1_01\jre\lib\rt.jar(java/lang/

Web Development Kit and Applications Installation Guide 113


Troubleshooting Installation

Object.class).
The major.minor version ’48.0’ is too recent for this tool to understand.
This problem is caused by the Apache Tomcat application server using an older verison
of tools.jar. To fix this error you should copy the tools.jar file from /j2sdk1.4.1_01/lib
into /Apache Tomcat 4.0/common/lib, or update your Apache Tomcat application
server to 4.1.

114 Web Development Kit and Applications Installation Guide

You might also like