EMC Documentum Web Development Kit and Webtop

Transcription

1 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Legal Notice Copyright EMC Corporation. All Rights Reserved. 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. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at ECD.Documentation.Feedback@emc.com

3 Table of Contents Preface... 9 Chapter 1 Quick Start Chapter 2 Planning for Deployment 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 Chapter 3 Preparing the Client Hosts Ensuring a certified JVM on browser clients Supporting Outlook mail message Using MailApp DAR for messages Configuring MailApp.properties Using configuration options in app.xml for import Using Citrix Presentation Server Client Ensuring active scripting is enabled 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 Configuring JBoss EAP 6.3.x Preparing Tomcat Disabling tag reuse Disabling HttpOnly property Improving performance on Tomcat 8.x Preparing vfabric tc Server Disabling tag reuse Disabling HttpOnly property Preparing WebLogic server Deploying WAR Disabling HttpOnly property EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 3

4 Table of Contents Supporting large content transfer operations in a managed server environment Preparing IBM WebSphere Deploying WAR Disabling HttpOnly property Preparing the Application Server for Java 2 security Preparing to use an external web server Chapter 5 Deploying a WDK-based Application Preparing the WAR file for deployment Enabling DFC connections to repositories Enabling DFC memory optimization Configuring UCF Forcing UCF to install a configured JRE Enabling presets and preferences repositories Configuring encrypted password for presets and 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 Enabling xplore search with Webtop s Deploying multiple applications Configuring custom HTTP session attributes Configuring URL addressable components and actions Enabling Documentum Collaborative Services Configuring Client capability roles Deploying Documentum Webtop in a cluster for Load Balancing and Failover scenario Chapter 6 Completing the Deployment Configuring IBM WebSphere after deployment Changing the classloader and compiler settings Setting custom webcontainer property com.ibm.ws.webcontainer. invokefilterscompatibility to true Configuring Oracle WebLogic Server 11g R1 (10.3.x) Deploying default virtual link support Accessing the application Testing WDK samples Chapter 7 Configuring User Authentication Single Sign-On for security servers WebSEAL Single Sign-On (SSO) authentication Prerequisites Configurations in the wdk/app.xml file to enable WebSEAL authentication Configuring Kerberos authentication Kerberos-based single sign-on authentication EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

5 Table of Contents Prerequisites Configuring wdk/app.xml to enable Kerberos authentication Enabling Kerberos authentication in the WDK application Configuring the Kerberos domain name Configuring Kerberos fallback Sample Kerberos configuration in app.xml Preparing the WDK application and browser to meet Kerberos Setup Requirements Create user account for the WDK application in the active directory Define a Service Principal Name for the WDK application and create the KeyTab file Configuring the client browser to use the SPNEGO protocol Creating the JAAS configuration file Creating a configuration file for the application server to connect to the KDC server Application server configuration Tomcat WebLogic JBoss JBoss 5.x JBoss 6.3.x WebSphere Configuring Netegrity SiteMinder SSO authentication Prerequisites Enabling single sign-on (SSO): Configuring app.xml for Netegrity Server single sign-on: Configuring User Principal authentication Chapter 8 Installing Application Connectors Overview GUI installation of Application Connectors Command-line installation of Application Connectors Location of installed files on the client host Chapter 9 Enabling the Webtop Express DocApp Chapter 10 Troubleshooting Deployment Wrong JRE used for application server No global registry or connection broker No connection to repository DM_VEL_INSTANTIATION_ERROR 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 Federated Search server and IPv6 clients EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 5

6 Table of Contents Presets not working Blank page error on deploying DA Documentum Application Connectors refers to Microsoft Virtual Machine installed on the client while calling UCF methods Chapter 11 Deploying a Custom Application Using the comment stripper utility Appendix A Predeployment Checklist Appendix B Directories and Files to Back Up Before Migration EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

7 Table of Contents List of Figures Figure 1. Basic WDK host configuration EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 7

8 Table of Contents List of Tables Table 1. Preferences configuration elements Table 2. Modal window elements in app.xml (<modalpopup>) Table 3. Authentication elements (<authentication>) Table 4. Authentication elements (<authentication>) Table 5. Location of files installed by Application Connectors on the client host Table 6. Express user capabilities Table 7. Comment stripper utility parameters Table 8. Predeployment tasks Table 9. Directories and files to back up EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

