Deployment Example: Deploying and Customizing the Documentum Portlet

Documentum Portlet

This section contains the following:

Introduction

Based on the Sun portlet specification JSR-168, a portlet is a Java-based web component, managed by a portlet container, that processes requests and generates dynamic content. Portlets are used by portals as pluggable user interface components that provide a presentation layer to Information Systems.

WDK for Portlets installs Documentum portlets, WDK run time, and WDK components into a portal Web application in a certified portal server. A single portlet class, DocumentumComponent, dispatches WDK components for each portlet. A portlet that dispatches a WDK component must specify its portlet class as com.documentum.web.env.jsr168.DocumentumComponent.

The components that are dispatched for portlet view and edit modes are specified for each portlet in the portlet.xml file. The context-sensitive portlet help file is dispatched to a new browser window based on the value of the help mode in the portlet.xml file.


Caution – Caution –

If your IDE creates portlets by creating the portlet class, make sure you do not create a Documentum portlet specifying the portlet class as DocumentumComponent. The IDE will overwrite the Documentum portlet class and render all Documentum portlets invalid. If this happens, you can restore the portlet class from your installation WAR file.


Portlet Files

WDK for Portlets installs the following portlets and supporting files:

/custom

Top Documentum portlet application layer. Use this directory for your custom portlet files

/help

Contains localized help files for portlets

/portlets

Contains portal-specific files as required by the portal vendor

/wdk

Contains WDK components and supporting files

/webcomponent

Extends the /wdk layer and defines more components

/WEB-INF/portlet.xml

Contains definitions for all JSR-168 compliant portlets including Documentum portlets

/WEB-INF/classes

Contains Documentum and custom classes for portlet components

/WEB-INF/lib

Contains Documentum JAR files

/WEB-INF/tlds

Contains Documentum tag libraries

/DOCUMENTUM_HOME

DFC is installed to this directory. The directory is selected during installation. If Documentum products have already been installed on the host, the pre-existing home directory is used.