Documentum TaskSpace EMC. Deployment Guide P/N A02. Version 6.5 SP 1

Transcription

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

2 Copyright 2009 EMC Corporation. All rights reserved. Published February 2009 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 TaskSpace Deployment Overview Chapter 2 Planning for Deployment Planning TaskSpace 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 Chapter 3 Preparing Requirements Specific to TaskSpace Documentum prerequisites for TaskSpace Installing the DAR Installer Installing the TaskSpace DAR with the DAR Installer DAR Installer fields Chapter 4 Preparing the Client Hosts Ensuring a certified JVM on browser clients Enabling HTTP content transfer in Internet Explorer Enabling UCF content transfer in Internet Explorer 7 on Windows Vista Enabling content transfer in Firefox Supporting Outlook mail message archives Using Citrix Presentation Server Client Turning off the pop-up blocker in Internet Explorer Chapter 5 Preparing the Application Server Host Setting the Java memory allocation Preparing environment variables for non-default DFC locations Preparing JBoss and Apache Tomcat Preparing IBM WebSphere Applying policies for WebSphere security Preparing Oracle Application Server Preparing Sun Java System Application Server Turning off tag pooling EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 3

4 Table of Contents Modifying the Sun policy file Turning off failover Preparing to use an external web server Chapter 6 Upgrading TaskSpace Chapter 7 Deploying TaskSpace Preparing the WAR file for deployment Enabling DFC connections to repositories Enabling DFC memory optimization Enabling presets and preferences repositories Deploying multiple applications Chapter 8 Completing the Deployment Configuring image viewers for TaskSpace Configuring the Brava! viewer for TaskSpace Configuring the Daeja viewer for TaskSpace Configuring the PAS viewer for TaskSpace Configuring the Adobe Reader viewer for TaskSpace Configuring the High Fidelity Forms viewer for TaskSpace Enabling TaskSpace for IRM Other considerations Enabling TaskSpace for Lightweight SysObjects Configuring UCF Configuring IBM WebSphere after deployment Changing the classloader and compiler settings Setting com.ibm.ws.webcontainer.invokefilterscompatibility to true Accessing the TaskSpace user interface Chapter 9 Configuring Single Sign-On for Security Servers 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 Presets not working Blank page error on deploying DA EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

5 Table of Contents Chapter 11 Troubleshooting TaskSpace Deployment Troubleshooting DAR deployment Troubleshooting application servers Troubleshooting TaskSpace deployment on WebLogic Troubleshooting TaskSpace deployment on WebSphere Resolving the java.lang.verifyerror Resolving the java.lang.nosuchmethoderror Resolving the JSPG0049E error Implementing configuration changes across multiple application servers Troubleshooting TaskSpace image viewer deployment Troubleshooting the Brava! image viewer Verifying that the Brava! Server is working Configuring the Brava! license server Specifying the version of the Brava! cab file Enabling client logs for Brava! viewer View other users annotations in Brava! Checking the Brava! viewer version Removing the Brava! viewer from a client computer Troubleshooting the Daeja image viewer Enabling client logs for the Daeja viewer Checking the Daeja viewer version Removing the Daeja viewer from a client computer Troubleshooting the Adobe Reader image viewer Configuring Adobe Reader byte serving on Firefox Troubleshooting when image does not display using Adobe Reader Specifying the deployment location for the image viewer Clearing the browser cache Allowing display of documents without using ACS/BOCS Changing the threshold for page serving Troubleshooting TaskSpace configuration Maintaining configurations while reinstalling the TaskSpaceDAR Troubleshooting a preset error Localizing labels of newly-created tabs Making custom object types available for role configuration Enabling hot keys in Firefox Appendix A Predeployment Checklist EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 5

6 Table of Contents List of Figures Figure 1. Basic WDK host configuration EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

7 Table of Contents List of Tables Table 1. Deployment scenarios Table 2. Image viewer scenarios Table 3. Selecting viewers Table 4. Page access terminology Table 5. DAR Installer fields Table 6. Preferences configuration elements Table 7. Authentication elements (<authentication>) Table 8. Predeployment tasks EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 7

8 Table of Contents 8 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

