EMC Documentum Web Publisher

Transcription

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

2 Copyright EMC Corporation. All rights reserved. Published September 2008 EMC believes the information in this publication is accurate as of its publication date. The information is subject to 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 Quick Start Chapter 2 Planning for Deployment About Web Publisher Required and optional supporting software Typical configuration Preparing the Content Server Application server host requirements Directory name restriction Content transfer directory permissions DNS resolution Deploying multiple applications Deploying language packs Customizing an application Portlet server Documentum Process Integrator 6.5 (Legacy version) Documentum Site Caching Services Optional LDAP server Chapter 3 Preparing the Client Hosts Ensuring a certified JVM on browser clients JVM requirements for Web Publisher Editor and Rules Editor Enabling HTTP content transfer in Internet Explorer Enabling UCF content transfer in Internet Explorer 7 on Windows Vista Enabling content transfer in Firefox Using Citrix Presentation Server Client Turning off the pop up blocker in Internet Explorer Additional considerations for Web Publisher Chapter 4 Preparing the Application Server Host Setting the Java memory allocation Turning off failover Preparing environment variables for non default DFC locations Preparing JBoss and Apache Tomcat Preparing BEA WebLogic EMC Documentum Web Publisher Version 6.5 Deployment Guide 3

4 Table of Contents Supporting large content transfer operations in a managed server environment Preparing IBM WebSphere Supporting failover in a cluster Applying policies for WebSphere security Preparing Oracle Application Server Preparing Sun Java System Application Server Turning off tag pooling Modifying the Sun policy file Turning off failover Preparing to use an external web server Installing the Site Caching Services target software Chapter 5 Upgrading a WDK Based Application Chapter 6 Deploying Web Publisher Preparing the WAR file for deployment Enabling DFC connections to repositories Enabling DFC memory optimization Enabling preferences repositories Enabling retention of folder structure and objects on export Enabling modal pop up windows Enabling external searches Configuring the connection to the search server Configuring the connection to the backup search server Deploying multiple applications Chapter 7 Completing the Deployment Configuring UCF Configuring IBM WebSphere after deployment Changing the classloader and compiler settings Setting com.ibm.ws.webcontainer.invokefilterscompatibility to true Deploying default virtual link support Enabling additional locales in the repository Installing the Web Publisher server files and DAR files Where the DAR file and server files are installed About the Web Publisher server files About the Web Publisher DAR file Installing the DAR files and server files on Windows hosts Installing the DAR files and server files on UNIX and Linux hosts Installing the server files Installing the DAR files Enhanced support for multi repository configurations Additional Accelera DAR file tasks Accelera preinstallation requirements Setting the regional options on Windows hosts Accelera postinstallation requirements Creating the Accelera database schema Installing and configuring Site Caching Services Modifying the DbUtils.inc file Creating a site publishing conguration EMC Documentum Web Publisher Version 6.5 Deployment Guide

5 Table of Contents Creating the WEB INF folder Testing the Accelera DAR file installation Publishing documents to the sample website Updating the data dictionary after installation Output of the data dictionary script Installing DAM DAR files Installing a DAR file with the DAR Installer Plugin Installing DAR files on UNIX or Linux hosts Installing the Site Caching Services source software 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 Completing the Web Publisher Page Builder installation process Preparing to upgrade Page Builder Installing Page Builder DAR files Migrating content from prior Page Builder versions Deploying the Upload Application WAR file for dynamic component Accessing the application Testing WDK samples Uninstalling the Web Publisher server files Chapter 8 Configuring Single Sign On for Security Servers Chapter 9 Troubleshooting Deployment Wrong JRE used for application server No global registry or connection broker No connection to repository DM_VEL_INSTANTIATION_ERROR Page not found error in browser Login page incorrectly displayed Slow performance Out of memory errors in console or log Slow display first time DFC using the wrong directories on the application server Application startup errors Tag pooling problem UCF client problems Citrix client problems Connection issues between an ECI Services server and IPv6 clients Web Publisher server side installer errors exception NoClassDefFounderror... com.documentum.wcm. servermethod.wcmexpirenowactionhandler Server side tracing for Web Publisher DAR file installation fails EMC Documentum Web Publisher Version 6.5 Deployment Guide 5

6 Table of Contents Text unaligned Users cannot access functions that their roles should allow Error when invoking login page after deploying WP on Sun 9.1 app server Chapter 10 Deploying a Custom Application Using the comment stripper utility Appendix A Predeployment Checklist EMC Documentum Web Publisher Version 6.5 Deployment Guide

7 Table of Contents List of Figures Figure 1. Basic WDK host configuration Figure 2. SCS configuration for Accelera EMC Documentum Web Publisher Version 6.5 Deployment Guide 7

8 Table of Contents List of Tables Table 1. Directories and files to back up Table 2. Preferences configuration elements Table 3. Modal window elements in app.xml (<modalpopup>) Table 4. Location of DAR files and Web Publisher server files on UNIX hosts Table 5. Location of DAR files and Web Publisher server files on Windows hosts Table 6. DAR Installer fields Table 7. Page Builder DAR file files Table 8. Authentication elements (<authentication>) Table 9. Comment stripper utility parameters Table 10. Predeployment tasks EMC Documentum Web Publisher Version 6.5 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 Web Publisher Release Notes. Intended audience This manual is intended primarily for administrators who are deploying an application based on WDK or Webtop. 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.5 Deployment Guide 9

10 Preface Revision history The following changes have been made to this document: Revision history Revision date July 2008 Description Initial publication for version 6.5 release. September 2008 Revised DAR file installation procedures in Chapter 7. Revised Page Builder deployment procedures. Corrected reference to Business Process Services product in Chapter 2. Related documentation You can download this deployment guide and the release notes applicable to WDK, Webtop, and Web Publisher on the product download site. Each WDK based 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: WDK Development Guide WDK and Webtop Reference Guide WDK Tutorial JavaDoc API reference documentation Additionally, Web Publisher has its own development guide and Javadoc. 10 EMC Documentum Web Publisher Version 6.5 Deployment Guide

