PDF Annotation Services Installation Guide

Transcription

1 PDF Annotation Services Installation Guide Version 5.3 March 2005

2 Copyright EMC Corporation

3 Table of Contents Preface... 5 Chapter 1 About PDF Annotation Services... 7 How PDF Annotation Services Works... 7 Chapter 2 Planning for PDF Annotation Services Installation... 9 About Installation... 9 Typical Configuration Required Software Chapter 3 Installing and Con guring PDF Annotation Services Configuring the Application Server and Application Server Host Installing DFC Configuring BEA WebLogic Configuring IBM WebSphere Configuring Apache TomCat Deploying PDF Annotation Services on the Application Server Deploying on BEA WebLogic Deploying on Windows with WebLogic Deploying on Solaris with WebLogic Deploying on IBM WebSphere Deploying on Apache TomCat Configuring the Docbase Creating the FDF Format in 5.3 and Earlier Docbases Storing the Application Server Location in the Docbase Storing the Location in 5.1 and Later Docbases Enabling Term-Hit Highlighting Internationalization Chapter 4 Uninstalling PDF Annotation Services Uninstalling from BEA WebLogic Uninstalling and Reinstalling on Apache TomCat Uninstalling from Apache TomCat Uninstalling from IBM WebSphere PDF Annotation Services Installation Guide 3

4 Table of Contents List of Tables 4 PDF Annotation Services Installation Guide

5 Preface This manual describes how to install and configure Documentum PDF Annotation Services, a product that allows end users of Documentum client products to make comments on PDF documents and store the comments in a Documentum repository (Docbase). Intended Audience This manual is intended for administrators and other users who install and configure Documentum PDF Annotation Services. For information on using PDF Annotation Services from a client, refer to documentation for Documentum Desktop and Webtop. Revision History The table lists the published versions of this document. Revision History Revision Date March, 2005 Description Initial Release PDF Annotation Services Installation Guide 5

6 Preface 6 PDF Annotation Services Installation Guide

7 About PDF Annotation Services Chapter 1 Documentum PDF Annotation Services enables users of Documentum Desktop, Webtop, or Documentum Compliance Manager (DCM) to use Adobe Acrobat to associate comments with PDF documents stored in a Documentum repository (Docbase). PDF Annotation Services runs on an application server. The application server may be installed on the Content Server host, but Documentum strongly recommends installing the application server on a different host. Installing the application server and Content Server on the same host creates a security problem. Caution: PDF Annotation Services replaces the annotation plugin for annotating PDF documents. Once you configure a Docbase to use PDF Annotation Services, you can no longer read PDF annotations in that repository that were created using the annotation plugin and Desktop or Desktop Client. How PDF Annotation Services Works PDF Annotation Services serves comments stored in a Docbase to Documentum client applications and allows you to store comments in a Docbase. To associate comments with a PDF document in a repository, you can log into the repository using a client program such as Documentum Desktop or Webtop, navigate to the PDF document. From Webtop, you can comment on a document by choosing File < View. When an end-user application requests a document from the Docbase, the application checks whether the document is a PDF or has an associated PDF rendition. If the document is a PDF or has a PDF rendition, the application next determines whether the Docbase is configured to use PDF Annotation Services. If yes, a browser session is started and Adobe Acrobat is launched in the browser window. Once the document is displayed in Adobe Acrobat 6.0, you can add comments to the document provided you have at least RELATE permission on the document. Once the comments are created, you can choose to save the comments to the docbase by clicking PDF Annotation Services Installation Guide 7

8 About PDF Annotation Services Send and Receive comments button in Adobe Acrobat 6.0. The comments are stored in the Documentum Docbase in FDF format. To view comments from Desktop, you can select the document in the content pane in the Windows Explorer. In the Document Info pane, select Comments on Version filter to show comments on the document. To view a comment, you can select the comment and right click Open menu item or double click on the comment. This will launch Adobe Acrobat 6.0 within Internet Explorer. The document will be displayed by Adobe Acrobat 6.0 and you can see the comments on the documents. Configure Webtop With The Comment Connector Configuration is required to enable the comment connector to step in. For this, you must install the comment connector and configure the docbase with the uri for the comment connector. Webtop when installed, does not recognise the Comment Connector even when it is connected to a docbase that is configured with the comment connector url. In such cases, when you invoke File > View in Webtop for a document with a PDF rendition will invoke the default application where you can add comments/notes. To make Webtop display the PDF rendition for commenting, you need to configure webtop with the comment connector URL, so that clicking File > View would show the PDF rendition instead of the original document. This configuration is done in the <application path to webtop>/webcomponent/app.xml file on the application server where the Webtop is installed. When you set the parameter in that file and restart the app server, Webtop would use Comment as the viewer for the documents. 8 PDF Annotation Services Installation Guide

