EMC Documentum Web Publisher

Transcription

1 EMC Documentum Web Publisher Version 6 Deployment Guide P/N EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published August 2007 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

3 Table of Contents Preface... 9 Chapter 1 Planning for Deployment About Web Publisher Typical configuration Content Server requirements Deploying multiple applications Customizing an application Required and optional supporting software Application server host requirements Directory name restriction Content transfer directory permissions DNS resolution Deploying language packs Portlet server Documentum Process Integrator Documentum Site Caching Services Optional LDAP server Chapter 2 Preparing the Client Hosts Ensuring a certified JVM on browser clients JVM requirements for Web Publisher Editor and Rules Editor Clearing the browser cache Supporting Outlook mail message archives Using Citrix Presentation Server Client Enabling UCF content transfer in Internet Explorer 7 on Windows Vista Additional considerations for Web Publisher Chapter 3 Preparing the Application Server Host Setting the Java memory allocation Preparing Apache Tomcat Preparing BEA WebLogic Supporting large content transfer operations in a managed server environment Preparing IBM WebSphere Supporting failover in a cluster Applying policies for WebSphere global security Supporting non-default content transfer locations Preparing Oracle Application Server EMC Documentum Web Publisher Version 6 Deployment Guide 3

4 Table of Contents Preparing Sun Java System Application Server Turning off tag pooling Modifying the Sun policy file Installing the Site Caching Services target software Preparing to use an external web server Chapter 4 Preparing to Upgrade Web Publisher Backing up customizations Cleaning up the application server startup script Uninstalling previous versions Preparing 4.x client hosts for an upgrade Chapter 5 Deploying Web Publisher Preparing the WAR file for deployment Enabling DFC connections to repositories Enabling preferences repositories Configuring external searches Deploying multiple applications Chapter 6 Completing the Deployment Configuring UCF Supporting multiple WDK applications Configuring IBM WebSphere after deployment Changing the classloader and compiler settings Configuring single sign-on support Deploying default virtual link support Enabling additional locales in the repository Installing the Web Publisher server files and DocApp Where the DocApp and server files are installed Enhanced support for multi-repository configurations About the Web Publisher server files About the Web Publisher DocApp Installing the Site Caching Services source software Installing the DocApp and server files on Windows hosts Installing the DocApp and server files on UNIX and Linux hosts Installing the server files Installing the DocApp Updating the data dictionary after installation Output of the data dictionary script Installing DAM DocApps Installing the Accelera DocApp Accelera preinstallation requirements Setting the regional options on Windows hosts Accelera installation requirements Installing the Accelera DocApp Creating the Accelera database schema Installing and configuring Site Caching Services Modifying the DbUtils.inc file Creating a site publishing con guration Creating the WEB-INF folder Testing the Accelera DocApp installation EMC Documentum Web Publisher Version 6 Deployment Guide

5 Table of Contents Publishing documents to the sample web site Using ewebeditpro Obtaining ewebeditpro Installing ewebeditpro HTML integration Installing ewebeditpro XML integration Installing imarkup Enabling imarkup on Windows 2003 Server Completing the Web Publisher Portlet Builder installation process After Web Publisher Portlet Builder is installed Completing the Web Publisher Page Builder installation process Accessing the application Connecting to 5.3x repositories Testing WDK samples Uninstalling the Web Publisher server files Chapter 7 Troubleshooting Deployment No connection to repository No global registry or connection broker Slow browser display Web Publisher server-side installer errors exception NoClassDefFounderror... com.documentum.wcm. servermethod.wcmexpirenowactionhandler Server-side tracing for Web Publisher DocApp installation fails Text unaligned Users cannot access functions that their roles should allow Chapter 8 Deploying a Custom Application Using the comment stripper utility Packaging a WAR file for deployment Appendix A Deployment Checklist EMC Documentum Web Publisher Version 6 Deployment Guide 5

6 Table of Contents List of Figures Figure 1. Basic WDK host configuration EMC Documentum Web Publisher Version 6 Deployment Guide

7 Table of Contents List of Tables Table 1. Output directories and JVM custom properties Table 2. Directories and files to back up Table 3. Preferences configuration elements Table 4. Location of DocApp and Web Publisher server files on UNIX hosts Table 5. Location of DocApp and Web Publisher server files on Windows hosts Table 6. Page Builder DocApp files Table 7. Comment stripper utility parameters Table 8. Deployment tasks EMC Documentum Web Publisher Version 6 Deployment Guide 7

8 Table of Contents 8 EMC Documentum Web Publisher Version 6 Deployment Guide

9 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 other WDK-based applications. However, this guide includes Web Publisher-specific considerations and procedures throughout. Web Development Kit (WDK) is a developer toolkit based on industry standards that facilitates the development of complex web-based applications connecting to Documentum Content Server and content repositories. WDK contains a large library of reusable components and controls that perform common content management functions and provide a uniform user interface to applications built with WDK. Webtop is a web application built on WDK that serves as the basis for the Documentum web client applications. These applications can be customized using WDK. For additional information on developing or customizing applications with WDK, refer to the Web Development Kit and Client Applications Development Guide. This guide may include instructions for application servers, or combinations of operating systems and applications servers that are not supported for your product. For the list of supported platforms, refer to the release notes for the product that you are deploying. Intended audience This manual is intended primarily for administrators who are deploying an application based on WDK or Webtop. EMC Documentum web client products are built on WDK and Webtop and have their own deployment guides that contain the general information in this guide as well as information specific to the product. To deploy a WDK-based application, you should be familiar with the application server s operating system and be able to install and configure a J2EE application server. EMC Documentum Web Publisher Version 6 Deployment Guide 9

10 Preface Revision history The following changes have been made to this document: Revision history Revision date August 2007 Description Initial publication for version 6.0 release. Related documentation You can download this deployment guide and the release notes applicable to WDK and the Webtop applications on the product download site. Each Webtop application contains an online user guide in HTML format and a PDF version of that guide in the help subdirectory of the application WAR file. The following developer documentation is available on the product download site for configuring and customizing WDK and Webtop applications. Additionally, each WDK-based product may have its own development guide. Refer to the download site for the product to obtain a product-specific development guide. WDK and Client Applications Development Guide WDK Reference Guide WDK and Applications Tutorial JavaDoc API reference documentation 10 EMC Documentum Web Publisher Version 6 Deployment Guide

11 Chapter 1 Planning for Deployment This chapter addresses software and hardware decisions you must make before you deploy WDK or a Webtop-based application. This chapter discusses the following topics: About Web Publisher, page 11 Typical configuration, page 12 Deploying multiple applications, page 14 Customizing an application, page 14 Required and optional supporting software, page 15 Portlet server, page 16 Documentum Process Integrator, page 17 Documentum Site Caching Services, page 17 Optional LDAP server, page 17 Application server host requirements, page 15 Deploying language packs, page 16 About Web Publisher Web Publisher simplifies and automates the creation of content for websites. Authors create and modify content without having to know how to construct web pages. Content is automatically published to multiple sites in multiple languages and formats. Developers use Web Publisher to maintain web page templates and site structures. Administrators maintain the Web Publisher system settings. Web Publisher connects to Content Server to store content in a repository and perform content management functions. Documentum Site Caching Services (SCS) is used to publish content from a repository to a designated location on a web site. EMC Documentum Web Publisher Version 6 Deployment Guide 11

12 Planning for Deployment Web Publisher Portlet Builder is an application built on top of Web Publisher that is used to create JSR-168 compliant portlets and deploy the portlets to portal servers. Using Portlet Builder, you can create portlets comprised of either repository content or content from external sources. Portlets can display static content or generated content. Generated content can be gathered from RSS feeds or web services. Web Publisher Page Builder is a Web Publisher editor that lets you create and edit a web pages while viewing the page as it will appear on the web. Unlike many web page development tools, Page Builder is fully browser-based and does not require downloading applets or ActiveX controls. Web Publisher Contributor is a simplified Web Publisher user interface. Using Web Publisher Contributor you can create content, edit content, and publish content to the web. Web Publisher Contributor makes the job of a contributor user easier by focusing on the tasks that they perform regularly. The interface is also configurable so that users can choose to have the functionality that they use often readily available to them and hide the functionality that they do not use. Typical con guration When deployed on a single application server, a typical WDK-based application requires the 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 browser Figure 1, page 13 shows the network components. 12 EMC Documentum Web Publisher Version 6 Deployment Guide

13 Planning for Deployment Figure 1. Basic WDK host con guration Caution: For security and performance reasons, do not install the Content Server and a WDK-based application on the same host. In addition, the Content Server installs an internal WebLogic server that for licensing reasons cannot be used to deploy web applications. Clustered environments WDK-based applications can be deployed in supported clustered environments. Refer to the release notes for each WDK-based application to learn which managed server configurations are supported. Content Server requirements The following topics describe Content Server requirements. If your application is certified for connections to either 5.3 or version 6 Content Server repositories, you must use a Content Server 6 global registry. If you connect to a 5.3 repository, the following functionality will not be available: Presets EMC Documentum Web Publisher Version 6 Deployment Guide 13

