EMC Documentum Document Image Services

Transcription

1 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide P/N A03 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published March 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... 5 Chapter 1 Deploying Document Image Services... 7 Planning deployment... 8 Documentum prerequisites Installing the DAR Installer Installing the Document Image Services DAR with the DAR Installer 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 Placing the plug in JAR file Chapter 2 Troubleshooting Document Image Services deployment Troubleshooting Document Image Services DAR deployment 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 privileged DFC problems Troubleshooting annotations EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 3

4 Table of Contents List of Tables Table 1. Deployment scenarios... 8 Table 2. Image viewer scenarios... 8 Table 3. Selecting viewers Table 4. Page access terminology Table 5. DAR Installer fields Table 6. Troubleshooting problems in TaskSpace EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

5 Preface This guide describes how to deploy EMC Documentum Document Image Services software. Intended Audience The information in this guide is intended for administrators who need to deploy Document Image Services 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. For instructions to configure and use Document Image Services with TaskSpace after deployment, refer to the following guides: Documentum TaskSpace Configuration Guide Documentum TaskSpace User Guide For instructions on how to deploy TaskSpace, refer to the Documentum TaskSpace Deployment Guide. Revision History The following changes have been made to this document. Revision History Revision Date December 2008 February 2009 March 2009 Description Initial publication Updated the Installing the DAR Installer section. Removed references to ImageServicesDARInstaller.zip. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 5

6 Preface 6 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

7 Chapter 1 Deploying Document Image Services This chapter describes how to deploy Document Image Services. Document Image Services provides imaging related features such as annotations, page serving and page modifications. It also provides a framework for a wide range of third party viewers. You can deploy the Document Image Services module with TaskSpace or with another application that uses the WDK Image viewer control. Note: Repositories from releases older than 6.0 are not supported with the Document Image Services software. The following describes the steps required to deploy Document Image Services: To deploy Document Image Services: 1. Before you begin deployment, consider whether you want to deploy Document Image Services with or without TaskSpace. Planning deployment, page 8 provides information about deployment scenarios, image viewer scenarios, and image viewer comparisons. 2. Install Documentum prerequisites and prepare the Documentum environment. Documentum prerequisites, page 12 provides information on how to prepare the Documentum environment. 3. In Documentum Administrator, create a user and give it the EMC Documentum administrator or superuser privilege level. This is required for DAR installations. For instructions, refer to the Documentum Administrator User Guide. 4. Install the required DARs to the repository or repositories that will be used with Document Image Services: a. Install the Documentum Composer DAR Installer Plug in zip file. For instructions, refer to Installing the DAR Installer, page 13. b. Install the Document Image Services DAR using the DAR Installer. For instructions, refer to Installing the Document Image Services DAR with the DAR Installer, page 14. c. (Optional) Install the TaskSpace DAR. For instructions, refer to the Documentum TaskSpace Deployment Guide. 5. Install JRE 1.5 or later on each application server. 6. (Optional) If you have deployed both Document Image Services and TaskSpace, configure one or more image viewers, such as Adobe Acrobat Reader, PAS, OpenOffice, Daeja ViewOne Pro, or IGC Brava!. Configuring image viewers for TaskSpace, page 15 provides instructions to configure image viewers. 7. If you are using BOCS, place a plug in JAR file on each BOCS server. Placing the plug in JAR file, page 18 provides instructions. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 7

8 Deploying Document Image Services 8. Test the deployment as appropriate for the application with which Document Image Services has been deployed. For example, if you have deployed Document Image Services with TaskSpace, access the application as you would for testing TaskSpace deployment alone. For instructions, refer to the Documentum TaskSpace Deployment Guide. Next, test the image viewer functionality by displaying a document in the document view template configured in Step If any problems occur, refer to Chapter 2, Troubleshooting Document Image Services deployment. Planning deployment Before you begin deployment, consider whether you want to deploy Document Image Services with or without TaskSpace. Table 1. Deployment scenarios Deployment scenario TaskSpace Document Image Services Both Description The TaskSpace module simplifies tasks through a streamlined user interface with built in image operations. TaskSpace is specifically designed for users who perform a large number of tasks, and who have to find documents and folders in very large repositories. For instructions on deploying TaskSpace, refer to the Documentum TaskSpace Deployment Guide. 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. 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 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 8 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