9 Preface This guide describes how to deploy EMC Documentum TaskSpace software. Intended audience The information in this guide is intended for administrators who need to deploy TaskSpace software. It assumes familiarity with basic Documentum functionality, such as repository configuration and maintenance. You should also be familiar with the Windows, UNIX, or Linux operating system and be able to install and configure a J2EE application server. Most of the chapters of this guide provide general information that applies to any WDK-based application. For information specific to TaskSpace, refer to Chapter 1, TaskSpace Deployment Overview and the Documentum TaskSpace Release Notes. For instructions on how to configure and use TaskSpace after deployment, refer to the following guides: Documentum TaskSpace Configuration Guide Documentum TaskSpace User Guide For instructions on how to deploy Document Image Services, refer to the Documentum Document Image Services Deployment Guide. Revision history The following changes have been made to this document. Revision History Revision Date December 2008 February 2009 Description Initial publication Updated the following sections: Installing the DAR Installer EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 9

10 Preface Revision Date Description Troubleshooting TaskSpace deployment on WebLogic 10 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

11 TaskSpace Deployment Overview Chapter 1 This chapter provides an overview of TaskSpace deployment. TaskSpace software, in combination with the rest of the Documentum Process Suite and the Documentum repository, delivers an end-to-end solution for managing high-volume Transactional Content Management (TCM) applications. Note: Repositories from releases older than 6.0 are not supported with the TaskSpace software. To deploy TaskSpace: 1. Before you begin deployment, consider whether you want to deploy TaskSpace alone or with Document Image Services. Other planning decisions are required, as for any WDK-based product. For information, refer to Chapter 2, Planning for Deployment. 2. Prepare the requirements that are specific to TaskSpace, such as the TaskSpace DAR. For instructions, refer to Chapter 3, Preparing Requirements Specific to TaskSpace. 3. Prepare the client hosts. For instructions, refer to Chapter 4, Preparing the Client Hosts. 4. On the computer that you intend to use as the application server host, perform the following steps: a. Ensure that your operating system is supported. Documentum TaskSpace Release Notes provides a list of supported operating systems. b. Install a supported application server. Documentum TaskSpace Release Notes provides a list of supported application servers. For more details, refer to Chapter 5, Preparing the Application Server Host. c. Log in to the operating system using a user account with administrative rights on the operating system, such as the Administrator user. d. To upgrade your repository from 6.0, some preparation is required. For instructions, refer to Chapter 6, Upgrading TaskSpace. e. Use the application server to deploy TaskSpace (TaskSpace.WAR) as described in Chapter 7, Deploying TaskSpace. 5. Complete the TaskSpace deployment. For instructions, refer to Chapter 8, Completing the Deployment. 6. (Optional) If you have deployed both TaskSpace and Document Image Services, configure one or more image viewers, such as Adobe Reader, PDF Annotation Services (PAS), High Fidelity Forms, Daeja ViewOne Pro, or IGC Brava!. For information, refer to Configuring image viewers for TaskSpace, page 47. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 11

12 TaskSpace Deployment Overview 7. Using the prepared user account, test the deployment. For instructions, refer to Accessing the TaskSpace user interface, page If any problems occur, refer to Chapter 10, Troubleshooting Deployment and Chapter 11, Troubleshooting TaskSpace Deployment. 12 EMC Documentum TaskSpace Version 6.5 SP1 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. Check your release notes for information on the application servers, browsers and other software in the environment that are certified for your product. This chapter discusses the following topics: Planning TaskSpace deployment, page 13 Required and optional supporting software, page 18 Typical configuration, page 18 Preparing the Content Server, page 19 Application server host requirements, page 20 Deploying multiple applications, page 20 Deploying language packs, page 21 Planning TaskSpace deployment Before you begin deployment, consider whether you want to deploy TaskSpace alone or with Document Image Services. Table 1. Deployment scenarios Deployment scenario TaskSpace Description The TaskSpace module simplifies tasks through a streamlined user interface with built-in image operations. TaskSpace is specifically designed for users who have to perform a large number of tasks, and who have to find documents and folders in very large repositories. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 13