9 Chapter 2 Planning for PDF Annotation Services Installation This chapter describes the process and effects of installing PDF Annotation Services. It describes the requirements for installing or upgrading PDF Annotation Services on a host computer, and provides information to assist you in planning a PDF Annotation Services installation. Before installing PDF Annotation Services, ensure that you understand the concepts in this chapter. This chapter contains the following main sections: About Installation, page 9 Required Software, page 10 About Installation To install PDF Annotation Services, perform the following tasks: Install and configure an application server. Deploy PDF Annotation Services on the application server. Configure Docbases where you use PDF Annotation Services. Modify the docbase config object with the URI of the application server. Enable term-hit highlighting. Term-hit highlighting highlights full-text search terms in PDF documents. It is available only for Documentum Desktop users. Use the instructions in the documentation for Content Rendition Services (formerly known as AutoRender Pro) to enable term-hit highlighting. Use the documentation that corresponds to your version of Content Rendition Services or AutoRender Pro. Ensure that the dmcl.ini files on client application host and the application server host point to DocBrokers that can provide connection information for the Docbase. PDF Annotation Services Installation Guide 9

10 Planning for PDF Annotation Services Installation In order to comment a PDF document, both the client application and the application server must be able to access the Docbase containing the document. Typical Con guration A typical configuration for PDF Annotation Services includes the following hosts: The Content Server host, where Content Server and a Docbase are installed. The Docbase s supporting database may be installed on the Content Server host or remotely. For Docbase installation information, refer to the Content Server Installation Guide. The application server host, where a supported application server and PDF Annotation Services are installed. Client hosts, from which end users access the Docbase using Documentum Desktop or Webtop An instance of PDF Annotation Services can serve multiple Docbases, provided the dmcl.ini file on the application server host points to DocBrokers providing connection information for those Docbases. Documentum strongly recommends installing the application server and PDF Annotation Services on a host remote from the Content Server host. Installing the application server on the Content Server host creates security problems. Required Software You must have specific items of software to use PDF Annotation Services. The release notes specify the required versions. PDF Annotation Services requires the following software: A properly configured Documentum Docbase An application server Documentum Foundation Classes (DFC) installed on the application server host Adobe Acrobat on the client machine 10 PDF Annotation Services Installation Guide

11 Installing and Con guring PDF Annotation Services Chapter 3 This chapter provides instructions for installing PDF Annotation Services. It contains the following main sections: Configuring the Application Server and Application Server Host, page 11 Deploying PDF Annotation Services on the Application Server, page 13 Configuring the Docbase, page 18 Enabling Term-Hit Highlighting, page 20 Internationalization, page 20 Con guring the Application Server and Application Server Host This section contains instructions for configuring the application server and its host for PDF Annotation Services. Installing DFC If you are installing a Documentum application on the application server host, that application installs DFC and no separate installation procedure is necessary. Otherwise, install DFC on the application server host. For information on installing DFC, refer to the Documentum Foundation Classes Installation Guide. PDF Annotation Services Installation Guide 11

12 Installing and Con guring PDF Annotation Services Con guring BEA WebLogic Use these instructions to configure BEA WebLogic for PDF Annotation Services. To con gure BEA Weblogic: 1. Install WebLogic using BEA s instructions. 2. Shut WebLogic down. 3. Navigate to the startwls.cmd file (Windows) or startwls.sh file (Solaris) in your domain. 4. Open the file in a text editor. 5. Locate the last occurrence of the string set CLASSPATH=. 6. Add the path to dfc.jar and dfc.properties to the string: set CLASSPATH=%PRE_CLASSPATH%;%WLP_PRE_CLASSPATH%;%WEBLOGIC_ CLASSPATH%;%CLASSPATH%;%POST_CLASSPATH%;%WLP_POST_CLASSPATH%;path_ to_dfc.jar;path_to_dfc.properties 7. Save the startwls.cmd file. 8. Start WebLogic. Note: If Webtop is sharing the server with comment connector, startdocumentum.cmd (or startdocumentum.sh) would have the appropriate Documentum environment settings when webtop is installed. So step 3 through 7 can be ignored For more information, refer to the Webtop Configuration Documents for setting up Webtop to use comment connector. Con guring IBM WebSphere Use these instructions to configure IBM WebSphere for PDF Annotation Services. To con gure IBM WebSphere: 1. Install WebSphere using IBM s instructions. 2. Log in to the WebSphere administrative console 3. In the left-hand pane, select Environment Shared Libraries. 4. Click New. 5. In the new shared library, enter documentum. 6. In the classpath, add the full path to dfc.jar and dfc.properties. 12 PDF Annotation Services Installation Guide