9 Deploying Document Image Services Image viewer scenario Image viewers Description 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: EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 9

10 10 IGC Brava! Daeja ViewOne Pro Table 3. Selecting viewers 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 Deploying Document Image Services

11 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 Deploying Document Image Services 11

12 Deploying Document Image Services 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 Documentum prerequisites This section briefly describes how to prepare the Documentum environment required by Document Image Services. 12 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

13 Deploying Document Image Services 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: 1. Install Content Server and create one or more repositories for Document Image Services users. For instructions, refer to the Content Server Installation Guide. 2. Install the following products in any order: Documentum Administrator. For instructions, refer to the Documentum Administrator Deployment Guide. Documentum Composer. For instructions, refer to the Documentum Composer Installation Guide. Documentum PDF Annotation Services (PAS), if you want to enable the PAS viewer in TaskSpace. For instructions, refer to the Documentum PDF Annotation Services Deployment Guide. 3. Check your release notes for additional information on the application servers, browsers, and other software in the environment that are certified for your product. Installing the DAR Installer Use the DAR Installer to install the Document Image Services DAR to a repository. The DAR Installer requires Composer to be installed but it does not launch the full Composer integrated development environment (IDE). The DAR Installer is useful for installing 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 format: darinstaller_workspace_yyy mm dd hh mm ss. Moving, deleting, or adding projects manually to the wokspace 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 Document Image Services DAR file with the DAR Installer. The Documentum Composer User Guide provides more information about Composer and headless Composer. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 13

14 Deploying Document Image Services Installing the Document Image Services DAR with the DAR Installer After you install the DAR Installer, you can install the Document Image Services DAR. Document Image Services 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 Document Image Services are located in the Document Image Services DAR. Use the DAR Installer to install the Document Image Services DAR in the global repository and once in each EMC Documentum repository in which any user will run Document Image Services. 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 the 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 Document Image Services DAR: 1. Download the Documentum Document Image Services DAR file for each EMC Documentum repository in which you plan to use Document Image Services. Go to search under Document Image Services to locate and download ImageServices.dar. 2. Run darinstaller.exe (located in the Composer root directory) to start the DAR Intaller 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. Table 5, page 14 provides a description of the fields. To view the log for the Document Image Services DAR installation, select the log files from the Log File drop down list box and click Open. 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. 14 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

15 Deploying Document Image Services Parameter Required Description Input File No The absolute file path to the install based parameter file. Local Folder No The absolute file path to localized.properties files. 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 the Connect button after typing the Docbroker host and port to retrieve the available repositories. User Name Yes The login name for the repository. Password Yes The password for logging into the repository. Domain No The domain where the repository resides. Configuring image viewers for TaskSpace If you deploy both Document Image Services and TaskSpace, you can use one or more image viewers. Configuring the Brava! viewer for TaskSpace, page 16 Configuring the Daeja viewer for TaskSpace, page 16 Configuring the PAS viewer for TaskSpace, page 17 Configuring the Adobe Reader viewer for TaskSpace, page 17 Configuring the High Fidelity Forms viewer for TaskSpace, page 18 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 15