14 Planning for Deployment Accelerated Caching Services (ACS) and Branch Office Caching Services (BOCS) write operations Create relationships Lifecycle enhancements in the properties, checkin, import and new document UI. Content Server 6 installs the required DocApps for a WDK-based application. You do not need to perform a separate installation of these. A global registry must be installed in your environment in order to run a WDK-based application. A global registry is a Content Server that has been designated as a global registry. For information on designating your application s global registry before deployment, refer to Enabling DFC connections to repositories, page 38. Caution: The global registry must be Content Server version 6. Deploying multiple applications You can deploy multiple WDK-based applications on a single host. Each instance of an application must be deployed to a different virtual directory. If the applications share the same application server instance, the applications must be the same version--version 6 or higher. You can deploy applications to separate instances of the application server. If the applications use different versions of DFC, you must deploy them in separate application server instances. Caution: A 5.3.x application cannot share the same instance as a version 6 application. One or both of the applications will not work properly. Customizing an application A developer license is required to develop custom applications. See your EMC Documentum account representative to obtain a developer license. Configuration Configuration is defined for support purposes as changing an XML file or modifying a (JavaServer 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 extension of WDK classes or the modification of JSP pages to include new functionality. Customization requires a developer license. 14 EMC Documentum Web Publisher Version 6 Deployment Guide

15 Planning for Deployment Customization of Documentum Administrator is not supported. Required and optional supporting software Additional software products are required for WDK and WDK applications including the 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. Refer to To configure connections in dfc.properties before deployment:, page 39 for information on configuring the docbroker before deployment. J2EE application server or servlet container All WDK-based applications require DocApps that must be installed in the repository. The Webtop DocApps are provided in Content Server version 6. If your application supports connections to a Content Server version 5.3.x, you must have a Content Server 6 global registry. The following features in the Webtop DocApps will not be available with a 5.3.x Content Server: ACS distributed write Create relationship Presets If the Content Server version is 5.3, the read notification feature will use the 5.3 notification script that is configured in the Content Server. It will not provide metadata or links. Application server host requirements The application server host used for WDK-based applications has the requirements described in the following sections. Directory name restriction Java does not allow directories containing the following characters, which must not appear in the directory names or paths of Documentum applications:! \ / : *? " < > EMC Documentum Web Publisher Version 6 Deployment Guide 15

16 Planning for Deployment Content transfer directory permissions The content transfer directory on the application server host is used to store files temporarily 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 write permissions on this temporary content transfer location. You can change the default value to a location on your application server host for which the application server instance owner has write permission. For information on specifying locations in the Unified Client Facilities (UCF) client and server configuration files, refer to Web Development Kit Development Guide. Some application servers require policies that grant permissions to write to these directories. Refer to deployment information for your application server to see Documentum policy settings. DNS resolution The Domain Name Server must be configured to properly resolve IP addresses based on the URL used to access the server. Deploying language packs Language packs are available to localize (translate) WDK-based applications. A language pack is a language-specific archive file that contains a graphical user interface (GUI) and user documentation that have been localized into a language other than the default application language, U.S. English. To deploy language packs, unpack your product WAR file and add the language packs according to the instructions in Web Development Kit Applications Language Pack Installation and Release Notes. Portlet server Web Publisher Portlet Builder requires a portlet server installed and configured to run with your application server. Refer to the application server and portlet server documentation for installation and configuration instructions. 16 EMC Documentum Web Publisher Version 6 Deployment Guide

17 Planning for Deployment Documentum Process Integrator Web Publisher Portlet Builder requires Process Integrator (PI) for using workflow templates. Refer to the Process Integrator documentation for installation instructions. Documentum Site Caching Services Documentum Site Caching Services (SCS) publishes documents from a Documentum repository directly to a website. SCS allows you to identify groups of documents to publish to the website, which version and format to publish, and when to publish the documents. This ensures that content on your website is accurate and timely. Site Caching Services is required by Web Publisher. Optional LDAP server You can optionally use an LDAP server with Web Publisher Portlet Builder. For information on configuring the LDAP server, refer to the Portlet Builder Administration Guide. EMC Documentum Web Publisher Version 6 Deployment Guide 17

18 Planning for Deployment 18 EMC Documentum Web Publisher Version 6 Deployment Guide

19 Chapter 2 Preparing the Client Hosts This chapter contains information on the following pre-deployment tasks: Ensuring a certified JVM on browser clients, page 19 JVM requirements for Web Publisher Editor and Rules Editor, page 20 Clearing the browser cache, page 20 Supporting Outlook mail message archives, page 20 Using Citrix Presentation Server Client, page 20 Enabling UCF content transfer in Internet Explorer 7 on Windows Vista, page 21 Additional considerations for Web Publisher, page 22 Ensuring a certi ed JVM on browser clients Browser client hosts require a certified version of the Sun Java virtual machine (JVM) to initiate content transfer in a WDK application. New machines may not have a VM installed in the browser. Check the release notes for your product version for the JVMs that are supported. If the WDK-based application is configured to use UCF content transfer, a lightweight applet is downloaded to the browser when the client makes the first content transfer or preferences request. If the JVM required for UCF is not present on the client machine, UCF uploads to the client a private JVM. This VM does not replace the JVM that is used by the browser. 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. EMC Documentum Web Publisher Version 6 Deployment Guide 19

20 Preparing the Client Hosts JVM requirements for Web Publisher Editor and Rules Editor To use an HTML editing application in Web Publisher, such as Web Publisher Editor or Rules Editor, you must have the Sun JVM installed and enabled. The Microsoft VM is not supported with Web Publisher Editor and Rules Editor. The Sun JVM is installed with Netscape but not with Internet Explorer. Clearing the browser cache Browsers cache JavaScript. WDK-based applications contain changes to the JavaScript files that existed in 5.x applications. Cached JavaScript in the browser from a 5.x WDK-based application may cause errors when the user connects to a version 6 application. Clear the browser JavaScript cache to avoid these errors. Supporting Outlook mail message archives WDK supports viewing and exporting dm_message_archive objects. If your WDK-based product displays Outlook mail messages, read these instructions. The objects can be viewed as HTML or as.msg files in Outlook. To view or export dm_message_archive objects as.msg files, the client must download and install a converter. This converter can be automatically installed as part of the UCF download. To enable automatic download, uncomment the ExMRE.exe section in the app\wdk\contentxfer\ucf.installer.config.xml file on the application server. The converter can take a long time to download and install. You can avoid the delay by deploying the ExMRE.exe installer using standard mechanisms such as Microsoft Systems Management Server (SMS). Using Citrix Presentation Server Client Citrix Presentation Server Client can be used as a web browser. Check the release notes for your WDK-based product to determine whether Citrix clients are supported for your product. In the Citrix environment, content files are exported or checked out to the Presentation Server host, not to individual client hosts. Each individual user works on a client 20 EMC Documentum Web Publisher Version 6 Deployment Guide

21 Preparing the Client Hosts host 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 to documentation provided by Citrix. Note: If you have previously attempted to content transfer to the client, it will use the client s location machine, and you must delete the ucf directory that was installed on the local client machine under the user s OS home directory, for example, C:\Documents and Settings\pradeep\Documentum\ucf. Enabling UCF content transfer in Internet Explorer 7 on Windows Vista Internet Explorer 7 on Windows Vista OS does not display a file download dialog to permit UCF content transfer unless it is enabled by adding the application server host to 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 con gure UCF to use le 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. EMC Documentum Web Publisher Version 6 Deployment Guide 21

22 Preparing the Client Hosts 3. Locate the element <platform os="windows" arch="x86">, which configures Windows clients. 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. Additional considerations for Web Publisher This section provides high-level instructions for installing supporting software required by Web Publisher on the Content Server host and in the repository. Some of these tasks must be completed after installing Web Publisher on the application server host. For complete instructions for the tasks listed below, refer to Chapter 6, Completing the Deployment. Install the Site Caching Services source software. This may be done before or after installing Web Publisher on the application server host. For more information, refer to Installing the Site Caching Services source software, page 56 and the Site Caching Services Installation Guide. Install the Web Publisher server files on the Content Server host. Install the server files after installing Web Publisher on the application server host. The server files contain Java methods that are executed on the Content Server host by the Java method server. The Java methods contain classes that are invoked by automatic activities in the default Web Publisher workflow. For details on installing the Web Publisher server files and DocApp, refer to Chapter 6, Completing the Deployment. Install the Web Publisher DocApp in the repository. Install the DocApp after installing Web Publisher on the application server host. The DocApp installs cabinets, folders, object types, lifecycles, workflow templates, permission set templates, alias sets, jobs, procedures, and methods required by Web Publisher. The Web Publisher DocApp also creates the dm_relation objects used by Web Publisher, sets lifecycles to execute as a Superuser, creates the four Web Publisher user roles (administrator, Web developer, content manager, and content author), and creates the Web Publisher default ACL. For details on setting up users, refer to the Web Publisher Administration Guide. 22 EMC Documentum Web Publisher Version 6 Deployment Guide

23 Preparing the Client Hosts You may optionally install the DocApp for the Web Publisher sample web site, called Accelera, in the repository. EMC Documentum Web Publisher Version 6 Deployment Guide 23

24 Preparing the Client Hosts 24 EMC Documentum Web Publisher Version 6 Deployment Guide

25 Chapter 3 Preparing the Application Server Host This chapter describes the tasks you must complete to prepare the application server host. Before you deploy a WDK-based application, ensure that your J2EE application server or Apache Tomcat servlet container is a supported version and that it can successfully serve sample JSP pages. Refer to the release notes for your EMC Documentum product for information about supported application servers and platforms. This section contains information on preparing the application server software before deploying a WDK application. This chapter contains the following sections: Setting the Java memory allocation, page 25 Preparing Apache Tomcat, page 26 Preparing BEA WebLogic, page 26 Preparing IBM WebSphere, page 27 Preparing Oracle Application Server, page 30 Preparing Sun Java System Application Server, page 31 Preparing to use an external web server, page 32 EMC Documentum does not provide support for installing or running application servers. Refer to the documentation for each application server for instructions on installing, stopping, starting, and running the application server. Contact the application server vendor for technical support. Setting the Java memory allocation The minimum recommended Sun Java memory allocation values for application servers on a small system are the following: -Xms1024m -Xmx1024m EMC Documentum Web Publisher Version 6 Deployment Guide 25

26 Preparing the Application Server Host Application servers can slow down, throw exceptions, or crash with an application that has a large number of Java Server Pages. Set the MaxPermSize parameter to 128 or higher to avoid this problem. Document caching can consume at least 80 MB of memory. User session caching can consume approximately 2.5 MB to 3 MB per user. Fifty connected users can consume over 200 MB of VM memory on the application server. Increase the values to meet the demands of the expected user load. For more information on these settings, refer to Java documentation at the Sun web site ( More information on application server performance tuning and benchmarking for Documentum products is available from your EMC Documentum SE or EMC Documentum Consulting. Preparing Apache Tomcat Please refer to your product release notes to determine whether Apache Tomcat is a supported application server for your product. You must disable tag reuse in Apache Tomcat in the web.xml file of the Tomcat /conf directory. Find the JSP servlet entry in web.xml. Add the enablepooling initialization parameter and set it to false: <servlet> <servlet-name>jsp</servlet-name> <servlet-class>org.apache.jasper.servlet.jspservlet</servlet-class> <init-param> <param-name>enablepooling</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>fork</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>xpoweredby</param-name> <param-value>false</param-value> </init-param> <load-on-startup>3</load-on-startup> </servlet> Preparing BEA WebLogic Please refer to your product release notes to determine whether BEA WebLogic is a supported application server for your product. 26 EMC Documentum Web Publisher Version 6 Deployment Guide

27 Preparing the Application Server Host The following topic describes preparations that may be necessary before you deploy a WDK-based application. Supporting large content transfer operations in a managed server environment If you are deploying in a WebLogic Managed Server environment and you use UCF to perform large content operations, set the WLIOTimeoutSecs parameter for the web server 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 WebSphere Please refer to your product release notes to determine whether IBM WebSphere is a supported application server for your product. The following topics describe how to prepare the application server to support failover in a cluster, to apply policies for global security, and to support non-default content transfer locations. Refer to your product release notes to determine whether failover is supported for your application. Supporting failover in a cluster Failover in a clustered environment requires a setting. Set the NoAffinitySwitchBack custom property to true in the WAS cluster. For more information on this setting, refer to the WebSphere documentation. Applying policies for WebSphere global security If WebSphere global security is enabled for the application server, you must apply the policies in the Documentum files app.policy, library.policy and was.policy. These files are provided by 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 to run without error. Add these policies to your existing files. EMC Documentum Web Publisher Version 6 Deployment Guide 27

28 Preparing the Application Server Host You must set up the environment variables that are referenced in these policies, and the application 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 the directory 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 the dfc.data.dir directory. To add additional policies for non-default content transfer locations, add the following lines to library.policy. For each policy that you add, set up an 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 the user directory for the application server host machine is a non-default location. The default 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) These environment variables must specify the same location as the value of the dfc.properties keys dfc.checkout.dir and dfc.export.dir. The default locations for these directories are checkout 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.registry environment variable must match the location specified in dfc.properties for the key dfc.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"; 28 EMC Documentum Web Publisher Version 6 Deployment Guide

29 Preparing the Application Server Host Policy for non-webtop WDK-based temporary content transfer (non-default location) You can use this policy for TaskSpace or other application that is not based 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 default location 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 is dfc.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"; Supporting non-default content transfer locations If you want to use non-default locations for content transfer, you must create custom JVM properties using the WebSphere administration console. Create a JVM custom property named dfc.data to reflect the path to the location. The value must match the value of dfc.data.dir in dfc.properties. Table 1, page 30 shows the custom properties you must create each DFC output directory that is not the default location. EMC Documentum Web Publisher Version 6 Deployment Guide 29

30 Preparing the Application Server Host Table 1. Output directories and JVM custom properties DFC output directory key dfc.data.dir dfc.user.dir dfc.checkout.dir dfc.export.dir dfc.registry.file JVM custom property name dfc.data dfc.user dfc.checkout dfc.export dfc.registry For dfc.registry, type the path to the parent directory of the file. Refer to the documentation for WebSphere for information on modifying JVM custom properties. Preparing Oracle Application Server Please refer to your product release notes to determine whether Oracle Application Server 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 compiletime to the value none as shown in the following example: <servlet> <servlet-name>jsp</servlet-name> <servlet-class>oracle.jsp.runtimev2.jspservlet</servlet-class> <init-param> <param-name>tags_reuse_default</param-name> <param-value>none</param-value> </init-param> </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> <init-param> <param-name>tags_reuse_default</param-name> <param-value>none</param-value> </init-param> </servlet> 30 EMC Documentum Web Publisher Version 6 Deployment Guide

31 Preparing the Application Server Host Preparing Sun Java System Application Server Please refer to your product release notes to determine whether Sun Java System Application 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-based applications. For the domain in which you will deploy the application, open default-web.xml, for example, install path/domains/domain1/config/default-web.xml Add the following <init-param> to the jsp servlet declaration as follows <servlet> <servlet-name>jsp</servlet-name> <servlet-class>org.apache.jasper.servlet.jspservl <init-param> <param-name>xpoweredby</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>enablepooling</param-name> <param-value>false</param-value> </init-param> <load-on-startup>3</load-on-startup> </servlet> Modifying the Sun policy le You must modify the server.policy file located in the server instance /config directory to add permissions for DFC location variables. Add the following policies if they are not already present in your file: grant { permission 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; }; EMC Documentum Web Publisher Version 6 Deployment Guide 31

32 Preparing the Application Server Host Replace the following variable in these policies or create an environment variable for it so that it can be resolved: $(instance.config.dir): The instance configuration directory, example: /var/opt/sunwappserver7/domains/domain1/server1/config/ Installing the Site Caching Services target software 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. For information on installing SCS, refer to the Site Caching Services Installation Guide. Preparing to use an external web server Please refer to your product release notes to determine whether external web servers are supported for your product. External web servers are sometimes used as a front end to the application server. For example, an external web server may be used for balancing the loads on a collection of application servers or used as a forward or reverse proxy server. UCF content transfer uses chunked transfer encoding, a standard of the HTTP 1.1 specification. Many proxy web servers such as the Sun server implement chunked transfer encoding a way that does not work properly with UCF. If the external server does not support HTTP 1.1 chunked encoding, you must configure UCF in the WDK-based application to use an alternative chunked encoding. The Web Development Kit and Client Applications Development Guide contains information on this configuration. If you are deploying in a manager server or network deployment environment, the external web server must provide session affinity support. 32 EMC Documentum Web Publisher Version 6 Deployment Guide

33 Chapter 4 Preparing to Upgrade Web Publisher Review this chapter and perform the tasks described in it before upgrading WDK application. This chapter contains the following information: Backing up customizations, page 33 Cleaning up the application server startup script, page 34 Uninstalling previous versions, page 34 Preparing 4.x client hosts for an upgrade, page 36 Backing up customizations If you customized a 5.x WDK-based application, Table 2, page 33 shows the files, directories, and subdirectories on the application server host that should be backed up. Customization of Documentum Administrator is not supported. Table 2. Directories and les to back up Directory/file /custom/app.xml /custom and subdirectories /custom/config /custom/strings /custom/theme subdirectories /WEB-INF/classes subdirectories /custom/src subdirectories /WEB-INF/tlds To back up if present app.xml JSP files XML files Properties files Branding files Custom classes Custom source files Custom tag libraries EMC Documentum Web Publisher Version 6 Deployment Guide 33

34 Preparing to Upgrade Web Publisher After upgrading, recompile your custom classes to ensure that the custom code still works. Add your backed up files to the new application for testing. For information about migration, refer to System Migration Guide. Cleaning up the application server startup script If you installed a WDK-based application of version 5.x, it has modified your application server startup file. Run the WDK-based application uninstaller to remove these modifications. Modifications to the start script are no longer required by WDK 6. Each WDK-based application contains the libraries required for version 6 within the WEB-INF directory. You must also verify that your application server host does not set environment variables for the JRE location which will cause the application to use the wrong JRE. Uninstalling previous versions It is recommended that you uninstall every application that uses DFC 5.x, and DFC 5.x itself, before deploying an application based on WDK 6. The following topics describe how to uninstall previous versions of WDK-based applications. They do not apply to WDK-based application of version 6. Those applications are not installed, so they cannot be uninstalled. When you run the 5.3.x uninstaller, the application server must be in the following state: Apache Tomcat must be stopped. BEA WebLogic must be running. IBM WebSphere must be running. Oracle Application Server must be running. Sun Java System Application Server must be running. You must ensure that the application server is in the correct state before running the uninstaller. Uninstalling a WDK-based application If only one instance of a product is installed on the application server host, use the Add/Remove Programs feature of Windows to uninstall the software. If multiple instances are installed or you are not sure how many instances are installed, navigate to the uninstaller directory for each instance you are removing and use the following procedure. 34 EMC Documentum Web Publisher Version 6 Deployment Guide

35 Preparing to Upgrade Web Publisher To uninstall WDK or a WDK application 1. Connect to the host as the application server installation owner. 2. Stop all other running programs. 3. Navigate to the appropriate uninstaller directory. Perform one of the following: a. On Windows: DFC_program_root\_uninst\product_name\app_server_name\virtual_dir The default path for the DFC program root on Windows is C:\Program Files\Documentum. b. On UNIX: $DOCUMENTUM_SHARED/_uninst/product_name/ app_server_name/virtual_dir 4. Perform one of the following: a. On Windows, double-click uninstall.exe. b. On UNIX, type the following command:./uninstall.bin Uninstalling DFC After all Documentum products are removed from the application server host, Documentum Foundation Classes (DFC) can be uninstalled and all remaining Documentum files, directories, and registry entries (if applicable) can be removed. You can also remove DFC from client hosts that have no Documentum applications installed. To uninstall DFC on Windows 1. Select Start > Settings > Control Panel > Add or Remove Programs. 2. Select Documentum DFC Runtime Environment. 3. Click Remove. If this product is the last Documentum product on the host, a dialog box is displayed that asks if you want to remove the JDK and other Documentum settings and directories. This removes Documentum from your registry settings. To uninstall DFC on UNIX or Linux 1. Navigate to $DOCUMENTUM_SHARED/_uninst/dfc. 2. Start the uinstaller:./uninstall.bin 3. Choose Remove Documentum completely. Uninstalling a WDK application that was installed by another user To uninstall Documentum products installed by a user other than yourself, you must change two parameters in the uninstall.ini file. EMC Documentum Web Publisher Version 6 Deployment Guide 35

36 Preparing to Upgrade Web Publisher To modify the uninstall.ini le: 1. Navigate to the product s _uninst directory. 2. Open the uninstall.ini file in a text editor. 3. Modify the values of the USER_ACCOUNT and USER_DOMAIN parameters: USER_ACCOUNT=new_user_account USER_DOMAIN=new_user_domain 4. Save the uninstall.ini file. Uninstalling a product that was installed on UNIX as root If you installed a product as root on a UNIX host, you cannot uninstall the product using the uninstaller. You must remove all Documentum installer entries from the /var/sadm/pkg directory. These are files with names that begin with IS. Run the following command to list all files in the directory beginning with IS: ls -rf /var/sadm/pkg/is* If no non-documentum files are returned by the list command, remove all of the Documentum installer files with this command: rm -rf /var/sadm/pkg/is* Caution: If there are non-documentum files that match the IS* wildcard expression, you must enumerate the Documentum files in the rm command. Preparing 4.x client hosts for an upgrade Before you upgrade to the current release, check in any objects checked out with Documentum clients that used DFC version 4.2 or earlier. DFC 6 cannot locate objects checked out by using DFC 4.x versions. 36 EMC Documentum Web Publisher Version 6 Deployment Guide

37 Chapter 5 Deploying Web Publisher After you complete the required predeployment tasks, deploy Web Publisher on the application server host. The following topics describe deployment information: Preparing the WAR file for deployment, page 37 Enabling DFC connections to repositories, page 38 Enabling preferences repositories, page 39 Configuring external searches, page 40 Deploying multiple applications, page 41 Preparing the WAR le for deployment Perform the following procedure to prepare the WDK-based application WAR file. To deploy a WDK-based application 1. Download the WDK application WAR file from the EMC download site to a temporary directory on the application server host. 2. Unpack the WAR file and modify the dfc.properties file following the instructions in Enabling DFC connections to repositories, page 38. You must perform this procedure before attempting to connect to Documentum repositories. 3. Enable the optional presets and preferences repositories in dfc.properties following the instructions in Enabling preferences repositories, page Add or migrate customizations from previous WDK-based applications. 5. Apply language packs if you have purchased them. 6. Re-archive the WAR file. EMC Documentum Web Publisher Version 6 Deployment Guide 37

38 Deploying Web Publisher 7. Deploy the WAR file according to the deployment instructions in your application server documentation. Enabling DFC connections to repositories You must provide connection broker and global registry values in dfc.properties before your application can connect to repositories. A global registry of Content Server version 6 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.xml The System Deployment Guide contains information about enabling a repository as a global registry. You can copy information from the dfc.properties file that was generated by the Content Server installer on your global registry host. The generated dfc.properties file contains the connection broker address and the encrypted global registry user login information. To use the dfc.properties le information from the global registry Content Server 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 UNIX hosts, 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]=address dfc.globalregistry.repository=repository_name dfc.globalregistry.username=username dfc.globalregistry.password=encrypted_password 4. Unpack the application WAR file. 5. Open the dfc.properties file located in WEB-INF/classes within this expanded WAR file 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 changes to it. 8. Save the dfc.properties file and deploy the application. 38 EMC Documentum Web Publisher Version 6 Deployment Guide