14 Planning for Deployment Deployment scenario Document Image Services Both Description The Document Image Services module provides support for imaging-oriented operations and is designed to support a wide range of document image viewers. The Document Image Services module works with TaskSpace or with another application that uses the WDK Image viewer control. For instructions on deploying Document Image Services, refer to the Documentum Document Image Services Deployment Guide. For instructions on using the Document Image Services module with another application that uses the WDK Image Viewer Control, refer to the Documentum Document Image Services Developer Guide. If you deploy both Document Image Services and TaskSpace, TaskSpace features include annotation support for Daeja ViewOne Pro and IGC Brava!, and page serving and page modifications for PDF and TIFF files. (Page serving does not apply to secure PDF files.) Install the image viewers separately. Also consider image viewer setup. Table 2. Image viewer scenarios Image viewer scenario UCF Image viewers Description If you deploy TaskSpace without Document Image Services, Unified Client Facilities (UCF) technology is used to display documents. This means that TaskSpace opens each document by using an association of file types to programs. For example, if a TaskSpace user displays an image, the document might open in Microsoft Paint. When UCF opens a file, it uses the file-program association from the client operating system. For more information on UCF, refer to the Web Development Kit and Client Applications Development Guide. If you deploy both Document Image Services and TaskSpace and you want to include image viewers in your deployment, you can install client components for Daeja ViewOne Pro or IGC Brava!. Adobe Acrobat Reader, PAS, and OpenOffice viewer providers are included in the TaskSpace installation. The following tables compare the available image viewers: 14 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

15 Table 3. Selecting viewers 15 IGC Brava! Daeja ViewOne Pro Documentum PAS Adobe Reader High Fidelity Forms Runtime ActiveX control Java applet ActiveX control ActiveX control ActiveX control N/A Localization Currently French, German, and Japanese All TaskSpacesupported languages All TaskSpacesupported languages All TaskSpacesupported languages Annotations Supported Supported Supported Not currently supported Major File Formats (For complete lists, refer to vendor documentation.) Page Modifications (PDF, TIFF) Page Access Browsers JPEG, PDF, TIFF, AutoCAD (dwf, dwg, dxf) BMP, EMF, GIF, JPEG, PCX, PDF, PNG, TIFF, TXT, and other common formats PDF only PDF and irm-pdf for IRM Refer to www. openoffice.org Not currently supported The OpenOffice Writer format (ODT) only, such as instances of high fidelity form templates Yes Yes No No No No Page Serving (TIFF/PDF) Internet Explorer only Page Serving (TIFF/PDF) All TaskSpacesupported browsers None Internet Explorer only Byte streaming (PDF) All TaskSpacesupported browsers None Internet Explorer only Browser All browsersupported languages Not currently supported GIF, JPEG, PDF, PNG for Firefox, and Internet Explorer. Internet Explorer also supports MS Office formats, irm-pdf, irm-msw8, irm-excel8book, irm-ppt8 for IRM. None All TaskSpacesupported browsers Planning for Deployment

16 16 Deployment IGC Brava! Server side deployment Daeja ViewOne Pro Server side deployment Documentum PAS Client side deployment Adobe Reader Client side deployment High Fidelity Forms Server side deployment License Server Yes No No No No No Website com Browser Browser vendor N/A Planning for Deployment

17 Planning for Deployment Note: Page serving and page modifications do not apply to secure PDF files. Note: IGC Brava! for TaskSpace (which is required if you use Brava! with DIS) and IGC Brava! for Webtop are not the same product. Each web application in which you want to use Brava! (TaskSpace or Webtop) requires a separate Brava! license file, which is governed by a standalone Brava! License server. The Brava, and Daeja viewers provide similar page access functionality, in which the viewer may be able to display the first page of a document before the entire document has been downloaded from the server. The following table defines page access terminology and indicates which viewers currently support each type of page access: Table 4. Page access terminology Page access term Definition Supporting viewers Byte streaming Page-level retrieval Page serving Page modifications Functionality of ACS and BOCS to stream back a range of bytes requested by Adobe Reader instead of returning an entire PDF file. Adobe Reader determines how many bytes it needs to retrieve before it can display the current content. Usually, if the PDF file is linearized for web display, Adobe Reader requests enough bytes of data to display the first page of the document. Depending on the PDF file content structure, display of subsequent pages might require retrieval of the entire PDF file. The viewer s ability to request ACS or BOCS to return one page of a multi-page file at a time instead of returning the entire file. Functionality built into ACS and BOCS using page aware plug-ins. When a file format has been registered with a page-aware plug-in, ACS and BOCS can split a multi-page file into individual pages and serve them back to the viewer if the viewer requests it. Page serving is supported only for PDF and TIFF files because only PDF and TIFF plug-ins are registered during deployment of Document Image Services. Note: Page serving does not apply to secure PDF files. Functionality built into both DIS and TaskSpace for document merging and page modifications such as deleting, inserting, splitting, and reordering pages in a multiple page document. Adobe Reader Brava and Daeja Brava and Daeja Brava and Daeja EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 17