9 Preface This guide describes how to deploy EMC Documentum Webtop and applications that are built on Web Development Kit (WDK) or Webtop. WDK is a developer toolkit based on industry standards that facilitates the development of complex web-based applications connecting to EMC 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 EMC Documentum web client applications. These applications can be customized using WDK. For additional information on developing or customizing applications with WDK, refer to the EMC Documentum Web Development Kit Development Guide. This guide may include instructions for application servers, or combinations of operating systems and application servers that are not supported for your product. For the list of supported platforms, refer to the EMC Documentum Environment and System Requirements Guide or the product release notes document for the product that you are deploying. Intended Audience This manual is intended primarily for administrators who are deploying an application based on WDK or Webtop. EMC Documentum web client products are built on WDK or Webtop and have their own deployment guides. These client deployment guides contain the same general information that is in this guide as well as information specific to the client product. To deploy a WDK-based application, you should be familiar with the application server s operating system and be able to install and configure a J2EE application server. Revision History Revision Date July 2015 Description Updated the Preparing the WAR file for deployment, page 29 section. EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 9

10 Preface Revision Date May 2015 December 2014 Description Updated the Supporting Outlook mail message, page 17 section. Initial publication. 10 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

11 Chapter 1 Quick Start This chapter describes the steps you need to perform to deploy your application. The steps are described in more detail in the chapters of this guide. Your product or environment may require additional steps, which you can find in the product-specific chapter or chapters of this guide or in the index. To perform a simple product 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 (if supported) plan to deploy a customized application. 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. If needed, you will install the mail message converter and prepare Citrix clients. 3. Prepare the application server. (Refer to Chapter 4, Preparing the Application Server Host.) Configure UCF, ensure you have sufficient memory allocated to the application server Java instance, turn off failover if it is not needed, and follow application-server and proxy-server specific preparation instructions. 4. Deploy the product WAR file using the application server standard deployment mechanism. (Refer to Chapter 5, Deploying a WDK-based Application.) 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, presets and preferences repositories, and optional Federated Search server. 5. Complete the deployment. (Refer to Chapter 6, Completing the Deployment.) After successful deployment, you can deploy root virtual link support, enable WebSphere global security if needed, and test the application samples. EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 11

12 Quick Start 12 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

13 Chapter 2 Planning for Deployment This chapter addresses software and hardware decisions you must make before you deploy a WDK-based application. This chapter contains instructions that are shared by all WDK-based products. For information on the application servers, browsers and other software in the environment that are certified for your product, see the EMC Documentum Environment and System Requirements Guide or the product release notes document. This chapter discusses the following topics: Required and optional supporting software, page 13 Typical configuration, page 14 Preparing the Content Server, page 15 Application server host requirements, page 15 Deploying multiple applications, page 16 Deploying language packs, page 16 Customizing an application, page 16 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 31 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. EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 13

14 Planning for Deployment 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 Global registry repository Client hosts that run a supported web browser Figure 1, page 14 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. For more information about the supported managed server configurations, see the EMC Documentum Environment and System Requirements Guide or the product release notes document. 14 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

15 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 30. 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 EMC Documentum Web Development Kit Development Guide. Some application servers require policies that grant permissions to write to these directories. Refer to deployment information for your application server to see Documentum policy settings. DNS resolution The Domain Name Server (DNS) must be configured to properly resolve IP addresses based on the URL used to access the server. EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 15

16 Planning for Deployment 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 EMC Documentum 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. 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. 16 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