11 Chapter 1 Quick Start This chapter outlines the steps you need to perform to deploy Web Publisher. The steps are described in more detail in the chapters of this guide. To perform a simple Web Publisher deployment: 1. Plan the deployment. (Refer to Chapter 2, Planning for Deployment.) Check that you have required and optional supporting software, prepare the Content Server, check application server environment requirements, prepare for multiple applications, plan for language pack deployment, and plan to deploy a customized application. Web Publisher requires that Documentum Site Caching Services be installed; additional requirements pertain to Portlet Builder. 2. Prepare the clients. (Refer to Chapter 3, Preparing the Client Hosts.) Install a supported browser virtual machine and perform specific browser preparations for IE 7 and Firefox. Review additional considerations specific to Web Publisher, such as installing Site Caching Services source software, and deploying the Web Publisher server files and DAR files. 3. Prepare the application servers. (Refer to Chapter 4, Preparing the Application Server Host.) Ensure you have sufficient memory allocated to the application server Java instance, turn off failover if it is not needed, and follow preparation instructions specific to the application server and proxy server. Site Caching Services target software is installed on the host. 4. Prepare for the upgrade. (Refer to Chapter 5, Upgrading a WDK Based Application.) If you have customized a previous deployment, certain files must be backed up prior to upgrading to Web Publisher 6.5. Customers who are upgrading to Page Builder 6.5 should consult Completing the Web Publisher Page Builder installation process, page 83 for upgrade and migration information. 5. Deploy the Web Publisher WAR file using the application server standard deployment mechanism. (Refer to Chapter 6, Deploying Web Publisher.) EMC Documentum Web Publisher Version 6.5 Deployment Guide 11

12 Quick Start You must first unpack the WAR file archive and enter some information that is specific to your environment: your connection broker and global registry information, optional preferences repositories, and optional ECIS search server. 6. Complete the deployment. (Refer to Chapter 7, Completing the Deployment.) After successful deployment, you can configure UCF, deploy root virtual link support, enable WebSphere global security if needed, and test the application samples. Deploy the server files and DAR files. Install ewebeditpro and imarkup, if required. Additional procedures are required for completing the installation of Portlet Builder and Page Builder, when applicable. 12 EMC Documentum Web Publisher Version 6.5 Deployment Guide

13 Chapter 2 Planning for Deployment This chapter addresses software and hardware decisions you must make before you deploy Web Publisher. This chapter discusses the following topics: About Web Publisher, page 13 Required and optional supporting software, page 14 Typical configuration, page 14 Preparing the Content Server, page 16 Application server host requirements, page 16 Deploying multiple applications, page 17 Deploying language packs, page 17 Customizing an application, page 17 Portlet server, page 18 Documentum Process Integrator 6.5 (Legacy version), page 18 Documentum Site Caching Services, page 18 Optional LDAP server, page 19 About Web 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 website. EMC Documentum Web Publisher Version 6.5 Deployment Guide 13

14 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 page while viewing the page as it will appear on the web. Unlike many web page development tools, Page Builder is fully browser based. Page Builder is an optional application that is purchased and installed separately from Web Publisher. 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. 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 41 for information on configuring the connection broker before deployment. J2EE application server or servlet container All WDK based applications require DARs that must be installed in the repository. The Webtop DARs are provided in Content Server version 6.5. Typical configuration 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 14 EMC Documentum Web Publisher Version 6.5 Deployment Guide

15 Planning for Deployment Global registry repository Client hosts that run a supported web browser Figure 1, page 15 shows the network components. Figure 1. Basic WDK host configuration 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 JBoss 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. EMC Documentum Web Publisher Version 6.5 Deployment Guide 15

16 Planning for Deployment Preparing the Content Server The following topics describe Content Server requirements. Content Server installs certain DARs that are required for a WDK based application. You do not need to perform a separate installation of these. Products built on WDK or Webtop may require additional DARs, which are available on the product download site. The global registry requirement A global registry of Content Server version 6.x 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 40. 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:! \ / : *? " < > 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 UCF client and server configuration files, refer to Web Development Kit Development Guide. 16 EMC Documentum Web Publisher Version 6.5 Deployment Guide

17 Planning for Deployment 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 (DNS) must be configured to properly resolve IP addresses based on the URL used to access the server. Deploying multiple applications You can deploy multiple WDK based applications of version 6.x 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.x 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. 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. 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 Java Server Page (JSP) page to configure controls on the page. Configuration does not require a developer license. EMC Documentum Web Publisher Version 6.5 Deployment Guide 17

18 Planning for Deployment 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. Customization of Documentum Administrator is not supported. 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. Documentum Process Integrator 6.5 (Legacy version) Web Publisher Portlet Builder requires Documentum Process Integrator 6.5 (Legacy version) for workflow template functionality. Refer to the Business Process Services Activity Template Migration Guide for installation instructions for the legacy product. 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. 18 EMC Documentum Web Publisher Version 6.5 Deployment Guide

19 Planning for Deployment 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 Web Publisher Administration Guide. EMC Documentum Web Publisher Version 6.5 Deployment Guide 19

20 Planning for Deployment 20 EMC Documentum Web Publisher Version 6.5 Deployment Guide

21 Chapter 3 Preparing the Client Hosts This chapter contains information on the following pre deployment tasks: Ensuring a certified JVM on browser clients, page 21 JVM requirements for Web Publisher Editor and Rules Editor, page 22 Enabling HTTP content transfer in Internet Explorer 7, page 22 Enabling UCF content transfer in Internet Explorer 7 on Windows Vista, page 22 Enabling content transfer in Firefox 2, page 23 Using Citrix Presentation Server Client, page 24 Turning off the pop up blocker in Internet Explorer, page 24 Additional considerations for Web Publisher, page 24 Ensuring a certified JVM on browser clients Browser client hosts require a certified version of the Sun Java virtual machine (JVM or VM) to initiate content transfer in a WDK application. New machines may not have a JVM 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. On Windows clients, if the JVM required for UCF is not present on the client machine, UCF uploads to a Windows client a private JVM. This VM does not replace the JVM that is used by the browser. For non Windows browser hosts with a JVM of 1.4.x, you must pre install version 1.5.0_06.x of the Sun JRE that will then be used by UCF. Since the UCF VM file (Sun JRE) is over 10 MB in size, the installation can cause a delay. You can avoid this delay by installing a compatible local JVM prior to using UCF transfer. EMC Documentum Web Publisher Version 6.5 Deployment Guide 21

