emc documentum webpublisher documentum® webpublisher version6.5 deploymentguide...

EMC® Documentum®

Web PublisherVersion 6.5

Deployment GuideP/N 300006613 A02

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748‑91031‑508‑435‑1000www.EMC.com

Copyright © 1994 ‑ 2008 EMC Corporation. All rights reserved.

Published September 2008

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

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

Table of Contents

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

Chapter 1 Quick Start ............................................................................................ 11

Chapter 2 Planning for Deployment ....................................................................... 13About Web Publisher .................................................................................. 13Required and optional supporting software.................................................. 14Typical configuration .................................................................................. 14Preparing the Content Server ...................................................................... 16Application server host requirements........................................................... 16Directory name restriction....................................................................... 16Content transfer directory permissions .................................................... 16DNS resolution....................................................................................... 17

Deploying multiple applications.................................................................. 17Deploying language packs .......................................................................... 17Customizing an application......................................................................... 17Portlet server .............................................................................................. 18Documentum Process Integrator 6.5 (Legacy version) ................................... 18Documentum Site Caching Services ............................................................. 18Optional LDAP server ................................................................................ 19

Chapter 3 Preparing the Client Hosts .................................................................... 21Ensuring a certified JVM on browser clients ................................................. 21JVM requirements for Web Publisher Editor and Rules Editor ....................... 22Enabling HTTP content transfer in Internet Explorer 7 .................................. 22Enabling UCF content transfer in Internet Explorer 7 on WindowsVista .......................................................................................................... 22Enabling content transfer in Firefox 2........................................................... 23Using Citrix Presentation Server Client ........................................................ 24Turning off the pop‑up blocker in Internet Explorer ...................................... 24Additional considerations for Web Publisher................................................ 24

Chapter 4 Preparing the Application Server Host .................................................. 27Setting the Java memory allocation .............................................................. 28Turning off failover..................................................................................... 28Preparing environment variables for non‑default DFC locations .................... 29Preparing JBoss and Apache Tomcat ............................................................ 29Preparing BEAWebLogic............................................................................ 30

EMC Documentum Web Publisher Version 6.5 Deployment Guide 3

Table of Contents

Supporting large content transfer operations in a managedserver environment................................................................................. 30

Preparing IBMWebSphere .......................................................................... 30Supporting failover in a cluster................................................................ 30Applying policies for WebSphere security ................................................ 30

Preparing Oracle Application Server............................................................ 33Preparing Sun Java System Application Server ............................................. 33Turning off tag pooling ........................................................................... 34Modifying the Sun policy file .................................................................. 34Turning off failover................................................................................. 35

Preparing to use an external web server ....................................................... 35Installing the Site Caching Services target software ....................................... 36

Chapter 5 Upgrading a WDKBased Application .................................................... 37

Chapter 6 Deploying Web Publisher ...................................................................... 39Preparing the WAR file for deployment ....................................................... 39Enabling DFC connections to repositories .................................................... 40Enabling DFC memory optimization............................................................ 42Enabling preferences repositories ................................................................ 42Enabling retention of folder structure and objects on export .......................... 43Enabling modal pop‑up windows................................................................ 43Enabling external searches .......................................................................... 44Configuring the connection to the search server........................................ 44Configuring the connection to the backup search server ............................ 45

Deploying multiple applications.................................................................. 45

Chapter 7 Completing the Deployment .................................................................. 47Configuring UCF........................................................................................ 47Configuring IBMWebSphere after deployment ............................................ 48Changing the classloader and compiler settings........................................ 48Setting com.ibm.ws.webcontainer.invokefilterscompatibility totrue ....................................................................................................... 48

Deploying default virtual link support ......................................................... 49Enabling additional locales in the repository ................................................ 49Installing the Web Publisher server files and DAR files ................................. 50Where the DAR file and server files are installed ...................................... 52About the Web Publisher server files........................................................ 56About the Web Publisher DAR file........................................................... 56Installing the DAR files and server files on Windows hosts........................ 57Installing the DAR files and server files on UNIX and Linux hosts ............. 59Installing the server files ..................................................................... 59Installing the DAR files ....................................................................... 60

Enhanced support for multi‑repository configurations .............................. 61Additional Accelera DAR file tasks .......................................................... 61Accelera preinstallation requirements .................................................. 62Setting the regional options on Windows hosts................................. 63

Accelera postinstallation requirements................................................. 63Creating the Accelera database schema ............................................ 64Installing and configuring Site Caching Services ............................... 64Modifying the DbUtils.inc file ......................................................... 65Creating a site publishing conguration ............................................. 66

4 EMC Documentum Web Publisher Version 6.5 Deployment Guide

Table of Contents

Creating the WEB‑INF folder .......................................................... 68Testing the Accelera DAR file installation............................................. 69Publishing documents to the sample website........................................ 69

Updating the data dictionary after installation.......................................... 70Output of the data dictionary script ......................................................... 71

Installing DAM DAR files ........................................................................... 73Installing a DAR file with the DAR Installer Plugin................................... 73Installing DAR files on UNIX or Linux hosts ............................................ 75

Installing the Site Caching Services source software ...................................... 76Using eWebEditPro .................................................................................... 76Obtaining eWebEditPro .......................................................................... 76Installing eWebEditPro HTML integration ............................................... 77Installing eWebEditPro XML integration .................................................. 78

Installing iMarkup...................................................................................... 79Enabling iMarkup on Windows 2003 Server ............................................. 82

Completing the Web Publisher Portlet Builder installation process................. 82Completing the Web Publisher Page Builder installation process ................... 83Preparing to upgrade Page Builder .......................................................... 83Installing Page Builder DAR files ............................................................. 83Migrating content from prior Page Builder versions .................................. 85Deploying the Upload Application WAR file for dynamiccomponent ............................................................................................. 86

Accessing the application ............................................................................ 87Testing WDK samples ................................................................................. 87Uninstalling the Web Publisher server files................................................... 88

Chapter 8 Configuring Single SignOn for Security Servers .................................. 91

Chapter 9 Troubleshooting Deployment ................................................................ 95Wrong JRE used for application server ......................................................... 96No global registry or connection broker ....................................................... 96No connection to repository ........................................................................ 96DM_VEL_INSTANTIATION_ERROR .......................................................... 97Page not found error in browser .................................................................. 97Login page incorrectly displayed ................................................................. 97Slow performance....................................................................................... 98Out of memory errors in console or log ........................................................ 98Slow display first time ................................................................................ 98DFC using the wrong directories on the application server ............................ 98Application startup errors .......................................................................... 98Tag pooling problem................................................................................... 99UCF client problems ................................................................................... 99Citrix client problems ............................................................................... 100Connection issues between an ECI Services server and IPv6 clients .............. 101Web Publisher server‑side installer errors................................................... 101exception NoClassDefFounderror... com.documentum.wcm.servermethod.WcmExpireNowActionHandler ....................................... 101

Server‑side tracing for Web Publisher ........................................................ 102DAR file installation fails .......................................................................... 103


Table of Contents

Text unaligned ......................................................................................... 103Users cannot access functions that their roles should allow.......................... 103Error when invoking login page after deploying WP on Sun 9.1app server ................................................................................................ 104

Chapter 10 Deploying a Custom Application ......................................................... 105Using the comment stripper utility ............................................................ 105

Appendix A Predeployment Checklist .................................................................... 107


Table of Contents

List of Figures

Figure 1. Basic WDK host configuration ......................................................................... 15Figure 2. SCS configuration for Accelera ........................................................................ 65


Table of Contents

List of Tables

Table 1. Directories and files to back up........................................................................ 37Table 2. Preferences configuration elements.................................................................. 42Table 3. Modal window elements in app.xml (<modalpopup>) ...................................... 44Table 4. Location of DAR files and Web Publisher server files on UNIX hosts.................. 52Table 5. Location of DAR files and Web Publisher server files on Windows hosts ............ 54Table 6. DAR Installer fields ........................................................................................ 74Table 7. Page Builder DAR file files .............................................................................. 84Table 8. Authentication elements (<authentication>)...................................................... 92Table 9. Comment stripper utility parameters ............................................................. 105Table 10. Predeployment tasks .................................................................................... 107


Preface

This guide describes how to deploy Documentum Web Publisher.

Web Publisher is a WDK‑based application. The deployment process is largely the same as for otherWDK‑based applications. However, this guide includes Web Publisher‑specific considerations andprocedures throughout.

Web Development Kit (WDK) is a developer toolkit based on industry standards that facilitates thedevelopment of complex web‑based applications connecting to Documentum Content Server andcontent repositories. WDK contains a large library of reusable components and controls that performcommon content management functions and provide a uniform user interface to applications builtwith WDK.

Webtop is a web application built on WDK that serves as the basis for the Documentum web clientapplications. These applications can be customized using WDK. For additional information ondeveloping or customizing applications with WDK, refer to theWeb Development Kit and ClientApplications Development Guide.

This guide may include instructions for application servers, or combinations of operating systemsand applications servers that are not supported for your product. For the list of supported platforms,refer to the Web Publisher Release Notes.

Intended audienceThis manual is intended primarily for administrators who are deploying an applicationbased on WDK or Webtop. To deploy a WDK‑based application, you should be familiarwith the application server’s operating system and be able to install and configure aJ2EE application server.


Preface

Revision historyThe following changes have been made to this document:

Revision history

Revision date Description

July 2008 Initial publication for version 6.5 release.

September 2008 Revised DAR file installation procedures in Chapter 7.Revised Page Builder deployment procedures. Correctedreference to Business Process Services product in Chapter 2.

Related documentationYou can download this deployment guide and the release notes applicable to WDK,Webtop, and Web Publisher on the product download site. Each WDK‑based applicationcontains an online user guide in HTML format and a PDF version of that guide in thehelp subdirectory of the application WAR file.

The following developer documentation is available on the product download site forconfiguring and customizing WDK and Webtop applications:• WDK Development Guide• WDK and Webtop Reference Guide• WDK Tutorial• JavaDoc API reference documentationAdditionally, Web Publisher has its own development guide and Javadoc.


Chapter 1Quick Start

This chapter outlines the steps you need to perform to deploy Web Publisher. The steps are describedin more detail in the chapters of this guide.

To perform a simple Web Publisher deployment:

1. Plan the deployment. (Refer to Chapter 2, Planning for Deployment.)Check that you have required and optional supporting software, prepare the ContentServer, check application server environment requirements, prepare for multipleapplications, plan for language pack deployment, and plan to deploy a customizedapplication. Web Publisher requires that Documentum Site Caching Services beinstalled; additional requirements pertain to Portlet Builder.

2. Prepare the clients. (Refer to Chapter 3, Preparing the Client Hosts.)Install a supported browser virtual machine and perform specific browserpreparations for IE 7 and Firefox. Review additional considerations specific to WebPublisher, such as installing Site Caching Services source software, and deployingthe Web Publisher server files and DAR files.

3. Prepare the application servers. (Refer to Chapter 4, Preparing the ApplicationServer Host.)Ensure you have sufficient memory allocated to the application server Java instance,turn off failover if it is not needed, and follow preparation instructions specific tothe application server and proxy server. Site Caching Services target software isinstalled on the host.

4. Prepare for the upgrade. (Refer to Chapter 5, Upgrading a WDK‑Based Application.)If you have customized a previous deployment, certain files must be backed up priorto upgrading to Web Publisher 6.5. Customers who are upgrading to Page Builder6.5 should consult Completing the Web Publisher Page Builder installation process,page 83 for upgrade and migration information.

5. Deploy the Web Publisher WAR file using the application server standarddeployment mechanism. (Refer to Chapter 6, Deploying Web Publisher.)


Quick Start

You must first unpack the WAR file archive and enter some information thatis specific to your environment: your connection broker and global registryinformation, optional preferences repositories, and optional ECIS search server.

6. Complete the deployment. (Refer to Chapter 7, Completing the Deployment.)After successful deployment, you can configure UCF, deploy root virtual linksupport, enable WebSphere global security if needed, and test the applicationsamples. Deploy the server files and DAR files. Install eWebEditPro and iMarkup,if required. Additional procedures are required for completing the installation ofPortlet Builder and Page Builder, when applicable.


Chapter 2Planning for Deployment

This chapter addresses software and hardware decisions you must make before you deploy WebPublisher.

This chapter discusses the following topics:• About Web Publisher, page 13• Required and optional supporting software, page 14• Typical configuration, page 14• Preparing the Content Server, page 16• Application server host requirements, page 16• Deploying multiple applications, page 17• Deploying language packs, page 17• Customizing an application, page 17• Portlet server, page 18• Documentum Process Integrator 6.5 (Legacy version), page 18• Documentum Site Caching Services, page 18• Optional LDAP server, page 19

About Web PublisherWeb Publisher simplifies and automates the creation of content for websites. Authorscreate 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 connects to Content Server to store content in a repository and performcontent management functions. Documentum Site Caching Services (SCS) is used topublish content from a repository to a designated location on a website.


Planning for Deployment

Web Publisher Portlet Builder is an application built on top of Web Publisher that is usedto create JSR‑168 compliant portlets and deploy the portlets to portal servers. UsingPortlet Builder, you can create portlets comprised of either repository content or contentfrom external sources. Portlets can display static content or generated content. Generatedcontent can be gathered from RSS feeds or web services.

Web Publisher Page Builder is a Web Publisher editor that lets you create and edit aweb page while viewing the page as it will appear on the web. Unlike many web pagedevelopment tools, Page Builder is fully browser‑based. Page Builder is an optionalapplication that is purchased and installed separately from Web Publisher.

Web Publisher Contributor is a simplified Web Publisher user interface. Using WebPublisher Contributor you can create content, edit content, and publish content to theweb. Web Publisher Contributor makes the job of a contributor user easier by focusingon the tasks that they perform regularly. The interface is also configurable so that userscan choose to have the functionality that they use often readily available to them andhide the functionality that they do not use.

Required and optional supporting softwareAdditional software products are required for WDK and WDK applications includingthe following:• Content Server and its associated database• Content Server global repository• Connection broker

You must specify one or more connection brokers in the dfc.properties file. Referto To configure connections in dfc.properties before deployment:, page 41 forinformation on configuring the connection broker before deployment.

• J2EE application server or servlet containerAll WDK‑based applications require DARs that must be installed in the repository. TheWebtop DARs are provided in Content Server version 6.5.

Typical configurationWhen deployed on a single application server, a typical WDK‑based application requiresthe following network components:• Application server host on which the WDK‑based application will be deployed• Separate Content Server host, where a repository is installed and where one or more

Content Servers run



• Global registry repository• Client hosts that run a supported web browserFigure 1, page 15 shows the network components.

Figure 1. Basic WDK host configuration

Caution: For security and performance reasons, do not install the Content Serverand a WDK‑based application on the same host. In addition, the Content Serverinstalls an internal JBoss server that for licensing reasons cannot be used to deployweb applications.

Clustered environments — WDK‑based applications can be deployed in supportedclustered environments. Refer to the release notes for each WDK‑based application tolearn which managed server configurations are supported.



Preparing the Content ServerThe following topics describe Content Server requirements.

Content Server installs certain DARs that are required for a WDK‑based application.You do not need to perform a separate installation of these. Products built on WDK orWebtop may require additional DARs, which are available on the product download site.

The global registry requirement — A global registry of Content Server version 6.xmust be installed in your environment in order to run a WDK‑based application. Aglobal registry is a Content Server that has been designated as a global registry. Forinformation on designating your application’s global registry before deployment, refer toEnabling DFC connections to repositories, page 40.

Application server host requirementsThe application server host used for WDK‑based applications has the requirementsdescribed in the following sections.

Directory name restriction

Java does not allow directories containing the following characters, which must notappear in the directory names or paths of Documentum applications:! \ / : * ? " < > |

Content transfer directory permissions

The content transfer directory on the application server host is used to store filestemporarily when they are transferred between the repository and the client machine.The default content transfer directory is specified in the app.xml file as the value of<server>.<contentlocation>. The application server instance owner must have writepermissions on this temporary content transfer location.

You can change the default value to a location on your application server host forwhich the application server instance owner has write permission. For informationon specifying locations in the UCF client and server configuration files, refer toWebDevelopment Kit Development Guide.



Some application servers require policies that grant permissions to write to thesedirectories. Refer to deployment information for your application server to seeDocumentum policy settings.

DNS resolution

The Domain Name Server (DNS) must be configured to properly resolve IP addressesbased on the URL used to access the server.

Deploying multiple applicationsYou can deploy multiple WDK‑based applications of version 6.x on a single host. Eachinstance of an application must be deployed to a different virtual directory. If theapplications share the same application server instance, the applications must be thesame version–version 6.x or higher.

You can deploy applications to separate instances of the application server. If theapplications use different versions of DFC, you must deploy them in separate applicationserver instances.