16 Deploying Document Image Services Configuring the Brava! viewer for TaskSpace This section provides image viewer configuration information that is specific to Document Image Services and TaskSpace deployment. For general information on configuring Brava!, refer to the IGC Brava! documentation. Note: The Brava! client component may be deployed on any operating system, but the Brava! license server must be deployed on Windows. Note: The Brava! viewer supports only one language on each client. To switch to another language after deployment, you must uninstall the Brava! viewer and reinstall it with the language that you want. To configure the Brava! viewer: 1. In Forms Builder, open or create a document view template. Configure the available Brava! viewer settings and save/install the template. For instructions, refer to the Documentum Forms Builder User Guide. 2. When IGC provides files, on each application server, navigate to taskspace\wdk\imageviewer, create a brava (case sensitive) directory, and deploy the files in the directory you created. If you want to deploy the files in a different location, specify the new deployment location in taskspace/wdk/config/imaging/ivf_config.xml. 3. On each application server, make sure that the configuration file (taskspace/wdk/config/imaging/ ivf_config.xml) correctly specifies your Brava! license server location URL. For example: <param> <name>bravaserverproperties</name> <value> </param> 4. In TaskSpace, map a file format to the Brava! viewer, add the document view template as a component, and map the component to a document object type for a role. For instructions, refer to the Documentum TaskSpace Configuration Guide. Configuring the Daeja viewer for TaskSpace This section provides image viewer configuration information that is specific to Document Image Services and TaskSpace deployment. For general information on configuring Daeja, refer to the Daeja ViewOne Pro documentation. To configure the Daeja viewer: 1. In Forms Builder, open or create a document view template. Configure the available Daeja viewer settings and save/install the template. For instructions, refer to the Documentum Forms Builder User Guide. 2. When Daeja provides files, on each application server, navigate to taskspace\wdk\imageviewer, create a daeja (case sensitive) directory, and deploy the files in the directory you created. If you want to deploy the files in a different location, specify the new deployment location in taskspace/wdk/config/imaging/ivf_config.xml. 16 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

17 Deploying Document Image Services 3. In TaskSpace, map a file format to the Daeja viewer, add the document view template as a component, and map the component to a document object type for a role. For instructions, refer to the Documentum TaskSpace Configuration Guide. Configuring the PAS viewer for TaskSpace Documentum PDF Annotation Services (PAS) enables users of Documentum TaskSpace to use Adobe Reader to create annotations (such as comments) on PDF documents or documents with PDF rendition and store those annotations in a Documentum repository. Adobe LiveCycle Reader Extensions (ARES) 7 is a prerequisite. This section provides image viewer configuration information that is specific to Document Image Services and TaskSpace deployment. For general information on configuring PAS, refer to the Documentum PDF Annotation Services Deployment Guide. To configure the PAS viewer: 1. Install and configure ARES and PAS. Configuration includes the following steps: a. On the computer where PAS is installed, in the review.properties file, specify the location of the ARES server. b. Specify the location of the PAS application server. You can do this either for the entire repository or just for TaskSpace. For detailed instructions, refer to the Documentum PDF Annotation Services Deployment Guide. 2. In Forms Builder, open or create a document view template. Configure the available PAS viewer settings and save/install the template. For instructions, refer to the Documentum Forms Builder User Guide. 3. In TaskSpace, map the PDF file format to the PAS viewer, add the document view template as a component, and map the component to a document object type for a role. For instructions, refer to the Documentum TaskSpace Configuration Guide. Note: Users who want to display multiple PDF documents or renditions at the same time can do so with Adobe Reader 7. Configuring the Adobe Reader viewer for TaskSpace This section provides image viewer configuration information that is specific to Document Image Services and TaskSpace deployment. The Adobe Reader viewer supports the PDF file type. For general information on configuring Adobe Reader, refer to the Adobe documentation. To configure the Adobe Reader viewer: 1. In Forms Builder, open or create a document view template. Configure the available Adobe Reader viewer settings and save/install the template. For instructions, refer to the Documentum Forms Builder User Guide. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 17