39 Deploying Web Publisher Note: If you create a new WAR file from this application directory, you must ensure that any paths that you specify in dfc.properties are valid directories on the application server and that the application server instance owner has write permission on the specified directories. To con gure 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 can add 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 a port 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 access to 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.properties file on the global registry Content Server host, or you can select another global registry user and encrypt the password using the following command from a command prompt (assumes the directory containing javaw.exe is on the system path): java -cp dfc.jar com.documentum.fc.tools.registrypasswordutils password_to_be_encrypted Enabling preferences repositories By default, persistent preferences are stored in the global repository. For better performance, you can configure your application to use different repositories for persistent preferences. Add your preferences repository settings to app.xml in the /custom directory of the application. Copy the entire <preferencesrepository> element from /wp/app.xml into EMC Documentum Web Publisher Version 6 Deployment Guide 39

40 Deploying Web Publisher /custom/app.xml and then specify your repository. For information on other preferences settings in app.xml, refer to Web Publisher Development Guide. Table 3. Preferences con guration elements Element <preferencesrepository>.<repository_path>.<repository> Description Contains a <repository> element. If this element is not present, user preferences are stored in the global repository, which can slow down performance. Specifies the path within the preference repository in which to store preferences. If the path does not exist at application startup, it will be created. Specifies the repository in which to store preferences, preferably not the global repository. Con guring external searches In order for users to search external sources, an administrator must configure Web Publisher s connection to an ECIS search server. If this connection has not been configured, users cannot include external sources in a search. To con gure the connection to an ECIS search server: 1. Navigate to dfc.properties, located in one of the following, depending on the operating system: %DOCUMENTUM%\config\repository_name $DOCUMENTUM/config/repository_name 2. Open dfc.properties in a text editor. 3. Enable the ECIS search server by setting the following: dfc.search.ecis.enable=true 4. Specify the RMI Registry host to connect to ECIS server by setting the following: dfc.search.ecis.host=localhost dfc.search.ecis.port=port where localhost is the IP address or machine name of the ECIS server, and port is the port number Web Publisher uses to access the ECIS server. The default port is EMC Documentum Web Publisher Version 6 Deployment Guide