18 Planning for Deployment 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 Enabling DFC connections to repositories, page 44 for information on how to configure 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 Global registry repository Client hosts that run a supported web browser Figure 1, page 19 shows the network components. 18 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

19 Planning for Deployment 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. 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 44. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 19

20 Planning for Deployment 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. 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. 20 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

21 Planning for Deployment 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. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 21

22 Planning for Deployment 22 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

23 Chapter 3 Preparing Requirements Specific to TaskSpace This chapter describes the steps required to prepare your environment for TaskSpace. To prepare your environment for a TaskSpace deployment: 1. Install Documentum prerequisites for TaskSpace. For instructions, refer to Documentum prerequisites for TaskSpace, page Create a user in Documentum Administrator and assign it the EMC Documentum administrator or superuser privilege level. This is required for Documentum archive (DAR) installations. For instructions on how to create a user with administrator or superuser privileges, refer to the Documentum Administrator User Guide. 3. Install the Documentum Composer DAR Installer Plug-in zip file. For instructions, refer to Installing the DAR Installer, page Install the TaskSpace DAR using the DAR Installer. For instructions, refer to Installing the TaskSpace DAR with the DAR Installer, page (Optional) Install the Document Image Services DAR. For instructions, refer to the Documentum Document Image Services Deployment Guide. Documentum prerequisites for TaskSpace This section briefly describes how to prepare the Documentum environment required by TaskSpace. Note: For each installation, log in to the operating system using a user account with administrative rights on the operating system, such as the Administrator user. To prepare the Documentum environment for TaskSpace: 1. Install Content Server and create one or more repositories for TaskSpace users. For instructions, refer to the Documentum Content Server Installation Guide. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 23

24 Preparing Requirements Specific to TaskSpace 2. Install the following products in any order: Documentum Administrator. For instructions on installing the application, refer to the Documentum Administrator Deployment Guide. Composer. For instructions on installing the application, refer to the Documentum Composer User Guide. Process Engine. Install the Process Engine on the Content Server. By default, this also installs the Forms DAR (the DAR for Forms Builder) and the Process Builder DAR. Both DARs are required. For instructions on installing the application, refer to the Documentum Process Engine Installation Guide. Process Builder application. For instructions on installing the application, refer to the Documentum Process Builder Installation Guide. Forms Builder application. For instructions on installing the application, refer to the Documentum Forms Builder Installation Guide. Documentum PDF Annotation Services (PAS). Install PAS if you want to enable the PAS viewer in TaskSpace. For instructions, refer to the Documentum PDF Annotation Services Deployment Guide. When the Documentum environment has been prepared for TaskSpace, do the following next: 1. Install the DAR Installer program. For instructions, refer to Installing the DAR Installer, page Install the TaskSpace DAR. For instructions, refer to Installing the TaskSpace DAR with the DAR Installer, page 25. If you want to enable the dashboard feature in TaskSpace, install Business Activity Monitor (BAM) after installing the TaskSpace DAR. For instructions on installing the application, refer to the Documentum Process Analyzer and Business Activity Monitor Installation Guide. Installing the DAR Installer Use the DAR Installer to install the TaskSpace DAR file to a repository. The DAR Installer requires Composer to be installed, but does not launch the full Composer IDE. The DAR Installer is useful to install Documentum product DAR files or in cases where you want to de-couple the development of DAR files from the installation of DAR files. When you open the DAR Installer program, it creates three folders in your Composer installation directory: darinstallerconfig - contains configuration files for the DAR Installer program. darinstallerlogs - the default location of the log files. darinstallerworkspaces - workspaces that the DAR Installer program creates and uses. The DAR Installer program does not delete these workspaces automatically, so you occasionally need to clean up this directory. The workspace directories are named in the following form: darinstaller_workspace_yyyy-mm-dd-hh-mm-ss. Moving, deleting, or adding projects manually to the workspace might have adverse effects on DAR installations. Documentum packages the DAR Installer with Composer and headless Composer. Download Composer or headless Composer, then install the TaskSpace DAR file with the DAR Installer. The Documentum Composer User Guide provides more information about Composer and headless Composer. 24 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