18 Deploying Document Image Services 2. In TaskSpace, map the PDF file format to the Adobe Reader viewer, add the document view template as a component, and map the component to a document object type for a role. For instructions, refer to the Documentum TaskSpace Configuration Guide. Configuring the High Fidelity Forms viewer for TaskSpace This section describes how to configure the High Fidelity Forms viewer for Document Image Services and TaskSpace deployment. The High Fidelity Forms viewer allows the use of high fidelity form templates in TaskSpace. To configure the High Fidelity Forms viewer: 1. In Forms Builder, open or create a document view template. Configure the available High Fidelity Forms viewer settings and save/install the template. For instructions, refer to the Documentum Forms Builder User Guide. 2. In TaskSpace, map the ODT file format to the High Fidelity Forms viewer, add the document view template as a component, and map the component to a document object type for a role. For instructions, refer to the Documentum TaskSpace Configuration Guide. Placing the plug in JAR file If you are using BOCS, a plug in JAR file is required on each BOCS server. After you install the Document Image Services DAR, you can place the plug in JAR file. To place the plug in JAR file: 1. Download the DocumentImageServices_BOCS_6.5.zip file from the following location: Note: The Powerlink website provides access to subscribenet.com/control/dctm/ index where a complete listing of products is available for download. 2. Unzip the downloaded DocumentImageServices_BOCS_6.5.zip file. 3. Locate the JAR file, image services bocs plugin.jar. 4. Copy the JAR file to the APP INF\lib directory of the BOCS EAR on your application server. 5. Stop the application server and restart it. 18 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

19 Troubleshooting Document Image Services deployment Chapter 2 This chapter contains information on troubleshooting Document Image Services deployment. Troubleshooting Document Image Services DAR deployment, page 19 Troubleshooting TaskSpace image viewer deployment, page 20 Troubleshooting privileged DFC problems, page 28 Troubleshooting annotations, page 29 Troubleshooting Document Image Services DAR deployment If problems occur when you test Document Image Services deployment, ensure that the Document Image Services DAR has installed the following items correctly, by checking for them in Webtop. Look for: In System/Modules/ImagingServiceAnnotationPluginModules, look for the annotationconfig.xml file. In System/Modules/SBO, look for the following folders: com.documentum.pageaware.pdf.ipdfpagehandlerservice com.documentum.pageaware.tiff.itiffpagehandlerservice com.documentum.services.imaging.annotationservice.iannotationservice com.documentum.services.imaging.pageaccess.ipageaccess In System/Modules/ImageServicesModule, look for PageModificationModule. If any of these items are missing, try installing the Document Image Services DAR again. For instructions, refer to Installing the Document Image Services DAR with the DAR Installer, page 14. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 19

20 Troubleshooting Document Image Services deployment Troubleshooting TaskSpace image viewer deployment If you have deployed both TaskSpace and Document Image Services, you can configure one or more image viewers, such as Adobe Reader, Daeja ViewOne Pro, or IGC Brava!. This section contains information on troubleshooting these image viewers. Troubleshooting the Brava! image viewer, page 20 Troubleshooting the Daeja image viewer, page 24 Troubleshooting the Adobe Reader image viewer, page 25 Specifying the deployment location for the image viewer, page 26 Clearing the browser cache, page 27 Allowing display of documents without using ACS/BOCS, page 27 Changing the threshold for page serving, page 27 For information on troubleshooting PDF Annotation Services (PAS), refer to the Documentum PDF Annotation Services Deployment Guide. Troubleshooting the Brava! image viewer This section contains information on troubleshooting the IGC Brava! image viewer. Verifying that the Brava! Server is working, page 20 Configuring the Brava! license server, page 21 Specifying the version of the Brava! cab file, page 21 Enabling client logs for Brava! viewer, page 22 View other users annotations in Brava!, page 22 Checking the Brava! viewer version, page 23 Removing the Brava! viewer from a client computer, page 23 Specifying the deployment location for the image viewer, page 26 Verifying that the Brava! Server is working The Brava! viewer requires a running Brava license server. The Brava server must be accessible to all Brava viewer clients on the network. To verify that the Brava! Server is working: 1. Launch Internet Explorer and login to your TaskSpace application. 20 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