22 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 not installed with Internet Explorer. Enabling HTTP content transfer in Internet Explorer 7 Internet Explorer (IE) version 7 has a default security setting that prevents the display of the file download dialog. You must add the WDK based application URL to the list of trusted sites in the browser in order to perform checkout, view, or edit in HTTP mode. Nothing happens when user exports as CSV if the browser security settings are disabled for prompt for file downloads and file download. These are disabled by default in IE7. The user must enable them. To enable HTTP file download in IE 7: 1. In the IE 7 browser menu, choose Tools > Internet Options and click the Security tab. 2. Choose Trusted sites and then click Custom level. 3. Scroll to the Downloads section and enable Automatic prompting for file downloads. 4. Click OK twice to save settings. 5. Close all browser windows and restart the browser. 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. 22 EMC Documentum Web Publisher Version 6.5 Deployment Guide

23 Preparing the Client Hosts To add the application server host to the list: 1. In IE7, go to Tools > Internet Options Security tab. 2. Select Trusted sites. Click Custom level in the section Security level for this zone. 3. Scroll to Downloads and check Automatic prompting for file downloads. 4. Click OK to accept changes, and close the browser. To turn off UAC on each client: 1. Log in as a user who has administrator privileges on the Windows Vista machine. 2. Open the Control panel and choose Administrative Tools. 3. In the left pane, choose User Accounts. 4. Choose Turn User Account Control on or off. 5. Uncheck Use User Account Control (UAC) to help protect your computer. 6. Click OK and restart the system. To configure UCF to use file registry mode: 1. Ensure the clients have checked in all checked out files. 2. Open the file ucf.installer.config.xml located in WDK based applications directory /wdk/contentxfer. 3. Locate the element <platform os=ʺwindowsʺ arch=ʺx86ʺ>, which configures 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. Enabling content transfer in Firefox 2 Firefox 2 requires a setting to enable content transfer. To enable file download in Firefox: 1. Open the Options menu in Firefox. 2. In the Main dialog Downloads section, enable Show the Downloads window when downloading a file and Close it when all downloads are finished. EMC Documentum Web Publisher Version 6.5 Deployment Guide 23

24 Preparing the Client Hosts 3. Check Always ask me where to save files. 4. On the Tabs dialog, check New pages should be opened in: a new window. 5. On the Content dialog, check Load images automatically, Enable JavaSript, and Enable Java. 6. Install the Firefox add on FireBug, which is available from mozilla.org. 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 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\<username>\Documentum\ucf. Turning off the pop up blocker in Internet Explorer Windows XP SP2 installs a pop up blocker in Internet Explorer that is enabled by default. HTTP content transfer operations in WDK applications are prevented by the pop up blocker. You must turn off the pop up blocker for HTTP transfer. 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 7, Completing the Deployment. 24 EMC Documentum Web Publisher Version 6.5 Deployment Guide

25 Preparing the Client Hosts 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 76 and the Site Caching Services Installation Guide. Install the Web Publisher server file installer on the Content Server host. This installer contains the following components: Server files Install the server files after installing Web Publisher on the application 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. Web Publisher DAR file (mandatory) Install the DAR file in the repository after installing Web Publisher on the application server host. The DAR file installs cabinets, folders, object types, lifecycles, workflow templates, permission set templates, alias sets, jobs, procedures, and methods required by Web Publisher. The Web Publisher DAR file 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. WcmPostReplication DAR file (optional) This DAR file provides the server method (wcmpostreplicationmethod) and job (wcmpostreplicationjob) needed in multi repository configurations. See Enhanced support for multi repository configurations, page 61 for details. Accelera DAR file (optional) You may optionally install the DAR file for the Web Publisher sample website, called Accelera, in the repository. Note that there are additional tasks related to use of the Accelera sample, including some preinstallation tasks; see Additional Accelera DAR file tasks, page 61 for details. Install the DAM DAR files: The Rich Media Services DAR file is mandatory for Web Publisher deployments. The Transformation DAR file is required if you are performing transformations in Web Publisher with any Content Transformation Services products. If you are using the optional Portlet Builder or Page Builder components, install their respective DAR files. If you are using ewebeditpro or imarkup, install these third party applications. EMC Documentum Web Publisher Version 6.5 Deployment Guide 25

26 Preparing the Client Hosts For details on installing the Web Publisher server files, DAR files, and third party applications, refer to Chapter 7, Completing the Deployment. 26 EMC Documentum Web Publisher Version 6.5 Deployment Guide

27 Chapter 4 Preparing the Application Server Host This chapter describes the tasks you must complete to prepare the application server host before deploying Web Publisher. Before you deploy a WDK based application, ensure that your J2EE application server or servlet container is a supported version and that it can successfully serve sample JSP pages. Refer to the Web Publisher Release Notes for information about supported application servers and platforms. Tip: EMC recommends but does not require that you uninstall DFC 5.x and any application that uses DFC 5.x and then reboot before deploying an application based on WDK 6.x. For uninstall procedures, refer to the 5.x product documentation. This chapter contains the following sections: Setting the Java memory allocation, page 28 Turning off failover, page 28 Preparing environment variables for non default DFC locations, page 29 Preparing JBoss and Apache Tomcat, page 29 Preparing BEA WebLogic, page 30 Preparing IBM WebSphere, page 30 Preparing Oracle Application Server, page 33 Preparing Sun Java System Application Server, page 33 Preparing to use an external web server, page 35 Installing the Site Caching Services target software, page 36 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. EMC Documentum Web Publisher Version 6.5 Deployment Guide 27