25 Preparing Requirements Specific to TaskSpace Installing the TaskSpace DAR with the DAR Installer After you install the DAR Installer, you can install the TaskSpace DAR. TaskSpace requires certain files and objects in any EMC Documentum repository to which it connects. You install these files and objects using a Documentum DAR, which is an archived collection of Documentum Content Server objects. The files and objects required by Documentum TaskSpace are located in the TaskSpace DAR. Using the DAR Installer, install the DAR in the global repository and once in each EMC Documentum repository in which any user will run TaskSpace. The following restrictions apply when installing DAR files: You must be a superuser or EMC Documentum administrator to install a DAR file. You cannot install DAR files with a version of Composer that is older than the DAR file version. For example, a DAR file that was created with Composer 6.5 SP1 cannot be installed using Composer 6.5. If the DAR file that you are installing depends on other, required DAR files, you must install those required DAR files first. If those required DAR files are already installed, you only need to have them in the same directory as the DAR file that you are installing. To install the TaskSpace DAR: 1. Download the Documentum TaskSpace DAR Installer zip file. Go to subscribenet.com/control/dctm/search, search under TaskSpace to locate and download TaskSpaceDARInstaller.zip. 2. Unzip the TaskSpaceDARInstaller.zip file for each EMC Documentum repository in which you plan to use TaskSpace. It contains the following files: readme.txt TaskSpace.dar 3. Run darinstaller.exe (located in the Composer root directory) to start the DAR Installer Plug-in and enter information in the DAR Installer fields: a. In the DAR Details section, specify values for the fields. b. In the Connection Broker Details section, specify values for Connection Broker Host and Connection Broker Port and click Connect. c. In the Repository Details section, specify values for the fields and click Install to install the DAR file to the repository. DAR Installer fields, page 26 provides a description of the fields. After you install the TaskSpace DAR, a script automatically runs. This script adds the current user (the user who installed the DAR) as a member of the ts_designer, form_designer, queue_admin, and queue_advance_processor roles. This user account is required for your initial TaskSpace login. After your initial TaskSpace login, you can create additional users, groups, and roles in the TaskSpace Administration tab to meet your needs. To view the log for the TaskSpace DAR installation, select the log file from the Log File drop-down list box and click Open. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 25

26 Preparing Requirements Specific to TaskSpace DAR Installer fields The following table describes the DAR Installer fields: Table 5. DAR Installer fields Parameter Required Description DAR Yes The absolute file path to the.dar file that you want to install. The file path cannot contain any I18N characters or the installation will fail. Input File No The absolute file path to the install-based parameter file Local Folder No The absolute file path to localized.properties files. If you want to make your application available in other languages, you need to localize the project data such as labels, tabs, and descriptions. Log File No The file to save the log to. If this is not specified, the file defaults to <DAR>.log Connection Broker Host Yes The address of the Connection Broker Connection Broker Port Yes The port of the Connection Broker Repository Repository Yes The name of the repository that you want to install the DAR file to. Click on the Connect button after entering the Docbroker host and port to retrieve the available repositories. User Name Yes The login name for the repository 26 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

27 Preparing Requirements Specific to TaskSpace Parameter Required Description Password Yes The password for logging into the repository Domain No The domain where the repository resides EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 27

28 Preparing Requirements Specific to TaskSpace 28 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

29 Chapter 4 Preparing the Client Hosts This chapter contains instructions that are shared by all WDK-based products. Check your release notes 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 29 Enabling HTTP content transfer in Internet Explorer 7, page 30 Enabling UCF content transfer in Internet Explorer 7 on Windows Vista, page 30 Enabling content transfer in Firefox, page 31 Supporting Outlook mail message archives, page 31 Using Citrix Presentation Server Client, page 32 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 TaskSpace Version 6.5 SP1 Deployment Guide 29

30 Preparing the Client Hosts 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. To add the application server host to the list: 1. In IE7, navigate 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. 30 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