21 Troubleshooting Document Image Services deployment 2. Determine what file format has been mapped to the Brava! image viewer for the current TaskSpace application. (On the Configuration tab, select the root node and scroll down to Viewers and Formats.) 3. In a search tab or folder tab, locate a document of that format. Click Edit or Open. 4. Right click a blank area on the browser and select View Source. The source HTML for the document view container appears in a text editor. 5. Search for the ServerProperties parameter and copy the content of the value attribute. 6. Launch a new Internet Explorer window, paste the value into the address bar. Change the ʺlocalhostʺ part of the URL to the computer name if the license server is different from the client computer. Press Enter. If there is no error message, then the Brava! Server is working. If there is an error message, refer to the Brava! documentation. Configuring the Brava! license server Brava! Server provides a mechanism for Brava! viewers on the network to acquire licenses. Make sure that the TaskSpace image viewer configuration file correctly specifies your Brava! license server location URL. To configure the Brava! license server: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for bravaserverproperties. Locate the default value: 3. Change localhost:8080 to indicate the name or IP address of a valid Brava! license server, accessible to all client computers. For example: <param> <name>bravaserverproperties</name> <value> </param> 4. Save the file. 5. Restart the application server. Specifying the version of the Brava! cab file Make sure that the TaskSpace image viewer configuration file correctly specifies the version of Brava! cab file. To specify the version of the Brava! cab file: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for BravaClientXWrapper. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 21

22 Troubleshooting Document Image Services deployment 3. Make sure that the specified version number matches that of your cab file. For example: <param> <name>codebase</name> <value>/wdk/imageviewer/brava/bravaclientxwrapper.cab#version= 6,0,8,0</value> <description>activex codebase</description> </param> 4. Save the file. 5. Restart the application server. Enabling client logs for Brava! viewer Client logs are helpful for diagnostic purposes when something unexpected happens. To enable client logs for Brava! viewer: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for bravaclientlogginglevel. 3. Change the value to 1 for fatal errors, 5 for no log, or any number in between. 4. Save the file. 5. Restart the application server. The log file is located on each client computer at C:\Documents and Settings\user ID\IGC\ClientLog.txt, where user ID is a Windows user name. For instructions on interpreting the log file, refer to the Brava documentation. View other users annotations in Brava! By default, the Brava! viewer displays only the annotations owned by the current user. You can configure the viewer to load all annotations when the image is loaded, whether or not the annotation is owned by the current user. To view other users annotations in Brava!: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for <ViewerProvider name=ʺbravaʺ>. 3. Add the following <param> and <param mapping> parameters: <param> <name>bravapreloadreadonlymarkupnames</name> <value>true</value> <description></description> </param> <param mapping> <name>preloadreadonlymarkupnames</name> 22 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

23 Troubleshooting Document Image Services deployment <value>bravapreloadreadonlymarkupnames</value> <description></description> </param mapping> 4. Save the file. 5. Restart the application server. Checking the Brava! viewer version If your client computers already have a version of the Brava! viewer, check whether it is a version that is supported with TaskSpace. For the versions of viewers that are supported with TaskSpace, refer to the Documentum TaskSpace Release Notes. To check the Brava! viewer version: 1. From a client workstation, launch Internet Explorer. 2. From the Tools menu, select Internet Options. 3. On the General tab, click Settings. The Settings dialog box appears. 4. Click View Objects. 5. Right click the BravaXClientIAdapterCtrl class and select Properties. The BravaXClientIAdapterCtrl Class Properties dialog box appears. 6. Click the Version tab. If your client computers have a version of the Brava! viewer that is not supported with TaskSpace, refer to Removing the Brava! viewer from a client computer, page 23. Removing the Brava! viewer from a client computer If your client computers have a version of the Brava! viewer that is not supported with TaskSpace, it is a good practice to remove it before installing the supported version, on each client computer. To remove the Brava! viewer from a client computer: 1. From a client workstation, launch Internet Explorer. 2. From the Tools menu, select Internet Options. 3. On the General tab, click Settings. The Settings dialog box appears. 4. Click View Objects. 5. Right click the BravaXClientIAdapterCtrl class and select Remove. 6. In Windows Explorer, locate the C:\Documents and Settings\user ID\IGC directory, where user ID is a Windows user name. Delete all files in this directory. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 23