41 Deploying Web Publisher Deploying multiple applications A WDK-based application of version 5.3.x cannot share the same application server instance as a version 6 application. Two or more WDK-based applications of version 6 can share the same application server instance if they are version 6 or higher. EMC Documentum Web Publisher Version 6 Deployment Guide 41

42 Deploying Web Publisher 42 EMC Documentum Web Publisher Version 6 Deployment Guide

43 Chapter 6 Completing the Deployment After you deploy a WDK application, there are additional procedures that you may need to perform in order to finish and verify the deployment. These procedures are described in the following sections: Configuring UCF, page 43 Supporting multiple WDK applications, page 44 Configuring IBM WebSphere after deployment, page 44 Configuring single sign-on support, page 45 Deploying default virtual link support, page 45 Enabling additional locales in the repository, page 46 Installing the Web Publisher server files and DocApp, page 47 Installing DAM DocApps, page 62 Installing the Accelera DocApp, page 65 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 86 Connecting to 5.3x repositories, page 86 Testing WDK samples, page 86 Uninstalling the Web Publisher server files, page 87 Con guring UCF The Web Development Kit and Client Applications Development Guide contains the following procedures: How to configure the UCF client content transfer directories, including client path substitution EMC Documentum Web Publisher Version 6 Deployment Guide 43

44 Completing the Deployment How to support self-signed or unsigned SSL certificates How to configure the UCF server for forward and reverse proxy servers and alternative chunking Note: The web server associated with an application server must support chunked requests. The web server forwards HTTP requests using chunked transfer encoding, as described in the HTP/1.1 protocol, to the back-end application server. If chunked requests are not supported then the client should use UCF alternative chunking mode. Supporting multiple WDK applications If you deploy BEA WebLogic on AIX, or if you run more than one WDK application on the application server, there is a required postdeployment task. When multiple web applications are running on a single WebLogic server and a user who is logged in to an application accesses a URL that issues a new cookie, the JSESSIONID for the original application is overwritten and the user must log in again when he or she returns to the first application. This problem occurs because by default WebLogic does not scope cookies by application name. To change this behavior, add the CookiePath parameter to the session-descriptor section of weblogic.xml file for the WDK application. For example, if the WDK application has the virtual directory (context path) mywebtop, the session-descriptor section of the weblogic.xml file includes the following: <session-descriptor> <session-param> <param-name> CookiePath </param-name> <param-value> /mywebtop </param-value> </session-param> </session-descriptor> Add the CookiePath parameter to the weblogic.xml file for each application running on a particular WebLogic Server. Con guring IBM WebSphere after deployment To complete the deployment, perform the following procedures. 44 EMC Documentum Web Publisher Version 6 Deployment Guide

