EMC Documentum Archive Services for Reports Version 1.7 SP1

Transcription

1 EMC Documentum Archive Services for Reports Version 1.7 SP1 INSTALLATION GUIDE P/N A02 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published August 2008 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners. ii EMC Documentum Archive Services for Reports Installation Guide

3 Contents Preface... v Chapter 1 Chapter 2 Chapter 3 Appendix A Introduction Overview Microsoft Windows Installation Scenarios Unix Installation Scenario Optional Components ASR Search Service ASR Report Miner Installing ASR (Microsoft Windows) Introduction Installation Installing Prerequisite Software Installing ASR Software Post-Installation Notes Installing ASR (Unix) Introduction Installation Installing Prerequisite Software Installing ASR Software Post-Installation Notes Upgrading from Previous Versions System Requirements... A-2 Upgrading from Versions 1.5 and 1.7 to Version 1.7 SP1... A-3 EMC Documentum Archive Services for Reports Installation Guide iii

4 Contents Prerequisites... A-3 Uninstalling earlier versions of ASR... A-3 Installing Version 1.7 SP1... A-4 Copying the Configuration Files... A-5 Copying the Workspaces and Project Files... A-6 Enabling Retrieval of Logical Documents Using Documentum... A-6 Verifying Your Projects... A-6 Upgrading from Version 1.4 and Earlier to Version 1.7 SP1... A-7 Prerequisites... A-7 Considerations... A-7 Uninstalling Version A-8 Installing Version 1.7 SP1... A-8 Copying the Configuration Files... A-9 Copying the Workspaces and Project Files... A-10 Enabling Retrieval of Logical Documents Using Documentum... A-10 Verifying Your Projects... A-10 Uninstalling Version 1.7 SP1... A-11 Microsoft Windows... A-11 Unix... A-12 Appendix B Appendix C Installing Transform Plug-in Licenses Overview... B-2 How It Works... B-2 Requesting Additional Licenses... B-2 Obtaining and Installing the License Key... B-3 Installing and Configuring RPS for Use with ASR Installing RPS on the Documentum Repository... C-2 Operating Environments with ASR... C-3 ASR with DFC 5.3 and 5.3 Content Server... C-3 ASR with DFC 6 and 6.0 Content Server... C-3 ASR with DFC 6 and 5.3 Content Server... C-6 Global Registry settings in dfc.properties file... C-6 Troubleshooting... C-8 iv EMC Documentum Archive Services for Reports Installation Guide

5 Preface As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes. If a product does not function properly or does not function as described in this document, please contact your EMC representative. Audience Related documentation This document is part of the EMC Documentum Archive Services for Reports documentation set, and is intended for use by system administrators. Related documents include: EMC Documentum Archive Services for Reports Installation Guide EMC Documentum Archive Services for Reports Administrator s Guide EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide EMC Documentum Archive Services for Reports Search Service Installation Guide EMC Documentum Archive Services for Reports Search Service Administrator s Guide EMC Documentum Archive Services for Reports Report Miner Administrator s Guide EMC Documentum Archive Services for Reports Release Notes EMC Documentum Archive Services for Reports Installation Guide v

6 Conventions used in this document EMC uses the following conventions for special notices. Note: A note presents information that is important, but not hazard-related.! CAUTION A caution contains information essential to avoid data loss or damage to the system or equipment.! IMPORTANT An important notice contains information essential to operation of the software. vi EMC Documentum Archive Services for Reports Installation Guide

7 Typographical conventions EMC uses the following type style conventions in this document: Normal Bold: Italic: Courier: Used in running (nonprocedural) text for: Names of interface elements (such as names of windows, dialog boxes, buttons, fields, and menus) Names of resources, attributes, pools, Boolean expressions, buttons, DQL statements, keywords, clauses, environment variables, filenames, functions, utilities URLs, pathnames, filenames, directory names, computer names, links, groups, service keys, file systems, notifications Used in running (nonprocedural) text for: Names of commands, daemons, options, programs, processes, services, applications, utilities, kernels, notifications, system call, man pages Used in procedures for: Names of interface elements (such as names of windows, dialog boxes, buttons, fields, and menus) What user specifically selects, clicks, presses, or types Used in all text (including procedures) for: Full titles of publications referenced in text Emphasis (for example a new term) Variables Used for: System output, such as an error message or script URLs, complete paths, filenames, prompts, and syntax when shown outside of running text Courier bold: Used for: Specific user input (such as commands) Courier italic: Used in procedures for: Variables on command line User input variables < > Angle brackets enclose parameter or variable values supplied by the user [ ] Square brackets enclose optional values Vertical bar indicates alternate selections - the bar means or { } Braces indicate content that you must specify (that is, x or y or z)... Ellipses indicate nonessential information omitted from the example EMC Documentum Archive Services for Reports Installation Guide vii

8 Where to get help EMC support, product, and licensing information can be obtained as follows. Product information For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at: Technical support For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account. Your comments Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Please send your opinion of this document to: techpub_comments@emc.com Your comments Comments and suggestions about our product documentation are always welcome. To provide feedback: 1. Go to: 2. Click the Feedback link. viii EMC Documentum Archive Services for Reports Installation Guide