24 Troubleshooting Document Image Services deployment Troubleshooting the Daeja image viewer This section contains information on troubleshooting the Daeja ViewOne Pro image viewer. Enabling client logs for the Daeja viewer, page 24 Checking the Daeja viewer version, page 24 Removing the Daeja viewer from a client computer, page 25 Specifying the deployment location for the image viewer, page 26 Enabling client logs for the Daeja viewer Client logs are helpful for diagnostic purposes when something unexpected happens. To enable client logs for the Daeja viewer: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for ImgEnableAnnotationTrace, daejatrace, ImgEnableTraceNet, daejatracenet and ImgEnableTraceJavaScript, and change the value to true. 3. Save the file. 4. Restart the application server. To view Daeja viewer client logs: 1. Login to your TaskSpace application. For instructions, refer to. 2. Determine what file format has been mapped to the Daeja image viewer for the current TaskSpace application. (On the Configuration tab, select the root node and scroll down to Viewers and Formats.) 3. In a search tab or folder tab, locate a document of that format. Click Edit or Open. 4. Bring up Sun Java Console from your browser. All Daeja client logs are output to the Java console. Checking the Daeja viewer version If your client computers already have a version of the Daeja viewer, check whether it is a version that is supported with TaskSpace. For the versions of viewers that are supported with TaskSpace, refer to the Documentum TaskSpace Release Notes. To check the Daeja viewer version: 1. Login to your TaskSpace application. For instructions, refer to. 2. Determine what file format has been mapped to the Daeja image viewer for the current TaskSpace application. (On the Configuration tab, select the root node and scroll down to Viewers and Formats.) 24 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

25 Troubleshooting Document Image Services deployment 3. In a search tab or folder tab, locate a document of that format. Click Edit or Open. 4. Click once anywhere inside the Daeja viewer to activate the viewer and then click the ViewOnePro logo at the lower right corner. Version information appears. Removing the Daeja viewer from a client computer If your client computers have a version of the Daeja viewer that is not supported with TaskSpace, it is a good practice to remove it before installing the supported version, on each client computer. To remove the Daeja viewer from a client computer: 1. In Windows Explorer, locate the C:\temp\viewone directory. 2. Delete all files in this directory. Troubleshooting the Adobe Reader image viewer This section contains information on troubleshooting the Adobe Reader image viewer. Troubleshooting when image does not display using Adobe Reader, page 26 Configuring Adobe Reader byte serving on Firefox, page 25 Configuring Adobe Reader byte serving on Firefox Some adjustments may be needed to allow byte serving to work for Adobe Reader browser control running on Firefox. To configure Adobe Reader byte serving on Firefox: 1. Make sure Adobe Reader is selected for the plugin to use at Firefox. a. From a client workstation, launch Firefox. b. From the Tools menu, select Options. c. Select Content. Click Manage. The Download Actions dialog box appears. d. Select PDF and click Change Action. The Change Action dialog box appears. e. Make sure that Use this Plugin is selected and Adobe Reader is specified. f. Click OK. 2. Make sure PDF Download plugin is removed from Firefox. 3. Make sure Brava!Reader plugin is removed from Firefox. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 25