13 Installing and Con guring PDF Annotation Services 7. Click Apply. 8. Click Ok. Con guring Apache TomCat Use these instructions to configure Apache Tomcat for PDF Annotation Services. To con gure Apache Tomcat: 1. Install Tomcat using Apache s instructions. 2. Shut Tomcat down. 3. On the Tomcat host, navigate to the Program Files\Apache Group\TomCat \bin folder. 4. Open the setclasspath.bat file (Windows) or setclasspath.sl file (Solaris) in a text editor. 5. Locate the string set CLASSPATH=. 6. Add the path to dfc.jar and dfc.properties to the string: set CLASSPATH=%JAVA_HOME%\lib\tools.jar;path_to_dfc. jar;path_to_dfc.properties 7. Save the setclasspath.bat file (Windows) or setclasspath.sl file (Solaris) 8. Start TomCat. Deploying PDF Annotation Services on the Application Server Use these instructions to deploy the application, which is distributed as a war file. There are instructions for BEA WebLogic, IBM WebSphere, and Apache TomCat: Deploying on BEA WebLogic, page 14 Deploying on IBM WebSphere, page 16 Deploying on Apache TomCat, page 18 PDF Annotation Services Installation Guide 13

14 Installing and Con guring PDF Annotation Services Deploying on BEA WebLogic Use these instructions to deploy on WebLogic. Separate instructions are provided for Windows and Solaris. Deploying on Windows with WebLogic Use these instructions if you are deploying PDF Annotation Services on Windows with BEA WebLogic. To deploy on WebLogic on Windows: 1. Log in to the WebLogic host as the user who installed WebLogic. 2. Shut down WebLogic if it is running. 3. Copy the AdobeCommentConnector.war file to the WebLogic host. 4. Rename the file documentum.war. 5. Start WebLogic. 6. Start the WebLogic Server Console. 7. In the left pane, select Deployments Web Applications Modules. 8. In the right pane, click Deploy a new Web Application Module. 9. In the Location area, select the localhost and navigate to the folder to which you copied the war file. 10. Select the radio button next to documentum.war. 11. Click Target Module. 12. On the Deploy a Web Application Module page, verify that the information is correct. 13. Click Deploy. 14. Close the WebLogic Server Console. 15. Create three required folders on the host for temporary files. c:\manhattan\pdf c:\manhattan\comments c:\manhattan\logs These are the default locations. The locations can be changed if you also modify the review.properties file, which is located in the webapps\documentum\web-inf\classes folder. 14 PDF Annotation Services Installation Guide

15 Installing and Con guring PDF Annotation Services Deploying on Solaris with WebLogic Use these instructions if you are deploying PDF Annotation Services on Solaris with BEA WebLogic. To deploy on WebLogic on Solaris: 1. Log in to the WebLogic host as the user who installed WebLogic. 2. Shut down WebLogic if it is running. 3. On Solaris, create a directory called /upload/documentum. For example, this might be /export/zinc2/weblogic/bea/user_projects/domains/ mydomain/ myserver/upload. 4. On Solaris, create a directory called /upload/documentum. For example, this might be /export/zinc2/weblogic/bea/user_projects/domains/ mydomain/ myserver/upload. 5. Copy the AdobeCommentConnector.war file to the WebLogic host. 6. Rename the file documentum.war. 7. On Solaris, copy the documentum.war file to the directory you created in step Expand the war file: jar xvf documentum.war 9. Optionally, delete the war file. After it is expanded, it is no longer required. 10. Open the startwls.sh file in an editor. 11. Add the paths $DOCUMENTUM_SHARED/dfc/dfc.jar and $DOCUMENTUM_ SHARED/config to the CLASSPATH. 12. Save the startwls.sh file. 13. Create three required folders on the host for temporary files. /manhattan/pdf /manhattan/comments /manhattan/logs These are the default locations. The locations can be changed if you also modify the review.properties file, which is located in the webapps/documentum/web-inf/classes folder. The application server must be restarted for the changes to take effect. 14. Make the /tmp/manhattan folder world-writable with full permissions: chmod -R a+w PDF Annotation Services Installation Guide 15