Deploying language packsLanguage packs are available to localize (translate) WDK‑based applications. A languagepack is a language‑specific archive file that contains a graphical user interface (GUI) anduser documentation that have been localized into a language other than the defaultapplication language, U.S. English. To deploy language packs, unpack your productWAR file and add the language packs according to the instructions inWeb DevelopmentKit Applications Language Pack Installation and Release Notes.

Customizing an applicationA developer license is required to develop custom applications. See your EMCDocumentum account representative to obtain a developer license.

Configuration — Configuration is defined for support purposes as changing an XMLfile or modifying a Java Server Page (JSP) page to configure controls on the page.Configuration does not require a developer license.



Customization — Customization is defined for support purposes as the extensionof WDK classes or the modification of JSP pages to include new functionality.Customization requires a developer license.

Customization of Documentum Administrator is not supported.

Portlet serverWeb Publisher Portlet Builder requires a portlet server installed and configured torun with your application server. Refer to the application server and portlet serverdocumentation for installation and configuration instructions.

Documentum Process Integrator 6.5 (Legacyversion)

Web Publisher Portlet Builder requires Documentum Process Integrator 6.5 (Legacyversion) for workflow template functionality. Refer to the Business Process ServicesActivity Template Migration Guide for installation instructions for the legacy product.

Documentum Site Caching ServicesDocumentum Site Caching Services (SCS) publishes documents from a Documentumrepository directly to a website. SCS allows you to identify groups of documents topublish to the website, which version and format to publish, and when to publish thedocuments. This ensures that content on your website is accurate and timely.

Site Caching Services is required by Web Publisher.



Optional LDAP serverYou can optionally use an LDAP server with Web Publisher Portlet Builder. Forinformation on configuring the LDAP server, refer to theWeb Publisher AdministrationGuide.


Chapter 3Preparing the Client Hosts

This chapter contains information on the following pre‑deployment tasks:• Ensuring a certified JVM on browser clients, page 21• JVM requirements for Web Publisher Editor and Rules Editor, page 22• Enabling HTTP content transfer in Internet Explorer 7, page 22• Enabling UCF content transfer in Internet Explorer 7 on Windows Vista, page 22• Enabling content transfer in Firefox 2, page 23• Using Citrix Presentation Server Client, page 24• Turning off the pop‑up blocker in Internet Explorer, page 24• Additional considerations for Web Publisher, page 24

Ensuring a certified JVM on browser clientsBrowser client hosts require a certified version of the Sun Java virtual machine (JVM orVM) to initiate content transfer in a WDK application. New machines may not have aJVM installed in the browser. Check the release notes for your product version for theJVMs that are supported.

If the WDK‑based application is configured to use UCF content transfer, a lightweightapplet is downloaded to the browser when the client makes the first content transferor preferences request.

On Windows clients, if the JVM required for UCF is not present on the client machine,UCF uploads to a Windows client a private JVM. This VM does not replace the JVM thatis used by the browser. For non‑Windows browser hosts with a JVM of 1.4.x, you mustpre‑install version 1.5.0_06.x of the Sun JRE that will then be used by UCF.

Since the UCF VM file (Sun JRE) is over 10 MB in size, the installation can cause a delay.You can avoid this delay by installing a compatible local JVM prior to using UCF transfer.


Preparing the Client Hosts

JVM requirements for Web Publisher Editorand Rules Editor

To use an HTML editing application in Web Publisher, such as Web Publisher Editor orRules Editor, you must have the Sun JVM installed and enabled. The Microsoft VM is notsupported with Web Publisher Editor and Rules Editor. The Sun JVM is not installedwith Internet Explorer.

Enabling HTTP content transfer in InternetExplorer 7

Internet Explorer (IE) version 7 has a default security setting that prevents the display ofthe file download dialog. You must add the WDK‑based application URL to the list oftrusted sites in the browser in order to perform checkout, view, or edit in HTTP mode.

Nothing happens when user exports as CSV if the browser security settings are disabledfor ’prompt for file downloads’ and ’file download’. These are disabled by default inIE7. The user must enable them.

To enable HTTP file download in IE 7:

1. In the IE 7 browser menu, choose Tools > Internet Options and click the Security tab.

2. Choose Trusted sites and then click Custom level.

3. Scroll to the Downloads section and enable Automatic prompting for filedownloads.

4. Click OK twice to save settings.

5. Close all browser windows and restart the browser.

Enabling UCF content transfer in InternetExplorer 7 on Windows Vista

Internet Explorer 7 on Windows Vista OS does not display a file download dialog topermit UCF content transfer unless it is enabled by adding the application server hostto the trusted sites list and doing one of the following:• Turn off User Account Control (UAC) security for each client.• Configure the application to use file registry mode.



To add the application server host to the list:

1. In IE7, go to Tools > Internet Options Security tab.

2. Select Trusted sites. Click Custom level in the section Security level for this zone.

3. Scroll to Downloads and check Automatic prompting for file downloads.

4. Click OK to accept changes, and close the browser.

To turn off UAC on each client:

1. Log in as a user who has administrator privileges on the Windows Vista machine.

2. Open the Control panel and choose Administrative Tools.

3. In the left pane, choose User Accounts.

4. Choose Turn User Account Control on or off.

5. Uncheck Use User Account Control (UAC) to help protect your computer.

6. Click OK and restart the system.

To configure UCF to use file registry mode:

1. Ensure the clients have checked in all checked out files.

2. Open the file ucf.installer.config.xml located in WDK‑based applications directory/wdk/contentXfer.

3. Locate the element <platform os=ʺwindowsʺ arch=ʺx86ʺ>, which configures Windowsclients.

4. Locate the child element <defaults>.<configuration name=ʺcom.documentum.ucfʺ>.<option name=ʺregistry.modeʺ>.

5. Change the value element to the following:<value>file</value>

6. Save and restart the application.

Enabling content transfer in Firefox 2Firefox 2 requires a setting to enable content transfer.

To enable file download in Firefox:

1. Open the Options menu in Firefox.

2. In theMain dialogDownloads section, enable Show the Downloads window whendownloading a file and Close it when all downloads are finished.



3. Check Always ask me where to save files.

4. On the Tabs dialog, check New pages should be opened in: a new window.

5. On the Content dialog, check Load images automatically, Enable JavaSript, andEnable Java.

6. Install the Firefox add‑on FireBug, which is available from mozilla.org.

Using Citrix Presentation Server ClientCitrix Presentation Server Client can be used as a web browser. Check the release notesfor your WDK‑based product to determine whether Citrix clients are supported foryour product.

In the Citrix environment, content files are exported or checked out to the PresentationServer host, not to individual client hosts. Each individual user works on a clienthost with an image of a web browser that is running on the Presentation Server host.For detailed information on enabling applications on Presentation Server, refer todocumentation provided by Citrix.

Note: If you have previously attempted to content transfer to the client, it will use theclient’s location machine, and you must delete the ucf directory that was installed on thelocal client machine under the user’s OS home directory, for example, C:\Documentsand Settings\<username>\Documentum\ucf.

Turning off the popup blocker in InternetExplorer

Windows XP SP2 installs a pop‑up blocker in Internet Explorer that is enabled by default.HTTP content transfer operations in WDK applications are prevented by the pop‑upblocker. You must turn off the pop‑up blocker for HTTP transfer.

Additional considerations for Web PublisherThis section provides high‑level instructions for installing supporting software requiredby Web Publisher on the Content Server host and in the repository. Some of these tasksmust be completed after installing Web Publisher on the application server host. Forcomplete instructions for the tasks listed below, refer to Chapter 7, Completing theDeployment.



• Install the Site Caching Services source software.

This may be done before or after installing Web Publisher on the application serverhost. For more information, refer to Installing the Site Caching Services sourcesoftware, page 76 and the Site Caching Services Installation Guide.

• Install the Web Publisher server file installer on the Content Server host.

This installer contains the following components:

— Server files

Install the server files after installing Web Publisher on the application serverhost. The server files contain Java methods that are executed on the ContentServer host by the Java method server. The Java methods contain classes that areinvoked by automatic activities in the default Web Publisher workflow.

— Web Publisher DAR file (mandatory)

Install the DAR file in the repository after installing Web Publisher on theapplication server host. The DAR file installs cabinets, folders, object types,lifecycles, workflow templates, permission set templates, alias sets, jobs,procedures, and methods required by Web Publisher. The Web Publisher DARfile also creates the dm_relation objects used by Web Publisher, sets lifecycles toexecute as a Superuser, creates the four Web Publisher user roles (administrator,Web developer, content manager, and content author), and creates the WebPublisher default ACL.

For details on setting up users, refer to theWeb Publisher Administration Guide.

— WcmPostReplication DAR file (optional)

This DAR file provides the server method (wcmPostReplicationMethod) andjob (wcmPostReplicationJob) needed in multi‑repository configurations. SeeEnhanced support for multi‑repository configurations, page 61 for details.

— Accelera DAR file (optional)

You may optionally install the DAR file for the Web Publisher sample website,called Accelera, in the repository. Note that there are additional tasks related touse of the Accelera sample, including some preinstallation tasks; see AdditionalAccelera DAR file tasks, page 61 for details.

• Install the DAM DAR files:

— The Rich Media Services DAR file is mandatory for Web Publisher deployments.

— The Transformation DAR file is required if you are performing transformationsin Web Publisher with any Content Transformation Services products.

• If you are using the optional Portlet Builder or Page Builder components, installtheir respective DAR files.

• If you are using eWebEditPro or iMarkup, install these third‑party applications.



For details on installing the Web Publisher server files, DAR files, and third‑partyapplications, refer to Chapter 7, Completing the Deployment.


Chapter 4Preparing the Application Server Host

This chapter describes the tasks you must complete to prepare the application server host beforedeploying Web Publisher.

Before you deploy a WDK‑based application, ensure that your J2EE application server or servletcontainer is a supported version and that it can successfully serve sample JSP pages. Refer to theWebPublisher Release Notes for information about supported application servers and platforms.

Tip: EMC recommends but does not require that you uninstall DFC 5.x and any application thatuses DFC 5.x and then reboot before deploying an application based on WDK 6.x. For uninstallprocedures, refer to the 5.x product documentation.

This chapter contains the following sections:• Setting the Java memory allocation, page 28• Turning off failover, page 28• Preparing environment variables for non‑default DFC locations, page 29• Preparing JBoss and Apache Tomcat, page 29• Preparing BEA WebLogic, page 30• Preparing IBM WebSphere, page 30• Preparing Oracle Application Server, page 33• Preparing Sun Java System Application Server, page 33• Preparing to use an external web server, page 35• Installing the Site Caching Services target software, page 36EMC Documentum does not provide support for installing or running application servers. Refer tothe documentation for each application server for instructions on installing, stopping, starting, andrunning the application server. Contact the application server vendor for technical support.


Preparing the Application Server Host

Setting the Java memory allocationThe minimum recommended Sun Java memory allocation values for application serverson a small system are the following:Xms1024m Xmx1024m

Application servers can slow down, throw exceptions, or crash with an applicationthat has a large number of Java Server Pages. Set the MaxPermSize parameter to 128or higher to avoid this problem.

Document caching can consume at least 80 MB of memory. User session caching canconsume approximately 2.5 MB to 3 MB per user. Fifty connected users can consumeover 200 MB of VM memory on the application server. Increase the values to meet thedemands of the expected user load.

To achieve better performance, add these parameters to the application server startupcommand line:serverXX:+UseParallelOldGC

server must be the first parameter on the command line.

Performance will improve because the Java client VM is not suitable for long runningserver jobs and the default Java garbage collector cannot clean up the heap quicklyenough—especially when the application server machine runs on multiple CPUs.