26 Troubleshooting Document Image Services deployment Troubleshooting when image does not display using Adobe Reader At this release of Viewer Framework, Adobe Reader browser control and Brava! viewer do not support URL fallback. If a document image does not display at Adobe Reader browser control, it is most likely that the ACS/BOCS is not configured and running correctly. The following steps apply only to Internet Explorer. To troubleshoot when image does not display using Adobe Reader: 1. Login to your TaskSpace application. For instructions, refer to. 2. Determine what file format has been mapped to the Adobe Reader image viewer for the current TaskSpace application. (On the Configuration tab, select the root node and scroll down to Viewers and Formats.) 3. In a search tab or folder tab, locate a document of that format. Click Edit or Open. 4. Right click a blank area near the Adobe Reader browser control and select View Source. The source HTML for the document view container appears in a text editor. 5. Search for name=ʺsrcʺ and copy the value of the value attribute. This value is the URL for displaying the document. 6. Launch a new Internet Explorer window, paste the URL into the address bar, and press Enter. If the document still does not appear, then it is likely that there is a ACS/BOCS configuration issue. For further instructions, refer to Allowing display of documents without using ACS/BOCS, page 27. Specifying the deployment location for the image viewer For Daeja ViewOne Pro or IGC Brava!, make sure that the TaskSpace image viewer configuration file correctly specifies the deployment location for the viewer. To specify the deployment location for the image viewer: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for codebase. 3. Make sure that the specified path matches the deployment location for the viewer. For example: <param> <name>codebase</name> <value>/wdk/imageviewer/daeja</value> <description>applet codebase</description> </param> 4. Save the file. 5. Restart the application server. 26 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

27 Troubleshooting Document Image Services deployment Clearing the browser cache The Viewer Framework is composed of many JavaScript files. Every hot fix, patch, service release or version upgrade of the Viewer Framework may involve changes in those JavaScript files. It is a good practice to clear the browser cache so that modified JavaScript file content can be downloaded to the client machine. To clear the browser cache in Internet Explorer: 1. From a client workstation, launch Internet Explorer. 2. From the Tools menu, select Internet Options. 3. On the General tab, click Delete Files. 4. Click OK. To clear the browser cache in Firefox: 1. From a client workstation, launch Firefox. 2. From the Tools menu, select Clear Private Data. 3. Click Clear Private Data Now. Allowing display of documents without using ACS/BOCS ACS/BOCS are separate products usually deployed on a separate machine other than the application server. To allow display of documents without using ACS/BOCS: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for usecontentserver. 3. Changing the value to false will make rich client viewers retrieve document images and annotations from the application server instead of ACS/BOCS. 4. Save the file. 5. Restart the application server. Changing the threshold for page serving Depending on the speed of your network connection, the page serving threshold should be adjusted for optimal performance. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 27

28 Troubleshooting Document Image Services deployment To change the threshold for page serving: 1. Navigate to the directory where your web server is installed. From there, navigate to webapps/taskspace/wdk/config/imaging. Open ivf_config.xml in a text editor. 2. Search for <name>contentsize</name>. 3. Change the number of bytes in the <value> element. The viewer framework will try to use page serving if the content size is greater than the value specified.</value>. 4. Save the file. 5. Restart the application server. Troubleshooting privileged DFC problems The following table provides an explanation of some possible problems you may encounter: Table 6. Troubleshooting problems in TaskSpace Message [DM_SESSION_E_CLIENT_AUTHENTICATION_ FAILURE]error:ʺCould not authenticate the client installation for reason: Not applicable [DM_SESSION_E_CLIENT_AUTHENTICATION_ FAILURE]error:ʺCould not authenticate the client installation for reason: Digital Signature verification failed [DM_SESSION_E_CLIENT_AUTHENTICATION_ FAILURE]error:ʺCould not authenticate the client installation for reason: Client hostname in authentication string doesn t match value in the registry [DM_SESSION_E_CLIENT_AUTHENTICATION_ FAILURE]error:ʺCould not authenticate the client installation for reason: Timestamp in authentication string has expired [DM_GROUP_E_PROTECTED_ROLE_UNKNOWN_ CLIENT]error:ʺThe requested role(role_name) is marked protected and the requesting application was either not known in this docbase s dm_client_rights table or its credentials did not match those in the dm_client_rights table [DM_GROUP_E_PROTECTED_ROLE_PRIV]error:ʺThe requesting application is not privileged to use role (role_name).ʺ [DM_SESSION_E_ADD_DYNAMIC_ROLE]error:ʺError adding dynamic role <dm_superusers_dynamic> Description Your DFC client is not known to the server Your DFC client does not match what is registered in the docbase (certificate) Your DFC client does not match what is registered in the docase (hostname) Client and server time synchronization Client is not privileged Client is not privileged Check docbase role definitions 28 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