16 Installing and Con guring PDF Annotation Services 15. Navigate to the webapps/documentum/web-inf/classes directory and open the review.properties file in a text editor. 16. Add these lines: PDFDir=/manhattan/pdf ArchiveDir=/manhattan/archive CommentsDir=/manhattan/comments ReviewLogDir=/manhattan/logs 17. Start WebLogic. 18. Start the WebLogic Server Console. 19. In the left pane, select Deployments Web Applications Modules. 20. In the right pane, click Deploy a new Web Application Module. Ensure that the application is deployed to the directory to which you expanded the war file. 21. In the Location area, select the localhost and navigate to the folder to which you copied the war file. 22. Select the radio button next to documentum.war. 23. Click Target Module. 24. On the Deploy a Web Application Module page, verify that the information is correct. 25. Click Deploy. 26. Close the WebLogic Server Console. 27. Start a Web browser and navigate to where host is the host on which PDF Annotation Services is installed, and port is where weblogic app server is listed Ensure that PDF Annotation Services is running correctly. Deploying on IBM WebSphere Use these instructions to deploy on IBM WebSphere. To deploy on WebSphere: 1. Log in to the WebSphere host as the user who installed WebSphere. 2. Copy the file AdobeCommentConnector.war to the local drive. 3. Rename AdobeCommentConnector.war to documentum.war. 4. Start WebSphere. 16 PDF Annotation Services Installation Guide

17 Installing and Con guring PDF Annotation Services 5. Start the WebSphere administrative console. 6. In the left-hand panel, select Application Install New Application. 7. In the right-hand pane, in the Server path field, type in the full path to documentum.war. 8. Enter /documentum as the Context Root. 9. Click Next. 10. Check Generate Default Bindings and click Next. 11. For the remainder of the WebSphere wizard, accept the wizard s default settings. 12. Click Finish. The application is deployed. The deployment automatically expands the documentum.war file. 13. In the left panel, select Applications Enterprise Application. 14. Select documentum. 15. In the Additional Properties table, select Libraries. 16. In the Library Ref section, click Add. 17. Select documentum from the drop-down list and click Ok. 18. Save the Master Configuration. 19. Restart the application. 20. Close the WebSphere administrative console. 21. Navigate to the webapps/documentum/web-inf/classes in the TomCat directory and open the review.properties file in a text editor. 22. Add these lines: PDFDir=/manhattan/pdf ArchiveDir=/manhattan/archive CommentsDir=/manhattan/comments ReviewLogDir=/manhattan/logs 23. Save the file. 24. On Solaris, create three required folders on the host for temporary files: /manhattan/pdf /manhattan/comments /manhattan/logs PDF Annotation Services Installation Guide 17

18 Installing and Con guring PDF Annotation Services Deploying on Apache TomCat Use these instructions to deploy on TomCat. To deploy on TomCat: 1. Log in to the TomCat host as the user who installed TomCat. 2. Shut down TomCat. 3. On the TomCat host, navigate to the Program Files\Apache Group\TomCat \webapps folder and create a subfolder called documentum. Note: This path may vary depending on how the TomCat is installed. 4. Copy the war file to the Program Files\Apache Group\TomCat \webapps\documentum folder. The war file expands automatically when the first request to the application is received by the application server. 5. If the war file does not expand, unzip the file manually to the Program Files\Apache Group\TomCat \webapps\documentum folder. 6. Create three required folders on the host for temporary files. c:\manhattan\pdf c:\manhattan\comments c:\manhattan\logs These are the default locations. The locations can be changed if you also modify the review.properties file, which is located in the webapps\documentum\web-inf\classes folder. 7. Restart TomCat. Con guring the Docbase Use these instructions to configure a Docbase for storing comments and using PDF Annotation Services. Creating the FDF Format in 5.3 and Earlier Docbases You do not need to create the FDF format (the format in which the comments are stored) in and later Docbases because the format is created automatically when you install a 5.3 Docbase or upgrade an earlier Docbase to version PDF Annotation Services Installation Guide

19 Installing and Con guring PDF Annotation Services To create the FDF format: 1. Start IAPI. 2. Connect to the Docbase as a Superuser or System Administrator. 3. Issue these commands: > create,c,dm_format > set,c,l,name fdf > set,c,l,description Acrobat FDF > set,c,l,mac_type FDF > set,c,l,mac_creator???? > set,c,l,mime_type application/fdf > set,c,l,dos_extension fdf > set,c,l,can_index F > set,c,l,topic_transform F > set,c,l,is_hidden F > save,c,l 4. Disconnect from IAPI. Storing the Application Server Location in the Docbase The location of the application server where PDF Annotation Services is running must be stored in the Docbase in order that comments can be served to end users. Storing the Location in 5.1 and Later Docbases In Docbases version 5.1 and later, set the values of the app_server_uri and app_server_name attributes of the server config object. Set the value of app_server_name to adobe_comment_connector. Set the value of app_server_uri in the forma: where machine_name is the host for the application server and port_number is the port on the host machine at which the application server listens. PDF Annotation Services Installation Guide 19