45 Completing the Deployment Changing the classloader and compiler settings Change the classloader setting for the WDK-based application module in WebSphere, in the Manage Modules section of the administration console. Select the WAR file and for Classloader order choose Classes loaded with application class loader first, then click 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/web-inf/ibm-web-ext.xmi Configure the settings as follows: <jspattributes xmi:id="jspattribute_ " name="jdksourcelevel" value="15"/> <jspattributes xmi:id="jspattribute_3" name="usejdkcompiler" value="true"/> This step is required because the default compiler assumes the presence of IBM WebSphere Studio. Con guring single sign-on support Content Server supports single sign-on (SSO) by using the RSA ClearTrust and Netegrity SiteMinder plugins. Refer to the Content Server Administrator s Guide for information on setting up pluggable authentication and single sign-on at the Content Server level. Web Development Kit Development Guide describes the authentication configuration element <authentication> and its entries in app.xml that are required to configure SSO for Webtop. You must type values that are valid for the third-party plugin that you are using. Deploying default virtual link support A virtual link is a URL that resolves to a document in a repository. The virtual link URL contains 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/app-name/repository-name:/folder-path/.../objectname EMC Documentum Web Publisher Version 6 Deployment Guide 45

46 Completing the Deployment You can install default virtual link support for URLs that do not contain the web application names. These links will be redirected to the current application. Default virtual links URLs have the following form: http(s)://server:port/repository-name:/folder-path/.../objectname http(s)://server:port/rightsite/repository-name:/folder-path/.../objectname http(s)://server:port/rs-bin/rightsite.dll//folder-path/.../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 must replace with the default virtual link application. Others require you to create a root web application manually or during application server installation. Refer to the documentation for the application server for information on a root web application. 2. Deploy the virtual link war file (vlink.war or ROOT.war) to the application server by using the mechanism recommended by the application server for deploying a default web application. 3. Modify the DefaultWdkAppName param-value in the web.xml of the virtual link WAR file. This parameter value specifies the WDK-based application that will handle the virtual link request if there is no current repository session for the user. If you 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 file that is bundled with vlink.war: <context-root>/</context-root> For more information on virtual links, refer to the WDK and Client Applications Development Guide. Enabling additional locales in the repository Documentum repositories are created with support for the language of the operating system of the host computer on which the repository is installed. For example, if the operating system is Japanese, the repository contains Documentum object type and attribute names for the Japanese locale. This information is stored in the data dictionary. You can add support for additional locales to the repository. The Web Publisher DocApp installs data dictionary information for all locales enabled in the repository, including user interface labels in the languages installed. Before you install the Web Publisher DocApp, update the list of supported locales in the repository configuration with any additional locales you need supported. For example, if a particular repository was created with only the English locale enabled and you need support for the French and German locales, use the procedure that follows to 46 EMC Documentum Web Publisher Version 6 Deployment Guide

47 Completing the Deployment enable French. When you install the Web Publisher DocApp, the data dictionary is automatically updated with French and German information. The following locales are supported: English (en) French (fr) German (de) Italian (it) Japanese (ja) Korean (ko) Simplified Chinese (zh) Spanish (es) Swedish (sv) To add locale support, you populate the data dictionary. Use the instructions in Appendix D of the Content Server Administration Guide to add the locales you need. During installation of the Web Publisher DocApp, the data dictionary is automatically updated with the correct Web Publisher labels in the additional locales. Installing the Web Publisher server les and DocApp Completing the installation of Web Publisher requires installing the Web Publisher server files on the Content Server host and installing the Web Publisher DocApp in all Web Publisher repositories. If you are installing Web Publisher on a UNIX Content Server host, ensure that the correct environment variables are set in the Content Server installation owner s environment. For complete information, refer to the Content Server Installation Guide. The Web Publisher server files and Web Publisher DocApp are installed using a separate installer called the Documentum Web Publisher Server Files Installer. Run this installer on the Content Server host. The repository where you are installing the DocApp must be running when the DocApp is installed. In a multiserver environment, run the installer on the primary Content Server host. On Windows Content Server hosts, the DocApp is installed automatically by a command-line version of Documentum Application Installer. If the DocApp does not install successfully, install it using the graphical version of DAI. Transfer the DocApp to a Windows host where DAI is installed, then install the DocApp in the Web Publisher repository. EMC Documentum Web Publisher Version 6 Deployment Guide 47

48 Completing the Deployment On a UNIX or Linux host, the server files installer places the Web Publisher DocApp on the Content Server host, but the installer cannot install the DocApp into the repository. You must transfer the DocApp to a Windows host and use Documentum Application Installer to install the DocApp. If you transfer the DocApp, do not change the name of the archive (WebPublisher, with no spaces and two capital letters) and do not transfer it to a directory where there are spaces in the path name. Documentum recommends that you install the server files and DocApp as the Content Server installation owner. This user has sufficient rights on the host and in the repository to perform the installation. The installer creates a DocApp log file called WebPublisher_installerLog.html when you install the Web Publisher default DocApp. The log file is displayed after the DocApp installation is complete. Create a backup of the log file to track any changes you make to the DocApp. The log file can be used as a reference for the default DocApp installation. The log file is saved in $DOCUMENTUM/dba/config/repository_nameon (UNIX or Linux) or %DOCUMENTUM%\dba\config\repository_name on Windows. Caution: Installing a new Web Publisher DocApp overwrites existing Web Publisher objects. Document any customizations to the objects and recreate the customizations after the upgrade. All 5.3.x customizations are supported in version 6.0. For additional information, refer to the System Migration Guide. You can optionally install a sample Web Publisher web site, called Accelera, which is contained in its own DocApp. Installing the Web Publisher DocApp is a prerequisite for installing the Accelera DocApp. The Accelera DocApp can be installed when you install the Web Publisher DocApp or at a later time. If you install it at a later time, we recommend that you install it in a clean repository and install the Web Publisher and Accelera DocApps at the same time. Where the DocApp and server les are installed The tables that follow contain the installation locations of the server files and Web Publisher DocApp on UNIX and Windows hosts. $DM_HOME (UNIX) or %DM_HOME% (Windows) is the Content Server installation directory. $DOCUMENTUM_SHARED (UNIX) or C:\Documentum (Windows) is the DFC program root directory. For more information on environment variables on the Content Server host, refer to the Content Server Installation Guide. 48 EMC Documentum Web Publisher Version 6 Deployment Guide

49 Completing the Deployment Table 4. Location of DocApp and Web Publisher server les on UNIX hosts Files wcm-api.jar WcmMethods.jar wcm-utils.jar Web Publisher Accelera WcmDQL.properties WcmTraceProp.properties WcmApplicationConfig. properties log4j.properties dbor.properties ServerApps.log Installation locations Java Method Server BPM Description $DOCUMEN- TUM_SHARED/ bea9.2/do- mains/dctm- Domain/up- load/method- Server/Server- Apps.ear/Dm- Methods.war/ WEB-INF/lib $DM_HOME/ install/docapps/ WebPublisher $DM_HOME/ bin/webpublisher /install $DOCUMEN- TUM_SHARED/ bea9.2/do- mains/dctm- Domain/up- load/method- Server/Server- Apps.ear/Dm- Methods.war/ WEB-INF/classes $DOCUMEN- TUM_SHARED/ bea9.2/domains/dctmdomain/ servers/dctm- Server_Method- Server_<server name>/logs $DOCUMEN- TUM_SHARED/ bea9.2/do- mains/dctm- Domain/up- load/method- Server/bpm.ear/ bpm.war/web- INF/lib $DOCUMEN- TUM_SHARED/ bea9.2/do- mains/dctm- Domain/up- load/method- Server/bpm.ear/ bpm.war/web- INF/classes Web Publisher job and method Java classes DocApp archive folders DocApp Installer files; for internal use only. Properties files used by Web Publisher to log or trace the application. If tracing is enabled through log4j. properties and WcmTraceProp. properties properties file, then log files are created in this directory. EMC Documentum Web Publisher Version 6 Deployment Guide 49

50 Completing the Deployment Files dm_wp_sender.ebs dm_wp_mailwrapper.sh dm_wp_sender_41.ebs WcmMethodsResource. properties data_dictionary_wcm.ini data_dictionary_ wcm_de_de.txt data_dictionary_ wcm_en.txt data_dictionary_ wcm_es_es.txt data_dictionary_ wcm_fr_fr.txt data_dictionary_ wcm_it_it.txt data_dictionary_ wcm_ja_jp.txt data_dictionary_ wcm_ko_kr.txt data_dictionary_ wcm_sv_se.txt data_dictionary_ wcm_zh_cn.txt datadictionaryoutput.txt Installation locations Java Method Server BPM Description $DM_HOME/bin $DM_ HOME/bin/ webpublisher/ Utils/ DataDictionary Docbasic scripts for notifications and properties file for Engagement Server integration. dm_wp_sender_ 41.ebs may be in this directory from an old installation on a 4.1 Content Server. dm_wp_ mailwrapper.sh enables Web Publisher to send HTML mail notifications. Web Publisher data dictionary files 50 EMC Documentum Web Publisher Version 6 Deployment Guide