For more information on these settings, refer to Java documentation at the Sun web site(http://java.sun.com). More information on application server performance tuning andbenchmarking for Documentum products is available from your EMC Documentum SEor EMC Documentum Consulting.

Turning off failoverIf your application server and environment combination does not support failover,you can turn off failover in app.xml. Refer to your product release notes to determinewhether failover is supported for your environment.

If you do not turn off failover, you may see failover validation messages in the applicationserver log, but these should not interfere with operations. Do not attempt to use theapplication in a failover environment that is not certified.

To turn off failover for the application, open app.xml in the custom directory and add thefollowing element:<failover><enabled>false</enabled>

</failover>



Preparing environment variables fornondefault DFC locations

The base location for content transfer on the application server host is specified bythe DFC environment variable dfc.data.dir. This location is specified as the valueof the key dfc.data.dir in dfc.properties located within the application WAR file inWEB‑INF/classes. If this variable is not set in the environment for the applicationserver, the default location is the documentum subdirectory of the current workingdirectory. (The current working directory contains the application server executable.)For example, in Tomcat the location is %CATALINA_HOME%/bin. On WebLogic, it is%BEA_HOME%/domains/wl_server/documentum.

By default, the checkout and export directories are subdirectories of the dfc.data.dirdirectory, and the user directory is the same as dfc.data.dir. If you wish to usenon‑default locations for these, you can create environment variables for dfc.checkout.dir,dfc.export.dir, and dfc.user.dir, respectively. The default value of dfc.registry.mode,which corresponds to the key dfc.registry.mode in dfc.properties, is ʺfileʺ. The full pathto this file by default is dfc.user.dir/documentum.ini. For a non‑default file name orlocation, specify it as the value of the environment variable dfc.registry.file.

Preparing JBoss and Apache TomcatPlease refer to your product release notes to determine whether JBoss or Apache Tomcatis a supported application server for your product.

You must disable tag reuse in JBoss and Apache Tomcat in the web.xml file of theTomcat /conf directory. Find the JSP servlet entry in web.xml. Add the enablePoolinginitialization parameter and set it to false:<servlet><servletname>jsp</servletname><servletclass>org.apache.jasper.servlet.JspServlet</servletclass><initparam><paramname>enablePooling</paramname><paramvalue>false</paramvalue>

</initparam><initparam><paramname>fork</paramname><paramvalue>false</paramvalue>

</initparam><initparam><paramname>xpoweredBy</paramname><paramvalue>false</paramvalue>

</initparam><loadonstartup>3</loadonstartup>

</servlet>



Preparing BEA WebLogicPlease refer to your product release notes to determine whether BEA WebLogic is asupported application server for your product.

The following topic describes preparations that may be necessary before you deploy aWDK‑based application.

Supporting large content transfer operations in amanaged server environment

If you are deploying in a WebLogic Managed Server environment and you use UCF toperform large content operations, set the WLIOTimeoutSecs parameter for the webserver plugin to a very large value. UCF requires a sticky session for a single operation.For additional details, refer to BEA’s documentation on Web Serve Plug‑ins parameters.

Preparing IBM WebSpherePlease refer to your product release notes to determine whether IBM WebSphere is asupported application server for your product.

The following topics describe how to prepare the application server to support failoverin a cluster, to apply policies for Java 2 security, and to support non‑default contenttransfer locations. Refer to your product release notes to determine whether failover issupported for your application.

Supporting failover in a cluster

Failover in a clustered environment requires a setting. Set the NoAffinitySwitchBackcustom property to true in the WAS cluster. For more information on this setting, refer tothe WebSphere documentation.

Applying policies for WebSphere security

If WebSphere global security is enabled for the application server, by default it enablesJava 2 security. Java 2 security requires security policies. You must apply the policies in



the Documentum files app.policy, library.policy and was.policy. These files are providedby EMC Documentum on the download site in the compressed archive PolicyFiles.zip.These files contain the minimum set of policies that are required for the application torun without error. Add these policies to your existing files.

You must set up the environment variables that are referenced in these policies, and theapplication server instance owner must have write permission on these directories.Define the following environment variables:• dfc.data.dir

By default, the dfc.data.dir directory is the Documentum subdirectory of thedirectory that contains the application server executable.

• webtop.content.xfer

Specifies the temporary content transfer directory on the application server.Must match the value in app.xml of the element <contentxfer>.<server>.<contentlocationwindows> or <contentlocationunix>.

The policy files in PolicyFiles.zip contain the minimum required policies for thedfc.data.dir directory. To add additional policies for non‑default content transferlocations, add the following lines to library.policy. For each policy that you add, set upan environment variable that specifies the non‑default location.

Tip: Select only the policies that are needed for your application.

Policy for local user directory (non‑default location) — This policy is required if theuser directory for the application server host machine is a non‑default location. Thedefault location is the same as the location specified by the dfc.properties key dfc.data.dir.permission java.io.FilePermission "$dfc.user$/", "read, write, delete";permission java.io.FilePermission "$dfc.user", "read, write, delete";

Policy for checkout and export directories (non‑default location) — Theseenvironment variables must specify the same location as the value of the dfc.propertieskeys dfc.checkout.dir and dfc.export.dir. The default locations for these directories arecheckout and export subdirectories of dfc.data.dir.permission java.io.FilePermission "$dfc.checkout$/", "read, write,delete";permission java.io.FilePermission "$dfc.checkout", "read, write, delete";

permission java.io.FilePermission "$dfc.export$/", "read, write,delete";permission java.io.FilePermission "$dfc.export", "read, write, delete";

Policy for DFC registry file (non‑default location) — The value of the dfc.registryenvironment variable must match the location specified in dfc.properties for the keydfc.registry.file.permission java.io.FilePermission "$dfc.registry$/", "read, write,delete";



permission java.io.FilePermission "$dfc.registry", "read, write,delete";

Policy for Webtop temporary content transfer directory (non‑default location) —permission java.io.FilePermission "$webtop.content.xfer$/", "read,write, delete";

permission java.io.FilePermission "$webtop.content.xfer", "read,write, delete";

Policy for non‑Webtop WDK‑based temporary content transfer (non‑defaultlocation) — You can use this policy for TaskSpace or other application that is notbased on Webtop:permission java.io.FilePermission "$wdk.content.xfer$/", "read,write, delete";permission java.io.FilePermission "$wdk.content.xfer", "read,write, delete";

Policy for documentum applications directory (non‑default location) — The defaultlocation is dfc.data.dir.permission java.io.FilePermission "$documentum$/", "read,write, delete";permission java.io.FilePermission "$documentum", "read, write,delete";

Policy for DFC class cache directory (non‑default location) — The default location isdfc.data.dir/cache.permission java.io.FilePermission "$dfc.cache.dir$/", "read,write, delete";permission java.io.FilePermission "$dfc.cache.dir", "read,write, delete";

Policy for Web Publisher —permission java.io.FilePermission "$wp.content.xfer$/", "read,write, delete";permission java.io.FilePermission "$wp.content.xfer", "read,write, delete";

Policy for Documentum Administrator —permission java.io.FilePermission "$da.content.xfer$/", "read,write, delete";permission java.io.FilePermission "$da.content.xfer", "read,write, delete";

Policy for Digital Asset Manager —permission java.io.FilePermission "$dam.content.xfer$/", "read,write, delete";permission java.io.FilePermission "$dam.content.xfer", "read,write, delete";



Policy for Content Intelligence Services —permission java.io.FilePermission "$cis.content.xfer$/", "read,write, delete";permission java.io.FilePermission "$cis.content.xfer", "read,write, delete";

Preparing Oracle Application ServerPlease refer to your product release notes to determine whether Oracle ApplicationServer is a supported application server for your product.

You must disable tag reuse for the application server.

To disable tag pooling for the application:

1. Open orion‑web.xml.

2. Change the default value of the <init‑param> tags_reuse_default from compiletimeto the value none as shown in the following example:<servlet><servletname>jsp</servletname><servletclass>oracle.jsp.runtimev2.JspServlet</servletclass><initparam><paramname>tags_reuse_default</paramname><paramvalue>none</paramvalue>

</initparam></servlet>

To disable tag pooling for all applications:

1. Open global‑web‑application.xml in < ORACLE_HOME >\j2ee\home\config

2. Add the following init‑param in the <servlet> element:<servlet><initparam><paramname>tags_reuse_default</paramname><paramvalue>none</paramvalue>

</initparam></servlet>

Preparing Sun Java System Application ServerPlease refer to your product release notes to determine whether Sun Java SystemApplication Server is a supported application server for your product.

The following topics describe preparations to deploy a WDK‑based application.



Turning off tag pooling

You must turn off tag pooling for the domain in which you deploy WDK‑basedapplications. For the domain in which you will deploy the application, opendefault‑web.xml, for example, install path/domains/domain1/config/default‑web.xml.Add the <init‑param> to the jsp servlet declaration as follows:<servlet><servletname>jsp</servletname><servletclass>org.apache.jasper.servlet.JspServl<initparam><paramname>xpoweredBy</paramname><paramvalue>true</paramvalue>

</initparam><initparam>

<paramname>enablePooling</paramname><paramvalue>false</paramvalue>

</initparam><loadonstartup>3</loadonstartup>

</servlet>

Modifying the Sun policy file

You must modify the server.policy file located in the server instance /config directoryto add permissions for DFC location variables. Add the following policies if they arenot already present in your file:grantpermission java.util.PropertyPermission "*", "read,write";permission java.io.FilePermission "$user.home/", "read, write, delete";permission java.io.FilePermission "/tmp/", "read, write, delete";permission java.io.FilePermission "$java.io.tmpdir/", "read, write,delete";permission java.io.FilePermission "$instance.config.dir/", "read, write,delete";permission java.lang.RuntimePermission "createClassLoader";permission java.net.SocketPermission "*", "connect,accept";permission java.lang.RuntimePermission "getProtectionDomain";permission java.lang.RuntimePermission "shutdownHooks";permission java.lang.reflect.ReflectPermission "*";permission java.security.AllPermission;;

Replace the following variable in these policies or create an environment variable for itso that it can be resolved:• $(instance.config.dir): The instance configuration directory, example:

/var/opt/SUNWappserver7/domains/domain1/server1/config/



Turning off failover

The Sun application server does not support failover. You must turn it off in the app.xmlfile located in the custom directory. Add the following lines to custom/app.xml:<failover><filter clientenv='portal'><enabled>false</enabled>

</filter><filter clientenv='not portal'><enabled>false</enabled>

</filter></failover>

Preparing to use an external web serverPlease refer to your product release notes to determine whether external web serversare supported for your product.

External web servers are sometimes used as a front end to the application server. Forexample, an external web server may be used for balancing the loads on a collection ofapplication servers or used as a forward or reverse proxy server.

UCF content transfer uses chunked transfer encoding, a standard of the HTTP 1.1specification. Many proxy web servers such as the Sun server implement chunkedtransfer encoding in a way that does not work properly with UCF. If the externalserver does not support HTTP 1.1 chunked encoding, you must configure UCF in theWDK‑based application to use an alternative chunked encoding. TheWeb DevelopmentKit Development Guide contains information on this configuration.

If you are deploying in a manager server or network deployment environment, theexternal web server must provide session affinity support.



Installing the Site Caching Services targetsoftware

If you are running Web Publisher, install the Documentum Site Caching Services (SCS)target software on the host to which documents are published from the repository. Forinformation on installing SCS, refer to the Site Caching Services Installation Guide.


Chapter 5Upgrading a WDKBased Application

This chapter contains instructions that are shared by all WDK‑based products. Check your releasenotes for information on the application servers, browsers, and other software that are certified foryour product. Review this chapter and perform the tasks described in it before upgrading a WDKapplication. Customization of Documentum Administrator is not supported.

Table 1, page 37 shows the files, directories, and subdirectories on the application server host thatshould be backed up.

Table 1. Directories and files to back up

Directory/file To back up if present

custom/app.xml app.xml

custom subdirectories JSP files

custom/config XML files

custom/strings Properties files

custom/theme subdirectories Branding files

WEB‑INF/classes subdirectories Custom classes

custom/src subdirectories Custom source files

WEB‑INF/tlds Custom tag libraries

WEB‑INF/classes/com/documentum/web/formext/session

Back up AuthenticationSchemes.properties,KeystoreCredentials.properties, andTrustedAuthenticatorCredentials.properties ifcustomized


Upgrading a WDKBased Application

After upgrading, recompile your custom classes to ensure that the custom code still works. Addyour backed up files to the new application for testing. For information about migration, refer toDocumentum 6.5 System Upgrade and Migration Guide.


Chapter 6Deploying Web Publisher

After you complete the required predeployment tasks, deploy Web Publisher on the applicationserver host.

The following topics describe how to deploy the application:• Preparing the WAR file for deployment, page 39• Enabling DFC connections to repositories, page 40• Enabling DFC memory optimization, page 42• Enabling preferences repositories, page 42• Enabling retention of folder structure and objects on export, page 43• Enabling modal pop‑up windows, page 43• Enabling external searches, page 44• Deploying multiple applications, page 45

Note: Presets do not apply to Web Publisher.

Preparing the WAR file for deploymentPerform the following procedure to prepare the WDK‑based application WAR file.

To deploy a WDKbased application:

1. Download the WDK application WAR file from the EMC download site to atemporary directory on the application server host.

2. Unpack the WAR file and modify the dfc.properties file following the instructions inEnabling DFC connections to repositories, page 40. You must perform this procedurebefore attempting to connect to Documentum repositories.

3. Enable the optional presets and preferences repositories in dfc.properties followingthe instructions in Enabling preferences repositories, page 42.


https://emc.subscribenet.com

Deploying Web Publisher

4. Add or migrate customizations from previous WDK‑based applications.

5. Apply language packs if you have purchased them.

6. Make any UCF configuration changes that your applications needs before deploying.Refer to theWDK Development Guide for details.

7. Re‑archive the WAR file.

8. Deploy the WAR file according to the deployment instructions in your applicationserver documentation.

Enabling DFC connections to repositoriesYou must provide connection broker and global registry values in dfc.properties beforeyour application can connect to repositories.

A global registry of Content Server version 6.x is required for WDK‑based applications.The global registry is a central repository that serves several purposes:• Deploys service‑based business objects (SBOs)• Stores network location objects• Stores application presets, unless another repository is configured in app.xml• Stores persistent user preferences, unless another repository is configured in app.xmlThe Content Server Installation Guide contains information about enabling a repositoryas a global registry.

You can copy information from the dfc.properties file that was generated by the ContentServer installer on your global registry host. The generated dfc.properties file containsthe connection broker address and the encrypted global registry user login information.

To use the dfc.properties file information from the global registry ContentServer repository:

1. On the global registry repository host, locate the Content Server installation directory.On Windows hosts, the default installation directory is C:\Documentum. On UNIXhosts, this directory is specified by the environment variable $DOCUMENTUM.

2. Open the file dfc.properties that is located in the config subdirectory.

3. Copy the following keys and their values from the file:dfc.docbroker.host[0]=addressdfc.globalregistry.repository=repository_namedfc.globalregistry.username=usernamedfc.globalregistry.password=encrypted_password

4. Unpack the application WAR file.



5. Open the dfc.properties file located in WEB‑INF/classes within this expanded WARfile directory.

6. Paste in the values that you copied from the global registry dfc.properties.

7. Use a text editor to configure additional properties in this file or make any changesto it.

8. Save the dfc.properties file and deploy the application.

Note: If you create a new WAR file from this application directory, you mustensure that any paths that you specify in dfc.properties are valid directories onthe application server and that the application server instance owner has writepermission on the specified directories.

To configure connections in dfc.properties before deployment:

1. Unpack the application WAR file.

2. Open the file dfc.properties in WEB‑INF/classes.

3. Add the fully qualified hostname for the docbroker to the following key. You canadd backup hosts by incrementing the index number within brackets.dfc.docbroker.host[0]=host_name

4. If you wish to use a port for the docbroker other than the default of 1489, add aport key to dfc.properties:dfc.docbroker.port=port_number

5. Add the global registry repository name to the following key:dfc.globalregistry.repository=repository_name

6. Add the username of the dm_bof_registry user to the following key:dfc.globalregistry.username=dm_bof_registry_user_name

The global registry user, who has the username of dm_bof_registry, has read accessto objects in the /System/Modules and /System/NetworkLocations only.

7. Add an encrypted password value for the following key:dfc.globalregistry.password=encrypted_password

You can either copy the username and encrypted password from the dfc.propertiesfile on the global registry Content Server host, or you can select another globalregistry user and encrypt the password using the following command from acommand prompt (assumes the directory containing javaw.exe is on the systempath):java cp dfc.jar com.documentum.fc.tools.RegistryPasswordUtilspassword_to_be_encrypted



Enabling DFC memory optimizationThe DFC diagnostics are set to true by default. To free up memory resources, setdfc.diagnostics.resources.enable in dfc.properties. Refer to Enabling DFC connectionsto repositories, page 40 for the procedure of unpacking the war file and modifyingdfc.properties. Add the following line to your dfc.properties file:dfc.diagnostics.resources.enable=false

Enabling preferences repositoriesBy default, persistent preferences are stored in the global repository. For betterperformance, you can configure your application to use different repositories forpersistent preferences.

Add your preferences repository settings to app.xml in the /custom directory of theapplication. Copy the entire <preferencesrepository> element from /wp/app.xml into/custom/app.xml and then specify your repository. For information on other preferencessettings in app.xml, refer to theWeb Publisher Development Guide.

Table 2. Preferences configuration elements

Element Description

<preferencesrepository> Contains a <repository> element. If thiselement is not present, user preferencesare stored in the global repository, whichcan slow down performance.

.<repository_path> Specifies the path within the preferencerepository in which to store preferences.If the path does not exist at applicationstartup, it will be created.

.<repository> Specifies the repository in which to storepreferences, preferably not the globalrepository.



Enabling retention of folder structure andobjects on export

Caution: If your users will be exporting folders with special characters (\/:*?"<>|)in its name, you should not turn this feature on. When a folder with a namecontaining a special character is encountered during export, an error occurs andthe export fails.

To enable retaining the same folder structure (as the one in the repository) and thecontained objects on the local file system when the parent folder is exported, add thefollowing element to your app.xml in the custom directory:<deepexport>

<enabled>true</enabled></deepexport>

The default is false.

Enabling modal popup windowsThe modal pop‑up window is a secondary browser pop‑up window with no browsercontrols either to maximize or minimize the window. This pop‑up window appearscentered in the screen. The pop‑up window provides a similar experience on the webas in desktop, where you can interact with a component in a pop‑up window. Theuser interface for the component appears in a pop‑up window (child window) on topof the parent window. If you invoke another component from the child window, theuser interface of the component appears on top of the child window and thus stackedone over the other pop‑up windows. You cannot access the parent window until youclose all the pop‑up windows.

The modal pop‑up window is supported only on Internet Explorer browser environment.The pop‑up window is not 508–compliant and hence it is not supported when 508accessibility features are turned on through the User Preferences.

In the wdk/app.xml file, <modalpopup> enables and disables the modal pop‑up feature.

Table 3, page 44 describes the elements that configure modal windows in app.xml:



Table 3. Modal window elements in app.xml (<modalpopup>)

Element Description

<enabled> Turns on or off modal windows in theapplication. Valid values: true | false.Default is true.

<actioninvocationpostprocessors> List of action invocation post processorsspecified in <postprocessor> elements.

<postprocessor> Specifies a post processor. The syntax is:

<postprocessor id="uniqueId"

action="yourAction"

class=

"YourActionInvocationPostProcessor"/>

where uniqueId is an application‑wideunique string identifier for the postprocessor; yourAction (optional)is the name of the action; andYourActionInvocationPostProcessor

is the post processor’s fully qualified Javaclass.

Enabling external searchesTo allow users to search external sources, an administrator must configure a connectionto an ECI Services server. (The ECI Services server is a separate product that is purchasedseparately fromWebtop and Content Server.) If this connection has not been configured,you cannot include external sources in your search.

Configuring the connection to the search server

The following procedure describes how to enable the ECI Services server to queryexternal sources. The ECI Services documentation provides more information about howto configure the ECI Services server itself.

To configure the connection to an ECI Services server:

1. Unpack the client application WAR file.

2. Open the file dfc.properties in WEB‑INF/classes.



3. Enable the ECI Services server by setting the following:dfc.search.ecis.enable=true

4. Specify the RMI Registry host for the ECI Services server by setting the following:dfc.search.ecis.host=host_IPdfc.search.ecis.port=portWhere• host_IP is IP address or machine name of the ECI Server.• port is the port number that accesses the ECI server. The default port is 3005.

Configuring the connection to the backup search server

You can set a backup server in case the primary ECI Services server is unreachable. If aDFC‑application cannot connect to the primary ECI Services server to query externalsources, the backup server is contacted. You can define the time period after which theapplication will try to connect again to the primary server. To define the backup server,specify the RMI host and port in the dfc.properties file:• dfc.search.ecis.backup.host : host of the backup ECI Services server. Default value

is: localhost.• dfc.search.ecis.backup.port : port of the backup ECI Services server. Default value

is: 3005.• dfc.search.ecis.retry.period : waiting period before retrying to connect to the

primary ECI Services server. This time is in milliseconds. Default value is: 300000.

Deploying multiple applicationsTwo or more WDK‑based applications of version 6.x can share the same applicationserver instance if they are version 6 or higher.


Chapter 7Completing the Deployment

After you deploy aWDK application, there are additional procedures that you may need to perform inorder to finish and verify the deployment. These procedures are described in the following sections:• Configuring UCF, page 47• Configuring IBM WebSphere after deployment, page 48• Deploying default virtual link support, page 49• Enabling additional locales in the repository, page 49• Installing the Web Publisher server files and DAR files, page 50• Installing DAM DAR files, page 73• Additional Accelera DAR file tasks, page 61• Using eWebEditPro, page 76• Installing iMarkup, page 79• Completing the Web Publisher Portlet Builder installation process, page 82• Completing the Web Publisher Page Builder installation process, page 83• Accessing the application, page 87• Testing WDK samples, page 87• Uninstalling the Web Publisher server files, page 88

Configuring UCFTheWeb Development Kit Development Guide contains the following procedures:• How to configure different content transfer mechanisms (UCF or HTTP) for roles.• How to configure the UCF client content transfer directories, including client path

substitution.• How to support self‑signed or unsigned SSL certificates.


Completing the Deployment

• How to configure the UCF server for forward and reverse proxy servers andalternative chunking.

Note: The web server associated with an application server must support chunkedrequests. The web server forwards HTTP requests using chunked transfer encoding,as described in the HTTP/1.1 protocol, to the back‑end application server. If chunkedrequests are not supported then the client should use UCF alternative chunkingmode.

Configuring IBM WebSphere after deploymentTo complete the deployment, perform the following procedures.

Changing the classloader and compiler settings

Change the classloader setting for the WDK‑based application module in WebSphere,in theManage Modules section of the administration console. Select the WAR file andfor Classloader order choose Classes loaded with application class loader first, thenclick Save.

Set the JSP compiler option to useJDKCompiler to true and the source level to 1.5 (JRE 5)in the configuration file ibm‑web‑ext.xmi under the application deployment directory,for example:WAS_INSTALL/AppServer/profiles/AppSrv01/config/cells/host_name/Node01Cell/applications/webtop_war.ear/deployments/webtop/webtop_war/webtop.war/WEBINF/ibmwebext.xmi

Configure the settings as follows:<jspAttributes xmi:id="JSPAttribute_1178213473751"name="jdkSourceLevel" value="15"/>

<jspAttributes xmi:id="JSPAttribute_3" name="useJDKCompiler"value="true"/>

Setting com.ibm.ws.webcontainer.invokefilterscompatibility to true

You must add the webcontainer com.ibm.ws.webcontainer.invokefilterscompatibilitycustom property and set it to true using the Websphere Admin console; otherwise, errorswill occur when you attempt to access the Webtop URL. For more information aboutsetting webcontainer custom properties, see Setting webcontainer custom properties.


http://www-1.ibm.com/support/docview.wss?rss=180<?Pub & EntityName=amp>uid=swg21284395


Deploying default virtual link supportA virtual link is a URL that resolves to a document in a repository. The virtual link URLcontains the repository name, folder path, and object name of the content to be accessed.All WDK‑based applications support virtual links in the following form:http(s)://server:port/appname/repositoryname:/folderpath/.../objectname

You can install default virtual link support for URLs that do not contain the webapplication names. These links will be redirected to the current application. Defaultvirtual links URLs have the following form:http(s)://server:port/repositoryname:/folderpath/.../objectnamehttp(s)://server:port/RightSite/repositoryname:/folderpath/.../objectnamehttp(s)://server:port/rsbin/RightSite.dll//folderpath/.../objectname

To install default virtual link support:

1. Deploy the vlink.war file as the root web application on the application server.Some application servers have an existing root web application which you mustreplace with the default virtual link application. Others require you to create a rootweb application manually or during application server installation. Refer to thedocumentation for the application server for information on a root web application.

2. Deploy the virtual link war file (vlink.war or ROOT.war) to the application serverby using the mechanism recommended by the application server for deploying adefault web application.

3. Modify the DefaultWdkAppName param‑value in the web.xml of the virtual linkWAR file. This parameter value specifies the WDK‑based application that willhandle the virtual link request if there is no current repository session for the user. Ifyou do not specify a parameter value, it will default to webtop.On Weblogic, add the following line to weblogic.xml file or use the weblogic.xml filethat is bundled with vlink.war:<contextroot>/</contextroot>

For more information on virtual links, refer to theWeb Development Kit Development Guide.

Enabling additional locales in the repositoryDocumentum repositories are created with support for the language of the operatingsystem of the host computer on which the repository is installed. For example, if theoperating system is Japanese, the repository contains Documentum object type andattribute names for the Japanese locale. This information is stored in the data dictionary.You can add support to the repository for additional locales.



The Web Publisher DAR file installs data dictionary information for all locales enabledin the repository, including user interface labels in the languages installed. Beforeyou install the Web Publisher DAR file, update the list of supported locales in therepository configuration with any additional locales you need supported. For example,if a particular repository was created with only the English locale enabled and youneed support for the French and German locales, use the procedure that follows toenable French. When you install the Web Publisher DAR file, the data dictionary isautomatically updated with French and German information.

The following locales are supported:• English (en)• French (fr)• German (de)• Italian (it)• Japanese (ja)• Korean (ko)• Simplified Chinese (zh)• Spanish (es)• Swedish (sv)To add locale support, you populate the data dictionary. Use the instructions inAppendix E of the Content Server Administration Guide to add the locales you need.During installation of the Web Publisher DAR file, the data dictionary is automaticallyupdated with the correct Web Publisher labels in the additional locales.

Installing the Web Publisher server files andDAR files

Completing the installation of Web Publisher requires installing the Web Publisherserver files on the Content Server host and installing the Web Publisher DAR file inall Web Publisher repositories.

If you are installingWeb Publisher on a UNIX Content Server host, ensure that the correctenvironment 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 DAR file are installed using a separateinstaller called the Documentum Web Publisher Server Files Installer. The optionalWcmPostReplication DAR and Accelera DAR are also included in the server filesinstaller. Run this installer on the Content Server host. The repository where you areinstalling a DAR file must be running when the DAR file is installed. In a multiserverenvironment, run the installer on the primary Content Server host.



For details about the WcmPostReplication DAR file, see Enhanced support formulti‑repository configurations, page 61. Additional tasks are associated with theAccelera DAR, including preinstallation tasks; see Additional Accelera DAR file tasks,page 61 for details.

Note: There are additional DAR files relating to Web Publisher that are not included inthe server files installer. Consult the following sections for information about theseadditional DAR files, which need to be deployed separately:• Installing DAM DAR files, page 73• Completing the Web Publisher Portlet Builder installation process, page 82• Completing the Web Publisher Page Builder installation process, page 83On Windows Content Server hosts, the DAR file is installed automatically by acommand‑line version of Documentum Composer, known as headless Composer.Headless Composer is embedded in Content Server 6.5 and is installed atC:\Documentum\WebPublisher\6.5\install\composer\composer\ComposerHeadless.This version of Composer should not be used for any other tasks, however; if you areinstalling DAR files manually (for Page Builder installations, for example), you mustobtain the headless Composer installer from the Download Center and install it on theContent Server host. Likewise, if you are using Web Publisher with an earlier versionof Content Server, download and install headless Composer before continuing withthese procedures.

On a UNIX or Linux host, the server files installer places the Web Publisher DAR file onthe Content Server host, but the installer cannot install the DAR file into the repository.You must transfer the DAR file to a Windows host and use Documentum Composer toinstall the DAR file.

If you transfer the DAR file, do not change the name of the archive (WebPublisher, withno spaces and two capital letters) and do not transfer it to a directory where there arespaces in the path name.

Documentum recommends that you install the server files and DAR file as the ContentServer installation owner. The user installing Web Publisher server files must have Writeaccess to the directory from which the installer is executed.

The server file installer creates DAR file log files that are displayed after the DAR fileinstallation is complete. Create a backup of the log files to track any changes you make tothe DAR files. Log files can be used as a reference for DAR file installation.

The log files are saved in $DOCUMENTUM/dba/config/repository_name on (UNIXor Linux) or %DOCUMENTUM%\dba\config\repository_name on Windows in thefollowing folders:• WebPublisher_WebPublisher for the mandatory Web Publisher DAR• WebPublisher_WcmPostReplication for the optional WcmPostReplication DAR• WebPublisher_AcceleraDemo for the optional Accelera DAR



Caution: Installing a new Web Publisher DAR file overwrites existing WebPublisher objects. Document any customizations to the objects and recreate thecustomizations after the upgrade. For additional information about customizations,refer to theWeb Publisher Development Guide and the Documentum System Upgradeand Migration Guide.

Where the DAR file and server files are installed

The tables that follow contain the installation locations of the server files andWeb Publisher DAR file on UNIX and Windows hosts. $DM_HOME (UNIX)or %DM_HOME% (Windows) is the Content Server installation directory.$DOCUMENTUM_SHARED (UNIX) or C:\Documentum (Windows) is the DFCprogram root directory. For more information on environment variables on the ContentServer host, refer to the Content Server Installation Guide.

Table 4. Location of DAR files and Web Publisher server files on UNIX hosts

FilesInstallation locationon Java Method Server Description

wcm‑api.jarWcmMethods.jarwcm‑utils.jar

$DOCUMENTUM_SHARED/jboss4.2.0/server/DctmServer_MethodServer/deploy/ServerApps.ear/DmMethods.war/WEB‑INF/lib

Web Publisher job andmethod Java classes

Web Publisher $DM_HOME/install/DARs/WebPublisher

DAR file archivefolders

$DM_HOME/bin/webPublisher /install

DAR file Installer files;for internal use only.

Accelera $DM_HOME/ install/DARs/AcceleraDemo

Accelera demo DARfiles

WcmDQL.propertiesWcmTraceProp.propertiesWcmApplicationConfig.propertieslog4j.propertiesdbor.properties

$DOCUMENTUM_SHARED/jboss4.2.0/server/DctmServer_MethodServer/deploy/ServerApps.ear/DmMethods.war/WEB‑INF/classes

Properties files used byWeb Publisher to log ortrace the application.




ServerApps.log $DOCUMENTUM_SHARED/ jboss4.2.0/server/DctmServer_MethodServer<servername>/logs

If tracing isenabled throughlog4j.properties andWcmTraceProp.properties propertiesfile, then log filesare created in thisdirectory.

dm_wp_sender.ebsdm_wp_mailwrapper.shdm_wp_sender_41.ebsWcmMethodsResource.properties

$DM_HOME/bin Docbasic scripts foremail notificationsand properties file forEngagement Serverintegration.dm_wp_sender_41.ebsmay be in this directoryfrom an old installationon a 4.1 Content Server.dm_wp_mailwrapper.shenables Web Publisherto send HTML mailnotifications.

data_dictionary_wcm.inidata_dictionary_wcm_de_DE.txtdata_dictionary_wcm_en.txtdata_dictionary_wcm_es_ES.txtdata_dictionary_wcm_fr_FR.txtdata_dictionary_wcm_it_IT.txtdata_dictionary_wcm_ja_JP.txtdata_dictionary_wcm_ko_KR.txtdata_dictionary_wcm_sv_SE.txtdata_dictionary_wcm_zh_CN.txtdatadictionaryoutput.txtdd_populate_wcm.batdd_populate_wcm.sh

$DM_HOME/bin/webPublisher/Utils/DataDictionary

Web Publisher datadictionary files

wcmAttachLifecycle.ebswcmConfigure.ebswcmLifecyclePostProcedure.ebswcmMethodServerUpdate.ebswcmMethodStandaloneUpdate.ebs

$DM_HOME/bin/webPublisher/Utils

Utility files usedfor reconfiguring ordebugging repositoryoperations.




wcmMigration.ebswcmPostConfigure.ebswcmUpdate.ebs

Table 5. Location of DAR files and Web Publisher server files on Windows hosts

FilesInstallation location onJava Method Server Description

wcm‑api.jarWcmMethods.jarwcm‑utils.jar

C:\Documen‑tum\jboss4.2.0\server\Dctm‑Server_Method‑Server\deploy\Server‑Apps.ear\DmMeth‑ods.war\WEB‑INF\lib

Web Publisher job andmethod Java classes.

Web Publisher %DM_HOME%\in‑stall\DARs\WebPub‑lisher

DAR file archivefolders.

%DM_HOME%\bin\webPub‑lisher\install

DAR file Installerfiles; for internal useonly.

Accelera %DM_HOME%\in‑stall\DARs\Acceler‑aDemo

Accelera demo DARfiles

WcmDQL.propertiesWcmTraceProp.propertiesWcmApplicationConfig.propertieslog4j.propertiesdbor.properties

C:\Documen‑tum\jboss4.2.0\server\Dctm‑Server_ Method‑Server\deploy\Server‑Apps.ear\DmMethods.war\WEB‑INF\classes

Properties files usedby Web Publisherto log or trace theapplication.

ServerApps.log C:\Documen‑tum\jboss4.2.0\server\DctmServer_MethodServer<servername>\logs

If tracing isenabled throughlog4j.propertiesand WcmTraceProp.properties propertiesfile, then log filesare created in thisdirectory.



FilesInstallation location onJava Method Server Description

dm_wp_sender.ebsdm_wp_mailwrapper.shdm_wp_sender_41.ebsWcmMethodsResource.properties

%DM_HOME%\bin Docbasic scripts foremail notificationsand properties file forEngagement Serverintegration.dm_wp_sender_41.ebs may be in thisdirectory from an oldinstallation on a 4.1Content Server.dm_wp_mailwrapper.shenables WebPublisher tosend HTML mailnotifications.

data_dictionary_wcm.inidata_dictionary_wcm_de_DE.txtdata_dictionary_wcm_en.txtdata_dictionary_wcm_es_ES.txtdata_dictionary_wcm_fr_FR.txtdata_dictionary_wcm_it_IT.txtdata_dictionary_wcm_ja_JP.txtdata_dictionary_wcm_ko_KR.txtdata_dictionary_wcm_sv_SE.txtdata_dictionary_wcm_zh_CN.txtdatadictionaryoutput.txtdd_populate_wcm.batdd_populate_wcm.sh

%DM_HOME%\bin\webPublisher\Utils\DataDictionary

Web Publisher datadictionary files.

wcmAttachLifecycle.ebswcmConfigure.ebswcmLifecyclePostProcedure.ebswcmMethodServerUpdate.ebswcmMethodStandaloneUpdate.ebswcmMigration.ebswcmPostConfigure.ebswcmUpdate.ebs

%DM_HOME%\bin\webPub‑lisher\Utils

Utility files usedfor reconfiguring ordebugging repositoryoperations



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 Javamethod server. The Java methods contain classes that are invoked by automatic activitiesin the default Web Publisher workflow. The classes change permissions and execute jobsas required. For more information on Java methods and the Java method server, refer tothe Content Server Administration Guide and the Content Server Installation Guide.

The wcm.jar and WcmMethods.jar files are installed to the shared directory. OnWindows, this is C:\Program Files\Documentum\Shared. On UNIX or Linux, thisis $DOCUMENTUM_SHARED.

About the Web Publisher DAR file

To install the Web Publisher DAR file, you must have Superuser privileges in therepository.

Installing the Web Publisher DAR file provides support for the English, German,French, Italian, Simplified Chinese, Spanish, Swedish, Korean, and Japanese languagesby installing data dictionary information for Web Publisher type and attribute labels,provided you created the data dictionary locales in the repository before the DAR fileis installed. Installing the DAR file also adds objects to the repository that are requiredby Web Publisher:• Cabinets• Folders• Object types• Lifecycles• Workflow templates• Permission set templates• Alias sets• Jobs• Methods• ProceduresAdditionally, installing the Web Publisher DAR file:• 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

— wcm_content_manager_role

— wcm_content_author_role• Creates the Web Publisher User Default ACL

Installing the DAR files and server files on Windowshosts

After you add any required locales to the repository, install the Web Publisher serverfiles and DAR files. (To add required locales to the repository, use the procedure inEnabling additional locales in the repository, page 49.) The Web Publisher DAR fileinstalls the data dictionary information for the locales to the repository. The installer(WPServerWinSetup.exe) invokes an embedded instance of Documentum Composer thatruns in command‑line mode, also referred to as Headless Composer.

Caution: The user installing Web Publisher server files must have Write access tothe directory from which the installer is executed.

To install the Web Publisher server files and DAR files 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 temporarydirectory on the Content Server host.

3. In the temporary directory, double‑click WPServerWinSetup.exe.TheWelcome dialog box is displayed.

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:\ProgramFiles\Documentum\Shared. The %DM_HOME%\bin\webpublisher folder iscreated. The %DOCUMENTUM%\dctm.jar file is modified.

7. Select a repository in which to install the Web Publisher DAR file.

8. Enter the user name and password of the Content Server installation owner, thenclick Next.The installer verifies that the repository is running and verifies that you are theContent Server installation owner.

9. Select the Web Publisher DAR file and, optionally, either or both of the Accelera andWcmPostReplication DAR files, then click Next.Installing the Web Publisher DAR file is required. Installing the Accelera DAR file isoptional, but if you intend to install both DAR files in a particular repository, it isstrongly recommended that you do so at the same time. The WcmPostReplicationDAR file is also optional; it provides a Content Server method and jobs for managingWeb Publisher in multi‑repository configurations. For more information on theWcmPostReplication DAR file, refer to Enhanced support for multi‑repositoryconfigurations, page 61.The DAR files are installed and the Log File dialog box is displayed. The installercreates a DAR file log file called WebPublisher_installerLog.html when youinstall the Web Publisher DAR file. Log files are also created for the Accelera andWcmPostReplication DAR files, where applicable, and are located in separate foldersat %DOCUMENTUM%\dba\config\repository_name. The Web Publisher DAR logfile is displayed after DAR file 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 Start > Programs > Administrative Tools > Services.

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 repository where you run Web Publisher.

Installing the DAR files and server files on UNIX andLinux hosts

After you add any required locales to the repository, install the Web Publisher server filesand DAR files. (To add required locales to the repository, use the procedure in Enablingadditional locales in the repository, page 49.) The Web Publisher DAR file installs thedata dictionary information for the locales to the repository.

When you run the wPServerOSSetup.bin on the Content Server host, the server filesare installed on the host. The DAR files (Web Publisher DAR, WcmPostReplicationDAR, and Accelera DAR) must be installed from a Windows computer that hasDocumentum Composer installed. The Web Publisher DAR is mandatory, while theWcmPostReplication and Accelera DARs are optional.

There are different procedures for installing the server files and the DAR files. Completethem both.

Installing the server files

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

Caution: The user installing Web Publisher server files must have Write access tothe directory from which the installer is executed.

To install the Web Publisher server files on UNIX and Linux hosts:

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.TheWelcome 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 theapplication 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 DAR files

Use these instructions to install the mandatory Web Publisher DAR file or the optionalWcmPostReplication and Accelera DARs on a UNIX host. The instructions requirethat you use Documentum Composer or headless Composer on a Windows host. SeeInstalling a DAR file with the DAR Installer Plugin, page 73 for more information.

To install the Web Publisher, WcmPostReplication, or Accelera DAR filein a UNIX repository:

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

2. Ensure that the dfc.properties file on the host is pointing to a connection brokerto which the UNIX repository projects.For example, if the repository projects to a connection broker called Troy, ensurethat Troy is listed in the dfc.properties file. The dfc.properties file is in theC:\Documentum\config or $DOCUMENTUM/config folder.

3. Use FTP or another protocol to transfer the DAR file from the Content Server host toa temporary folder on the Windows host.

4. Follow the procedure in Installing a DAR file with the DAR Installer Plugin, page73 to install the DAR file(s).

5. Repeat this procedure in each repository where you run Web Publisher.DocumentumComposer creates aDAR file log file calledWebPublisher_installerLog.htmlwhen you install the Web Publisher DAR file. Log files are also created for the Acceleraand WcmPostReplication DAR files, where applicable. The log files are saved in$DOCUMENTUM/dba/config/repository_name; separate folders are created for eachDAR’s log files.



Enhanced support for multirepository configurations

For multi‑repository configurations, Web Publisher includes a DAR file,WcmPostReplication, which provides the server method and job needed inmulti‑repository configurations.

This optional DAR file is included in the Web Publisher server files installer, and it willbe installed if you choose to do so during server file installation; see Installing the WebPublisher server files and DAR files, page 50 for details. If you install this DAR file,it is copied to $DM_HOME\install\DAR files\WebPublisher by the installer. Yoursystem administrator will also need to customize the jobs included in this DAR file foryour environment.

The WcmPostReplication DAR file installs the wcmPostReplicationMethod method.The method aids Web Publisher in synchronizing objects between the source and thetarget repositories. This method also removes category relation objects so that they donot point to the incorrect repository once objects are replicated to the target repository.This method is run by the wcmPostReplicationJob job.

The WcmPostReplication DAR file also installs the wcmPostReplicationJob job. SetwcmPostReplicationJob to the Inactive state and run the job after a replication job hasfinished successfully. Use Documentum Administrator to create a job sequence in whicha replication job runs and the wcmPostReplicationJob job runs when the replication job iscompleted. We recommend that you set up the job sequence so that the postreplicationjob will only run if the replication job succeeds. You can also use a job sequence to chainseveral replication jobs and several post replication jobs together.

Three parameters are needed for the wcmPostReplicationJob job:• The dest_folder parameter specifies the target replication folder or cabinet. This

is the same target folder or cabinet found in the replication job.• The object_type parameter specifies the object type to be replicated. By default

this parameter is set to dm_document. You can specify any object type.• The log_mismatch parameter can be set to either True or False. If this parameter

is set to True, the post replication process examines the translation relation objectsrelated to the files in the target folder or cabinet. It will report any incorrectly createdrelation objects in the trace file.

For information on creating job sequences, refer to the Content Server AdministrationGuide and online Help for Documentum Administrator.

Additional Accelera DAR file tasks

The Accelera DAR file installs repository components for the Accelera.com samplewebsite, which is discussed in theWeb Publisher Administration Guide. Documentum



provides the sample website for administrators and Web developers to use as a startingpoint for website customization. The Accelera DAR file contains object types, lifecycles,workflow templates, permission set templates, Web Publisher Editor templates, aliassets, procedures, methods, cabinets and content for the website. You are not required toinstall the Accelera DAR file; it is a sample only.

Installing the Web Publisher DAR file is a prerequisite for installing the Accelera DARfile. Both of these DAR files are installed by the Web Publisher server files installer, asdescribed in Installing the Web Publisher server files and DAR files, page 50. If you planto install the Web Publisher and Accelera DAR files in the same repository, Documentumstrongly recommends installing the two DAR files at the same time. If you did not opt toinstall the Accelera DAR when the server files installer was run initially, Documentumrecommends that you re‑run this installer so that the Web Publisher DAR and AcceleraDAR are installed together.

Installing the Accelera DAR file at a later time overwrites the FolderMap.xml file, whichWeb Publisher requires, with Accelera‑specific information. This is typically not an issue,because FoderMap.xml is empty after installing the Web Publisher DAR file. However, ifyou have made customizations to FolderMap.xml, you need to take extra steps to retainthese customizations. If you decide to use the Accelera sample website after installingthe Web Publisher DAR file, you can either:• Install the Web Publisher and Accelera DAR files in a clean repository.• In the repository whereWeb Publisher is already installed, record any customizations

to FolderMap.xml.

After the Accelera DAR file is installed and FolderMap.xml is versioned, openFolderMap.xml, restore the customizations, and save FolderMap.XML as a newversion.

The Accelera DAR file is a sample website only. You are not required to install it.Documentum is not responsible for the sample’s accuracy or completeness.

This section discusses these topics:• Accelera preinstallation requirements, page 62• Accelera postinstallation requirements, page 63• Testing the Accelera DAR file installation, page 69• Publishing documents to the sample website, page 69

Accelera preinstallation requirements

Ensure that the following tasks are completed before you install the Accelera DAR file:

1. Install Documentum Administrator.



2. Install three web application server instances for the WIP, Staging, and Activeeditions of the Accelera website.

3. Ensure that the regional setting is correct. Refer to Setting the regional options onWindows hosts, page 63.

Setting the regional options on Windows hosts

The Regional Options dialog box is where the locale, numerical display, time, andcurrency parameters are set on Windows hosts. Ensure that each Content Server hostwhere the Accelera DAR file installed uses the correct settings during installation. Afterinstallation is complete, the settings can revert to your normal settings.

To set regional settings:

1. Navigate to Start > Control Panel > Regional 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 andLong date format fields.

4. Click OK.

5. When DAR file installation is complete, you can return the Regional Settings to theprevious settings.

Accelera postinstallation requirements

After the Accelera DAR file is installed with the Web Publisher server files installer,complete these procedures to enable the Accelera sample website:

1. Creating the Accelera database schema, page 64

2. Installing and configuring Site Caching Services, page 64

3. Modifying the DbUtils.inc file, page 65

4. Creating a site publishing conguration, page 66

5. Creating the WEB‑INF folder, page 68



Creating the Accelera database schema

The Accelera web application is heavily metadata‑driven; this metadata is published to adatabase schema by Site Caching Services (SCS), and then accessed from the Accelera JSPpages via JDBC. As a result, you need several components:• A database schema for use by the Accelera webapps. Note that the connection

information used by the JSPs is common for all editions of the webapp (WIP,Publishing, and Staging), and is defined in the DbUtils.inc file within the Acceleraweb cabinet. You therefore need only one schema, and consequently one set ofdatabase credentials, for all three web application server instances.

• A JDBC driver for your database. You should make sure that it is available for allyour web applications. If you are using WebLogic, it is likely that the JDBC driverwill already be available; if you are using Tomcat, it is convenient to put the driverin $CATALINA_HOME/common/lib.

• Site publishing configurations for the three environments that define threeseparate database table names for publishing metadata. Having each publishingconfiguration define separate table names is necessary, since the Accelera webappcan only have one schema, and the three environments need separate copies of themetadata. Be sure to record the table names; they will be needed when you set upthe WEB‑INF folder for each web application.

Installing and configuring Site Caching Services

You will need to install both the source and target components of SCS. When you installand configure the target, set it to populate the database schema created for the Acceleraeditions. As an example, refer to the following screenshot from the target configurator:



Figure 2. SCS configuration for Accelera

The username and password you enter here should match that of the schema you created.

Modifying the DbUtils.inc file

The Accelera.com web application obtains its database credentials from the DbUtils.incfile, found in the accelera.com web cabinet at /Accelera.com/includes/util. You will needto update the JDBC connection string, and the userid and password of the databaseschema. Note that the same DbUtils.inc file is used in all three environments, which iswhy you want a single schema. Use different table names for your three publishingconfigurations. An example DbUtils.inc file is included below.

Example 71. DbUtils.inc

<%////Database Connection Variables **CONFIGURE HERE**//Your DB connection string can be found in the//webcache.ini file. Use the user name and password//you specified during webacache installation.//String strJDBCDriverName = "oracle.jdbc.driver.OracleDriver";String strDbConnectionString= "jdbc:oracle:thin:@(description=

(address=(host=localhost)(protocol=TCP)(port=1521))



(connect_data=(sid=ORCL)))";String strDbUserName = "scstarget";String strDbUserPassword = "demo";

%>

Creating a site publishing configuration

After installing the Accelera DAR file, edit the site publishing configuration that isinstalled with the DAR file. Site publishing configurations determine which documentsare published by Site Caching Services from a repository to a website. Use DocumentumAdministrator to edit the Accelera site publishing configuration. Refer to online Helpfor Documentum Administrator for complete instructions on creating and modifyingsite publishing configurations.

The Accelera web application is designed to be the default (root) web application. Thepaths that are embedded within the JSP and HTML files in the webapp assume that theAccelera application is at the application server root. Therefore, when you configure sitepublishing for WIP, Staging, and Active, you must have three separate web applicationservers running, each with a separate default web application. Each of your threeseparate publishing configurations should publish to the default web applications of thethree application servers.

Our experience is that setting up the three separate servers is easier with WebLogic thanTomcat. Essentially, you use the Configuration Wizard to create three server instances,then modify all three instances and create a default webapp for them. If you use Tomcat,more manual work is involved; you must have three separate copies of the Tomcat rootdirectory (each with a modified server.xml file), and it is difficult to run the separateserver instances as services.

The following procedure assumes that Site Caching Services and DocumentumAdministrator are installed.

To modify the site publishing configuration:

1. Start Documentum Administrator and connect to the Accelera repository as aSuperuser.You can use the Content Server installation owner account or another Superuseraccount.

2. Click Site Publishing.

3. Choose the Accelera.com English (US)‑Active publishing configuration.

4. Set values in the site publishing configuration.

Note: Do not change any other values.

a. Select Active state.



b. Enter accelera_active as the configuration name.

c. Click Publishing Folder and browse the repository to the Accelera.com folder.

d. In the Version field, type active.

e. Type the target host name.This is the host where the SCS target software is installed.

f. Type the target port for making connections to the target host.The port you type must match the port specified when you installed SCS orthe publishing job fails.

g. Choose Non‑secure as the connection type.

h. Type the target root directory to which you want to publish. The default isc:\publishdir\active.

Caution: The contents of the target root directory are deleted during a fullrefresh or initial publishing operation. Ensure that you specify the correctdirectory as the target root directory.

i. Click the Advanced tab.

j. Select the following Additional Properties:press_release.pr_datepress_release.pr_targetpress_release.pr_press_datepress_release.pr_topicproduct_detail.pd_classproduct_detail.pd_imgproduct_detail.pd_numberproduct_detail.pd_priceproduct_detail.pd_typeproduct_detail.pd_short_descwcm_category.cps_node_namedm_sysobject.subjectdm_sysobject.titledm_sysobject.r_content_sizedm_sysobject.r_object_typedm_sysobject.r_modify_datedm_sysobject.a_categorydm_sysobject.keywordsdm_sysobject.authorsbio_detail.bio_titlebio_detail.bio_thumbnail_image_urlbio_detail.bio_first_namebio_detail.bio_last_namenews_detail.nd_dateaccelera_content.ac_document_type

k. Ensure the Property Table Name is specified as accelera_active.



l. Select the following Formats:gifjsjsphtmlpngjpegjpeg_thjpeg_lresjpeg_storypdfpub_htmlinccssswf

Note: The jpeg_th, jpeg_lres, and jpeg_story formats are optional.

m. Select a new Export Directory or leave the default unchanged.

n. Type the transfer user name, password, and domain.These are the same transfer user name, password, and domain that you providedduring SCS target installation.

5. Click OK.Repeat this procedure to set the publishing configurations for the WIP and Staging sites.For each publishing configuration, update the configuration name, the version labels, theproperty table name, and the target directory as appropriate.

Note: Creating all three publishing configurations and all three web application serversis recommended for optimum performance, but is not strictly necessary. WIP shouldbe created to enable In‑Context Editing.

Creating the WEBINF folder

You need to create a folder WEB‑INF under the root directory of the default webapplication for all three application server instances. Under this WEB‑INF folder, createweb.xml and weblogic.xml. Samples of these files are given below. You must modify thewebcache_table context parameter in the web.xml file to reflect the correct table name forthat environment. Note that SCS adds an ʺ_s suffix for the single‑value metadata thatit publishes, so the table name that you enter in the web.xml should be the table namedefined in the publishing configuration, appended with ʺ_s.

Example 72. web.xml

<?xml version="1.0" ?><!DOCTYPE webapp PUBLIC "//Sun Microsystems, Inc.//DTDWeb Application 2.3//EN" "http://java.sun.com/dtd/webapp_2_3.dtd"><webapp>



<welcomefilelist><welcomefile>index.jspwelcomefile>index.jsp><welcomefile>index.htmlwelcomefile>index.html></welcomefilelist>

<contextparam><paramname>webcache_tableparamname>webcache_table><paramvalue>accelera_wip_sparamvalue>accelera_wip_s></contextparam></webapp>

Example 73. weblogic.xml

<!DOCTYPE weblogicwebapp PUBLIC "//BEA Systems, Inc.//DTD Web Application 8.1//EN" "http://www.bea.com/servers/wls810/dtd/weblogic810webjar.dtd"><weblogicwebapp><contextroot>/contextroot>/></weblogicwebapp>

Testing the Accelera DAR file 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 website.

2. Login to Documentum Administrator.


4. Select the Accelera.com site publishing configuration.

5. Click Tools > End‑to‑End Test.

6. Click View > Logs and examine the resulting log file.The log file tells you whether a real publishing operation would have succeeded orfailed, 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 website

After you test the site publishing configuration, publish the Accelera website. Link testdocuments to the source folder identified in the Web publishing configuration, andpublish them using Documentum Administrator. For information on linking documentsto 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 Accelerarepository.


3. Select the Accelera.com Web publishing configuration.

4. Click Tools > Publish.

5. Select Publish Entire Site.If you do not select Publish Entire Site, SCS defaults to an incremental refresh. Afull refresh deletes the entire contents of the target root directory and republishesall items specified by the Web publishing configuration. It also deletes attributeinformation 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 operationis complete. If you do not check this, the screen does not refresh until the publishingoperation is complete. Your browser may time out.

7. Select aMethod Trace Level of 5.

8. Click OK.

9. Open a different browser window and type 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 theweb server is listening.

10. Click Communications to view the sample website.

Updating the data dictionary after installation

Use these instructions to enable language support for additional locales. The sectionsbelow contain instructions for:• Adding supported locales to the repository• Modifying the data_dictionary_wcm.ini file• Running the data dictionary population script

To update the locales supported in the repository:

1. Use the instructions in Appendix E, Populating and Publishing the Data Dictionary,in the Content Server Administration Guide to install additional locales in therepository.



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 ofthe 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 repository name, user name, andpassword:dmbasic f%DM_HOME%\bin\dd_populate.ebs eEntry_Point repository_NAMEUSER_NAME PASSWORD data_dictionary_wcm.ini

The repository name is the name of the repository in which you installed the WebPublisher DAR file, the user name is the name of the Superuser, and the passwordis the Superuser’s password. You can use the Content Server installation owner’suser 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.The new data dictionary locale information is installed in the repository. Whenthe data dictionary publishing job runs next, the information is available to WebPublisher.

Output of the data dictionary script

The data dictionary population script, dd_populate_wcm.bat (Windows) ordd_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 theoutput 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: 05072003 12:34:15 ##

## ##

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

Starting to read data file

Setting the data dictionary population locale to: deSetting the data dictionary population codepage to: ISO88591SUCCESSFUL: type level Data Dictionary Population for type wcm_localeSUCCESSFUL: attribute level Data Dictionary Population for type wcm_localeSUCCESSFUL: type level Data Dictionary Population for type wcm_auto_namingSUCCESSFUL: attribute level Data Dictionary Population fortype wcm_auto_namingSUCCESSFUL: type level Data Dictionary Population for type wcm_change_setSUCCESSFUL: attribute level Data Dictionary Population fortype wcm_change_setSUCCESSFUL: type level Data Dictionary Population for type wcm_channelSUCCESSFUL: attribute level Data Dictionary Population for type wcm_channelSUCCESSFUL: type level Data Dictionary Population for type wcm_editionSUCCESSFUL: attribute level Data Dictionary Population for type wcm_editionSUCCESSFUL: type level Data Dictionary Population for type wcm_edition_fldSUCCESSFUL: attribute level Data Dictionary Population fortype wcm_edition_fldSUCCESSFUL: type level Data Dictionary Population for type wcm_categorySUCCESSFUL: attribute level Data Dictionary Population fortype wcm_categorySUCCESSFUL: type level Data Dictionary Population for type wcm_channel_fldSUCCESSFUL: type level Data Dictionary Population for type wcm_configSUCCESSFUL: attribute level Data Dictionary Population fortype wcm_configData 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.



Installing DAM DAR filesThere are two Digital Asset Manager DAR files that affect Web Publisher deployments:• Rich Media Services DAR file

This DAR file ismandatory for Web Publisher deployments.• Transformation DAR file

This DAR file is required if you are performing transformations in WebPublisher with any Content Transformation Services products (such as DocumentTransformation Services or Media Transformation Services).

Use headless Composer and the DAR installer plug‑in to install the DAR files. Composermust have access to the repository where Web Publisher is installed. You must downloadand install headless Composer before continuing with these procedures.

Note: You must have Superuser privileges for the repositories in which you want toinstall the DAR file.

The following sections outline the procedure for installing DAR files with headlessComposer. This procedure can be followed when manually installing other DAR filessuch as the Portlet Builder and Page Builder DARs. Consult the Documentum ComposerUser Guide for more information about Composer.

Installing a DAR file with the DAR Installer Plugin

You can use the DAR Installer Plugin to install a DAR file to a repository if you do notwant to use the interface within Composer. The DAR Installer plugin requires Composerto be installed, but does not launch the full Composer IDE. The DAR Installer Pluginis useful in cases where you want to de‑couple the development of DAR files from theinstallation of DAR files. It is also useful in situations where installation of DAR files isrequired as part of a deployment process. When you open the DAR Installer Plugin, itcreates three folders in your Composer installation directory:

• darinstallerconfig ‑ contains configuration files for the DAR Installer Plugin• darinstallerlogs ‑ the default location of the log files• darinstallerworkspaces ‑ workspaces that are created and used by the DAR Installer

Plugin. The DAR Installer Plugin does not delete these workspaces automatically,so you occasionally need to clean up this directory. The workspace directories arenamed in the following form: darinstaller_workspace_yyyy‑mm‑dd‑hh‑mm‑ss.



The DAR Installer requires you to fill in certain values that are marked with an asterisk(*). All other fields are optional. For a description of the fields for the DAR InstallerUtility, see Table 6, page 74.

To install a DAR file:

1. Download the DAR Installer zip file. You can find the DAR Installer Plugin by goingto https://emc.subscribenet.com/control/dctm/search and searching for ʺComposer”to reach the Documentum Composer download site.

2. Unzip the DAR Installer zip file to the root of your Composer or headless Composerinstallation directory.

3. Run darinstaller.exe, which is located in the Composer root directory, to start theDAR Installer Plugin.

4. In the DAR Details section, specify values for the fields.

5. In the Connection Broker Details section, specify values for Connection BrokerHost and Connection Broker Port and click Connect.

6. In the Repository Details section, specify values for the fields and click Install toinstall the DAR file to the repository.

You can view the log for the DAR installation by selecting the log file from the LogFile drop down menu and clicking Open.

Table 6. DAR Installer fields

Parameter Required Description

DAR Yes The absolute file pathto the .dar file that youwant to install. The filepath cannot contain anyI18N characters or theinstallation will fail.

Input File No The absolute file path tothe install‑based parameterfile

Local Folder No The absolute file path tolocalized .properties files.If you want to make yourapplication available inother languages, you needto localize the project datasuch as labels, tabs, anddescriptions.


https://emc.subscribenet.com/control/dctm/search


Parameter Required Description

Log File No The file to save the log to.If this is not specified, thefile defaults to <DAR>.log

Connection Broker Host Yes The address of theConnection Broker

Connection Broker Port Yes The port of the ConnectionBroker Repository

Repository Yes The name of the repositorythat you want to installthe DAR file to. Click onthe Connect button afterentering the Docbrokerhost and port to retrievethe available repositories.

User Name Yes The login name for therepository

Password Yes The password for logginginto the repository

Domain No The domain where therepository resides

Installing DAR files on UNIX or Linux hosts

Composer is certified for use on Windows hosts only. To install DAR files on UNIX orLinux, transfer the DAR files to a Windows host and run the DAR Installer Plugin.

To install DAM DAR files in a UNIX repository:

1. Log in to a Windows host where Documentum Composer is installed.

2. Ensure that the dfc.properties file on the host is pointing to a connection brokerto which the UNIX repository projects.For example, if the repository projects to a connection broker called Troy, ensurethat Troy is listed in the dfc.properties file. The dfc.properties file is in theC:\Documentum\config or $DOCUMENTUM/config folder.

3. Use FTP or another protocol to transfer the DAM DAR files (Rich Media ServicesDAR file, and where applicable, the Transformation DAR file) from the ContentServer host to a temporary folder on the Windows host.



4. Follow the procedure in Installing a DAR file with the DAR Installer Plugin, page73 to install the DAR file(s).

5. Repeat this procedure in each repository where you run Web Publisher.

Installing the Site Caching Services sourcesoftware

If you use Web Publisher, install or upgrade to the required version of the Site CachingServices source software. The SCS source software is installed on the Content Serverhost. For complete information on installing or upgrading SCS, refer to the Site CachingServices Installation Guide.

Using eWebEditProeWebEditPro, from Ektron, Inc., is Web Publisher’s Web‑based HTML editor.eWebEditPro is a WYSIWYG, browser‑based HTML editor that enables authors toeasily create hyperlinks and Web content such as text and images. eWebEditPro can beinstalled on either Windows or UNIX systems.

For information on supported eWebEditPro versions, refer to theWeb Publisher ReleaseNotes.

Technical support for eWebEditPro is shared between EMC and Ektron. EMCsupports Web Publisher and eWebEditPro integration. Ektron supports eWebEditProinstallation, configuration, and use. Contact Ektron technical support on the Web athttp://www.ektron.com/support.cfm or by telephone at (603) 594‑0249.

For information on obtaining eWebEditPro from the EMC Download Center, refer toObtaining eWebEditPro, page 76.

Obtaining eWebEditPro

If you purchased licenses for eWebEditPro and you have a SubscribeNet account, accessthe software through the EMC Download Center using your existing login ID andpassword.

If you purchased licenses for eWebEditPro, but you are not a registeredSubscribeNet user, request access by logging on to the Administration Assistant (at


http://www.ektron.com/support.cfm


http://softwaresupport.emc.com/support) and clicking Request a full‑access account.You can also request access by sending email to [email protected].

If you have not purchased licenses for eWebEditPro, contact your EMCAccount Managerto inquire about pricing and licensing terms.

Your login ID and password are sent to you by EMC. You cannot change your password.If you lose your password use the password finder on the EMC Download Centerlogin page.

Installing eWebEditPro HTML integration

Use these instructions to install the eWebEditPro HTML integration software on theapplication server host.

To download and modify eWebEditPro:

1. Log on to the application server host where Web Publisher is running as theapplication server installation owner.

2. In a web browser, navigate to the EMC Download Center at:https://EMC.subscribenet.com

3. Log in to the EMC 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 theewebeditpro folder and preserve the directory structure.

9. Open the ewebeditpro.js file in a text editor.

10. Change the linevar eWebEditProPath = "/ewebeditpro3/";


http://softwaresupport.emc.com/support

https://documentum.subscribenet.com


orvar eWebEditProPath = "/ewebeditpro4/";

tovar eWebEditProPath = "/WP_virtual_directory/ewebeditpro/";

11. Also change the linevar WebImageFXPath = "/ewebeditpro3/";

orvar WebImageFXPath = "/ewebeditpro4/";

tovar WebImageFXPath = "/WP_virtual_directory/ewebeditpro/";

whereWP_virtual_directory is the virtual directory where Web Publisher is installed.

12. Copy the customevents.js, and config.xml files from WP_virtual_directory/wp/ewebeditpro to the temporary folder ewebeditpro you created in Step 7.

13. Stop the application server.This automatically stops the Web Publisher process.

14. Copy the ewebeditpro folder toWP_virtual_directory whereWP_virtual_directory isthe virtual directory in which Web Publisher is installed.

15. Start the application server.Starting the application server automatically starts Web Publisher.

Installing eWebEditPro XML integration

The eWebEditPro XML integration includes the ability to edit HTML (refer to thesections above) and extends it to XML. Use these instructions to install the eWebEditProXML integration.

To install the eWebEditPro XML integration:

1. Create a directory called ewebeditpro one level under the Web Publisher virtualdirectory.This is /WP_virtual_directory/ewebeditpro/.

2. In a web browser, navigate to the EMC Download Center:https://EMC.subscribenet.com

3. Log in to the EMC Software Downloads site.

4. Click the link Ektron eWebEditPro.

5. Click the link Ektron eWebEditPro XML, Version 4.2.


https://emc.subscribenet.com


6. Click Download.A single software package applies to UNIX and Windows installations.

7. Save the product distribution file ewebeditproxml4dctm.zip.

8. Extract the file to the ewebeditpro directory that you created in Step 1, preservingthe directory structure created by the zip file.

9. Navigate to the ewebeditpro directory created in Step 1.This is /WP_virtual_directory/ewebeditpro/.

10. Open the ewebeditpro.js file in a text editor.

11. Locate these lines:eWebEditProPath = "/ewebeditpro4/";WebImageFXPath = "/ewebeditpro4/";

12. Change them to:eWebEditProPath = "/WP_virtual_directory/ewebeditpro/";WebImageFXPath = "/WP_virtual_directory/ewebeditpro/";

whereWP_virtual_directory is the virtual directory where Web Publisher is installed.

13. Save the file.

14. Copy the ewebeditprolicensekey.txt file to the ewebeditpro folder.

15. Copy the following files from theWP_virtual_directory/wp/ewebeditpro directory toWP_virtual_directory/ewebeditpro:• config.xml• customerevents.js• configdatadesign.xml• configdataentry.xml• ewebeditpromedia.js

Installing iMarkupiMarkup is an integration that allows users to put annotations or markup, such asdrawings and text, on web pages. When a Web Publisher end user loads a web page inWeb view, the annotations for the version loaded are displayed.

The iMarkup annotations are stored in a standalone database, not in a repository.One iMarkup database can serve annotations for multiple Web Publisher repositories,provided the repository names are unique.



Documentation for iMarkup is available from the iMarkup website (http://www.imarkup.com/docs). Use these instructions in conjunction with iMarkup documentationto install iMarkup. Perform these steps after installing Web Publisher.

To install the iMarkup SDK:

1. Create a database for iMarkup annotations.

2. Record the name of the database and the login credentials (the database user nameand the user’s password).

3. Stop Web Publisher.

4. Create a folder for iMarkup on the Web Publisher host.

5. Download iMarkup from the iMarkup website (http://www.imarkup.com/docs ) tothe folder on the Web Publisher host.

6. Uncompress the distribution file.

7. Add the iMarkup folder location to the application server startup file.For example, on Tomcat, this is catalina.bat. If the iMarkup folder is c:\imarkup, thecatalina.bat file contains:set CATALINA_OPTS= Dimarkup_dir=C:\imarkup

8. Copy the following jar files to the directoryWP_virtual_directory/WEB‑INF/lib :• servlet‑api.jar• imarkup.jar• xerces‑J_1.4.0.jar• castor‑0.9.5.3‑xml.jar

9. Ensure that the following jar files are placed in application classpath:• servlet‑api.jar• imarkup.jar• castor‑0.9.5.3‑xml.jar

Note: You can find the servlet‑api.jar file in tomcat common\lib folder.

10. Remove the entry for castor‑0.9.5.2xml.jar from the application server classpath.

11. From the Documentum\Shared directory on the application server, remove the filecastor‑0.9.5.2xml.jar (castor‑0.9.5.3xml.jar is the correct version to use with iMarkup).

12. Ensure that the JDBC driver for your database is referenced in the application serverclasspath.The JDBC drivers are included in the iMarkup distribution file. They are in the JDBCDrivers\database_name folder. For example, on SQL Server, the filenames are:msbase.jarmssqlserver.jar


http://www.imarkup.com/docs




msutil.jar

13. Open the WEB‑INF\web.xml file for Web Publisher and uncomment the followingsections:<listener><listenerclass>imarkup.sdk.session_listener</listenerclass>

</listener>...<servlet><servletname>imarkup_servlet</servletname><servletclass>imarkup.sdk.imarkup_servlet</servletclass>

</servlet>...<servletmapping><servletname>imarkup_servlet</servletname><urlpattern>/imarkup.asp</urlpattern>

</servletmapping>

14. Navigate to the imarkup.properties file in the \imarkup directory.

15. Open the imarkup.properties file in a text editor.

16. Modify the following lines:• InterfaceURL

This is the URL to the iMarkup SDK servlet. For example:InterfaceURL = http://host_name:port/wp/imarkup.asp

• DB_DRIVER

This is the JDBC driver for the database. For example, for SQL Server:DB_Driver = com.microsoft.jdbc.sqlserver.SQLServerDriver

For other databases, follow the examples in the file.• DB_URL

This is the URL to the table or database you created. For example:DB_URL = jdbc:microsoft:sqlserver://host_name:port;DatabaseName=database_name

• DB_User

This is the database user for the RDBMS.• DB_Password

This is the database user’s password.17. Save the imarkup.properties file.

18. Restart Web Publisher.If iMarkup loads correctly, you see messages indicating this.

19. On each Internet Explorer browser client machine, install the iMarkup plugin.



Refer to the iMarkup documentation for instructions. iMarkup is only supportedwith Internet Explorer.

Enabling iMarkup on Windows 2003 Server

Signed ActiveX controls, which are Internet Explorer components, allow plugins suchas iMarkup to extend the functionality of the browser. Signed ActiveX controls can beloaded using JavaScript or can be loaded automatically by the browser when it startsusing Browser Helper Objects.

On Windows 2003 Server, Microsoft changed the default setting so that Browser HelperObjects are not automatically loaded. To enable iMarkup under Windows 2003 Server,use one of these methods:• Enable browser extensions in Internet Explorer.

In Internet Explorer, choose Tools > Internet Options > Advanced and select Enablethird party browser extensions.

• Use JavaScript in a custom popup window to load the iMarkup ActiveX control.

Completing the Web Publisher Portlet Builderinstallation process

After you install Web Publisher, the Web Publisher server files, and the Web PublisherDAR file, complete the Web Publisher Portlet Builder installation process by installingthe Portlet Builder DAR file.

The Portlet Builder DAR file is installed in the same way as the DAM DAR files, usingheadless Composer and the DAR Installer Plugin. See Installing DAM DAR files, page73 for the complete procedure.

After completing the installation process, use the instructions in theWeb Publisher UserGuide to create portlets. You must then deploy the portlets to the portal server. You mayalso optionally use an LDAP server. Refer to the documentation for the portal server forinstructions on deploying portlets and configuring LDAP.



Completing the Web Publisher Page Builderinstallation process

After you install Web Publisher, the Web Publisher server files, and the Web PublisherDAR file, complete the Page Builder installation process by following the relevantprocedures in this section:

1. Preparing to upgrade Page Builder, page 83

2. Installing Page Builder DAR files, page 83

3. Migrating content from prior Page Builder versions, page 85

4. Deploying the Upload Application WAR file for dynamic component, page 86

Note: Page Builder is an optional application that is purchased separately from WebPublisher.

Preparing to upgrade Page Builder

If you are upgrading from an earlier version of Page Builder, ensure that all Page Buildercontent (both templates and web pages) is checked in prior to installing Page Builder6.5. This requirement is needed as part of the migration process due to architecturalchanges made in Page Builder 6.5.

Installing Page Builder DAR files

You must install the Page Builder DAR file to enable Page Builder functionality.Optionally, Page Builder customers can also install the Page Builder Samples DAR file.Be aware of the following installation notes pertaining to these DAR files:• The Page Builder DAR file must be installed before the Samples DAR file.• If you reinstall the Page Builder DAR file at any time, it will override the Samples

DAR file. In this case, reinstall the Samples DAR as well.The Page Builder DAR file and Samples DAR file are installed in the same way as theDAM DAR files, using headless Composer and the DAR Installer Plugin. See InstallingDAM DAR files, page 73 for the complete procedure.

After installing the Page Builder DAR files:• Restart both the repository to which you installed the Page Builder DAR file(s) and

the Java Method Server.



• Use the instructions in theWeb Publisher User Guide to create templates and webpages.

The Page Builder DAR file installs several files including Page Builder specific objecttypes, alias sets, jobs, methods, formats, modules, and data objects. These files aredescribed in the following table.

Table 7. Page Builder DAR file files

File names Descriptions

Object Types:

wcm_auto_publish Used to mark content to be automaticallypublished by the wcmAutoPublish job.

wcm_managed_link Used to mark objects as managed linkedobjects.

Alias Sets:

PageBuilder Enables users to set permissions specificto Page Builder DAR file content.

Jobs:

Clean_Up_Managed_Link_Job Used to clean up managed link object(s).For example, if a child document isremoved then the managed link does notneed to reference the child document.

wcmAutoPublish Used to publish the content. After a userenables a site publishing configurationand sets the frequency, a new relationobject will be created between the contentand the Site Publishing Service. Then itwill set the next invocation date. The jobwill search in the repository frequentlyto find the relations which have theinvocation date past the current time. Thejob then passes the content IDs to SitePublishing Services to publish the content.

Methods:

wcmAutoPublish Used to run the wcmAutoPublish job.

wcmCleanUpManagedLink Used to run the Clean_Up_Managed_Link_Job job.

Formats:



File names Descriptions

pb_xml Page Builder’s internal format used tostore templates and content files.

Relation Types:

wcm_auto_publish Create the link between the document andpublish job.

wcm_link Creates the link between a parentdocument and a child document.

wcm_link_internal Manages the link between the managedlink object and the child document.

wcm_managed_link Manages the link between the parentdocument and the managed link object.

wcm_pb_template_blueprint Creates the link between Page Buildertemplates and the blueprint from whichthe templates were created.

Modules:

PageBuilderAspect Used on Page Builder format object.

Data Objects:

Blueprints Creates the blueprints folder and addsthe default blueprint to that folder in therepository.

Managed Links Creates an empty Managed Links folderin the repository. This folder is used tocontain managed link objects which arepopulated when you add links in PageBuilder; for example, when creating anembedded component.

The Page Builder Samples DAR file provides sample templates and web pages thatprovide basic web page layouts and illustrate the use of the XML component anddynamic component. The samples are located at:• Sites (Web Cabinets) > PageBuilderSamples• Site Manager > Content Templates > PBSampleTemplates

Migrating content from prior Page Builder versions

After ensuring that Page Builder content created in prior versions was checkedinto the repository and then installing the Page Builder DAR file(s), the



next task relating to migration is to configure migration functionality in theWcmApplicationConfig.properties file.

To configure migration:

1. Locate the WcmApplicationConfig.properties file in the WEB‑INF\classes folder.

2. Open the file.

3. Change the default setting of pagebuilder.contentmigration from:pagebuilder.contentmigration=false

to:pagebuilder.contentmigration=true

4. Save and close the WcmApplicationConfig.properties file.Page Builder content can now be migrated in Page Builder 6.5. After creating a new filein Page Builder 6.5, users can select theMigrate action on the context menu to migratelegacy web cabinets or folders in the Site Overview blade. Page Builder creates a newversion (which is compatible with Page Builder 6.5) of each migrated file. See theWebPublisher User Guide, Web Publisher online help, or the Page Builder help file for details.

Deploying the Upload Application WAR file for dynamiccomponent

The dynamic component element in Page Builder 6.5 is used to add dynamic XMLcontent to a web page. In order to preview dynamic content, the Upload ApplicationWAR file must be deployed to the application server. This application helps the usersupload their files from the repository to a staging environment.

The Upload Application WAR file can be deployed on any Java‑based application server.Ideally, the WAR file should be deployed in the environment where the users want topreview their dynamic component; however, you can deploy the Upload Application onthe same application server where Web Publisher and Page Builder are deployed.

Notify content developers of the correct application URL, because they must add thisURL to the dynamic component’s properties in Page Builder in order to preview dynamiccontent. The URL is entered in the Specify the Upload Application field. See theWebPublisher User Guide, Web Publisher online help, or the Page Builder help file for detailsabout the dynamic component element.



Accessing the applicationThis section provides you with information on accessing and testing the deployment ofa WDK‑based application by connecting through a browser client. Before you test thedeployment, ensure the application is started in the application server. For informationon starting the application, refer to the documentation of the application server.

If the application requires additional configuration or setup, such as installing a DAR orDocApp, perform those steps before you test the application.

To verify the deployment and configuration of a WDK application:

1. Open a browser window and type this URL:http://host_name:port_number/virtual_directory

Where:• host_name is the host where the application server is installed. If the browser

is on the application server machine, substitute localhost for host_name; forexample, http://localhost:8080/webtop.

• port_number is the port where the application server listens for connections• virtual_directory is the virtual directory for your applicationFor example, if the application server host is named iris, the port is 8080, and theapplication virtual directory is webtop, the URL is http://iris:8080/webtop.

2. Log in to a repository through the WDK‑based application.If the login succeeds, the application is correctly deployed and configured.

Testing WDK samplesAfter deploying a WDK‑based application, you can view WDK sample pages afterlogging into a repository. The sample JSP pages, component definitions, and supportingcompiled class files are provided in a zip file along with the product download. Unzipthem to your application root directory, preserving the folder hierarchy in the zip file.

To view the WDK samples:

1. Ensure that the application server is running.

2. Open a browser and type the following 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



• virtual_directory is the virtual directory for the applicationA login dialog box appears.

3. Log in to a test repository.The login dialog box reappears 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.

5. Click Session Zoo and type a valid repository username, password, repository name,and domain (if required), then click Create Connection.The repository is listed in theAll Connected Repositories section of the page, and theStatus message line starts with Successfully connected to repository repository_name

6. Continue to experiment with other samples, especially Menu Zoo, Tree Control, andFX Control Pens.Some samples have Create Test Cab andDestroy Test Cab buttons. These create anddelete a test cabinet in the repository and require Create Cabinet privileges.

Uninstalling the Web Publisher server filesAfter uninstalling Web Publisher, the Web Publisher server files directory(webpublisher_server) and the install.ini file are still present on the Content Server host.You must delete these files to completely uninstall Web Publisher.

Use the following procedure to uninstall the Web Publisher files from the Content Serverhost.

To uninstall the Web Publisher server files:

1. Before you uninstall the Web Publisher server files, stop the Java Method Server.

2. Connect to the Content Server host as the Content Server installation owner.



3. Start the server files uninstaller.• On Windows, click Start > Settings > Add/Remove Programs, select

Documentum Web Publisher version_number Server Files, and clickChange/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.


Chapter 8Configuring Single SignOn for SecurityServers

TaskSpace supports SSO using RSA Access Manager (formerly known as ClearTrust).

RSA Access Manager users must have the same login names as the Content Server repository. Usernames are case‑sensitive for the Content Server, so Access Manager user names must be at least 8characters in length and have the same case as the repository login. Errors in authentication arelogged in the /Documentum/dba/log/dm_rsa.log file.

To enable single signon (SSO):

1. Configure the RSA Access Manager security server to authenticate repository users.(Refer to the security server documentation.)

2. Configure the web application server to use an external HTTP Server supported bythe security server. (Refer to the RSA security server documentation.)

3. Configure the Content Server plugin. (Refer to the Documentum Content Serverdocumentation.)

4. Configure the WDK‑based application in app.xml as described in To configureapp.xml for a security server single sign‑on:, page 92.

5. Create a directory named rsaConfig under the root WDK‑based applicationdirectory. Copy two files: aserver.conf from the Access Manager server andwebagent.conf from the RSA web agent. Paste them into the rsaConfig directory.If you make changes to the original files, you must copy the changed files to yourWDK‑based application rsaConfig directory. For more information on these files,refer to the RSA documentation.

6. Locate the file AuthenticationScheme.properties in WEB‑INF/classes/com/documentum/web/formext/session. The SSO authentication scheme classes.Modify the properties file to make your preferred SSO authentication scheme(SSOAuthenticationScheme or RSASSOAuthenticalScheme) first in the list ofauthentications that are attempted during login.


Configuring Single SignOn for Security Servers

If the Docbase Login scheme is listed before the SSO scheme, the user is presentedwith a login screen instead of single sign‑on.

7. Restart the application server.

To configure app.xml for a security server single signon:

1. Open the app.xml file in your applications /custom directory.

2. Copy from app.xml the <authentication> element and its entire contents, and pasteinto your custom app.xml.

3. Update the <sso_config> element under the existing <authentication> element asshown in the following example:<authentication><domain/><docbase>secure_docbase</docbase><service_class>com.documentum.web.formext.session.AuthenticationService

</service_class><sso_config><ecs_plug_in>dm_rsa</ecs_plug_in><ticket_cookie>CTSESSION</ticket_cookie><user_header>HTTP_CT_REMOTE_USER</user_header>

</sso_config></authentication>

Table 8, page 92 describes valid values for each element.

Table 8. Authentication elements (<authentication>)

Element Description

<docbase> Specifies default repository name. When SSOauthentication is enabled but a repositoryname is not explicitly spelled out bythe user nor defined in this element, thesso_login component is called. In this casethe component prompts the user for therepository name.

<domain> Specifies Windows network domain name.

<service_class> Specifies fully qualified name of class thatprovides authentication service. This classcan perform pre‑ or post‑processing ofauthentication.

<sso_config> Contains SSO authentication configurationelements.



Element Description

<sso_config>.<ecs_plug_in>

Specifies name of the Content Serverauthentication plugin (not the authenticationscheme name). Valid value:dm_rsa

<sso_config>.<ticket_cookie>

Specifies name of vendor‑specific cookie thatholds the sign‑on ticket. Valid value:CTSESSION

<sso_config>.<user_header>

Specifies name of vendor‑specific header thatholds the username. Valid value:HTTP_CT_REMOTE_USER.


Chapter 9Troubleshooting Deployment

This chapter provides information on troubleshooting a Web Publisher deployment. In addition,consult the Web Development Kit Troubleshooting Guide and the Web Publisher Release Notes forinformation regarding additional items that can affect deployment, configuration, and usability.

This section provides performance tuning information and troubleshooting information:• Wrong JRE used for application server, page 96• No global registry or connection broker, page 96• No connection to repository, page 96• DM_VEL_INSTANTIATION_ERROR, page 97• Page not found error in browser, page 97• Login page incorrectly displayed, page 97• Slow performance, page 98• Out of memory errors in console or log, page 98• Slow display first time, page 98• DFC using the wrong directories on the application server, page 98• Application startup errors , page 98• Tag pooling problem, page 99• UCF client problems, page 99• Citrix client problems, page 100• Connection issues between an ECI Services server and IPv6 clients, page 101• Web Publisher server‑side installer errors, page 101• Server‑side tracing for Web Publisher, page 102• DAR file installation fails, page 103• Text unaligned, page 103• Users cannot access functions that their roles should allow, page 103• Error when invoking login page after deploying WP on Sun 9.1 app server, page 104


Troubleshooting Deployment

Wrong JRE used for application serverIf the application server host has multiple JREs on the system, the wrong JRE maybe used by the application server. Check your application server documentation forinstructions on using the correct JRE with your application server. For example, theTomcat application server uses a JAVA_HOME environment variable. If this variablevalue is specified in the application startup batch file catalina.bat or in the service.batfile for Windows services.

The error that is displayed in Tomcat using the wrong JRE is the following:ERROR [Thread1]org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/webtop] Error configuring application listener of classcom.documentum.web.env.NotificationManagerjava.lang.UnsupportedClassVersionError:com/documentum/web/env/NotificationManager(Unsupported major.minor version 49.0)atjava.lang.ClassLoader.defineClass0(Native Method)

No global registry or connection brokerGlobal registry information must be configured in dfc.properties. The application servermust be able to download required BOF modules from the global registry repository. Ifthe information in dfc.properties is incorrect, the application server cannot downloadappropriate BOF modules, and following exception is thrown:ERROR...Caused by: DfDocbrokerException:: THREAD: main; MSG:[DFC_DOCBROKER_REQUEST_FAILED] Request to Docbroker "10.8.3.21:1489" failed;ERRORCODE: ff; NEXT: null

To fix this error, either provide the correct BOF registry connection information indfc.properties, or do not provide any connection information at all. Refer to the ContentServer Installation Guide for information on enabling a repository as a global registry.

No connection to repositoryIf the application server log contains the following error during application initialization,it indicates that you have not specified a connection broker in the dfc.properties file ofyour application WAR file:at org.apache.catalina.startup.Bootstrap.main(Bootstrap.java:432)Caused by: DfDocbrokerException:: THREAD: main; MSG:[DFC_DOCBROKER_REQUEST_FAILED] Request to Docbroker "10.8.3.21:1489" failed; ERRORCODE: ff;NEXT: null



AWDK‑based application must have information about the available connection brokerin order to establish a connection to repositories. Refer to To configure connections indfc.properties before deployment:, page 41 for information on enabling the connection indfc.properties.

If the repository that is specified as the global repository is down, the following messagemay be displayed:Caused by: DfNoServersException:: THREAD: main; MSG:[DM_DOCBROKER_E_NO_SERVERS_FOR_DOCBASE]error: "The DocBroker runningon host (10.8.3.21:1489) does not know of a server for the specifieddocbase(wtD6winsql)"; ERRORCODE: 100; NEXT: null

DM_VEL_INSTANTIATION_ERRORThis error can be caused by several setup problems:• Not using a version 6 global registry repository• Installing DAB 5.3 on the same machine as the application server

Page not found error in browserIf the client browser uses the Java 1.6 JRE, the application URL may return a ʺpagecannot be foundʺ error. Check your product release notes for the supported browserenvironments.

Login page incorrectly displayedIf the login page displays several login buttons, the browser does not have the Sun Javaplugin installed. You must download and install the Sun Java plugin for the browser.

If the login page displays several controls with the same label, you have not turnedoff tag pooling in the application server. Refer to Tag pooling problem, page 99 fortroubleshooting information on this problem.



Slow performanceMany performance enhancements are documented inWeb Development Guide DevelopmentKit. You can also obtain a system sizing guide from the documentation on Powerlink.

Set dfc.diagnostics.resources.enable to false in dfc.properties unless you are using theDFC diagnostics. This setting uses a significant amount of memory.

Out of memory errors in console or logCheck to make sure that you have allocated sufficient RAM for the application serverVM. For more information, refer to Setting the Java memory allocation, page 28.

The following error is common when the MaxPermSize is set too low:java.lang.OutOfMemoryError: PermGen space

Slow display first timeThe 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.

DFC using the wrong directories on theapplication server

If you have not specified content transfer directories in dfc.properties, DFC will first lookfor global environment variables that set directory locations.

Application startup errorsIf you installed a WDK‑based application of version 5.x , it has modified your applicationserver startup file. Run the WDK‑based application uninstaller to remove thesemodifications. Modifications to the start script are no longer required by WDK 6.x.


http://powerlink.emc.com


Each WDK‑based application contains the libraries required for version 6.x within theWEB‑INF directory.

You must also verify that your application server host does not set environment variablesfor the JRE location which will cause the application to use the wrong JRE.

Tag pooling problemIf you have not properly disabled tag pooling in the application server, you will seeseveral instances of the same control on the login page. For instructions on disablingpooling in Tomcat, refer to Preparing JBoss and Apache Tomcat, page 29. For the SunJava System server, refer to Turning off tag pooling, page 34. For Oracle, refer toPreparing Oracle Application Server, page 33.

Caution: After you disable tag pooling, you must clear the cached JSP classfiles which still may contain pooled tags. Refer to your application serverdocumentation to find the location of the generated class files. For example, Tomcatdisplays the following error message:com.documentum.web.form.control.TagPoolingEnabledException:JSP tag pooling is not supported.

UCF client problemsIf the error message ʺCompatible Java Run time environment is not installed” isdisplayed on a non‑Windows client, make sure that you have installed version 1.5.0_06of the Sun JRE on the client; this version will be used by UCF and will not interfere withthe browser VM. The client browser VM must be one that is certified in the releasenotes. It will be used for non‑UCF applets.

If a UCF error is reported on the client, the following troubleshooting steps may help:• For UCF timeouts, check whether anti‑virus software on the application server is

monitoring port 8080 or the application server port that is in use. You may need toturn off monitoring of the application server port.

• For very slow UCF downloads, check to make sure virus scanning within zip filesis not turned on.

• Ensure that the user has a supported JRE version on the machine in order to initiateUCF installation. Supported JRE versions are listed in the DFC and Webtopapplication release notes. You can point the client browser to a Java tester utility suchas Javatester utility to verify the presence and version of a JRE.


http://www.javatester.org/version.html


• See if the process from the launch command is running: Open the browser Javaconsole look for ʺ invoked runtime: ... connected, uid: ... A UID indicates successfulconnection to the UCF server.

• Are there any errors on the UCF server side? Check the application server console.• Restart the browser and retry the content transfer operation.• Kill the UCF launch process and retry the content transfer operation.• If UCF operations still do not launch, delete the client UCF folder located in

USER_HOME/username/Documentum/ucf.• Search the client system for files that start with ucfinit.jar‑ and delete them.• Delete the JRE cache from the JRE Control Panel > Temporary Internet Files.• Delete the proxy server cache.

Citrix client problemsOn the Citrix Server, ensure that the WDK‑based application is published, the Citrixdesktop is published, and the user’s roaming profile is set up correctly so that UCF willnot download to the local host. Perform the following procedure to clean up UCF forroaming users if the roaming profile was not set up properly.

To configure the web application for roaming profiles

1. Delete the documentum directory that was installed in the user’s home directory, forexample, C:\Documents and Settings\<user name>\Documentum.

2. Edit ucf.installer.config.xml in /wdk/contentXfer in the WDK application.Change every environment variable in this file that uses the Java home directory$javauser.home to use the roaming profile environment variable:<defaults><ucfHome value="$env(USERPROFILE)/Documentum/ucf"/><ucfInstallsHome="$env(USERPROFILE)/Documentum/ucf"/><configuration name="com.documentum.ucf">

<option name="user.dir"><value>$envUSERPROFILE/Documentum</value></option>

3. Save and restart the application server.



Connection issues between an ECI Servicesserver and IPv6 clients

ECI Services server uses the RMI protocol to communicate with the client applications.When the client application launches a request against the ECI Services server, itindicates the IP address that the ECI Services server should use to respond. However ifthe client has multiple IPs, it may send an IP address that the ECI Services server cannotuse to respond. To avoid any connection issue, you need to modify the command thatlaunches the client by setting the Djava.rmi.server.hostname property in the Java options.

The following example describes how to update the catalina.bat script that launches theWDK application and forces the RMI IP to connect:set JAVA_OPTS=%JAVA_OPTS% Djava.rmi.server.hostname=<IPv6 address>

Web Publisher serverside installer errorsThe Web Publisher server‑side installer copies and installs files that are needed tocorrectly run the Web Publisher Java methods. If files are not correctly copied or installedyou may see errors when you try to perform certain tasks. Following is a common erroryou 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 isnot able to find the classes because the dctm.jar and wcm.jar files are not in the user’sclasspath.

You may receive this error if the Content Server environment is not correctly set up. Thiserror may manifest itself to the user if a user clicks Expire Now to expire a document inthe Web Publisher user interface.

If you do not discover the source of your error from the above steps, you should turn onthe Web Publisher tracing for server side methods.



Serverside tracing for Web PublisherYou may need to turn on server side tracing if you are having problems with yourapplication and cannot resolve them. Tracing captures information that will help youand Documentum determine the source of the issue.

To turn on serverside tracing:

1. Navigate to the log4j.properties file.

2. Add the location entry to the file, for example:log4j.appender.WcmAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.WcmAppender.File=C:\\DOCUMENTUM\\dba\\log\\wcm\\wcm_log.txtlog4j.appender.WcmAppender.Append=truelog4j.appender.WcmAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.WcmAppender.layout.ConversionPattern=%dHH:mm:ss,SSS %10r %5p [%10t] %20c %5x %m%nlog4j.appender.WcmAppender.DatePattern='.'yyyywwdd

3. Set the various trace parameters in the WcmTraceProp.properties file to true. Theseparameters are self‑explanatory. For example:com.documentum.wcm.Trace.WCMSESSIONENABLEDBYDEFAULT=truecom.documentum.wcm.Trace.WCMDQLUTIL=falsecom.documentum.wcm.Trace.WCMUTIL=truecom.documentum.wcm.Trace.WCMPARSERERROR=falsecom.documentum.wcm.Trace.WCMLIFECYCLESRVC=truecom.documentum.wcm.Trace.WCMDELETEOBJECT=falsecom.documentum.wcm.Trace.WCMCHECKINSRVC=falsecom.documentum.wcm.Trace.WCMCHECKOUTSRVC=falsecom.documentum.wcm.Trace.WCMCANCELCHECKOUTSRVC=falsecom.documentum.wcm.Trace.WCMEDITSRVC=falsecom.documentum.wcm.Trace.WCMSESSIONLIFECYCLEEVENT=truecom.documentum.wcm.Trace.WCMASYNCTASK=truecom.documentum.wcm.Trace.WCMPUBLISH=truecom.documentum.wcm.Trace.WCMCHANGESET=truecom.documentum.wcm.Trace.WCMAPPCONFIG=truecom.documentum.wcm.Trace.WCMSERVERMETHOD_SESSION=truecom.documentum.wcm.Trace.WCMCLIPBOARDSRVC=falsecom.documentum.wcm.Trace.WCMTRACE=truecom.documentum.wcm.Trace.WCMMONITORJOB=truecom.documentum.wcm.Trace.WCMPROCESSWORKFLOW=truecom.documentum.wcm.Trace.WCMDYNAMICCONTENTJOB=truecom.documentum.wcm.Trace.WCMOBJECTBAGJOB=truecom.documentum.wcm.Trace.WCMOBJECTBAGJOB_DETAIL=truecom.documentum.wcm.Trace.WCMSTRATTRANSLATIONWF=truecom.documentum.wcm.Trace.WCMSERVERSIDEUTIL=true

This will generate a WCM server‑side trace.You should also view the log statements in the server log file for error information.



DAR file installation failsWere you logged in to the repository as a Superuser? If you tried to install the DAR filewithout Superuser privileges, you might have rendered the repository unable to beused for Web Publisher.

Did the data dictionary job dm_DataDictionaryPublisher successfully complete beforeyou installed the DAR file? If the job did not install correctly and you tried to install theDAR file the DAR file 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\repository_name.

Refer to the Content Server Administration Guide for information on correcting anydm_DataDictionaryPublisher installation issue.

For other reasons the DAR file might have failed, check the installer log file. The log file’slocation is specified in the installation procedure.

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

Users cannot access functions that their rolesshould allow

Use Documentum Administrator to check the Web Publisher User Default ACL(permission set). The Web Publisher User Default ACL must 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 update theACL.

Error when invoking login page after deployingWP on Sun 9.1 app server

After deploying Web Publisher on Sun 9.1 application server, you may see the followingerror on initial login:A FATAL error has occurred.

Close all browser windows and try to login again. If the problempersists, contact support....

To resolve this problem, restart the domain after you have deployed wp.war on thisapplication server.


Chapter 10Deploying a Custom Application

The following topics describe tools that assist in packaging your custom application. Refer to yourproduct release notes to determine whether customization of the product is supported.

The following topic describes how to deploy your custom application:• Using the comment stripper utility, page 105

Using the comment stripper utilityYour JSP pages will load faster if you strip out white space and comments. A commentstripper tool, CommentStripper, is provided in /WEB‑INF/classes/com/documentum/web/tools. Table 9, page 105 describes the parameters to use in starting this tool fromthe console.

Table 9. Comment stripper utility parameters

Parameter Description

args filename Removes comments from a single file

args *.ext Removes comments from all files with thespecified extension

? Displays help

l Removes leading white space

t Removes trailing white space

m Removes HTML comment blocks <!‑...‑>and <!‑‑...‑‑>

j Removes JSP and JavaScript / * ... * /comments

r Recurses directories from current


Deploying a Custom Application

Parameter Description

oxx Uses specified extension instead ofoverwriting original file

v Outputs in verbose mode (OFF by default)

The tool has already been run on some WDK‑based applications such as Webtop. Thecommented files, useful for development, are provided in a JAR file in the base directory:unstripped.jar.


Appendix A

Predeployment Checklist

Use this checklist to ensure you have performed all required tasks when you deploy or upgradea WDK‑based application.

Table 10. Predeployment tasks

Requirement For More Information Completed?

Review the release notes for therelease you are installing or towhich you are upgrading.

The release notes are available on the EMCDocumentum download site.

Validate your hardwareconfiguration.

Release Notes

Validate your application serverand clients operating systems.

Release Notes

Create any required operatingsystem accounts.

Network administrators

Verify that the applicationserver instance owner has writepermissions on the temporarycontent transfer directories.

Network administrators. The requirementis described in Content transfer directorypermissions, page 16.

Determine the repositoriesto which end users of theapplication will connect.


Determine the connectionbrokers to which therepositories project.



Predeployment Checklist

Requirement For More Information Completed?

Determine which repositoryon the network is the globalregistry repository, and obtainthe global registry user’s username and password.


Determine which repositorieswill be used to store presets anduser preferences.


Determine whether languagepacks will be required.

Web Development Kit Applications LanguagePack Installation and Release Notes

Prepare the application serverhost and application serversoftware according to thevendor’s requirements.

Specific requirements are described inChapter 4, Preparing the ApplicationServer Host.


Index

AAccelera DAR file

installing, 62 to 70preinstallation requirements, 62

Accelera sample websiteDAR file, 25described, 61installing the DAR file, 50

Apache TomcatJava heap size, 28

applicationtools, 105

application server host requirementsJava heap size, 28

application serversperformance tuning, 28starting, 47startup files, 98verifying, 47

applicationsmultiple , 45

Bbacking up customizations, 37BEA WebLogic

domains, 30Java heap size, 28session affinity support, 35

browsersCitrix client, 24Internet Explorer, 22slow display, debugging, 98

CCitrix client, 24ClearTrust

configuration, 91clients

preparing, 21

set JVM, 21clustered environments, Oracle

Application Server, 33comment stripper, 105Composer, headless, 51, 57, 73configuration, typical, 14connection

troubleshooting, 96connection broker

troubleshooting, 96connection brokers, 40

deployment requirement, 14Content Server

deployment requirement, 14environment variables, 52requirements, 16versions, 16Web Publisher installation, 24

Content Server requirementsglobal registry, 16

content transferenable in IE7, 22enable inFirefox, 23temporary directory, 16

customizing applicationsbacking up customizations, 37developer licenses, 17

DDAM DAR files, 73DAR files

installation failures, 103installing on UNIX or Linux, 75installing using the DAR Installer, 73installing Web Publisher, 50Rich Media Services, 73Transformation, 73Web Publisher on UNIX, 59Web Publisher on Windows, 57

DAR Installer Plugin, 73


Index

DARs, 14requirement, 16

data dictionary, 49, 56, 70 to 71deep export

element, see italicstestdefault web applications, 49deploying

application server hostrequirements, 16

customizing an application, 17multiple applications, 17planning, 13required directories, 16single application server, 14supporting software, 14typical configuration, 14Web Publisher, 39

deploymentcompleting the process, 47testing, 87

developer licenses, 17developing applications, 17DFC

global registry, 40dfc.properties, 41

connection broker, 40directories

content transfer, 16permissions, 16

DNSrequirement, 17

docbrokertroubleshooting, 96

documentationrelated, 10

Documentum Administratorcustomizing, 17

domains, BEA WebLogic, 30

Eenvironment

variables, 29environment variables, 52

CLASSPATH, 101eWebEditPro

HTML integration, 77installing, 76XML integration, 78

external web servers, 35

FFirefox

preparing for content transfer, 23FolderMap.xml file, 62forward proxy

preparation, 35

Gglobal registry, 40

requirement, 16troubleshooting, 96

global security on IBMWebSphere, 48

Hheadless Composer, 51, 57, 73

IIBM WebSphere

global security, 48Java heap size, 28predeployment requirements, 30session affinity support, 35

iMarkup, 79, 82installation owner

content transfer directory, 16required permissions, 16

installingapplication server software, 27DAR file using the DAR Installer, 73DAR files on UNIX or Linux, 75DARs, 14eWebEditPro, 76host requirements, 14multiserver environments, 50Site Caching Services, 18UNIX hosts, 51virtual link support, 49Web Publisher, 57, 59 to 60Web Publisher DAR file, 50Web Publisher Page Builder, 83Web Publisher Portlet Builder, 82Web Publisher server files, 50Windows hosts, 51

installing DAR filesPage Builder, 83Portlet Builder, 82

Internet Explorer, 22


Index

Windows XP SP2, 24Internet Explorer 7

preparing for content transfer, 22

JJava

heap size, 28memory allocation values, 28

Java heapMaxPermSize parameter, 28

Java method server, 56JBoss

predeployment, 29

Llanguage packs, 17locales, enabling, 49localization, 17login page

troubleshooting, 97

MMaxPermSize parameter on BEA

WebLogic, 28memory

dfc.properties, 42modal pop‑up windows

enabling, 43multiple applications, deploying, 17multiserver environments, 50

OOracle Application Server

clustered environment, 33Java heap size, 28predeployment requirements, 33WebCache, 33

Oracle WebCache, 33out of memory errors, 28

PPage Builder

deploying Upload Application WARfile, 86

installing, 83installing DAR files, 83

migrating content from earlierversions, 85

upgrading, 83performance

DFC setting, 42tuning, 28

planning for deployment, 13policies

Sun Java System ApplicationServer, 34

WebSphere, 30pop‑up blockers, 22portal servers, 18Portlet Builder

installing, 82installing DAR file, 82

predeployment requirementsIBM WebSphere, 30Java heap size, 28JBoss, 29Oracle Application Server, 33Sun Java System Application

Server, 33Tomcat, 29WebLogic domain, 30

preferencesrepository, 42

preinstallation requirementsapplication server software,

preparing, 27Web Publisher Portlet Builder, 18

preparingapplication server host, 27client JVM, 21clients, 21

proxy serverpreparation, 35

Rregional options, setting, 63repositories

enabling locales, 49locales, enabling, 49

repositoryfor preferences, 42

required directoriescontent transfer, 16

reverse proxypreparation, 35


Index

Rich Media Services DAR file, 73RSA

configuration, 91

Ssecurity

WebSphere, 30session affinity support, 35single sign‑on

configuration, 91Site Caching Services, 13

described, 76installing, 76source software, 25target software, 36Web Publisher requirement, 18

SSOconfiguration, 91

startup files, application server, 98Sun Java

disabling, 22HTML editing applications, 22plugin, 21

Sun Java System Application Serverpredeployment requirements, 33

Ttag pooling

Sun Java System ApplicationServer, 34

troubleshooting, 99Tomcat

predeployment, 29tools

deployment, 105Transformation DAR file, 73troubleshooting

DAR file installation failures, 103text unaligned, 103Web Publisher install errors

exceptionNoClassDefFounderror, 101

Web Publisher role functions, 103Web Publisher server file errors, 101Web Publisher server side tracing, 102

Trusted Sites, 22typical configuration, 14

UUCF content transfer, 21uninstalling Web Publisher, 88UNIX and Linux requirements

Web Publisher server files, 51upgrading

application server startup files, 98overview, 37Page Builder, 83

Upload Application WAR file, 86

Vvariables

environment, 29viewing WDK samples, 87virtual link support

eWebEditPro, 77in 5.3 and later installations, 49legacy support, 49

WWAR file

for Page Builder, 86preparing for deployment, 39

WcmPostReplication DAR file, 61WDK (Web Development Kit)

customizing applications, 9described, 9documentation, 10

WDK applicationsaccessing, 87verifying, 87

Web PublisherAccelera sample website, 62DAR file, 25, 50, 52, 56, 60, 62DAR file installation failures, 103data dictionary, 70deploying, 39described, 13enabling iMarkup on Windows 2003

Server, 82environment variables, 101eWebEditPro HTML integration, 77eWebEditPro XML integration, 78exception

NoClassDefFounderror, 101HTML editing applications, 22iMarkup, 79


Index

Java methods, 56Java requirements, 22multi‑repository configurations, 61on UNIX hosts, 59on Windows hosts, 57Page Builder, 83Portlet Builder, 82preparing the Content Server host, 24roles, 103server files, 50, 52, 56server‑side tracing, 102Site Caching Services, 18, 25, 36troubleshooting roles, 103troubleshooting server‑side

installation, 101

WcmPostReplication DAR file, 61Web Publisher Contributor, described, 14Web Publisher Page Builder

described, 14installing, 83

Web Publisher Portlet Builder, 18described, 14installing, 82

web servers, external, 35Windows

Web Publisher server files, 51XP SP2, 24