20 Installing and Con guring PDF Annotation Services The following instructions use IAPI. Alternatively, use Documentum Administrator to add the correct app_server_name and app_server_uri to each server config object in the Docbase. To store the application server location in 5.1 and later Docbases: 1. Start IAPI. 2. Connect to the Docbase as a Superuser or System Administrator. 3. Issue these commands: > retrieve,c,dm_server_config > append,c,l,app_server_name adobe_comment_connector > append,c,l,app_server_uri > save,c,l > reinit,c where machine_name is the host for the application server and port_number is the port on the host machine at which the application server listens. 4. If you are running a multi-server configuration, repeat step 3 for each server config in the Docbase. 5. Log out and close IAPI. Enabling Term-Hit Highlighting Term-hit highlighting is a Documentum Desktop feature that highlights a full-text search term in a PDF retrieved by the search. Use the instructions in the AutoRender Pro Administration Guide or Content Rendition Services Administration Guide to enable term-hit highlighting. (AutoRender Pro and Content Rendition Services are the same product. The name depends on the version you are using.) Term-hit highlighting is not available to users of Webtop. Internationalization This release of PDF Annotation Services is installed with localization to French, Italian, German, Spanish, Japanese and Korean already implemented. In the webapps\documentum\web-inf\classes folder on the application server host, there are files called AcrobatReviewConnector_xx.properties, where xx corresponds to the locale implemented by the file (for example, en for English). 20 PDF Annotation Services Installation Guide

21 Installing and Con guring PDF Annotation Services Based on the locale of the client that calls PDF Annotation Services, the correct AcrobatReviewConnector_xx.properties file is located. To enable strings for a different locale, create a new AcrobatReviewConnector_xx. properties file for that locale and store it in the webapps\documentum\web-inf\classes folder on the application server host. PDF Annotation Services Installation Guide 21

22 Installing and Con guring PDF Annotation Services 22 PDF Annotation Services Installation Guide

23 Chapter 4 Uninstalling PDF Annotation Services This chapter explains how to uninstall PDF Annotation Services. To uninstall PDF Annotation Services, you must connect to the application server host as the user who installed the application server. Uninstalling from BEA WebLogic Use these instructions to uninstall from a WebLogic application server. To uninstall from BEA WebLogic: 1. Log in to the WebLogic host as the user who installed WebLogic. 2. Start the WebLogic Admin Console. 3. In the left-hand pane, select Web Application Modules. The Web application for PDF Annotation Services appears in the right-hand pane. 4. Click the trash can icon next to the PDF Annotation Services application. The application server warns you that deleting the application also undeploys it. 5. Click Yes. The application server undeploys PDF Annotation Services. Uninstalling and Reinstalling on Apache TomCat If you wish to uninstall and reinstall PDF Annotation Services using the same TomCat server instance, do not use the procedures in Uninstalling from Apache TomCat, page 24. Instead, use the following instructions. PDF Annotation Services Installation Guide 23

24 Uninstalling PDF Annotation Services To uninstall and reinstall PDF Annotation Services on TomCat: 1. Log in to the host as the user who installed TomCat. 2. Stop TomCat. 3. Navigate to the /webapps folder. 4. Delete the contents of documentum directory in the webapps folder. 5. Extract the documentum war file into the documentum directory. 6. Reboot the host computer. 7. Run startup.bat to restart the application server. Uninstalling from Apache TomCat Use these instructions to uninstall from a TomCat application server. To uninstall PDF Annotation Services from Apache TomCat: 1. Log in to the TomCat host as the user who installed TomCat. 2. Stop TomCat. 3. Navigate to the /webapps folder. 4. Delete the /webapps/documentum folder. 5. Restart TomCat. Uninstalling from IBM WebSphere Use these instructions to uninstall from an IBM WebSphere application server. To uninstall PDF Annotation Services from IBM WebSphere: 1. Log in to the WebSphere host as the user who installed WebSphere. 2. Log in to the administrative console. 3. In the left pane, select Applications- Enterprise Applications. 4. Check the check box next to documentum. 5. Click Stop. The application is stopped. 6. Click Uninstall. 24 PDF Annotation Services Installation Guide

25 Uninstalling PDF Annotation Services The application is uninstalled. PDF Annotation Services Installation Guide 25

26 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United State and other countries. All other trademarks used herein are the property of their respective owners.