17 Chapter 3 Preparing the Client Hosts This chapter contains instructions that are shared by all WDK-based products. Check the EMC Documentum Environment and System Requirements Guide or the product release notes document for information on the browsers that are certified for your product. This chapter contains information on the following predeployment tasks: Ensuring a certified JVM on browser clients, page 17 Supporting Outlook mail message, page 17 Using Citrix Presentation Server Client, page 19 Ensuring active scripting is enabled, page 19 Ensuring a certified JVM on browser clients Browser client hosts require a certified version of the Oracle 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. 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 downloads a private JVM to the client machine. This VM does not replace the JVM that is used by the browser. For non-windows browser hosts with a JVM of 1.7.x or later, you must pre-install a supported version of the Oracle JRE that will then be used by UCF. Since the UCF VM file (Oracle 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. Supporting Outlook mail message New messages through Webtop are imported in the dm_document type or any of its subtypes. Ensure that you install MailApp.dar on the Content Server to use the changed management features. The EMC Documentum Webtop Release Notes contains detailed information on the system requirements. EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 17

18 Preparing the Client Hosts You can view the dm_document (.msg) objects using Microsoft Outlook. To view the messages in the.msg format, the client must have the Microsoft Outlook. The existing EMCMF objects can be migrated using the migration utility. The EMC Documentum Webtop Migration Guide contains detailed information. If the EMCMF objects are not migrated, ES1_MRE.msi is required to view the EMCMF objects in Microsoft Outlook. To use the View as Outlook option in the HTML Viewer, the client must have the ES1_MRE.msi file. The ES1_MRE.msi file is automatically installed as part of UCF download. To enable automatic download of the ES1_MRE.msi, uncomment the ES1_MRE.msi section in the <WebApp Root>/wdk/contentXfer/ucf.installer.config.xml file on the application server. The ES1_MRE.msi gets downloaded and installed on your client machine. Using MailApp DAR for messages To enable the changed management features, you must install MailApp.dar on the Content Server. MailApp.dar extracts the following metadata information from messages and attaches them in the form of aspects to the message and then imports the message into the repository as a dm_document type or any of its subtypes. From address To address Cc Address Bcc Address Sent date Received date Size Attachment count Message signed Importance Message Subject Sensitivity Message class Message id MailApp.dar also separates the internal attachment objects and stores them as separate objects in the repository. By default, attachment separation is disabled. This element can be enabled from the MailApp.properties file. Configuring MailApp.properties The MailApp.properties file is introduced for the changed management feature. 18 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

19 Preparing the Client Hosts By default, MailApp.properties is located in <WebApp Root>\WEB-INF\classes. The default values are used and it is not necessary to configure the properties. However, you can modify the value of the properties to change the default behavior. shouldseparateattachments=false If the value is false, then message attachments are not separated. objecttypeforattachments=dm_document This indicates the object type for the attachments. It must either be dm_document or its subtypes, except dm_message_archive and its subtypes. shouldparsemsgfile=true If the value is true, then the.msg files are parsed. The new.msg files are parsed through MailApp.dar and attributes like From, Cc, and so on are retrieved and stored as aspect attributes. If the value is false, the.msg file are not parsed and stored as the dm_document type object without having any aspect attributes. In addition, s search through attributes is not possible and not displayed in the properties and listing pages. Using configuration options in app.xml for import Following configuration options (optional) are available in app.xml for importing s in <mailmessage-support>. <skip-duplicate-messages>: Specifies whether to log errors for duplicate messages and continue importing (true) or throw an error and stop importing (false). The default value is true. <override-object-name>: Specifies whether you can change the object name of objects through import. The default value is false. Using Citrix Presentation Server Client Citrix Presentation Server Client can be used as a web browser. 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. Ensuring active scripting is enabled In Internet Explorer, the active scripting option is enabled by default, which is required for Webtop to work. In case active scripting is disabled, you need to enable it by performing the following steps: EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 19

20 Preparing the Client Hosts 1. Open Internet Explorer. 2. Navigate to Tools > Internet Options. 3. In the Internet Options dialog box, on the Security tab, click Custom level. 4. In the Security Settings dialog box, under Active scripting, click Enable. 5. Click OK twice. 20 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

21 Chapter 4 Preparing the Application Server Host This chapter describes the tasks you must complete to prepare the application server host before deploying the WDK-based application. 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. Your selected application server and optional external web server must be certified for the product. Check the EMC Documentum Environment and System Requirements Guide or the product release notes document for information on the application servers that are certified for that product. EMC 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. This chapter contains the following sections. Setting the Java memory allocation, page 21 Required information for all application servers Turning off failover, page 22 Preparing environment variables for non-default DFC locations, page 22 Information for enterprise environments that do not use the default (recommended) DFC environment locations. Preparing JBoss, page 23 Preparing Tomcat, page 24 Preparing vfabric tc Server, page 25 Preparing WebLogic server, page 26 Preparing IBM WebSphere, page 27 Preparing to use an external web server, page 28 Setting the Java memory allocation The minimum recommended Oracle Java memory allocation values for application servers on a small system (only for 32-bit) are the following: -Xms1024m -Xmx1024m EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 21

22 Preparing the Application Server Host However, applying these Oracle Java memory allocation settings can slow down application servers, throw exceptions, or crash with an application that has a large number of Java Server Pages. For example, the following error is common when the value set for MaxPermSize is too low and the application server host memory is exhausted: java.lang.outofmemoryerror: PermGen space It is recommended that you set the value of the MaxPermSize parameter to 128 or higher, to avoid such errors. Document caching can consume at least 80 MB of memory. User session caching can consume approximately 2.5 MB to 3 MB per user. Fifty connected users can consume over 200 MB of VM memory on the application server. Increase the values to meet the demands of the expected user load. For more information on these settings, refer to Java documentation at Oracle s Java 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. 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> 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 %WebLogic_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, 22 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

23 Preparing the Application Server Host is "file". The full path to this file by default is dfc.user.dir/documentum.ini. For a non-default file na me or location, specify it as the value of the environment variable dfc.registry.file. Preparing JBoss Configuring JBoss EAP 6.3.x 1. If available, delete the dfc.keystore and wdk.keystore files in <JBoss Home>\bin (Windows) and <JBoss Home>/bin (Linux). 2. Move the keystore files from <WebApp Root>\WEB-INF\classes (Windows) and <WebApp Root>/WEB-INF/classes (Linux) to the bin folder of the <JBoss Home> directory. 3. Copy the contents of the classes folder from <WebApp Root>\WEB-INF\classes (Windows) and <WebApp Root>/WEB-INF/classes (Linux) to a temporary location (for example, Temp-Loc). Execute the following command at Temp-Loc to create a web-inf-classes jar file: jar -cvf web-inf-classes.jar * 4. Copy the web-inf-classes.jar file to <WebApp Root>\WEB-INF\lib (Windows) and <WebApp Root>/WEB-INF/lib (Linux). 5. Delete the classes folder from <WebApp Root>\WEB-INF (Windows) and <WebApp Root>/WEB-INF (Linux). 6. Add the configuration entry (in bold) to the subsystem tag in standalone.xml in <JBoss Home>\standalone\configuration (Windows) and <JBoss Home>/standalone/configuration (Linux) to disable tag pooling: <subsystem xmlns="urn:jboss:domain:web:2.1" default-virtual-server="default-host" native="false"> <connector name="http" protocol="http/1.1" scheme="http" socket-binding="http"/> <virtual-server name="default-host" enable-welcome-root="true"> <alias name="localhost"/> <alias name="example.com"/> </virtual-server> <configuration> <jsp-configuration tag-pooling="false"/> </configuration> </subsystem> 7. Configure the binding address by replacing with the application server host IP address in <wsdl-host> and <interfaces> tags in standalone.xml 8. Execute the following command at <WebApp Root> to repackage the Webtop WAR file: jar cvf webtop.war * EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 23

24 Preparing the Application Server Host Preparing Tomcat Disabling tag reuse You must disable tag reuse in /conf/web.xml. Find the JSP servlet entry and set the enablepooling initialization parameter to false (as shown in bold): <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> Disabling HttpOnly property 1. Modify the <Context> element in the context.xml file located at <Tomcat Home>\conf: From <Context> To <Context usehttponly="false"> 2. Restart the application server. Improving performance on Tomcat 8.x To improve performance on Tomcat 8.x, perform the following: Enable the web application server s compression. Disable the WDK compression filter. To enable the web application server compression: 1. Navigate to <Tomcat Home>/conf. 2. Locate and open server.xml. 3. Search for Connector port= It contains the following entry: 24 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

25 Preparing the Application Server Host <Connector port="8080" protocol="http/1.1" connectiontimeout="24000" redirectport="8443"/> 4. Append the following entry to the Connector tag: compression="on" compressionminsize="2048" compressablemimetype="text/html,text/xml,application/xml,text/ plain,text/css,text/javascript,text/json,application/ x-javascript,application/javascript,application/json" usesendfile="false" Here is updated Connector tag (appended entry in bold): <Connector port="8080" protocol="http/1.1" connectiontimeout="20000" redirectport="8443" compression="on" compressionminsize="2048" compressablemimetype="text/html,text/xml,application/xml,text/ plain,text/css,text/javascript,text/json,application/ x-javascript,application/javascript,application/json" usesendfile="false"/> To disable the WDK compression filter: New flag is introduced in Webtop 6.8 to enable/disable the default WDK compression filter. 1. Open wdk/app.xml and navigate to the end of the document. 2. Search for the <compression_filter_enabled> tag and set it to false. <compression_filter_enabled>false</compression_filter_enabled> The default value is true. 3. Restart the application server. Preparing vfabric tc Server Disabling tag reuse You must disable tag reuse in /conf/web.xml. Find the JSP servlet entry and set the enablepooling initialization parameter to false (as shown in bold): <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> EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 25

26 Preparing the Application Server Host </init-param> <load-on-startup>3</load-on-startup> </servlet> Disabling HttpOnly property 1. Modify the <Context> element in the context.xml file located at <vfabric tc Server Home>\conf: From <Context> To <Context usehttponly="false"> 2. Restart the application server. Preparing WebLogic server The following topic describes preparations that may be necessary before you deploy a WDK-based application. Deploying WAR The Preparing the WAR file for deployment, page 29 section contains detailed information on deploying the WAR file. Disabling HttpOnly property 1. Modify the <session-descriptor> element in the WebLogic.xml file located at \webtop\web-inf: From <session-descriptor> To <session-descriptor> <cookie-http-only>false</cookie-http-only> </session-descriptor> 2. Restart the application server. 26 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

27 Preparing the Application Server Host 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. The Oracle documentation contains additional details on Web Server Plug-in parameters. Preparing IBM WebSphere The following topics describe how to prepare the application server to support failover in a cluster, and to support non-default content transfer locations. Deploying WAR The Preparing the WAR file for deployment, page 29 section contains detailed information on deploying the WAR file. Disabling HttpOnly property Deselect Set session cookies to HTTPOnly to help prevent cross-site scripting attacks from the location Application servers>server1>session management>cookies Note: If there are multiple applications deployed in the same application server and if you require to set the flag HttpOnly just for WDK application, then perform the following steps: 1. Deselect Set session cookies to HTTPOnly to help prevent cross-site scripting attacks from All Applications>webtop>Session management>cookies. 2. Check Override the session management from All Application >Webtop>session management. Preparing the Application Server for Java 2 security If you plan to use Java 2 security for securing access to available system resources in your Webtop installation, then you must use the Java policy configuration file that is bundled with your application server. The java policy configuration file of the application server specifies the permissions granted to the classes, in your Webtop installation. To help you update the java policy configuration file of the application server, an example policy template file is included in the Webtop installation (Webtop.example.java.policy file). The file specifies the permissions required to access the EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 27

28 Preparing the Application Server Host Webtop classes. The Webtop.example.java.policy file is included in the webtop.war file, and gets extracted into the <webtop_app_root> folder. Note: Caution: Do not omit any permission specified in the Webtop.example.java.policy file while incorporating the permissions in the application server Java policy configuration file. Otherwise, Webtop may fail to start or some features might fail to work. Refer to the documentation for each application server for instructions on adding or updating permissions in the security policy file of the application server. The Webtop.example.java.policy file contains a default set of permissions that are required for Webtop functionality. If you customize Webtop, then you must incorporate other relevant permissions in your application server policy file. EMC Documentum does not support such changes to the application server policy files. To enable Java 2 security in the application server: 1. Navigate to webtop_app_root\webtop.example.java.policy and identify the permissions that must be incorporated into the application server security policy file. 2. Navigate to the policy file of your application server. Based on the syntax and locations specified in the application server documentation, add, or update the permissions (identified in the Webtop.example.java.policy file), in the policy file of the application server. 3. Configure your application server to pick the security policy files. Preparing to use an external web server 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 Oracle 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 EMC Documentum 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. 28 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

29 Chapter 5 Deploying a WDK-based Application This chapter contains instructions that are shared by all WDK-based products. Check the EMC Documentum Environment and System Requirements Guide or the product release notes document for information on the application servers, browsers and other software in the environment that are certified for your product. After you complete the required predeployment tasks, deploy a WDK application on the application server host. The following topics describe how to deploy the application: Preparing the WAR file for deployment, page 29 Enabling DFC connections to repositories, page 30 Enabling DFC memory optimization, page 32 Configuring UCF, page 32 Forcing UCF to install a configured JRE, page 32 Enabling presets and preferences repositories, page 33 Enabling retention of folder structure and objects on export, page 35 Enabling modal pop-up windows, page 35 Enabling external searches, page 36 Enabling xplore search with Webtop s, page 37 Deploying multiple applications, page 37 Configuring custom HTTP session attributes, page 37 Enabling Documentum Collaborative Services, page 38 Deploying Documentum Webtop in a cluster for Load Balancing and Failover scenario, page 39 Preparing the WAR file for deployment Perform the following procedure to prepare the WDK-based application WAR file. EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 29

30 Deploying a WDK-based Application 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 30. You must perform this procedure before attempting to connect to Documentum repositories. 3. Enable the presets and preferences repositories in app.xml following the instructions in Enabling presets and preferences repositories, page 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 EMC Documentum Web Development Kit Development Guide for details. 7. If deploying to a production environment, remove the following files: <web-app root>\unstripped.jar <web-app root>\webtop.example.java.policy <web-app root>\webtop\webtop.vep <web-app root>\webtop\webtop BEA.vep <web-app root>\webtop\src 8. Re-archive the WAR file. 9. 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 EMC Documentum 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. 30 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

31 Deploying a WDK-based Application To provide connection broker and global registry values of the content server, in the dfc.properties file of custom WDK Application WAR file: Configure the dfc.properties file of the application to connect the application to the content server and the 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. Navigate to the config subdirectory and open the dfc.properties file. 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 dfc.docbroker.port[0]=port_number 4. Unpack the custom WDK Application WAR file to the ROOT directory of the application server. 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 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 31

32 Deploying a WDK-based Application You can either copy the username and encrypted password from the dfc.properties file on the global registry Content Server host, or you can select another global registry user and encrypt the password using the following command from a command prompt (assumes the directory containing javaw.exe is on the system path): java -cp dfc.jar com.documentum.fc.tools.registrypasswordutils password_to_be_encrypted Enabling DFC memory optimization You can free up memory resources by adding the following line to your dfc.properties file to define and set DFC diagnostics: dfc.diagnostics.resources.enable=false If you want to identify the code that causes the session leaks problem, set the value of the dfc.diagnostics.resources.enable parameter in dfc.properties to true. For instructions about unpacking the war file of your application and modifying dfc.properties, see Enabling DFC connections to repositories, page 30. Configuring UCF The EMC Documentum 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. 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. Forcing UCF to install a configured JRE If your WDK-based application uses UCF content transfer, it is mandatory that the browser has a Oracle JRE installed. By default, the UCF installer uses the Oracle JRE that is installed in the browser if its version is the same as or later than the version of JRE in the UCF installer. A later version of JRE sometimes introduces problems in an application. If you do not want to allow multiple JRE versions, you can configure the UCF installer to use or install only the version that is configured in the installer configuration file. You must add an enforcejreinstallation attribute to the runtime java element in the file ucf.installer.config.xml to use the configured JRE version. This file is located in your web application directory, wdk/contentxfer. Change the runtime java element by adding the enforcejreinstallation attribute as follows: 32 EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide

33 Deploying a WDK-based Application platform os="windows" arch="x86"> <runtime type="java" version="1.5.0" href="win-jre1.5.0_06.zip" exepath="jre1.5.0_06\bin\java.exe" enforcejreinstallation="true"> If users have already installed UCF, you must force an update of the UCF configuration every time you make changes to the UCF configuration on the application server. Ensure that you append a new letter to the app version to force the update. In the following example, the version is changed: <app id="shared" version=" a" compatibilityversion="5.3.0"/> Enabling presets and preferences repositories By default, presets and persistent preferences are stored in the global repository. For better performance, you can configure your application to use different repositories for presets and persistent preferences. Add your preferences repository settings to app.xml in the /custom directory of the application. Copy the entire <preferencesrepository> element from /wdk/app.xml into /custom/app.xml and then specify your repository. The EMC Documentum Web Development Kit Development Guide contains detailed information on other preferences settings in app.xml. Table 1. 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. To give users the ability to create presets using the presets editor, assign those users the role dmc_wdk_presets_coordinator. Configuring encrypted password for presets and preferences repositories 1. Change the default passwords in Content Server. For both dmc_wdk_presets_owner and dmc_wdk_preferences_owner users, the default password must be changed using IAPI in Content Server. To do this, login to IAPI as an Administrator and execute the following commands. To change the password for the dmc_wdk_presets_owner user: EMC Documentum Web Development Kit and Webtop Version 6.8 Deployment Guide 33