51 Completing the Deployment Files dd_populate_wcm.bat dd_populate_wcm.sh wcmattachlifecycle.ebs $DM_ wcmconfigure.ebs HOME/bin/ wcmlifecyclepostprocedure. webpublisher/ ebs Utils wcmmethodserverupdate. ebs wcmmethodstandaloneupdate. ebs wcmmigration.ebs wcmpostconfigure.ebs wcmupdate.ebs Installation locations Java Method Server BPM Description Utility files used for reconfiguring or debugging repository operations. Table 5. Location of DocApp and Web Publisher server les on Windows hosts Files wcm-api.jar WcmMethods.jar wcm-utils.jar Web Publisher Accelera Installation locations Java Method Server BPM Description C:\Documentum\bea9.2\domains\Dctm- Domain\up- load\method- Server\Server- Apps.ear\Dm- Methods. war\web- INF\lib %DM_ HOME%\install\DocApps\WebPublisher %DM_ HOME%\bin\webPublisher\install C:\Documentum\bea9.2\domains\Dctm- Domain\up- load\method- Server\bpm. ear\bpm. war\web- INF\lib Web Publisher job and method Java classes. DocApp archive folders. DocApp Installer files; for internal use only. EMC Documentum Web Publisher Version 6 Deployment Guide 51

52 Completing the Deployment Files WcmDQL.properties WcmTraceProp.properties WcmApplicationConfig. properties log4j.properties dbor.properties ServerApps.log dm_wp_sender.ebs dm_wp_mailwrapper.sh dm_wp_sender_41.ebs WcmMethodsResource. properties Installation locations Java Method Server BPM Description C:\Documentum\bea9.2\domains\Dctm- Domain\up- load\method- Server\Server- Apps.ear\Dm- Methods. war\web- INF\classes C:\Documentum\bea9.2\domains\DctmDomain\servers\Dctm- Server_Method- Server_<server name>\logs %DM_ HOME%\bin C:\Documentum\bea9.2\domains\Dctm- Domain\up- load\method- Server\bpm. ear\bpm. war\web- INF\classes Properties files used by Web Publisher to log or trace the application. If tracing is enabled through log4j. properties and WcmTraceProp. properties properties file, then log files are created in this directory. Docbasic scripts for notifications and properties file for Engagement Server integration. dm_wp_ sender_41.ebs may be in this directory from an old installation on a 4.1 Content Server. dm_wp_ mailwrapper.sh enables Web Publisher 52 EMC Documentum Web Publisher Version 6 Deployment Guide

53 Completing the Deployment Files data_dictionary_wcm.ini data_dictionary_wcm_de_de.txt data_dictionary_wcm_en.txt data_dictionary_wcm_es_es.txt data_dictionary_wcm_fr_fr.txt data_dictionary_wcm_it_it.txt data_dictionary_wcm_ja_jp.txt data_dictionary_wcm_ko_kr.txt data_dictionary_wcm_sv_se.txt data_dictionary_wcm_zh_cn.txt datadictionaryoutput.txt dd_populate_wcm.bat dd_populate_wcm.sh Installation locations Java Method Server BPM Description %DM_ HOME%\bin\ webpublisher\utils\ DataDictionary wcmattachlifecycle.ebs %DM_ wcmconfigure.ebs HOME%\bin\webPublisher\Utils wcmlifecyclepostprocedure. ebs wcmmethodserverupdate. ebs wcmmethodstandaloneupdate. ebs wcmmigration.ebs wcmpostconfigure.ebs wcmupdate.ebs to send HTML mail notifications. Web Publisher data dictionary files. Utility files used for reconfiguring or debugging repository operations EMC Documentum Web Publisher Version 6 Deployment Guide 53

54 Completing the Deployment Enhanced support for multi-repository con gurations For multi-repository configurations, Web Publisher (version 5.3 SP1 and later) includes a new DocApp, WcmPostReplication, which provides the server method and job needed in multi-repository configurations. If you install this DocApp, it is copied to $DM_HOME\install\DocApps\WebPublisher by the installer. Your system administrator will also need to customize the jobs included in this DocApp for your environment. The WcmPostReplication DocApp installs the wcmpostreplicationmethod method. The method aids Web Publisher in synchronizing objects between the source and the target repositories. This method also removes category relation objects so that they do not point to the incorrect repository once objects are replicated to the target repository. This method is run by the wcmpostreplicationjob job. The WcmPostReplication DocApp also installs the wcmpostreplicationjob job. Set wcmpostreplicationjob to the Inactive state and run the job after a replication job has finished successfully. Use Documentum Administrator to create a job sequence in which a replication job runs and the wcmpostreplicationjob job runs when the replication job is completed. We recommend that you set up the job sequence so that the postreplication job will only run if the replication job succeeds. You can also use a job sequence to chain several 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 objects related to the files in the target folder or cabinet. It will report any incorrectly created relation objects in the trace file. For information on creating job sequences, refer to the Content Server Administration Guide and online Help for Documentum Administrator. About the Web Publisher server les The Web Publisher server files consist of two jar files, wcm.jar and WcmMethods.jar. These files contain Java methods that are executed on the Content Server host by the Java method server. The Java methods contain classes that are invoked by automatic activities in the default Web Publisher workflow. The classes change permissions and execute jobs 54 EMC Documentum Web Publisher Version 6 Deployment Guide

55 Completing the Deployment as required. For more information on Java methods and the Java method server, refer to the Content Server Administrator s Guide and the Content Server Installation Guide. The wcm.jar and WcmMethods.jar files are installed to the shared directory. On Windows, this is C:\Program Files\Documentum\Shared. On UNIX or Linux, this is $DOCUMENTUM_SHARED. About the Web Publisher DocApp To install the Web Publisher DocApp, you must have Superuser privileges in the repository. Installing the Web Publisher DocApp provides support for the English, German, French, Italian, Simplified Chinese, Spanish, Swedish, Korean, and Japanese languages by installing data dictionary information for Web Publisher type and attribute labels, provided you created the data dictionary locales in the repository before the DocApp is installed. Installing the DocApp also adds objects to the repository that are required by Web Publisher: Cabinets Folders Object types Lifecycles Workflow templates Permission set templates Alias sets Jobs Methods Procedures Additionally, installing the Web Publisher DocApp Creates dm_relation objects used by Web Publisher Creates the four Web Publisher user groups: Administrator Web developer Content manager Content author EMC Documentum Web Publisher Version 6 Deployment Guide 55

56 Completing the Deployment 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 Site Caching Services source software If you use Web Publisher, install or upgrade to the required version of the Site Caching Services source software. The SCS source software is installed on the Content Server host. For complete information on installing or upgrading SCS, refer to the Site Caching Services Installation Guide. Installing the DocApp and server les on Windows hosts After you add any required locales to the repository, install the Web Publisher server files and DocApp. (To add required locales to the repository, use the procedure in Enabling additional locales in the repository, page 46.) The DocApp installs the data dictionary information for the locales to the repository. The installer (WPServerWinSetup.exe) includes an embedded instance of the Documentum Application Installer (DAI, formerly DocApp Installer) that runs in command-line mode. To install the Web Publisher server les and DocApp on Windows hosts: 1. Log in to the Content Server host as the Content Server installation owner. 2. Copy WPServerWinSetup.exe from the distribution package to a temporary directory on the Content Server host. 3. In the temporary directory, double-click WPServerWinSetup.exe. The Welcome dialog box is displayed. 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. 56 EMC Documentum Web Publisher Version 6 Deployment Guide

57 Completing the Deployment 6. Click Next. The Web Publisher server files are installed to drive:\program Files\Documentum\Shared. The %DM_HOME%\bin\webpublisher folder is created. The %DOCUMENTUM%\dctm.jar file is modified. 7. Select a repository in which to install the Web Publisher DocApp. 8. Enter the user name and password of the Content Server installation owner, then click Next. The installer verifies that the repository is running and verifies that you are the Content Server installation owner. 9. Select the Web Publisher DocApp and, optionally, either or both of the Accelera and WCMPostReplication DocApps, then click Next. Installing the Web Publisher default DocApp is required. Installing the Accelera DocApp is optional, but if you intend to install both DocApps in a particular repository, it is strongly recommended that you do so at the same time. The WCMPostReplication DocApp provides a Content Server method and jobs for managing Web Publisher in multi-repository configurations. For more information on the WCMPostReplication DocApp, refer to Enhanced support for multi-repository configurations, page 54. The DocApps are installed and the Log File dialog box is displayed. The installer creates a DocApp log file called WebPublisher_installerLog.html when you install the Web Publisher default DocApp. The log file is displayed after DocApp installation is complete. 10. Click Next. The Installation Summary dialog box is displayed. 11. Click Finish. 12. Restart the Documentum Java method server a. Click 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. EMC Documentum Web Publisher Version 6 Deployment Guide 57

58 Completing the Deployment Installing the DocApp and server les on UNIX and Linux hosts After you add any required locales to the repository, install the Web Publisher server files and DocApp. (To add required locales to the repository, use the procedure in Enabling additional locales in the repository, page 46.) The DocApp installs the data dictionary information for the locales to the repository. When you run the wpserverossetup.bin on the Content Server host, the server files are installed on the host. The DocApp must be installed from a Windows computer that has Documentum Application Builder or Application Installer (former DocApp Installer) installed. There are different procedures for installing the server files and the DocApp. Complete them both. Installing the server les Use these instructions to install the server files and DocApp on a UNIX host. To install the Web Publisher server les 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. The Welcome dialog box is displayed. 3. Click Next. The License Agreement dialog box is displayed. 4. Click I agree to the licensing terms and click Next. The Install Preview dialog box is displayed and the files are installed. 5. Navigate to the $DOCUMENTUM/dba/log/wcm directory. 6. Using a text editor, create a file called wcm_log.txt. The wcm_log.txt file stores error messages about errors that occur while the application is running. 7. Restart the Java method server. a. Navigate to the $DM_HOME/tomcat/bin/ directory. b. Run the shutdown.sh script. 58 EMC Documentum Web Publisher Version 6 Deployment Guide