28 Preparing the Application Server Host 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 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. To achieve better performance, add these parameters to the application server startup command line: server XX:+UseParallelOldGC server must be the first parameter on the command line. Performance will improve because the Java client VM is not suitable for long running server jobs and the default Java garbage collector cannot clean up the heap quickly enough especially when the application server machine runs on multiple CPUs. For more information on these settings, refer to Java documentation at the Sun web site ( More information on application server performance tuning and benchmarking for Documentum products is available from your EMC Documentum SE or EMC Documentum Consulting. Turning off failover If your application server and environment combination does not support failover, you can turn off failover in app.xml. Refer to your product release notes to determine whether failover is supported for your environment. If you do not turn off failover, you may see failover validation messages in the application server log, but these should not interfere with operations. Do not attempt to use the application in a failover environment that is not certified. To turn off failover for the application, open app.xml in the custom directory and add the following element: <failover> <enabled>false</enabled> </failover> 28 EMC Documentum Web Publisher Version 6.5 Deployment Guide

29 Preparing the Application Server Host Preparing environment variables for non default DFC locations The base location for content transfer on the application server host is specified by the DFC environment variable dfc.data.dir. This location is specified as the value of the key dfc.data.dir in dfc.properties located within the application WAR file in WEB INF/classes. If this variable is not set in the environment for the application server, the default location is the documentum subdirectory of the current working directory. (The current working directory contains the application server executable.) For example, in Tomcat the location is %CATALINA_HOME%/bin. On WebLogic, it is %BEA_HOME%/domains/wl_server/documentum. By default, the checkout and export directories are subdirectories of the dfc.data.dir directory, and the user directory is the same as dfc.data.dir. If you wish to use non default locations for these, you can create environment variables for dfc.checkout.dir, dfc.export.dir, and dfc.user.dir, respectively. The default value of dfc.registry.mode, which corresponds to the key dfc.registry.mode in dfc.properties, is ʺfileʺ. The full path to this file by default is dfc.user.dir/documentum.ini. For a non default file name or location, specify it as the value of the environment variable dfc.registry.file. Preparing JBoss and Apache Tomcat Please refer to your product release notes to determine whether JBoss or Apache Tomcat is a supported application server for your product. You must disable tag reuse in JBoss and 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> EMC Documentum Web Publisher Version 6.5 Deployment Guide 29

30 Preparing the Application Server Host Preparing BEA WebLogic Please refer to your product release notes to determine whether BEA WebLogic is a supported application server for your product. 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 Java 2 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 security If WebSphere global security is enabled for the application server, by default it enables Java 2 security. Java 2 security requires security policies. You must apply the policies in 30 EMC Documentum Web Publisher Version 6.5 Deployment Guide

31 Preparing the Application Server Host 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. 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"; EMC Documentum Web Publisher Version 6.5 Deployment Guide 31

32 Preparing the Application Server Host permission java.io.filepermission "${dfc.registry}", "read, write, delete"; Policy for Webtop temporary content transfer directory (non default location) permission java.io.filepermission "${webtop.content.xfer}${/} ", "read, write, delete"; permission java.io.filepermission "${webtop.content.xfer}", "read, write, delete"; Policy for non Webtop WDK based temporary content transfer (non 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"; 32 EMC Documentum Web Publisher Version 6.5 Deployment Guide

33 Preparing the Application Server Host Policy for Content Intelligence Services permission java.io.filepermission "${cis.content.xfer}${/} ", "read, write, delete"; permission java.io.filepermission "${cis.content.xfer}", "read, write, delete"; Preparing Oracle Application 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> 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. EMC Documentum Web Publisher Version 6.5 Deployment Guide 33

34 Preparing the Application Server Host 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 <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 file 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; }; 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/ 34 EMC Documentum Web Publisher Version 6.5 Deployment Guide

35 Preparing the Application Server Host Turning off failover The Sun application server does not support failover. You must turn it off in the app.xml file located in the custom directory. Add the following lines to custom/app.xml: <failover> <filter clientenv='portal'> <enabled>false</enabled> </filter> <filter clientenv='not portal'> <enabled>false</enabled> </filter> </failover> Preparing to use an external web 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 in 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 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. EMC Documentum Web Publisher Version 6.5 Deployment Guide 35

36 Preparing the Application Server Host 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. 36 EMC Documentum Web Publisher Version 6.5 Deployment Guide

37 Chapter 5 Upgrading a WDK Based Application This chapter contains instructions that are shared by all WDK based products. Check your release notes for information on the application servers, browsers, and other software that are certified for your product. Review this chapter and perform the tasks described in it before upgrading a WDK application. Customization of Documentum Administrator is not supported. Table 1, page 37 shows the files, directories, and subdirectories on the application server host that should be backed up. Table 1. Directories and files to back up Directory/file custom/app.xml custom subdirectories custom/config custom/strings custom/theme subdirectories WEB INF/classes subdirectories custom/src subdirectories WEB INF/tlds WEB INF/classes/com/ documentum/web/formext/session To back up if present app.xml JSP files XML files Properties files Branding files Custom classes Custom source files Custom tag libraries Back up AuthenticationSchemes.properties, KeystoreCredentials.properties, and TrustedAuthenticatorCredentials.properties if customized EMC Documentum Web Publisher Version 6.5 Deployment Guide 37

38 Upgrading a WDK Based Application 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 Documentum 6.5 System Upgrade and Migration Guide. 38 EMC Documentum Web Publisher Version 6.5 Deployment Guide

39 Chapter 6 Deploying Web Publisher After you complete the required predeployment tasks, deploy Web Publisher on the application server host. The following topics describe how to deploy the application: Preparing the WAR file for deployment, page 39 Enabling DFC connections to repositories, page 40 Enabling DFC memory optimization, page 42 Enabling preferences repositories, page 42 Enabling retention of folder structure and objects on export, page 43 Enabling modal pop up windows, page 43 Enabling external searches, page 44 Deploying multiple applications, page 45 Note: Presets do not apply to Web Publisher. Preparing the WAR file for 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 40. 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 42. EMC Documentum Web Publisher Version 6.5 Deployment Guide 39

40 Deploying Web Publisher 4. Add or migrate customizations from previous WDK based applications. 5. Apply language packs if you have purchased them. 6. Make any UCF configuration changes that your applications needs before deploying. Refer to the WDK Development Guide for details. 7. Re archive the WAR file. 8. 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.x is required for WDK based applications. The global registry is a central repository that serves several purposes: Deploys service based business objects (SBOs) Stores network location objects Stores application presets, unless another repository is configured in app.xml Stores persistent user preferences, unless another repository is configured in app.xml The Content Server Installation 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 file 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. 40 EMC Documentum Web Publisher Version 6.5 Deployment Guide

41 Deploying Web Publisher 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. 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 configure connections in dfc.properties before deployment: 1. Unpack the application WAR file. 2. Open the file dfc.properties in WEB INF/classes. 3. Add the fully qualified hostname for the docbroker to the following key. You 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 EMC Documentum Web Publisher Version 6.5 Deployment Guide 41

42 Deploying Web Publisher Enabling DFC memory optimization The DFC diagnostics are set to true by default. To free up memory resources, set dfc.diagnostics.resources.enable in dfc.properties. Refer to Enabling DFC connections to repositories, page 40 for the procedure of unpacking the war file and modifying dfc.properties. Add the following line to your dfc.properties file: dfc.diagnostics.resources.enable=false 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 /custom/app.xml and then specify your repository. For information on other preferences settings in app.xml, refer to the Web Publisher Development Guide. Table 2. Preferences configuration 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. 42 EMC Documentum Web Publisher Version 6.5 Deployment Guide

43 Deploying Web Publisher Enabling retention of folder structure and objects on export Caution: If your users will be exporting folders with special characters (\/:*?"<> ) in its name, you should not turn this feature on. When a folder with a name containing a special character is encountered during export, an error occurs and the export fails. To enable retaining the same folder structure (as the one in the repository) and the contained objects on the local file system when the parent folder is exported, add the following element to your app.xml in the custom directory: <deepexport> <enabled>true</enabled> </deepexport> The default is false. Enabling modal pop up windows The modal pop up window is a secondary browser pop up window with no browser controls either to maximize or minimize the window. This pop up window appears centered in the screen. The pop up window provides a similar experience on the web as in desktop, where you can interact with a component in a pop up window. The user interface for the component appears in a pop up window (child window) on top of the parent window. If you invoke another component from the child window, the user interface of the component appears on top of the child window and thus stacked one over the other pop up windows. You cannot access the parent window until you close all the pop up windows. The modal pop up window is supported only on Internet Explorer browser environment. The pop up window is not 508 compliant and hence it is not supported when 508 accessibility features are turned on through the User Preferences. In the wdk/app.xml file, <modalpopup> enables and disables the modal pop up feature. Table 3, page 44 describes the elements that configure modal windows in app.xml: EMC Documentum Web Publisher Version 6.5 Deployment Guide 43

44 Deploying Web Publisher Table 3. Modal window elements in app.xml (<modalpopup>) Element <enabled> <actioninvocationpostprocessors> <postprocessor> Description Turns on or off modal windows in the application. Valid values: true false. Default is true. List of action invocation post processors specified in <postprocessor> elements. Specifies a post processor. The syntax is: <postprocessor id="uniqueid" action="youraction" class= "YourActionInvocationPostProcessor"/> where uniqueid is an application wide unique string identifier for the post processor; youraction (optional) is the name of the action; and YourActionInvocationPostProcessor is the post processor s fully qualified Java class. Enabling external searches To allow users to search external sources, an administrator must configure a connection to an ECI Services server. (The ECI Services server is a separate product that is purchased separately from Webtop and Content Server.) If this connection has not been configured, you cannot include external sources in your search. Configuring the connection to the search server The following procedure describes how to enable the ECI Services server to query external sources. The ECI Services documentation provides more information about how to configure the ECI Services server itself. To configure the connection to an ECI Services server: 1. Unpack the client application WAR file. 2. Open the file dfc.properties in WEB INF/classes. 44 EMC Documentum Web Publisher Version 6.5 Deployment Guide

45 Deploying Web Publisher 3. Enable the ECI Services server by setting the following: dfc.search.ecis.enable=true 4. Specify the RMI Registry host for the ECI Services server by setting the following: dfc.search.ecis.host=host_ip dfc.search.ecis.port=port Where host_ip is IP address or machine name of the ECI Server. port is the port number that accesses the ECI server. The default port is Configuring the connection to the backup search server You can set a backup server in case the primary ECI Services server is unreachable. If a DFC application cannot connect to the primary ECI Services server to query external sources, the backup server is contacted. You can define the time period after which the application will try to connect again to the primary server. To define the backup server, specify the RMI host and port in the dfc.properties file: dfc.search.ecis.backup.host : host of the backup ECI Services server. Default value is: localhost. dfc.search.ecis.backup.port : port of the backup ECI Services server. Default value is: dfc.search.ecis.retry.period : waiting period before retrying to connect to the primary ECI Services server. This time is in milliseconds. Default value is: Deploying multiple applications Two or more WDK based applications of version 6.x can share the same application server instance if they are version 6 or higher. EMC Documentum Web Publisher Version 6.5 Deployment Guide 45

46 Deploying Web Publisher 46 EMC Documentum Web Publisher Version 6.5 Deployment Guide

47 Chapter 7 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 47 Configuring IBM WebSphere after deployment, page 48 Deploying default virtual link support, page 49 Enabling additional locales in the repository, page 49 Installing the Web Publisher server files and DAR files, page 50 Installing DAM DAR files, page 73 Additional Accelera DAR file tasks, page 61 Using ewebeditpro, page 76 Installing imarkup, page 79 Completing the Web Publisher Portlet Builder installation process, page 82 Completing the Web Publisher Page Builder installation process, page 83 Accessing the application, page 87 Testing WDK samples, page 87 Uninstalling the Web Publisher server files, page 88 Configuring UCF The Web Development Kit Development Guide contains the following procedures: How to configure different content transfer mechanisms (UCF or HTTP) for roles. How to configure the UCF client content transfer directories, including client path substitution. How to support self signed or unsigned SSL certificates. EMC Documentum Web Publisher Version 6.5 Deployment Guide 47

48 Completing the Deployment 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 HTTP/1.1 protocol, to the back end application server. If chunked requests are not supported then the client should use UCF alternative chunking mode. Configuring IBM WebSphere after deployment To complete the deployment, perform the following procedures. Changing the classloader and compiler settings Change the classloader setting for the WDK based application module in WebSphere, in 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"/> Setting com.ibm.ws.webcontainer. invokefilterscompatibility to true You must add the webcontainer com.ibm.ws.webcontainer.invokefilterscompatibility custom property and set it to true using the Websphere Admin console; otherwise, errors will occur when you attempt to access the Webtop URL. For more information about setting webcontainer custom properties, see Setting webcontainer custom properties. 48 EMC Documentum Web Publisher Version 6.5 Deployment Guide

49 Completing the Deployment 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 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 Web Development Kit 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 to the repository for additional locales. EMC Documentum Web Publisher Version 6.5 Deployment Guide 49

50 Completing the Deployment The Web Publisher DAR file 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 DAR file, 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 enable French. When you install the Web Publisher DAR file, 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 E of the Content Server Administration Guide to add the locales you need. During installation of the Web Publisher DAR file, the data dictionary is automatically updated with the correct Web Publisher labels in the additional locales. Installing the Web Publisher server files and DAR files Completing the installation of Web Publisher requires installing the Web Publisher server files on the Content Server host and installing the Web Publisher DAR file 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 DAR file are installed using a separate installer called the Documentum Web Publisher Server Files Installer. The optional WcmPostReplication DAR and Accelera DAR are also included in the server files installer. Run this installer on the Content Server host. The repository where you are installing a DAR file must be running when the DAR file is installed. In a multiserver environment, run the installer on the primary Content Server host. 50 EMC Documentum Web Publisher Version 6.5 Deployment Guide

51 Completing the Deployment For details about the WcmPostReplication DAR file, see Enhanced support for multi repository configurations, page 61. Additional tasks are associated with the Accelera DAR, including preinstallation tasks; see Additional Accelera DAR file tasks, page 61 for details. Note: There are additional DAR files relating to Web Publisher that are not included in the server files installer. Consult the following sections for information about these additional DAR files, which need to be deployed separately: Installing DAM DAR files, page 73 Completing the Web Publisher Portlet Builder installation process, page 82 Completing the Web Publisher Page Builder installation process, page 83 On Windows Content Server hosts, the DAR file is installed automatically by a command line version of Documentum Composer, known as headless Composer. Headless Composer is embedded in Content Server 6.5 and is installed at C:\Documentum\WebPublisher\6.5\install\composer\composer\ComposerHeadless. This version of Composer should not be used for any other tasks, however; if you are installing DAR files manually (for Page Builder installations, for example), you must obtain the headless Composer installer from the Download Center and install it on the Content Server host. Likewise, if you are using Web Publisher with an earlier version of Content Server, download and install headless Composer before continuing with these procedures. On a UNIX or Linux host, the server files installer places the Web Publisher DAR file on the Content Server host, but the installer cannot install the DAR file into the repository. You must transfer the DAR file to a Windows host and use Documentum Composer to install the DAR file. If you transfer the DAR file, 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 DAR file as the Content Server installation owner. The user installing Web Publisher server files must have Write access to the directory from which the installer is executed. The server file installer creates DAR file log files that are displayed after the DAR file installation is complete. Create a backup of the log files to track any changes you make to the DAR files. Log files can be used as a reference for DAR file installation. The log files are saved in $DOCUMENTUM/dba/config/repository_name on (UNIX or Linux) or %DOCUMENTUM%\dba\config\repository_name on Windows in the following folders: WebPublisher_WebPublisher for the mandatory Web Publisher DAR WebPublisher_WcmPostReplication for the optional WcmPostReplication DAR WebPublisher_AcceleraDemo for the optional Accelera DAR EMC Documentum Web Publisher Version 6.5 Deployment Guide 51

52 Completing the Deployment Caution: Installing a new Web Publisher DAR file overwrites existing Web Publisher objects. Document any customizations to the objects and recreate the customizations after the upgrade. For additional information about customizations, refer to the Web Publisher Development Guide and the Documentum System Upgrade and Migration Guide. Where the DAR file and server files are installed The tables that follow contain the installation locations of the server files and Web Publisher DAR file on UNIX and Windows hosts. $DM_HOME (UNIX) or %DM_HOME% (Windows) is the Content Server installation directory. $DOCUMENTUM_SHARED (UNIX) or C:\Documentum (Windows) is the DFC program root directory. For more information on environment variables on the Content Server host, refer to the Content Server Installation Guide. Table 4. Location of DAR files and Web Publisher server files 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 Installation location on Java Method Server $DOCUMENTUM_ SHARED/jboss4.2.0/ server/dctmserver_ MethodServer/deploy/ ServerApps.ear/ DmMethods.war/WEB INF/lib $DM_HOME/install/ DARs/WebPublisher $DM_HOME/bin/ webpublisher /install $DM_HOME/ install/ DARs/AcceleraDemo $DOCUMENTUM_ SHARED/jboss4.2.0/ server/dctmserver_ MethodServer/ deploy/serverapps. ear/dmmethods. war/web INF/classes Description Web Publisher job and method Java classes DAR file archive folders DAR file Installer files; for internal use only. Accelera demo DAR files Properties files used by Web Publisher to log or trace the application. 52 EMC Documentum Web Publisher Version 6.5 Deployment Guide

53 Completing the Deployment Files ServerApps.log 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 dd_populate_wcm.bat dd_populate_wcm.sh wcmattachlifecycle.ebs wcmconfigure.ebs wcmlifecyclepostprocedure.ebs wcmmethodserverupdate.ebs wcmmethodstandaloneupdate. ebs Installation location on Java Method Server $DOCUMENTUM_ SHARED/ jboss4.2.0/ server/dctmserver_ MethodServer<server name>/logs $DM_HOME/bin $DM_HOME/bin/ webpublisher/utils/ DataDictionary $DM_HOME/bin/ webpublisher/utils Description 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 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.5 Deployment Guide 53

54 Completing the Deployment Files wcmmigration.ebs wcmpostconfigure.ebs wcmupdate.ebs Installation location on Java Method Server Description Table 5. Location of DAR files and Web Publisher server files on Windows 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 location on Java Method Server C:\Documentum\jboss4.2. 0\server\Dctm Server_Method Server\deploy\Server Apps.ear\DmMethods.war\WEB INF\lib %DM_HOME%\install\DARs\WebPublisher %DM_ HOME%\bin\webPublisher\install %DM_HOME%\install\DARs\AcceleraDemo C:\Documentum\jboss4.2. 0\server\Dctm Server_ Method Server\deploy\Server Apps.ear\DmMethods. war\web INF\classes C:\Documentum\jboss4.2. 0\server\DctmServer_ MethodServer<server name>\logs Description Web Publisher job and method Java classes. DAR file archive folders. DAR file Installer files; for internal use only. Accelera demo DAR files 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. 54 EMC Documentum Web Publisher Version 6.5 Deployment Guide

55 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 dd_populate_wcm.bat dd_populate_wcm.sh wcmattachlifecycle.ebs wcmconfigure.ebs wcmlifecyclepostprocedure.ebs wcmmethodserverupdate.ebs wcmmethodstandaloneupdate.ebs wcmmigration.ebs wcmpostconfigure.ebs wcmupdate.ebs Installation location on Java Method Server %DM_HOME%\bin %DM_HOME%\bin\ webpublisher\utils\ DataDictionary %DM_ HOME%\bin\webPublisher\Utils Description 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. Utility files used for reconfiguring or debugging repository operations EMC Documentum Web Publisher Version 6.5 Deployment Guide 55

56 Completing the Deployment About the Web Publisher server files The Web Publisher server files consist of two jar files, wcm.jar and WcmMethods.jar. These files contain Java methods that are executed on the Content Server host by the Java method server. The Java methods contain classes that are invoked by automatic activities in the default Web Publisher workflow. The classes change permissions and execute jobs as required. For more information on Java methods and the Java method server, refer to the Content Server Administration 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 DAR file To install the Web Publisher DAR file, you must have Superuser privileges in the repository. Installing the Web Publisher DAR file 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 DAR file is installed. Installing the DAR file 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 DAR file: Creates dm_relation objects used by Web Publisher 56 EMC Documentum Web Publisher Version 6.5 Deployment Guide

57 Completing the Deployment Creates the four Web Publisher user groups: Administrator Web developer Content manager Content author Creates the four Web Publisher user roles: wcm_administrator_role wcm_web_developer_role wcm_content_manager_role wcm_content_author_role Creates the Web Publisher User Default ACL Installing the DAR files and server files on Windows hosts After you add any required locales to the repository, install the Web Publisher server files and DAR files. (To add required locales to the repository, use the procedure in Enabling additional locales in the repository, page 49.) The Web Publisher DAR file installs the data dictionary information for the locales to the repository. The installer (WPServerWinSetup.exe) invokes an embedded instance of Documentum Composer that runs in command line mode, also referred to as Headless Composer. Caution: The user installing Web Publisher server files must have Write access to the directory from which the installer is executed. To install the Web Publisher server files and DAR files on Windows hosts: 1. Log in to the Content Server host as the Content Server installation owner. 2. Copy WPServerWinSetup.exe from the distribution package to a 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. EMC Documentum Web Publisher Version 6.5 Deployment Guide 57

58 Completing the Deployment The Install Preview dialog box is displayed. 6. Click Next. The Web Publisher server files are installed to drive:\program Files\Documentum\Shared. The %DM_HOME%\bin\webpublisher folder is created. The %DOCUMENTUM%\dctm.jar file is modified. 7. Select a repository in which to install the Web Publisher DAR file. 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 DAR file and, optionally, either or both of the Accelera and WcmPostReplication DAR files, then click Next. Installing the Web Publisher DAR file is required. Installing the Accelera DAR file is optional, but if you intend to install both DAR files in a particular repository, it is strongly recommended that you do so at the same time. The WcmPostReplication DAR file is also optional; it provides a Content Server method and jobs for managing Web Publisher in multi repository configurations. For more information on the WcmPostReplication DAR file, refer to Enhanced support for multi repository configurations, page 61. The DAR files are installed and the Log File dialog box is displayed. The installer creates a DAR file log file called WebPublisher_installerLog.html when you install the Web Publisher DAR file. Log files are also created for the Accelera and WcmPostReplication DAR files, where applicable, and are located in separate folders at %DOCUMENTUM%\dba\config\repository_name. The Web Publisher DAR log file is displayed after DAR file installation is complete. 10. Click Next. The Installation Summary dialog box is displayed. 11. Click Finish. 12. Restart the Documentum Java method server a. Click Start > Programs > Administrative Tools > Services. b. On the Services dialog box, scroll to Documentum Java Method Server. c. Right click Documentum Java Method Server. d. Click Stop. e. Right click Documentum Java Method Server. f. Click Start. g. Close the Services dialog box. 58 EMC Documentum Web Publisher Version 6.5 Deployment Guide

59 Completing the Deployment 13. Repeat this procedure in each repository where you run Web Publisher. Installing the DAR files and server files on UNIX and Linux hosts After you add any required locales to the repository, install the Web Publisher server files and DAR files. (To add required locales to the repository, use the procedure in Enabling additional locales in the repository, page 49.) The Web Publisher DAR file 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 DAR files (Web Publisher DAR, WcmPostReplication DAR, and Accelera DAR) must be installed from a Windows computer that has Documentum Composer installed. The Web Publisher DAR is mandatory, while the WcmPostReplication and Accelera DARs are optional. There are different procedures for installing the server files and the DAR files. Complete them both. Installing the server files Use these instructions to install the server files on a UNIX host. Caution: The user installing Web Publisher server files must have Write access to the directory from which the installer is executed. To install the Web Publisher server files on UNIX and Linux hosts: 1. Copy the wpserverossetup.bin to the Content Server host. 2. In the directory to which you copied the file, type: wpserverossetup.bin where OS corresponds to the operating system on which you are installing. 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. EMC Documentum Web Publisher Version 6.5 Deployment Guide 59

60 Completing the Deployment 6. Using a text editor, create a file called wcm_log.txt. The wcm_log.txt file stores error messages about errors that occur while the application is running. 7. Restart the Java method server. a. Navigate to the $DM_HOME/tomcat/bin/ directory. b. Run the shutdown.sh script. c. Run the startup.sh script. Installing the DAR files Use these instructions to install the mandatory Web Publisher DAR file or the optional WcmPostReplication and Accelera DARs on a UNIX host. The instructions require that you use Documentum Composer or headless Composer on a Windows host. See Installing a DAR file with the DAR Installer Plugin, page 73 for more information. To install the Web Publisher, WcmPostReplication, or Accelera DAR file in a UNIX repository: 1. Log in to a Windows host where the Documentum Composer is installed. 2. Ensure that the dfc.properties file on the host is pointing to a connection 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 DAR file from the Content Server host to a temporary folder on the Windows host. 4. Follow the procedure in Installing a DAR file with the DAR Installer Plugin, page 73 to install the DAR file(s). 5. Repeat this procedure in each repository where you run Web Publisher. Documentum Composer creates a DAR file log file called WebPublisher_installerLog.html when you install the Web Publisher DAR file. Log files are also created for the Accelera and WcmPostReplication DAR files, where applicable. The log files are saved in $DOCUMENTUM/dba/config/repository_name; separate folders are created for each DAR s log files. 60 EMC Documentum Web Publisher Version 6.5 Deployment Guide

61 Completing the Deployment Enhanced support for multi repository configurations For multi repository configurations, Web Publisher includes a DAR file, WcmPostReplication, which provides the server method and job needed in multi repository configurations. This optional DAR file is included in the Web Publisher server files installer, and it will be installed if you choose to do so during server file installation; see Installing the Web Publisher server files and DAR files, page 50 for details. If you install this DAR file, it is copied to $DM_HOME\install\DAR files\webpublisher by the installer. Your system administrator will also need to customize the jobs included in this DAR file for your environment. The WcmPostReplication DAR file 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 DAR file 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. Additional Accelera DAR file tasks The Accelera DAR file installs repository components for the Accelera.com sample website, which is discussed in the Web Publisher Administration Guide. Documentum EMC Documentum Web Publisher Version 6.5 Deployment Guide 61

62 Completing the Deployment provides the sample website for administrators and Web developers to use as a starting point for website customization. The Accelera DAR file contains object types, lifecycles, workflow templates, permission set templates, Web Publisher Editor templates, alias sets, procedures, methods, cabinets and content for the website. You are not required to install the Accelera DAR file; it is a sample only. Installing the Web Publisher DAR file is a prerequisite for installing the Accelera DAR file. Both of these DAR files are installed by the Web Publisher server files installer, as described in Installing the Web Publisher server files and DAR files, page 50. If you plan to install the Web Publisher and Accelera DAR files in the same repository, Documentum strongly recommends installing the two DAR files at the same time. If you did not opt to install the Accelera DAR when the server files installer was run initially, Documentum recommends that you re run this installer so that the Web Publisher DAR and Accelera DAR are installed together. Installing the Accelera DAR file 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 DAR file. 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 website after installing the Web Publisher DAR file, you can either: Install the Web Publisher and Accelera DAR files in a clean repository. In the repository where Web Publisher is already installed, record any customizations to FolderMap.xml. After the Accelera DAR file is installed and FolderMap.xml is versioned, open FolderMap.xml, restore the customizations, and save FolderMap.XML as a new version. The Accelera DAR file is a sample website only. You are not required to install it. Documentum is not responsible for the sample s accuracy or completeness. This section discusses these topics: Accelera preinstallation requirements, page 62 Accelera postinstallation requirements, page 63 Testing the Accelera DAR file installation, page 69 Publishing documents to the sample website, page 69 Accelera preinstallation requirements Ensure that the following tasks are completed before you install the Accelera DAR file: 1. Install Documentum Administrator. 62 EMC Documentum Web Publisher Version 6.5 Deployment Guide

63 Completing the Deployment 2. Install three web application server instances for the WIP, Staging, and Active editions of the Accelera website. 3. Ensure that the regional setting is correct. Refer to Setting the regional options on Windows hosts, page 63. 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 DAR file 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 DAR file installation is complete, you can return the Regional Settings to the previous settings. Accelera postinstallation requirements After the Accelera DAR file is installed with the Web Publisher server files installer, complete these procedures to enable the Accelera sample website: 1. Creating the Accelera database schema, page Installing and configuring Site Caching Services, page Modifying the DbUtils.inc file, page Creating a site publishing conguration, page Creating the WEB INF folder, page 68 EMC Documentum Web Publisher Version 6.5 Deployment Guide 63

64 Completing the Deployment 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. 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 configuring 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: 64 EMC Documentum Web Publisher Version 6.5 Deployment Guide

65 Completing the Deployment Figure 2. SCS configuration for Accelera The username and password you enter here should match that of the schema you created. Modifying the DbUtils.inc file The Accelera.com web application obtains its database credentials from the DbUtils.inc file, found in the accelera.com web cabinet at /Accelera.com/includes/util. You will need to update the JDBC connection string, and the userid and password of the database schema. Note that the same DbUtils.inc file is used in all three environments, which is why you want a single schema. Use different table names for your three publishing configurations. An example DbUtils.inc file is included below. Example 7 1. DbUtils.inc <% // //Database Connection Variables **CONFIGURE HERE** //Your DB connection string can be found in the //webcache.ini file. Use the user name and password //you specified during webacache installation. // String strjdbcdrivername = "oracle.jdbc.driver.oracledriver"; String strdbconnectionstring= "jdbc:oracle:thin:@(description= (address=(host=localhost)(protocol=tcp)(port=1521)) EMC Documentum Web Publisher Version 6.5 Deployment Guide 65