9 Invisible Body Tag 1 Introduction This chapter provides an introduction to the installation process for Archive Services for Reports and includes the following topics: Overview Optional Components Introduction 1-1

10 1 Introduction Overview Archive Services for Reports includes the following components: ASR Server processing component ASR Studio configuration application ASR Console diagnostics application A series of plug-ins used to perform individual operations in ASR Depending on the platform on which you are installing ASR, there are different scenarios to consider. Microsoft Windows Installation Scenarios You can run the ASR installation program for Microsoft Windows to install ASR Server, ASR Studio, ASR Console and plug-ins on a single Microsoft Windows Server computer that meets the minimum system requirements for ASR Server. Refer to the EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements. Alternatively, you can run the installation program for Microsoft Windows to install ASR Server and plug-ins on a Microsoft Windows computer that meets the minimum system requirements for ASR Server. You can then install the ASR Studio and ASR Console client applications on a separate Microsoft Windows computer that meets the minimum system requirements for ASR Studio. Refer to the EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements. Unix Installation Scenario You can run the ASR installation program for Unix to install ASR Server and plug-ins on a Unix machine. You can then install the ASR Studio and ASR Console client applications on a separate Microsoft Windows computer that meets the minimum system requirements for ASR Studio. Refer to the EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements. 1-2 EMC Documentum Archive Services for Reports Installation Guide

11 Introduction 1 Optional Components The following optional ASR components can also be installed. Procedures for installing each component is included in the documentation that accompanies the component. ASR Search Service ASR Search Service manages storage and access to archived content. Users can quickly browse, search and retrieve individual enterprise reports and data using ASR Search Service interfaces. Refer to the following documents to install and user the ASR Search Service: EMC Documentum ASR Search Service Installation Guide EMC Documentum ASR Search Service Administrator's Guide ASR Report Miner ASR Report Miner is an OLAP compliant solution that allows all report content, regardless of format, to be extracted and cached for data mining. Refer to the EMC Documentum ASR Report Miner Administrator's Guide for information on installing and using ASR Report Miner. Optional Components 1-3

12 1 Introduction 1-4 EMC Documentum Archive Services for Reports Installation Guide

13 Invisible Body Tag 2 Installing ASR (Microsoft Windows) This chapter provides detailed instructions for installing and activating the ASR Server on a Microsoft Windows operating system and includes the following topics: Introduction Installation Installing ASR (Microsoft Windows) 2-1

14 2 Installing ASR (Microsoft Windows) Introduction The ASR installation program for Microsoft Windows includes the following components: ASR Server processing component ASR Studio configuration application ASR Console diagnostics application A series of plug-ins used to perform individual operations in ASR For more information on Microsoft Windows installation scenarios, refer to Introduction on page EMC Documentum Archive Services for Reports Installation Guide

15 Installing ASR (Microsoft Windows) 2 Installation This section includes the following topics: Installing Prerequisite Software on page 2-3 Installing ASR Software on page 2-5 Post-Installation Notes on page 2-7 Installing Prerequisite Software During the ASR software installation, the installer will require you to reference directories related to database drivers. In addition, Documentum Foundation Classes (DFC) software will be required if you plan to run the "Store in Documentum Docbase" plug-in. Before installing ASR software, install the prerequisite software described in this section. Note: If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details. Database Drivers Download and install one or both of the following drivers: Microsoft SQL Server If using Microsoft SQL Server you must install the MS SQL Server 2005 JDBC Driver, 1.1 or later. The latest drivers can be found at: c47053eb-3b d-81e1ec91c1ba&displaylang=en This driver works against MS SQL Server 2000 and Oracle If using an Oracle database you must install the latest Oracle 10g Release 2 JDBC Drivers: ojdbc14.jar and orai18n.jar. The drivers can be found at: Installation 2-3