59 Completing the Deployment c. Run the startup.sh script. Installing the DocApp Use these instructions to install the default Web Publisher DocApp on a UNIX host. The instructions require that you use Documentum Application Installer on a Windows host. To install the Web Publisher DocApp in a UNIX repository: 1. Log in to a Windows host where the Documentum Application Installer is installed. 2. Ensure that the dfc.properties file on the host is pointing to a connection broker to which the UNIX repository projects. For example, if the repository projects to a connection broker called Troy, ensure that Troy is listed in the dfc.properties file. The dfc.properties file is in the C:\Documentum\config or $DOCUMENTUM/config folder. 3. Use FTP or another protocol to transfer the Web Publisher DocApp from the Content Server host to a temporary folder on the Windows host. 4. On the Windows host, click Start > Programs > Documentum Application Installer. The Documentum Login dialog box is displayed. 5. In the Repository field, select the repository where you are installing the Web Publisher DocApp. 6. Enter the user name and password of a user who has Superuser privileges in the repository. 7. Click OK. The Select DocApp Archive dialog box is displayed. 8. Browse to $DM_HOME/product/6.0/install/DocApps/WebPublisher. Do not change the name of the DocApp archive. 9. Click OK. 10. If required, specify a different Application Installer log file name and location. Documentum recommends using the path to the Web Publisher DocApp as the path name. 11. Click OK. The DocApp Installer dialog box is displayed. 12. Verify that the information on the dialog box is correct. 13. Click Start Installation. A prompt is displayed. EMC Documentum Web Publisher Version 6 Deployment Guide 59

60 Completing the Deployment 14. Click OK. 15. If the Connected Users dialog box is displayed, click Yes. If the DocApp Installer dialog box displays the following, the installation succeeded: <P>COMMIT TRANSACTION</P>. xxxx INSTALLATION DONE xxxx. If the DocApp Installer dialog box displays the following, the installation failed: <P>ABORT TRANSACTION</P>. 16. Click Quit Installer. 17. Repeat this procedure in each repository where you run Web Publisher. Documentum Application Installer creates a DocApp log file called WebPublisher_installerLog.html when you install the Web Publisher default DocApp. The log file is saved in $DOCUMENTUM/dba/config/repository_nameon (UNIX or Linux) or %DOCUMENTUM%\dba\config\repository_name on Windows. Updating the data dictionary after installation Use these instructions to enable language support for additional locales. The sections below contain instructions for: Adding supported locales to the 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 D, Populating and Publishing the Data Dictionary, in the Content Server Administration Guide, to install additional locales in the repository. 2. Log in to the Content Server host as the Content Server installation owner. 3. Navigate to the data_dictionary_wcm.ini file. The default location is $DM_HOME/bin/webPublisher/Utils/DataDictionary (UNIX) or %DM_HOME%\bin\webPublisher\Utils\DataDictionary (Windows). 4. Open the data_dictionary_wcm.ini file in a text editor. The file lists the available locales. They are commented out. 5. Uncomment the line for each new language by removing the # at the beginning of the line. For example, if the line is 60 EMC Documentum Web Publisher Version 6 Deployment Guide

61 Completing the Deployment #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, and password:. dmbasic -f%dm_home%\bin\dd_populate.ebs -eentry_point -- repository_name USER_NAME PASSWORD data_dictionary_wcm.ini The repository name is the name of the repository you installed the Web Publisher DocApp to, the user name is the name of the Superuser, and the password is the Superuser s password. You can use the Content Server installation owner s user name and password. 9. Save and close the dd_populate_wcm or dd_populate_wcm.sh file. 10. Run the script. On Windows, double-click dd_populate_wcm.bat. On UNIX, type dd_populate_wcm.sh. The new data dictionary locale information is installed in the repository. When the data dictionary publishing job runs next, the information is available to Web Publisher. Output of the data dictionary script The data dictionary population script, dd_populate_wcm.bat (Windows) or dd_populate_wcm.sh (UNIX), populates the data dictionary with data specified in the data_dictionary.ini file, for example, data_dictionary_wcm_de_de.txt. This is the output of the script. Connected to the server as dmadmin. Starting population for NLS files Looking for data_dictionary_wcm_de_de.txt in the current directory. ########################################################################## ## ## ## ## EMC Documentum Web Publisher Version 6 Deployment Guide 61

62 Completing the Deployment ## Population Data File: data_dictionary_wcm_de_de.txt ## ## ## ## Start Time: :34:15 ## ## ## ########################################################################## Starting to read data file Setting the data dictionary population locale to: de Setting the data dictionary population codepage to: ISO SUCCESSFUL: type level Data Dictionary Population for type wcm_locale SUCCESSFUL: attribute level Data Dictionary Population for type wcm_locale SUCCESSFUL: type level Data Dictionary Population for type wcm_auto_naming SUCCESSFUL: attribute level Data Dictionary Population for type wcm_auto_naming SUCCESSFUL: type level Data Dictionary Population for type wcm_change_set SUCCESSFUL: attribute level Data Dictionary Population for type wcm_change_set SUCCESSFUL: type level Data Dictionary Population for type wcm_channel SUCCESSFUL: attribute level Data Dictionary Population for type wcm_channel SUCCESSFUL: type level Data Dictionary Population for type wcm_edition SUCCESSFUL: attribute level Data Dictionary Population for type wcm_edition SUCCESSFUL: type level Data Dictionary Population for type wcm_edition_fld SUCCESSFUL: attribute level Data Dictionary Population for type wcm_edition_fld SUCCESSFUL: type level Data Dictionary Population for type wcm_category SUCCESSFUL: attribute level Data Dictionary Population for type wcm_category SUCCESSFUL: type level Data Dictionary Population for type wcm_channel_fld SUCCESSFUL: type level Data Dictionary Population for type wcm_config SUCCESSFUL: attribute level Data Dictionary Population for type wcm_config Data Dictionary Population for file data_dictionary_wcm_de_de.txt complete Setting the session_locale to: en Data Dictionary Population Complete Disconnected from the server. Installing DAM DocApps There are two Digital Asset Manager DocApps that affect Web Publisher deployments: Rich Media Services DocApp This docapp is mandatory for Web Publisher deployments. Transformation DocApp This docapp is required if you are performing transformations in Web Publisher with any Content Transformation Services products (such as Document Transformation Services or Media Transformation Services). 62 EMC Documentum Web Publisher Version 6 Deployment Guide

63 Completing the Deployment Installing the DocApps requires an installation of Documentum Application Installer that can access the repository where Web Publisher is installed. Note: You must have Superuser privileges for the repositories in which you want to install the DocApp. Procedures are provided for installing these DocApps in Windows repositories and UNIX repositories. To install a DAM DocApp in a Windows repository: 1. Log in to a machine with Documentum Application Installer. 2. Download the DocApp from the EMC download site to a temporary directory on the Application Installer host. Rich Media Services DocApp is mandatory. Transformation DocApp is required if performing transformations in the Web Publisher repository. 3. Unzip the downloaded DocApp file. With the Rich Media Services DocApp, the result is a folder called Rich_Media_Services. With the Transformation DocApp, the result is a folder called Transformation. 4. Select Start > Programs > Documentum > Application Installer. 5. Connect to the Web Publisher repository as a user with Superuser privileges. Enter the repository, user name, password, and domain when prompted and click OK. The domain is the operating system domain against which your user account is authenticated. You might not be required to enter the domain. Note: Your repository user account must have the Superuser privilege. Superuser privilege is the highest level of user privilege in a repository. Users with the Superuser privilege have a minimum access level of Read for all sysobjects. They also have the ability to change the object-level permissions of any object. For more details about Superuser abilities and to learn how to grant superuser privilege to a user, see the Content Server Administration Guide. 6. In the Select DocApp Archive dialog box, click Browse to find the correct DocApp folder (as described in Step 3). Caution: EMC Documentum recommends that you do not change the name of the DocApp archive folder because Application Installer uses it to install the DocApp archive and the DocApp archive folder might be specified in paths (such as in the XML configuration file or location aliases). 7. Select the folder and click OK. EMC Documentum Web Publisher Version 6 Deployment Guide 63

64 Completing the Deployment By default, the installer log files are named Rich_Media_Services_installerLog.html and Transformation_installerLog.html, and are saved in c:\temp. a. To select a different location for the installer log, click Browse (next to the Path name field) and select a directory. b. To specify a different filename, type a new one in the File name field. 8. Click OK in the Select DocApp Archive dialog box. You are returned to the main window. 9. Click Start Installation. When a message box is displayed that states, "This will take a few minutes to complete," click Yes to continue. If a message box is displayed that states that there are connected users, click Yes to continue. If you specified aliases for objects in your DocApp, then the Resolve Alias dialog box is displayed. 10. In the Resolve Alias dialog box, select the alias or folder in the repository under Value: a. To find the appropriate folder, click Browse, select the folder (do not double-click the folder to open it) and then click Select. b. Select the corresponding user or group from the drop-down list. 11. Click OK. Application Installer installs the DocApp archive. If errors occur and the text, "Abort transaction," is displayed in the Installation Status window, do not exit Application Installer. Refer to the Documentum Application Installer User Guide. 12. Stop and restart the Web Publisher application server. To install a DAM DocApp in a UNIX repository: 1. Log in to a Windows host where the Documentum Application Installer is installed. 2. Ensure that the dfc.properties file on the host is pointing to a connection broker to which the UNIX repository projects. For example, if the repository projects to a connection broker called Troy, ensure that Troy is listed in the dfc.properties file. The dfc.properties file is in the C:\Documentum\config or $DOCUMENTUM/config folder. 3. Use FTP or another protocol to transfer the DAM DocApp (Rich Media Services DocApp, and where applicable, the Transformation DocApp) from the Content Server host to a temporary folder on the Windows host. 4. On the Windows host, click Start > Programs > Documentum Application Installer. 64 EMC Documentum Web Publisher Version 6 Deployment Guide