29 Troubleshooting Document Image Services deployment Message [DM_GROUP_E_NOT_DYNMAIC_MEMBER]error: ʺUser is not a potential dynamic member of group role_name. AccessControlException Description User must be added to the dm_superusers_dynamic role PageModificationModule has not been installed as privileged, or the module has been installed with an incorrect definition of its privilege Refer to Documentum Document Image Services Development Guide for instructions to configure and enable TaskSpace for privileged DFC. Troubleshooting annotations If you are unable to save any annotations, you may need to reinstall the Document Image Services DAR. To troubleshoot this annotation problem: 1. Check the repository to determine whether the following components have been installed: AnnotationService SBO annotationconfig.xml (If the Daeja ViewOne Pro viewer is used) DaejaPlugin module 2. Reinstall the Document Image Services DAR. For instructions, refer to Installing the Document Image Services DAR with the DAR Installer, page 14. EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 29

30 Troubleshooting Document Image Services deployment 30 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide

31 Index A Adobe LiveCycle Reader Extensions, 17 Adobe Reader byte serving on Firefox, 25 comments stored in repository, 17 configuring for TaskSpace, 17 image display, 26 troubleshooting, 25 annotations in Brava!, viewing other users, 22 troubleshooting, 29 ARES, 17 B BOCS, plug in JAR file, 18 Brava! configuring for TaskSpace, 16 license server, 21 logs, enabling, 22 removing viewer, 23 Server, 20 troubleshooting, 20 viewer version, 23 viewing other users annotations, 22 browsers clearing cache, 27 byte serving on Firefox, Adobe Reader, 25 C comments, storing in repository, 17 Content Server viewing documents without, 27 D Daeja checking version, 24 configuring for TaskSpace, 16 logs, enabling, 24 removing viewer, 25 troubleshooting, 24 DAR Installer field definitions, 14 installing plug in, 13 DAR, Document Image Services, installing, 14 deploying Document Image Services, 7 deploying Document Image Services, Documentum prerequisites, 12 deployment planning, 8 troubleshooting, 19 Document Image Services deployment overview, 7 planning, 8 prerequisites, 12 Document Image Services DAR, installing, 14 Documentum environment, 12 Documentum prerequisites, installing, 12 E environment, Documentum, 12 F Firefox Adobe Reader byte serving, 25 H high fidelity form templates configuring viewer for, 18 I image viewers Adobe Reader, 17 Brava!, 16 EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide 31

32 Index Daeja, 16 High Fidelity Forms, 18 PDF Annotation Services (PAS), 17 installing DAR Installer, 13 Document Image Services DAR, 14 J JAR file plug in, 18 L license server, Brava!, 21 logs enabling for Brava!, 22 enabling for Daeja, 24 viewing Daeja, 24 P page serving, threshold, 27 PAS configuring for TaskSpace, 17 requirement for, 13 PDF Annotation Services, 17 prerequisites deployment, 12 JRE, 7 privileged DFC troubleshooting, 28 R removing viewer Brava!, 23 Daeja, 25 T threshold for page serving, 27 troubleshooting annotations, 29 DAR deployment, 19 privileged DFC problems, 28 TaskSpace image viewers, 20 V version Brava! viewer, 23 Daeja viewer, 24 viewing documents without Content Server, EMC Documentum Document Image Services Version 6.5 SP1 Deployment Guide