31 Preparing the Client Hosts 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 Firefox 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. 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. Supporting Outlook mail message archives WDK supports viewing and exporting dm_message_archive objects. If your WDK-based product displays Outlook mail messages, read these instructions. dm_message_archive objects can be viewed as HTML or as.msg files in Outlook. To view or export dm_message_archive objects as.msg files, the client must have an converter installed. This converter can be automatically installed as part of the UCF download. However, the converter can take a long time to download and install. You can avoid this delay by deploying the ExMRE.exe installer using standard mechanisms, such as Microsoft Systems Management Server (SMS). To enable automatic download of the converter: 1. Uncomment the ExMRE.exe section in the app\wdk\contentxfer\ucf.installer.config.xml file on the application server. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 31

32 Preparing the Client Hosts 2. Specify <messagearchive-support> in wdk/app.xml. In addition, on 6.5 repositories, you must install the 6.5 collaborative services-related DARs. (On 5.3 and 6.0 repositories, you must install DCO, Collaborative Services, and Messaging Application DocApps.) You can run an message migration utility that converts the.msg objects to a.emcmf objects. The emcmf object type adds -specific attributes and attachment handling. This utility is available on the Powerlink site. 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 SP3 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. 32 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

33 Chapter 5 Preparing the Application Server Host This chapter contains instructions that are shared by all WDK-based products. Check your release notes for information on the application servers that are certified for your product. This chapter describes the tasks you must complete to prepare the application server host before deploying your 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. 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. For uninstall procedures, refer to the 5.x product documentation. This chapter contains the following sections. Your selected application server and optional external web server must be certified for your product. Setting the Java memory allocation, page 34 Required information for all application servers Preparing environment variables for non-default DFC locations, page 34 Information for enterprise environments that do not use the default (recommended) DFC environment locations. Preparing JBoss and Apache Tomcat, page 35 Preparing IBM WebSphere, page 35 Preparing Oracle Application Server, page 38 Preparing Sun Java System Application Server, page 38 Preparing to use an external web server, page 40 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. EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 33

34 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. 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. 34 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

35 Preparing the Application Server Host 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> Preparing IBM WebSphere IBM WebSphere is a supported application server for TaskSpace. The following topics describe how to prepare IBM WebSphere for use with TaskSpace. 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 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 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 35

36 Preparing the Application Server Host Specifies the temporary content transfer directory on the application server. Must match the value in app.xml of the element <contentxfer>.<server>.<contentlocationwindows> or <contentlocationunix>. The policy files in PolicyFiles.zip contain the minimum required policies for the dfc.data.dir directory. To add additional policies for non-default content transfer locations, add the following lines to library.policy. For each policy that you add, set up an environment variable that specifies the non-default location. Tip: Select only the policies that are needed for your application. Policy for local user directory (non-default location) This policy is required if the user directory for the application server host machine is a non-default location. The default location is the same as the location specified by the dfc.properties key dfc.data.dir. permission java.io.filepermission "${dfc.user}${/}-", "read, write, delete"; permission java.io.filepermission "${dfc.user}", "read, write, delete"; Policy for checkout and export directories (non-default location) These environment variables must specify the same location as the value of the dfc.properties keys dfc.checkout.dir and dfc.export.dir. The default locations for these directories are checkout and export subdirectories of dfc.data.dir. permission java.io.filepermission "${dfc.checkout}${/}-", "read, write, delete"; permission java.io.filepermission "${dfc.checkout}", "read, write, delete"; permission java.io.filepermission "${dfc.export}${/}-", "read, write, delete"; permission java.io.filepermission "${dfc.export}", "read, write, delete"; Policy for DFC registry file (non-default location) The value of the dfc.registry environment variable must match the location specified in dfc.properties for the key dfc.registry.file. permission java.io.filepermission "${dfc.registry}${/}-", "read, write, delete"; permission java.io.filepermission "${dfc.registry}", "read, write, delete"; Policy for Webtop temporary content transfer directory (non-default location) permission java.io.filepermission "${webtop.content.xfer}${/}-", "read, write, delete"; permission java.io.filepermission "${webtop.content.xfer}", "read, write, delete"; 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"; 36 EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide

37 Preparing the Application Server Host 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"; EMC Documentum TaskSpace Version 6.5 SP1 Deployment Guide 37