16 2 Installing ASR (Microsoft Windows) dbc/htdocs/jdbc_10201.html The 10g driver works against Oracle 9 and 10. Documentum DFC Download and install the appropriate version of the Documentum Foundation Classes (DFC) software provided on the ASR software download site. Installing DFC sets or updates a CLASSPATH environment variable. Example: CLASSPATH=C:\Program Files\Documentum\dctm.jar;C:\Documentum\Config The CLASSPATH variable must include the full pathnames of the dctm.jar file as well as the Documentum\Config\ directory. These values are required to be set in order for the ASR "Store in Documentum Docbase" task to work correctly. Adobe Acrobat Download and install Adobe Acrobat Standard or Adobe Acrobat Professional (version 6.0 or higher) from the Adobe web site ( Note: To ensure successful integration with ASR Studio, you must also install the latest patches for the version of Acrobat you install. 2-4 EMC Documentum Archive Services for Reports Installation Guide

17 Installing ASR (Microsoft Windows) 2 Installing ASR Software To perform a typical install of ASR Server: 1. Ensure that you are logged in as the same user account that was used to install Documentum (e.g., dmadmin). 2. Locate the Archive Services for Reports Server installer. Double click the file to launch the installation wizard. 3. After reading the information in the Introduction window of the installation wizard, select Next. 4. Read and accept the terms of the EMC Software License Agreement, and click Next. 5. On the Choose Install Set page of the installation wizard, select the components you want to install. Click Next. 6. On the Installation Requirements page, read and verify that all requirements have been met (refer to Installing Prerequisite Software on page 2-3). If necessary, use the link provided to update the system with any required components not yet installed, or click Cancel to end the installation and manually update. 7. In the Choose Install Folder screen, choose the folder in which you want to install ASR, the click Next. 8. On the ASR Server s Root Folder page, select the path in which you want the ASR Server program to maintain your development and production files. You can browse using the [Choose...] button, if the default location is not where you would like the files to reside. When ready, click Next. 9. On the Documentum Database Storage page, select Lightweight Document if desired. This option enables portions of a document to be stored in a relational database to facilitate faster ingestion and search retrieval. Click Next. 10. On the Database Selections page, if you elected to utilize the Lightweight Document option, or the Mining Plug-in was chosen from the Install Set page, you must choose whether to use an SQL Server and/or Oracle database. You can select both database types depending on the requirements of your environment. For example, you may have Installation 2-5

18 2 Installing ASR (Microsoft Windows) older reports stored in a legacy Microsoft SQL database while newer reports are stored in an Oracle database. When ready, Click Next. 11. Depending on the selected database, one or both of the following pages displays. If you selected a Microsoft SQL Server 2005 database, the MS SQL Server 2005 JDBC Drivers Location page displays. Enter the location of the JDBC drivers. Click Next. If you selected an Oracle database, the Oracle JDBC Drivers Location page displays. Enter the location of the JDBC drivers. Click Next. 12. On the Server Failure Notification page, provide information about delivering an message to one or more recipients in the event that ASR Server fails while processing. Enter the appropriate information, and click Next. This is an optional configuration. 13. The Transformation Plug-in Registration Required page is a reminder to register the transform plug-ins that were selected for installation. The relevant section of the Installation Guide is named for reference. 14. In the Choose Shortcut Folder page, select where to create product icons and click Next. It is recommended you select Other to install the shortcuts in the default location. 15. Review the details on the Pre-Installation Summary page and click Install. Installation proceeds, and displays several more screens, some with reminders to consult further sections in the installation documentation. A progress bar in the Installing ASR Processing Server page shows that installation is continuing. 2-6 EMC Documentum Archive Services for Reports Installation Guide

19 Installing ASR (Microsoft Windows) In the Logical Document Configuration Required screen, a reminder is displayed regarding enabling retrieval of logical documents using Documentum. Refer to Enabling Retrieval of Logical Documents Using Documentum on page A-6 for this information. 17. The Post-Install Actions Required page makes reference to the next section of this present chapter. 18. The Installation Complete page indicates that the software installation has finished successfully. Click Done, and then refer to the next section of this chapter for post-installation instructions. Post-Installation Notes You must modify the Documentum ASR Server service to run using the the permissions of the installation user. This enables the ASR processing server to create and modify files using the permissions of this user. 1. Click Start > Programs > Administrative Tools > Services. 2. Right-click the Documentum ASR Server service and select Properties. 3. Select the Log On tab. 4. Select the This account radio button and enter the user account information for the installation user. 5. Click Apply. 6. Click OK. 7. Right-click the Documentum ASR Server service and click Restart. Note: If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details. Installation 2-7

20 2 Installing ASR (Microsoft Windows) 2-8 EMC Documentum Archive Services for Reports Installation Guide

21 Invisible Body Tag 3 Installing ASR (Unix) This chapter provides detailed instructions for installing and activating the ASR Server on a Unix operating system and includes the following topics: Introduction Installing ASR Software Installing ASR (Unix) 3-1

22 3 Installing ASR (Unix) Introduction The ASR installation program for Unix includes the following components: ASR Server processing component A series of plug-ins used to perform individual operations in ASR The following client applications must be installed on a Microsoft Windows computer: ASR Studio configuration application ASR Console diagnostics application For more information on Unix installation scenarios, refer to Introduction on page EMC Documentum Archive Services for Reports Installation Guide

23 Installing ASR (Unix) 3 Installation This section includes the following topics: Installing Prerequisite Software on page 3-3 Installing ASR Software on page 3-5 Post-Installation Notes on page 3-7 Installing Prerequisite Software During the ASR software installation, the installer will require you to reference directories related to database drivers. In addition, Documentum Foundation Classes (DFC) software will be required if you plan to run the "Store in Documentum Docbase" plug-in. Before installing ASR software, install the prerequisite software described in this section. Note: If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details. Database Drivers Download and install one or both of the following drivers: Microsoft SQL Server If using Microsoft SQL Server you must install the MS SQL Server 2005 JDBC Driver, 1.1 or later. The latest drivers can be found at: c47053eb-3b d-81e1ec91c1ba&displaylang=en Oracle If using an Oracle database you must install the latest Oracle 10g Release 2 JDBC Drivers: ojdbc14.jar and orai18n.jar. The drivers can be found at: dbc/htdocs/jdbc_10201.html Installation 3-3

24 3 Installing ASR (Unix) Documentum DFC Download and install the appropriate version of the Documentum Foundation Classes (DFC) software provided on the ASR software download site. Environment Variables Three environment variables participate in the installation and/or operation of DFC and ASR: DOCUMENTUM environment variable must be defined and exported to the root Documentum installation directory. DOCUMENTUM_SHARED environment variable must be defined and exported to the shared directory. CLASSPATH environment variable is established or updated during the installation of DFC. It must include the full pathname to the dctm.jar file and the Documentum/config directory. It must be defined and also exported. These two values in this variable must be defined in order for the "Store in Documentum Docbase" task to work correctly. In order to install DFC on a UNIX system, the DOCUMENTUM and DOCUMENTUM_SHARED environment variables need to be defined and exported in the shell prior to running the DFC installer. These same values must be defined and exported for ASR to work as well. As a convenience, you can refer to the set_dctm_env.sh file, usually located in the $DOCUMENTUM_SHARED/dfc directory. Note: the ASR start_server script checks during startup that the DOCUMENTUM and DOCUMENTUM_SHARED environment variables are defined, and if not, a warning is printed to the console. File and Directory Permissions After installing the DFC, make sure that the permissions are set to 777 on the dfc/shared/cache and dfc/shared/config directories. This is required to enable the "Store In Documentum" task to create lock files and write to the cache. If a user other than the DFC installation user runs ASR on this machine, and these directories and their contents are not world writable, there can be permissions errors due to the current user not having rights to those locations. 3-4 EMC Documentum Archive Services for Reports Installation Guide

25 Installing ASR (Unix) 3 Installing ASR Software To perform a typical installation of ASR Server and plug-ins: 1. Ensure that you are logged in as the same user account that was used to install Documentum (e.g., dmadmin). 2. Place the installation files in a desired location. Unzip the files if necessary (gunzip) and use chmod 777 on the files. 3. Run the installation executable. Note: In some cases when in stalling on a SUSE Linux operating system, you may see the following message. This message can safely be ignored: "awk: error while loading shared libraries: libdl.so.2: cannot open shared object file: No such file or directory." 4. After reading the information in the Introduction window of the installation wizard, click Next. 5. Read and accept the terms of the EMC Software License Agreement, and click Next. 6. On the Choose Install Set page of the installation wizard, select the components you want to install. Click Next. 7. On the Clients Unavailable page, note that the ASR Studio and ASR Console client applications can be installed only on Microsoft Windows machines. Click Next. 8. On the Installation Requirements page, read and verify that all requirements have been met (refer to Installing Prerequisite Software on page 3-3). If necessary, use the link provided to update the system with any required components not yet installed, or click Cancel to end the installation and manually update. When ready, click Next. 9. On the Choose Install Folder screen, choose the folder in which you want to install ASR. 10. On the ASR Server s Root Folder page, select the path in which you want the ASR Server program to maintain your development and production files. You can browse using the [Choose...] button, if the default location is not where you would like the files to reside. When ready, click Next. Installation 3-5

26 3 Installing ASR (Unix) 11. On the Documentum Database Storage page, select Logical document storage in database capability if desired. This option enables portions of a document to be stored in a relational database to facilitate faster ingestion and search retrieval. Click Next. 12. On the Database Selections page, if you elected to utilize the Logical document storage in database capability option, or the Mining Plug-in was chosen from the Install Set page, you must choose whether to use an SQL Server or Oracle database. You can select both database types depending on the requirements of your environment. For example, you may have older reports stored in a legacy Microsoft SQL database while newer reports are stored in an Oracle database. When ready, click Next. 13. Depending on the selected database, one of the following pages displays. If you selected a Microsoft SQL Server 2005 database, the MS SQL Server 2005 JDBC Drivers Location page displays. Enter the location of the JDBC drivers. Click Next. If you selected an Oracle database, the Oracle JDBC Drivers Location page displays. Enter the location of the JDBC drivers. Click Next. 14. On the Server Failure Notification page, provide information about delivering an message to one or more recipients in the event that ASR Server fails while processing. Enter the appropriate information and click Next. This is an optional configuration. 15. The Transformation Plugin Registration Required page is a reminder to register the transform plug-ins that were selected for installation. The relevant section of the Installation Guide is named for reference. When ready, click Next. 16. Review the details on the Pre-Installation Summary page and click Install. 17. The components of ASR are installed. Installation proceeds, and displays several more screens, some 3-6 EMC Documentum Archive Services for Reports Installation Guide

27 Installing ASR (Unix) 3 with reminders to consult further sections in the installation documentation. A progress bar in the Installing ASR Processing Server page shows that installation is continuing. 18. A reminder is displayed regarding enabling retrieval of logical documents using Documentum. Refer to Enabling Retrieval of Logical Documents Using Documentum on page A-6 for this information. Click Next. 19. The Post-Install Actions Required page makes reference to the next section of this present chapter. Click Next. 20. The Installation Complete page indicates that the software installation has finished successfully. Click Done. Post-Installation Notes If the installation was performed while logged on as a user other than root, you must update the owner of checkpassword as follows: 1. Navigate to the install location. 2. Navigate into the bin directory (e.g., /opt/emc/documentum_asr/processingserver/bin). 3. You must give checkpassword root user permissions. Perform a chown root checkpassword. You must run this command as a root user. In addition to giving checkpassword root owner permissions, you must modify the sticky bit to allow this executable to be run as root by non-root users. Perform the following command: $ chmod +s./checkpassword 4. Verify the configuration by performing a ls -l to display the permissions. The results displayed should be similar to the following: -r-sr-s--x 1 root admin Dec checkpassword Installation 3-7

28 3 Installing ASR (Unix) In this example, the group is admin. Your group should be the same as the group of the user that installed ASR processing server (e.g., dmadmin). You can run the following two commands to set the permissions correctly: chmod o+x checkpassword chmod ug+s checkpassword 5. Run start_server to start the ASR processing server. Each time you run the start_server script, a new script called stop_server is created. To stop the ASR processing server, run stop_server. Note: If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details. 3-8 EMC Documentum Archive Services for Reports Installation Guide

29 Invisible Body Tag A Upgrading from Previous Versions This appendix provides instructions on upgrading from a previous release of ASR Server to version 1.7 SP1, and includes the following sections: System Requirements...A-2 Upgrading from Versions 1.5 and 1.7 to Version 1.7 SP1...A-3 Upgrading from Version 1.4 and Earlier to Version 1.7 SP1...A-7 Upgrading from Previous Versions A-1

30 A Upgrading from Previous Versions System Requirements Before performing an upgrade you must ensure that your environment meets the minimum hardware and software requirements for ASR 1.7 SP1. Refer to the following requirements: Microsoft Windows prerequisite software Installing Prerequisite Software on page 2-3 Unix prerequisite software Installing Prerequisite Software on page 3-3 EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements. A-2 EMC Documentum Archive Services for Reports Installation Guide

31 Upgrading from Previous Versions A Upgrading from Versions 1.5 and 1.7 to Version 1.7 SP1 This section explains how to upgrade from version 1.5.x through 1.7 of Archive Services for Reports to version 1.7 SP1. Prerequisites Upgrading from ASR versions 1.5 and 1.7 to ASR version 1.7 SP1 requires that you uninstall the previous version of ASR. To ensure business continuity, you should first copy any important information from the prevous ASR version 1.x.x installation directory (C:\Program Files\Documentum_ASR\) to a temporary location so that it can be referenced later in the upgrade process. Important information includes: The ASR config directory which typically contains references to ASR projects you want to retain. The ASR Server directory which typically contains ASR Workspace and Project files. Licenses for any Crawford Technologies PRO suite of print stream conversion products. This area gets overwritten with temorary licences which have a newer timestamp, when ASR 1.7 SP1 is installed. Windows %ALLUSERSPROFILE%\Application Data\crawfordtech Unix /usr/local/crawfordtech/ Uninstalling earlier versions of ASR Microsoft Windows Before installing version 1.7 SP1, you must uninstall the previous version. This section describes procedures for uninstalling on Microsoft Windows and Unix. IMPORTANT: Ensure you have read Prerequisites on page A-3. To uninstall earlier versions on Microsoft Windows: Upgrading from Versions 1.5 and 1.7 to Version 1.7 SP1 A-3

32 A Upgrading from Previous Versions 1. Click Start > Settings > Control Panel. The Control Panel window appears. 2. Select Add or Remove Programs. 3. Locate Documentum ASR in the Add or Remove Programs window, and choose to uninstall it. 4. Close the Add or Remove Programs window and the Control Panel window. Unix IMPORTANT: Ensure you have read Prerequisites on page A-3. To uninstall earlier versions of ASR on Unix: 1. Navigate to the current ASR Server installation location 2. Run the uninstaller binary file located in the uninstall directory. Installing Version 1.7 SP1 Install version 1.7 SP1 of ASR using the instructions found in one of the following sections: Installing ASR (Microsoft Windows) on page 2-1 Installing ASR (Unix) on page 3-1 A-4 EMC Documentum Archive Services for Reports Installation Guide

33 Upgrading from Previous Versions A Copying the Configuration Files After installing ASR version 1.7 SP1, copy the configuration files according to the table below: Table A-1 Configuration File Locations Operating System Copy Copy Files To Windows UNIX Crawford Technologies PRO suite licenses, if any The following files (if they exist): asr_studio.config asr_console.config fopcfg.xml system.ini From the temporary location for the config directory established in Prerequisites on page A-3. The following files (if they exist): fopcfg.xml system.ini From the temporary location for the config directory established in Prerequisites on page A-3. Any files copied to a temporary location, per the Prerequisites on page A-3. C:\Program Files\EMC\Documentum_ASR\ ProcessingServer\config /opt/emc/documentum_asr/ servers/config Windows: %ALLUSERSPROFILE%\Applica tion Data\crawfordtech Unix: /usr/local/crawfordtech/ Upgrading from Versions 1.5 and 1.7 to Version 1.7 SP1 A-5

34 A Upgrading from Previous Versions Copying the Workspaces and Project Files After installing ASR version 1.7 SP1, move the Workspaces and Project files according to the table below: Table A-2 Workspaces and Project File Locations Operating System Copy Copy Files To... Windows UNIX All folders and files within the the temporary location for the Server directory established in Prerequisites on page A-3. All folders and files within the the temporary location for the Server directory established in Prerequisites on page A the location you selected in the ASR Common Root Folder screen during installation. The default path for this location is: C:\EMC\Documentum_ASR\ ProcessingServer /opt/emc/documentum_asr/ servers Enabling Retrieval of Logical Documents Using Documentum If you are using Documentum Webtop and Documentum Administrator (DA) for retrieval of logical documents, please follow the instructions the EMC Archive Services for Reports Extern Store Plug-in Installation Guide to complete the setup. Verifying Your Projects With any upgrade of ASR, it is important for the user to verify that all projects still run as with the previous release of ASR by running them using ASR Studio 1.7 SP1 and ASR Processing Server 1.7 SP1. A-6 EMC Documentum Archive Services for Reports Installation Guide

35 Upgrading from Previous Versions A Upgrading from Version 1.4 and Earlier to Version 1.7 SP1 This section explains how to upgrade from versions 1.4 and earlier of Archive Services for Reports to version 1.7 SP1. Prerequisites Upgrading to ASR version 1.7 SP1 requires that you uninstall the previous version of ASR. To ensure business continuity, you should first copy any important information from the ASR version 1.4 installation directory (C:\Program Files\Acartus\ApertureONE) to a temporary location so that it can be referenced later in the upgrade process. Important information includes: The ASR 1.4 config directory which typically contains references to ASR projects you want to retain. The ASR 1.4 Server directory which typically contains ASR Workspace and Project files. Licenses for any Crawford Technologies PRO suite of print stream conversion products. This area gets overwritten with temorary licences which have a newer timestamp, when ASR 1.7 SP1 is installed. Windows %ALLUSERSPROFILE%\Application Data\crawfordtech Unix /usr/local/crawfordtech/ Considerations Understand the following considerations: If you intend to use a Documentum repository with ASR 1.7 SP1, the database must be case-sensitive. If you intend to use a StoreInArchive repository with ASR 1.7 SP1, you can continue to use the existing ASR 1.4 database if it was created as not case sensitive. If the database is case-sensitive, you will need to create a new database association and configure that database as case-sensitive. Upgrading from Version 1.4 and Earlier to Version 1.7 SP1 A-7

36 A Upgrading from Previous Versions Uninstalling Version 1.4 Before installing version 1.7 SP1, you must uninstall version 1.4. This section describes procedures for uninstalling on Microsoft Windows or Unix. Microsoft Windows IMPORTANT: Ensure you have read Prerequisites on page A-3. To uninstall ASR version 1.4 on Microsoft Windows: 1. Click Start > Settings > Control Panel. The Control Panel window appears. 2. Select Add or Remove Programs. 3. Locate Acartus - ApertureONE Processing Server in the Add or Remove Programs window, and choose to uninstall it. 4. Close the Add or Remove Programs window and the Control Panel window. Unix IMPORTANT: Ensure you have read Prerequisites on page A-3. To uninstall ASR version 1.4 on Unix: 1. Navigate to the current ASR Server installation location 2. Run the uninstaller binary file located in the Uninstall_Acartus ApertureONE Processing Server directory. Installing Version 1.7 SP1 Install version 1.7 SP1 of ASR using the instructions found in one of the following sections: Installing ASR (Microsoft Windows) on page 2-1 Installing ASR (Unix) on page 3-1 A-8 EMC Documentum Archive Services for Reports Installation Guide

37 Upgrading from Previous Versions A Copying the Configuration Files After installing ASR version 1.7 SP1, copy the configuration files according to the table below: Table A-3 Configuration File Locations Operating System Copy Copy Files To Windows UNIX Crawford Technologies PRO suite licenses, if any The following files (if they exist): a1studio.config a1console.config fopcfg.xml system.ini From the temporary location for the config directory established in Prerequisites on page A-3. The following files (if they exist): fopcfg.xml system.ini From the temporary location for the config directory established in Prerequisites on page A-3. Any files copied to a temporary location, per the Prerequisites on page A-3. C:\Program Files\EMC\Documentum_ASR\ ProcessingServer\config You must also rename the following files: a1studio.config to asr_studio.config a1console.config to asr_console.config /opt/emc/documentum_asr/ servers/config Windows: %ALLUSERSPROFILE%\Application Data\crawfordtech Unix: /usr/local/crawfordtech/ Upgrading from Version 1.4 and Earlier to Version 1.7 SP1 A-9

38 A Upgrading from Previous Versions Copying the Workspaces and Project Files After installing ASR version 1.7 SP1, move the Workspaces and Project files according to the table below: Table A-4 Workspaces and Project File Locations Operating System Copy Copy Files To... Windows All folders and files within the the temporary location for the Server directory established in Prerequisites on page A the location you selected in the ASR Common Root Folder screen during installation. The default path for this location is: C:\EMC\Documentum_ASR\ ProcessingServer UNIX All folders and files within the the temporary location for the Server directory established in Prerequisites on page A-3. /opt/emc/documentum_asr/ servers Enabling Retrieval of Logical Documents Using Documentum If you are using Documentum Webtop and Documentum Administrator (DA) for retrieval of logical documents, please follow the instructions the EMC Archive Services for Reports Extern Store Plug-in Installation Guide to complete the setup. Verifying Your Projects With any upgrade of ASR, it is important for the user to verify that all projects still run as with the previous release of ASR by running them using ASR Studio 1.7 SP1 and ASR Processing Server 1.7 SP1. A-10 EMC Documentum Archive Services for Reports Installation Guide

39 Upgrading from Previous Versions A Uninstalling Version 1.7 SP1 If for some reason you need to uninstall ASR version 1.7 SP1, you can follow the steps in this section, for both Microsoft Windows and Unix. Microsoft Windows To uninstall ASR version 1.7 SP1 on Microsoft Windows: 1. Click Start > Settings > Control Panel. The Control Panel window appears. 2. Select Add or Remove Programs. 3. Locate ASR Processing Server in the Add or Remove Programs window, and choose to uninstall it. 4. Close the Add or Remove Programs window and the Control Panel window. The removal process displays some status screens, and may display the results messages similar to the ones in Figure A-1. Figure A-1 Uninstall Complete -- Messages Uninstalling Version 1.7 SP1 A-11

40 A Upgrading from Previous Versions The uninstall process is designed not to remove the directories where your project information is stored. Therefore, the following messages are merely informational, and not a warning: Unable to remove directory C:\EMC\Documentum_ASR\servers\production Unable to remove directory C:\EMC\Documentum_ASR\servers\development Having uninstalled ASR 1.7 SP1, your ASR 1.7 SP1 project information remains. In the case where you want to reinstall the software your project information is ready to be made use of. On Windows, the default location for these is C:\EMC\Documentum_ASR\servers\. If you chose a different server project location, the pathnames in the Uninstall Complete -- Messages screen would be different. Unix IMPORTANT: Ensure you have read Prerequisites on page A-3. To uninstall ASR version 1.7 SP1 on Unix: 1. Navigate to the current ASR Server installation location. 2. Run the uninstaller binary file located in the uninstall directory. A-12 EMC Documentum Archive Services for Reports Installation Guide

41 Invisible Body Tag B Installing Transform Plug-in Licenses This appendix provides instructions on obtaining and activating a license for each of the transform plug-ins available for ASR, and includes the following sections: Overview... B-2 Obtaining and Installing the License Key... B-3 Installing Transform Plug-in Licenses B-1

42 B Installing Transform Plug-in Licenses Overview EMC has embedded products from the Crawford Technologies PRO suite of print stream conversion products into EMC Documentum Archive Services for Reports as plug-ins. The ASR installation program installs plug-ins that support the following conversions: AFP to PDF AFP to PDF/A Metacode DJDE to PDF Metacode DJDE to PDF/A PCL to PDF PCL to PDF/A Postscript to PDF Postscript to PDF/A How It Works The transform plug-ins are licensed using a single license key file which enables one or more transform to be used in a production environment. Although transform plug-ins will function without the license key, the output will include a watermark which indicates the plug-in is running with an evaluation license. Requesting Additional Licenses If you have requested and obtained a license key for one or more transform plug-ins, and subsequently want to add more transform plug-ins to the license key, you must repeat the procedure described in Obtaining and Installing the License Key on page B-3. This enables you to to obtain a replacement license key that supports the additional transform plug-ins. B-2 EMC Documentum Archive Services for Reports Installation Guide

43 Installing Transform Plug-in Licenses B Obtaining and Installing the License Key To obtain a license key for a transform plug-in, you must generate a system key from the ASR server, the system key output to EMC (along with some required information), receive the license key from EMC, and install the key. To obtain a license key: 1. The ASR installation includes a system key generation application named ctsyskey. Locate the application in the ASR installation directory as shown in Table B-1: Table B-1 System Key Generation Application Location Platform Microsoft Windows IBM AIX Sun Solaris HP-UX Linux Location ASR_INSTALL_DIR\Crawford\ctsyskey\windows ASR_INSTALL_DIR/Crawford/ctsyskey/aix ASR_INSTALL_DIR/Crawford/ctsyskey/solaris ASR_INSTALL_DIR/Crawford/ctsyskey/hpux ASR_INSTALL_DIR/Crawford/ctsyskey/linux 2. Run the system key generation application. The application generates output similar to the following: CTISYSKEY_BEGIN=====> AD15FC56AB6C3D4A5199E67B DB CFA1D A0D6B5A91B8D0B7316B CBBEB0A922289F3A594B3519B EACBEFBE2655 <=====CTISYSKEY_END 3. Do one of the following: Copy the output Redirect the output from ctsyskey to a file using standard file redirection command such as ctsyskey > syskey.txt 4. Paste the output in an message addressed to ASR_Licensing@emc.com. The must also include the following information: The name of all transform plug-ins to be licensed Obtaining and Installing the License Key B-3

44 B Installing Transform Plug-in Licenses The name of the company that licensed the transform plug-ins The contact information of the individual where the license key should be sent, including: Name address Phone The name of the host machine on which the transform plug-in(s) will be run The host machine operating system environment When the request is received, EMC will generate a license key file and upload it to the your customer account in the EMC Download Center at emc.subscribenet.com. If this license key file is not available in the Download Center within 48 hours of receiving an order notification from the licensing team, you can contact the licensing team at ASR_Licensing@emc.com. 5. Place the license key file (prolcnse.lic) in the appropriate location for your processing server platform: Windows %ALLUSERSPROFILE%\application data\crawfordtech Unix /usr/local/crawfordtech/ B-4 EMC Documentum Archive Services for Reports Installation Guide

45 Invisible Body Tag C Installing and Configuring RPS for Use with ASR This appendix provides instructions for installing Retention Policy Services (RPS) on the Documentum Content Server for use with ASR, and includes the following sections: Installing RPS on the Documentum Repository... C-2 Operating Environments with ASR... C-3 Troubleshooting... C-8 Installing and Configuring RPS for Use with ASR C-1

46 C Installing and Configuring RPS for Use with ASR Installing RPS on the Documentum Repository To configure RPS on the repository, for use with ASR: 1. At the time of installation of repository, choose to install Retention Policy Services and enter the key that you received with your license. 2. Also download the following from Documentum Retention Policy Services Content Server Files for windows Documentum Retention Policy Services DocApp 3. On the Content Server host, extract the contents of Documentum Retention Policy Services Content Server Files for windows and run rpsserverwinsetup.exe. This installs the files needed for RPS. 4. Using Documentum Application Installer, install the Documentum Retention Policy Services DocApp on the repository. C-2 EMC Documentum Archive Services for Reports Installation Guide

47 Installing and Configuring RPS for Use with ASR C Operating Environments with ASR ASR has been tested with RPS in several Documentum environments. ASR with DFC 5.3 and 5.3 Content Server Ingestion of reports into an RPS-enabled folder works fine using a normal installation of DFC 5.3 against an RPS-enabled 5.3 repository. No Global Registry entry is required in the dfc.properties file. ASR with DFC 6 and 6.0 Content Server On the DFC client, Global Registry entry in C:\Documentum\Config\dfc.properties is mandatory; for details refer to Global Registry settings in dfc.properties file on page C-6. Also, this client must be registered as a "privileged" client in the Global Repository. This can be achieved through Documentum Administrator. The steps are detailed below: 1. Logon to the repository using Documentum Administrator (DA). Click the node "Privileged Clients" on the left side browsertree. Figure C-1 Click "Privileged Clients" on the left pane Operating Environments with ASR C-3

48 C Installing and Configuring RPS for Use with ASR 2. From the File menu, click "Manage Clients" Figure C-2 Click "Manage Clients" on the file menu C-4 EMC Documentum Archive Services for Reports Installation Guide

49 Installing and Configuring RPS for Use with ASR C 3. A "Manage Clients" dialog appears. Select the client you want to register as a "privileged client" from the left pane and add it to the right pane by clicking the right arrow. Click OK to close the dialog. Figure C-3 Manage Clients dialog Operating Environments with ASR C-5

50 C Installing and Configuring RPS for Use with ASR 4. Right click on the client you just added and click "Approve Privilege". Figure C-4 Approving Privilege for selected client This DFC 6 client is now a "privileged client". ASR is now ready to ingest documents into an RP-enabled folder. ASR with DFC 6 and 5.3 Content Server When ASR is run with DFC 6, Global Registry setting in C:\Documentum\Config\dfc.properties is mandatory. Without this, ingestion does not happen. Also, there is no concept of Privileged Client here since the repository being used is pre D6. Ingestion into an RP-enabled folder happens when the Global Registry setting is configured in dfc.properties file on the client side (the same system on which ASR is installed). Global Registry settings in dfc.properties file When ASR is running on a system with DFC 6 (or greater) installed, the following entries are required in the C-6 EMC Documentum Archive Services for Reports Installation Guide

51 Installing and Configuring RPS for Use with ASR C C:\Documentum\Config\dfc.properties file on both the Content Server and the DFC client running ASR: dfc.globalregistry.repository=<name of repository config d as global registry> dfc.globalregistry.username=<usually it is dm_bof_registry> dfc.globalregistry.password=<password of dm_bof_registry user> At the time of installation of a repository, the user is asked if he wants to configure the repository to be a Global Registry. If he chooses yes, he would be asked to choose a password for dm_bof_registry user. The dfc.properties file on the Content Server will then be updated with these values. The same values need to be copied to the dfc.properties file on the DFC client system where ASR is running. Note: These global registry settings are required only when ASR is running on a system with DFC 6 or greater, installed. Operating Environments with ASR C-7