65 Completing the Deployment The Documentum Login dialog box is displayed. 5. In the Repository field, select the repository where you are installing the DocApp. 6. Enter the user name and password of a user who has Superuser privileges in the repository. 7. Click OK. The Select DocApp Archive dialog box is displayed. 8. Browse to $DM_HOME/product/6.0/install/DocApps/Rich_Media_Services or $DM_HOME/product/6.0/install/DocApps/Transformation. Do not change the name of the DocApp archive. 9. Click OK. 10. If required, specify a different Application Installer log file name and location. Documentum recommends using the path to the DocApp as the path name. 11. Click OK. The DocApp Installer dialog box is displayed. 12. Verify that the information on the dialog box is correct. 13. Click Start Installation. A prompt is displayed. 14. Click OK. 15. If the Connected Users dialog box is displayed, click Yes. If the DocApp Installer dialog box displays the following, the installation succeeded: <P>COMMIT TRANSACTION</P>. xxxx INSTALLATION DONE xxxx. If the DocApp Installer dialog box displays the following, the installation failed: <P>ABORT TRANSACTION</P>. 16. Click Quit Installer. 17. Repeat this procedure in each repository where you run Web Publisher. Installing the Accelera DocApp The Accelera DocApp installs repository components for the Accelera.com sample web site, which is discussed in the Web Publisher Administration Guide. Documentum provides the sample web site for administrators and Web developers to use as a starting point for web site customization. The Accelera DocApp contains object types, lifecycles, workflow templates, permission set templates, Web Publisher Editor templates, alias EMC Documentum Web Publisher Version 6 Deployment Guide 65

66 Completing the Deployment sets, procedures, methods, cabinets and content for the web site. You are not required to install the Accelera DocApp. It is a sample only. Installing the Web Publisher DocApp is a prerequisite for installing the Accelera DocApp. If you plan to install the Web Publisher and Accelera DocApps in the same repository, Documentum strongly recommends installing the two DocApps at the same time. Installing the Accelera DocApp at a later time overwrites the FolderMap.xml file, which Web Publisher requires, with Accelera-specific information. This is typically not an issue, because FoderMap.xml is empty after installing the Web Publisher DocApp. However, if you have made customizations to FolderMap.xml, you need to take extra steps to retain these customizations. If you decide to use the Accelera sample web site after installing the Web Publisher DocApp, you can either: Install the Web Publisher and Accelera DocApps in a clean repository. In the repository where Web Publisher is already installed, record any customizations to FolderMap.xml. After the Accelera DocApp is installed and FolderMap.xml is versioned, open FolderMap.xml, restore the customizations, and save FolderMap.XML as a new version. The Accelera DocApp is a sample web site only. You are not required to install it. Documentum is not responsible for the sample s accuracy or completeness. This section discusses these topics: Accelera preinstallation requirements, page 66 Accelera installation requirements, page 67 Testing the Accelera DocApp installation, page 75 Publishing documents to the sample web site, page 75 Accelera preinstallation requirements Ensure that the following tasks are completed before you install the Accelera DocApp: 1. Install Content Server, and configure a repository. 2. Install a web application server for Documentum applications, and install Documentum Administrator and Web Publisher. 3. Install three web application server instances for the WIP, Staging, and Active editions of the Accelera website. 4. On UNIX Content Server hosts, transfer the DocApp to a Windows machine where Documentum Application Installer is located. Running the server-side installer places the Accelera DocApp on the Content Server host. Documentum Application Builder and Application Installer run on Windows hosts only. 66 EMC Documentum Web Publisher Version 6 Deployment Guide

67 Completing the Deployment 5. Determine where to install the Accelera DocApp. Be advised that the Accelera DocApp overwrites any existing FolderMap.xml settings during installation. If you have made modifications to this file, back up and then restore FolderMap.xml. 6. If you have Documentum Application Builder installed, ensure that the regional setting is correct. Refer to Setting the regional options on Windows hosts, page 67. Setting the regional options on Windows hosts The Regional Options dialog box is where the locale, numerical display, time, and currency parameters are set on Windows hosts. Ensure that each Content Server host where the Accelera DocApp installed uses the correct settings during installation. After installation is complete, the settings can revert to your normal settings. 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 and Long date format fields. 4. Click OK. 5. When DocApp installation is complete, you can return the Regional Settings to the previous settings. Accelera installation requirements Installation of the Accelera sample website involves a number of procedures: 1. Installing the Accelera DocApp, page Creating the Accelera database schema, page Installing and configuring Site Caching Services, page Modifying the DbUtils.inc file, page Creating a site publishing con guration, page Creating the WEB-INF folder, page 74 EMC Documentum Web Publisher Version 6 Deployment Guide 67

68 Completing the Deployment Installing the Accelera DocApp In this procedure, you install the Accelera DocApp to an existing repository. Do not install the Accelera DocApp in a production repository. You must already have the Web Publisher DocApp installed in the repository. If the Web Publisher DocApp installation fails you cannot install the Accelera DocApp. No option to install the Accelera DocApp is displayed by the installer. To install the Accelera DocApp: 1. Connect to the Content Server host as the Content Server installation owner. 2. If the Content Server host is a UNIX machine, copy the Accelera DocApp from the server host to a Windows host where Documentum Application Builder is installed. The default location of the Accelera DocApp on the Content Server host is $DM_HOME\product\6.0\install\DocApps. 3. Ensure that the Web Publisher DocApp is installed in the repository where you are installing the Accelera DocApp. 4. Log in to a Windows host where Documentum Application Builder is installed. 5. Ensure that the dfc.properties file on the Windows host is pointing to a connection broker to which the repository projects. For example, if the repository projects to a connection broker called Athens, ensure that Athens is listed in the dfc.properties file. The dfc.properties file is in the C:\Documentum\config or $DOCUMENTUM/config folder. 6. Click Start > Programs > Documentum > Application Installer. 7. In the Repository field, select the repository where you are installing the Accelera DocApp. 8. Type the user name and password of a user who has Superuser privileges in the repository. 9. Click OK. The Select DocApp Archive dialog box is displayed. 10. In the top, unnamed field (which might be grayed out), type the folder path of the DocApp. To navigate to the location, click Browse. On a Windows host, the default location of the DocApp is C:\Documentum\product\6.0\install\DocApps. 11. To change the path and filename of the Documentum Application Installer log file, edit the values in the appropriate fields and click OK. 12. Verify that the information displayed is correct. 68 EMC Documentum Web Publisher Version 6 Deployment Guide

69 Completing the Deployment 13. Click Start Installation. 14. Click OK. 15. If the Connected Users dialog box is displayed, click Yes. Web Publisher installs the DocApp. The installation takes up to 15 minutes, depending upon the hardware and network. 16. If the Connected Users dialog box is displayed, click Yes. On UNIX, if the DocApp Installer dialog box displays the following, the installation succeeded: <P>COMMIT TRANSACTION</P> xxxx INSTALLATION DONE xxxx On Windows, if the DocApp Installer dialog box displays the following, the installation failed: <P>ABORT TRANSACTION</P> 17. Click Quit Installer. 18. If the installation failed, review the DocApp installer log file for information about the process. The log files default location is: $DOCUMENTUM/dba/config/repository_name (UNIX) or %DOCUMENTUM%\dba\config\repository_name (Windows) and the default name is WebPublisher_installerLog.html. Also, refer to the Troubleshooting Installation chapter (particularly DocApp installation fails, page 92). Creating the Accelera database schema The Accelera web application is heavily metadata-driven; this metadata is published to a database schema by Site Caching Services (SCS), and then accessed from the Accelera JSP pages 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 Accelera web cabinet. You therefore need only one schema, and consequently one set of database credentials, for all three web application server instances. A JDBC driver for your database. You should make sure that it is available for all your web applications. If you are using WebLogic, it is likely that the JDBC driver will already be available; if you are using Tomcat, it is convenient to put the driver in $CATALINA_HOME/common/lib. EMC Documentum Web Publisher Version 6 Deployment Guide 69

70 Completing the Deployment Site publishing configurations for the three environments that define three separate database table names for publishing metadata. Having each publishing configuration define separate table names is necessary, since the Accelera webapp can only have one schema, and the three environments need separate copies of the metadata. Be sure to record the table names; they will be needed when you set up the WEB-INF folder for each web application. Installing and con guring Site Caching Services You will need to install both the source and target components of SCS. When you install and configure the target, set it to populate the database schema created for the Accelera editions. As an example, refer to the following screenshot from the target configurator: The username and password you enter here should match that of the schema you created. 70 EMC Documentum Web Publisher Version 6 Deployment Guide