Records Manager Installation Guide Version 5.3 SP4 December 2006
Copyright 1994-2006 EMC Corporation
Table of Contents Preface... 7 Chapter 1 About your download folder... 9 Chapter 2 Overview of the RM Installation Process... 11 Chapter 3 Installing RM... 13 Installing RM Content Server files on Windows... 13 Installing RM Content Server files on Unix/Linux Hosts... 14 Installing RM Application Server files on Windows... 14 Installing RM Application Server files on Unix/Linux Hosts... 15 Installing RM DocApps on Windows... 15 Installing RM DocApps on Unix and Linux hosts... 17 Chapter 4 Upgrading RM 5.3 SP3 Hot x to RM 5.3 SP4... 19 Chapter 5 Upgrading RM 5.3 SP3 to RM 5.3 SP3 Hot x... 21 Chapter 6 Upgrading RPS 5.3 SP3 to RM 5.3 SP3 Hot x... 23 Chapter 7 Upgrading RPS 5.3 SP2 to RM 5.3 SP3 Hot x... 25 Chapter 8 Upgrading RPS 5.3 SP1 or Earlier to RM 5.3 SP3 Hot x... 29 Chapter 9 Uninstalling Content Server les and Application Server les... 31 Chapter 10 Con guring RM... 33 Chapter 11 Con guring RM Event Auditing... 35 Chapter 12 Installing Records Manager Outlook Activator for Records Email... 39 Appendix A Installing Brava! Webtop Server for RM... 43 Records Manager Installation Guide 3
Table of Contents List of Figures Figure A 1. RMA Webtop alias... 43 4 Records Manager Installation Guide
Table of Contents List of Tables Records Manager Installation Guide 5
Table of Contents 6 Records Manager Installation Guide
Preface This guide provides step-by-step instructions for installing the various components of Documentum Records Manager 5.3 SP4 (RM 5.3 SP4). The Records Manager client, Records Manager Administrator (RMA), displays the RM node and the RPS node. RPS functionality however, is disabled until you have the RPS node activated with a license key. Procedures are provided so that RM can be installed with the mandatory DocApps to declare formal records. Although you can declare formal records with the mandatory DocApps, you will need to install on top of the mandatory DocApps, one or two optional DocApps to declare formal records according to DoD 5015.2 Chapter 2 and DoD 5015.4 Chapter 4 specifications. If your organization requires it, you can install the Chapter 2 DocApp without the Chapter 4 DocApp to declare Chapter 2 formal records only, or you can install both Chapter 2 and Chapter 4 DocApps to declare Chapter 2 and Chapter 4 formal records. Note: Upgrading from any previous legacy Records Manager installation is not supported. Intended Audience This guide is intended for the system administrator or IT professional who installs enterprise software. Installing Records Manager Administrator requires administrative access to the computers on which the components are installed. Revision History The following changes have been made to this document. Records Manager Installation Guide 7
Preface Revision History Revision Date December 2006 Description 5.3 SP4 8 Records Manager Installation Guide
About your download folder Chapter 1 You will need to create a folder to contain Records Manager when it is downloaded from the EMC Software Support Site. The folder in which you download and extract the files that constitute your RM software is referred to in this document as your download folder. Note: The downloaded file is compressed and must be decompressed to gain access to the files within. To decompress the file, you will need WinZip from WinZip Computing, Inc. If you do not have WinZip installed, you can visit www.winzip.com to obtain a copy of the software. Unix files are in.tar format. There is no need to install any application to untar the.tar files. The download folder can be on either a local or network drive. Records Manager Installation Guide 9
About your download folder 10 Records Manager Installation Guide
Chapter 2 Overview of the RM Installation Process Procedures are provided to install RM on both Windows and Unix platforms. Using installers, RM is typically deployed on two servers: Content Server Application Server Note: If a version of RM previous to 5.3 SP4 is already installed, uninstall both the Content Server files and the Application Server files, then follow the upgrade procedure applicable to the version of RM already installed before you run any installer. The DocApps however should not be removed or uninstalled. The upgrade script will take care of the DocApps. Make sure RM is upgraded to the 5.3 SP3 Hotfix release before it is upgraded to 5.3 SP4. The RM application contains the Retention Policy Services (RPS) product built-in. Although built-in, you may use the products independently or in conjunction. RMA displays the RM node and, the RPS node when activated with a license key. RM 5.3 SP4 is comprised of several components. It is assumed that a supported DBMS, Application Server, and a 5.3 SP3 or SP4 Content Server repository have been previously configured. Records Manager Installation Guide 11
Overview of the RM Installation Process 12 Records Manager Installation Guide
Installing RM Chapter 3 Note: Use these procedures only if you are installing Records Manager for the first time. Otherwise, refer to the applicable upgrade procedure consistent with the version of Records Manager that is already installed. This chapter contains the following installation procedures: Follow these procedures in the order provided according to the applicable operating system. Follow procedures 1, 3, 5, and ignore the others if you are performing a Windows installation of RM. Or, follow procedures 2, 4, 6, and ignore the others if you are performing a Unix or Linux installation of RM. 1. Installing RM Content Server files on Windows, page 13 2. Installing RM Content Server files on Unix/Linux Hosts, page 14 3. Installing RM Application Server files on Windows, page 14 4. Installing RM Application Server files on Unix/Linux Hosts, page 15 5. Installing RM DocApps on Windows, page 15 6. Installing RM DocApps on Unix and Linux hosts, page 17 Installing RM Content Server les on Windows To complete the RM installation, the RM Server Files for the Content Server must be installed. The RM Server files provide the necessary support for RM on the Content Server. Follow these steps to install the RM Server Files: 1. Log in to the Content Server host as the Content Server installation owner. 2. Copy the RM server files program, Records_Manager_Server_Files_5.3_SP4_ windows.exe, to a temporary directory on the Content Server host. 3. Unzip the file. 4. Double-click rmaserverwinsetup.exe. The Welcome dialog box is displayed. 5. Click Next. 6. Choose I Agree to the license terms. Records Manager Installation Guide 13
Installing RM 7. Click Next. 8. Follow the on-screen prompts to finish the installation. 9. Restart the Documentum Java Method Server from the services applet in the Control Panel. Installing RM Content Server les on Unix/Linux Hosts Follow these steps to complete the RM Server Files installation on a Unix or Linux host: 1. Log in to the Content Server host as the Content Server installation owner. 2. Copy the RM server files program, Records_Manager_Server_Files_5.3_SP4_xx.tar (where xx is the particular platform specific environment Solaris, HPUX etc.), to a temporary directory on the Content Server host. 3. Decompress the file. To decompress, type: tar -xvf <filename> 4. Run the rmaserverxxsetup.bin program. The files are installed on the Content Server host. 5. Click Next. 6. Choose I Agree to the license terms. 7. Click Next. 8. Follow the on-screen prompts to finish the installation. 9. Disconnect from the Content Server host. Installing RM Application Server les on Windows To install RM application server les on Windows: 1. Extract the files contained in the Records_Manager_5.3_SP4_windows.zip archive to a temporary directory on the Application Server host. 2. Launch the installation process by double-clicking the rmawinsetup.exe file from this temporary directory. 3. Follow the on-screen prompts to complete the installation of RM on the Application Server. 14 Records Manager Installation Guide
Installing RM Installing RM Application Server les on Unix/Linux Hosts To install RM application server les on Unix: 1. Extract the files contained in the Records_Manager_5.3_SP4_xx.tar (where xx is the particular platform specific environment Solaris, HPUX etc.) archive to a temporary directory on the Application Server host. 2. Launch the installation process by running rmaxxsetup.bin file from the temporary directory. 3. Follow the on-screen prompts to complete the installation of RM on the Application Server. Installing RM DocApps on Windows Although you can install up to 6 DocApps for a complete installation of RM, only 3 are mandatory to get RM up and running. The DocApps must be installed in the order listed: 1. RPS DocApp (rpsdocapp.tar), mandatory 2. RM DocApp (rmdocapp.tar), mandatory 3. Forms Builder DocApp (BPM-Forms.zip), mandatory Note: If the BPM-Forms DocApp fails to install, make sure that xforms.jar is on the Classpath. If you are upgrading RM 5.3 SP3 to RM 5.3 SP4, do not install the Forms Builder DocApp. 4. RM Default DocApp (RM_Defaultdocapp.tar), optional 5. DoD Chap 2 DocApp (rm_dod5015_2_docapp.tar), optional 6. DoD Chap 4 DocApp (rm_dod5015_4_docapp.tar), optional Install the RM Default DocApp: If you intend to create Formal Records. If you intend to install the Chapter 2 DocApp and also wish to use the Naming Policy and Forms templates found in the RM Default DocApp. If you would like to have a sample File Plan installed. Do not install the RM Default DocApp: Records Manager Installation Guide 15
Installing RM If you do not intend to create formal records nor use the Chapter 2 DocApp functionality. If you intend to create Formal Records or use Chapter 2 functionality and plan to create your own Naming Policy(s) and Form Templates. If you are planning to create Chapter 4 formal records, the Chapter 4 DocApp must not be installed independently of the Chapter 2 DocApp and it must be installed only after the Chapter 2 DocApp is installed. Although Chapter 2 functionality is possible without the Chapter 4 DocApp, Chapter 4 functionality is dependant on both Chapter 2 and Chapter 4 DocApps. Note: The DocApp files must be extracted from the files listed above to a temporary folder location and run by the Documentum Application Installer (DAI 5.3 SP4) to install the various DocApps. You must use DAI 5.3 SP4 to install the DocApps. The various DocApps must be installed in each Docbase that is to be used with RM. This can be done from any host that has the Documentum Application Installer (DAI) and that can communicate with the Content Server. The instructions below demonstrate the first DocApp installation of the RPS DocApp. Follow the same process to install the remaining mandatory DocApps (or any optional DocApps) in the order specified above. You must install the four mandatory DocApps in each repository that is to be used with RM. To install the RPS DocApp in a Windows repository: 1. Extract and copy rpsdocapp.tar to a temporary folder on a server that has DAI 5.3 SP4 installed. 2. Perform the following substeps to install the RPS DocApp. a. Click Start Programs Documentum Application Installer. b. Connect to the Docbase as the installation owner. c. Browse to the temporary folder called rps where the rpsdocapp.tar file is extracted. Your selection appears in the Application Installer window. d. Click OK to proceed to the installation screen. e. Click Start Installation from the Application Installer window to begin the process of updating the DocApp for the Docbase. The installation is complete when the Quit installer button becomes available. f. View the file rps_installerlog.html for any errors. 3. Repeat the process in order to install the remaining mandatory DocApps. 16 Records Manager Installation Guide
Installing RM Installing RM DocApps on Unix and Linux hosts Although you can install up to 6 DocApps for a complete installation of RM, only 3 are mandatory to get RM up and running. The DocApps must be installed in the order listed: 1. RPS DocApp (rpsdocapp.tar) 2. RM DocApp (rmdocapp.tar) 3. Forms Builder DocApp (BPM-Forms.zip) Note: If the BPM-Forms DocApp fails to install, make sure that xforms.jar is on the Classpath. 4. RM Default DocApp (RM_Defaultdocapp.tar), optional 5. DoD Chap 2 DocApp (rm_dod5015_2_docapp.tar), optional 6. DoD Chap 4 DocApp (rm_dod5015_4_docapp.tar), optional Install the RM Default DocApp: If you intend to create Formal Records. If you intend to install the Chapter 2 DocApp and also wish to use the Naming Policy and Forms templates found in the RM Default DocApp. If you would like to have a sample File Plan installed. Do not install the RM Default DocApp: If you do not intend to create formal records nor use the Chapter 2 DocApp functionality. If you intend to create Formal Records or use Chapter 2 functionality and plan to create your own Naming Policy(s) and Form Templates. If you are planning to create Chapter 4 formal records, the Chapter 4 DocApp must not be installed independently of the Chapter 2 DocApp and it must be installed only after the Chapter 2 DocApp is installed. Although Chapter 2 functionality is possible without the Chapter 4 DocApp, Chapter 4 functionality is dependant on both Chapter 2 and Chapter 4 DocApps. Note: The DocApp files must be extracted from the files listed above to a temporary folder location and run by the Documentum Application Installer (DAI 5.3 SP4) to install the various DocApps. You must use DAI 5.3 SP4 to install the DocApps. The various DocApps must be installed in each Docbase that is to be used with RM. This can be done from any host that has the Documentum Application Installer (DAI 5.3 SP4) and that can communicate with the Content Server. The instructions below demonstrate the first DocApp installation of the RPS DocApp. Follow the same process to install the remaining mandatory DocApps (or any optional Records Manager Installation Guide 17
Installing RM DocApps) in the order specified above. You must install the four mandatory DocApps in each repository that is to be used with RM. To install the RPS DocApp on Unix or Linux hosts: 1. Connect to a Windows host where DAI 5.3 SP4 is installed. Ensure that the dmcl.ini file on the host points to a DocBroker (Connection Broker) that connects to the Unix host. 2. Extract and copy rpsdocapp.tar to a temporary folder on a server that has DAI installed. 3. Perform the following substeps to install the RPS DocApp. a. Click Start Programs Documentum Application Installer. b. Connect to the Docbase as the installation owner. c. Browse to the temporary folder called rps where the rpsdocapp.tar file is extracted. Your selection appears in the Application Installer window. d. Click OK to proceed to the installation screen. e. Click Start Installation from the Application Installer window to begin the process of updating the DocApp for the Docbase. The installation is complete when the Quit installer button becomes available. f. View the file rps_installerlog.html for any errors. 4. Repeat the process in order to update additional Docbases if necessary. 18 Records Manager Installation Guide
Chapter 4 Upgrading RM 5.3 SP3 Hot x to RM 5.3 SP4 To upgrade RM on the Content Sever: 1. Stop the Java Method Server on the Content Server. 2. Uninstall the RM 5.3 SP3 Content Server Files and application server files. On Windows use the Add/Remove programs to remove the RM 5.3 SP3 Content Server files installation. On Unix use the Uninstall script deployed with the original installation. Refer to Chapter 9, Uninstalling Content Server files and Application Server files for complete details. 3. Run the RM 5.3 SP4 Content Server Files installer on the Content Server. On Windows refer to Installing RM Content Server files on Windows, page 13. On Unix refer to Installing RM Content Server files on Unix/Linux Hosts, page 14. 4. Using the Documentum Application Installer 5.3 SP4, install the RM 5.3 SP4 DocApps into the repository (docbase). On Windows refer to Installing RM DocApps on Windows, page 15. On Unix refer to Installing RM DocApps on Unix and Linux hosts, page 17 Note: Review the rm docapp installer log file for possible warnings to determine what actions must be taken if any. 5. Restart your Java Method Server. You must restart (or start if it was stopped) your Java Method Server in your Services, for the changes to take effect. To upgrade RM on the Application Sever 6. Uninstall the RM 5.3 SP3 Application Server files. On Windows use the Add/Remove programs to remove the RM 5.3 SP3 Application Server files installation. On Unix use the Uninstall script deployed with the original installation. 7. Run the RM 5.3 SP4 Application Server Files installer on the Application Server. On Windows refer to Installing RM Application Server files on Windows, page 14. On Unix refer to Installing RM Application Server files on Unix/Linux Hosts, page 15. Records Manager Installation Guide 19
Upgrading RM 5.3 SP3 Hot x to RM 5.3 SP4 The upgrade process for RM 5.3 SP3 Hotfix to RM 5.3 SP4 on the Content Server is now finished. If the Application Server and the Content Server are installed on the same physical host, start the Application Server service. 20 Records Manager Installation Guide
Chapter 5 Upgrading RM 5.3 SP3 to RM 5.3 SP3 Hot x To upgrade RM on the Content Sever: 1. Stop the Java Method Server on the Content Server. 2. Uninstall the RM 5.3 SP3 Content Server Files and Application Server files. On Windows use the Add/Remove programs to remove the RM 5.3 SP3 Content Server files installation. On Unix use the Uninstall script deployed with the original installation. Refer to Chapter 9, Uninstalling Content Server files and Application Server files for complete details. 3. Run the RM 5.3 SP3 Hotfix Content Server Files installer on the Content Server. On Windows refer to Installing RM Content Server files on Windows, page 13. On Unix refer to Installing RM Content Server files on Unix/Linux Hosts, page 14. 4. Using the Documentum Application Installer 5.3 SP3, install the RM 5.3 SP3 Hotfix DocApps into the repository (docbase). On Windows refer to Installing RM DocApps on Windows, page 15. On Unix refer to Installing RM DocApps on Unix and Linux hosts, page 17 Note: Review the rm docapp installer log file for possible warnings to determine what actions must be taken if any. 5. If you previously upgraded from RPS 5.3 SP2 to RM 5.3 SP3, you must perform this step. Skip this step if you installed RM 5.3 SP3 for the first time. Do not run the upgrade script if you installed RM 5.3 SP3 for the first time. Run the rps_upgrade_sp2_sp3.ebs script, using DmBasic.exe. This will modify the Retention Policies and instances of retentions to comply with the RM 5.3 SP3 object model. a. Copy the rps_upgrade_sp2_sp3.ebs script to your C:\Documentum\product\5. 3\bin folder. Records Manager Installation Guide 21
Upgrading RM 5.3 SP3 to RM 5.3 SP3 Hot x b. Open a command prompt (a DOS window), on the Content Server that is hosting the rps repository, and navigate to DOCUMENTUM > product > 5.3 > bin. In general, this will be C:\Documentum\product\5.3\bin. c. Use the following syntax to execute the script: dmbasic.exe f <path and file name to script> e <entry point method name> <docbase_name user_name password> To create a log of the output running from this script, append > rpslog.html to the command-line statement. This will re-direct the output from the command prompt to the file name specified after the > (greater than) character. An example command line would appear as follows: dmbasic frps_upgrade_sp2_sp3.ebs emigrate DCTM_RPS qaadmin qaadmin > c:\temp\rpslog.html Note: The directory \Temp must exist at C:\Temp, otherwise an error will occur. This will upgrade the Docbase called "DCTM_RPS" whose install owner account and password are "qaadmin" while outputting the results to a log file called "rpslog.html" in the C:\Temp directory of the Content Server host machine. Note: You can use your browser to view the log file once the upgrade is complete. 6. Restart your Java Method Server. You must restart (or start if it was stopped) your Java Method Server in your Services, for the changes to take effect. To upgrade RM on the Application Sever 7. Uninstall the RM 5.3 SP3 Application Server files. On Windows use the Add/Remove programs to remove the RM 5.3 SP3 Application Server files installation. On Unix use the Uninstall script deployed with the original installation. 8. Run the RM 5.3 SP3 Hotfix Application Server Files installer on the Application Server. On Windows refer to Installing RM Application Server files on Windows, page 14. On Unix refer to Installing RM Application Server files on Unix/Linux Hosts, page 15. The upgrade process for RM 5.3 SP3 to RM 5.3 SP3 Hotfix on the Content Server is now finished. If the Application Server and the Content Server are installed on the same physical host, start the Application Server service. 22 Records Manager Installation Guide
Chapter 6 Upgrading RPS 5.3 SP3 to RM 5.3 SP3 Hot x To upgrade RM on the Content Sever: 1. Stop the Java Method Server on the Content Server. 2. Uninstall the RPS 5.3 SP3 Content Server Files and Application Server files. On Windows use the Add/Remove programs to remove the RPS 5.3 SP3 Content Server files installation. On Unix use the Uninstall script deployed with the original installation. Refer to Chapter 9, Uninstalling Content Server files and Application Server files for complete details. 3. Run the RM 5.3 SP3 Hotfix Content Server Files installer on the Content Server. On Windows refer to Installing RM Content Server files on Windows, page 13. On Unix refer to Installing RM Content Server files on Unix/Linux Hosts, page 14. 4. Using the Documentum Application Installer 5.3 SP3, install the RM 5.3 SP3 Hotfix DocApps into the repository (docbase). On Windows refer to Installing RM DocApps on Windows, page 15. On Unix refer to Installing RM DocApps on Unix and Linux hosts, page 17 5. If you previously upgraded from RPS 5.3 SP2 to RPS 5.3 SP3, you must perform this step. Skip this step if you installed RPS 5.3 SP3 for the first time. Do not run the upgrade script if you installed RPS 5.3 SP3 for the first time. Run the rps_upgrade_sp2_sp3.ebs script, using DmBasic.exe. This will modify the Retention Policies and instances of retentions to comply with the RPS 5.3 SP3 object model. a. Copy the rps_upgrade_sp2_sp3.ebs script to your C:\Documentum\product\5. 3\bin folder. b. Open a command prompt (a DOS window), on the Content Server that is hosting the rps repository, and navigate to DOCUMENTUM > product > 5.3 > bin. In general, this will be C:\Documentum\product\5.3\bin. c. Use the following syntax to execute the script: Records Manager Installation Guide 23
Upgrading RPS 5.3 SP3 to RM 5.3 SP3 Hot x dmbasic.exe f <path and file name to script> e <entry point method name> <docbase_name user_name password> To create a log of the output running from this script, append > rpslog.html to the command-line statement. This will re-direct the output from the command prompt to the file name specified after the > (greater than) character. An example command line would appear as follows: dmbasic frps_upgrade_sp2_sp3.ebs emigrate DCTM_RPS qaadmin qaadmin > c:\temp\rpslog.html Note: The directory \Temp must exist at C:\Temp, otherwise an error will occur. This will upgrade the Docbase called "DCTM_RPS" whose install owner account and password are "qaadmin" while outputting the results to a log file called "rpslog.html" in the C:\Temp directory of the Content Server host machine. Note: You can use your browser to view the log file once the upgrade is complete. 6. Restart your Java Method Server. You must restart (or start if it was stopped) your Java Method Server in your Services, for the changes to take effect. To upgrade RPS to RM on the Application Sever 7. Uninstall the RPS 5.3 SP3 Application Server files. On Windows use the Add/Remove programs to remove the RPS 5.3 SP3 Application Server files installation. On Unix use the Uninstall script deployed with the original installation. 8. Run the RM 5.3 SP3 Hotfix Application Server Files installer on the Application Server. On Windows refer to Installing RM Application Server files on Windows, page 14. On Unix refer to Installing RM Application Server files on Unix/Linux Hosts, page 15. The upgrade process for RPS 5.3 SP3 to RM 5.3 SP3 Hotfix on the Content Server is now finished. If the Application Server and the Content Server are installed on the same physical host, start the Application Server service. 24 Records Manager Installation Guide
Chapter 7 Upgrading RPS 5.3 SP2 to RM 5.3 SP3 Hot x To upgrade RPS to RM on the Content Sever: 1. Upgrade Content Server from 5.3 SP2 to 5.3 SP3. Refer to Content Server 5.3 SP3 Installation Guide for complete details if necessary. 2. Use the Content Server configurator to upgrade the repository (docbase) from 5.3 SP2 to 5.3 SP3. Refer to Content Server 5.3 SP3 Installation Guide for complete details if necessary. 3. Stop the Java Method Server on the Content Server. 4. Uninstall the RPS 5.3 SP2 Content Server Files and the Application Server files. On Windows use the Add/Remove programs to remove the RPS 5.3 SP2 Content Server files installation. On Unix use the Uninstall script deployed with the original installation. Refer to Chapter 9, Uninstalling Content Server files and Application Server files for complete details. 5. Run the RM 5.3 SP3 Hotfix Content Server Files installer on the Content Server. On Windows refer to Installing RM Content Server files on Windows, page 13. On Unix refer to Installing RM Content Server files on Unix/Linux Hosts, page 14. 6. Using the Documentum Application Installer 5.3 SP3, install the RM 5.3 SP3 Hotfix DocApps into the repository (docbase). On Windows refer to Installing RM DocApps on Windows, page 15. On Unix refer to Installing RM DocApps on Unix and Linux hosts, page 17. 7. Run the rps_upgrade_sp2_sp3.ebs script using DmBasic.exe. This will modify the Retention Policies and instances of retentions to comply with the RM 5.3 SP3 object model. a. Copy the rps_upgrade_sp2_sp3.ebs script to your C:\Documentum\product\5. 3\bin folder. Records Manager Installation Guide 25
Upgrading RPS 5.3 SP2 to RM 5.3 SP3 Hot x b. Open a command prompt (a DOS window), on the Content Server that is hosting the rps repository, and navigate to DOCUMENTUM > product > 5.3 > bin. In general, this will be C:\Documentum\product\5.3\bin. c. Use the following syntax to execute the script: dmbasic.exe f <path and file name to script> e <entry point method name> <docbase_name user_name password> To create a log of the output running from this script, append > rpslog.html to the command-line statement. This will re-direct the output from the command prompt to the file name specified after the > (greater than) character. An example command line would appear as follows: dmbasic frps_upgrade_sp2_sp3.ebs emigrate DCTM_RPS qaadmin qaadmin > c:\temp\rpslog.html Note: The directory \Temp must exist at C:\Temp, otherwise an error will occur. This will upgrade the Docbase called "DCTM_RPS" whose install owner account and password are "qaadmin" while outputting the results to a log file called "rpslog.html" in the C:\Temp directory of the Content Server host machine. Note: You can use your browser to view the log file once the upgrade is complete. 8. Restart your Java Method Server. You must restart (or start if it was stopped) your Java Method Server in your Services, for the changes to take effect. To upgrade RPS to RM on the Application Server 9. Run the RM 5.3 SP3 Hotfix Application Server Files installer on the Application Server. On Windows refer to Installing RM Application Server files on Windows, page 14. On Unix refer to Installing RM Application Server files on Unix/Linux Hosts, page 15. The upgrade process for RPS 5.3 SP2 to RM 5.3 SP3 Hotfix on the Content Server is now finished. If the Application Server and the Content Server are installed on the same physical host, start the Application Server service. Note: The Retention Policy rollover feature was introduced in RM 5.3 SP3. As part of Step 7, all retention policies created in RPS 5.3 SP2 that had a Disposition Method of Review were migrated to have a Disposition Strategy of Review. These migrated retention policies must also specify a rollover retention policy as a requirement of RM 5.3 SP3. If the output log generated by Step 7, lists retention policies with a Disposition Strategy of Review, follow the remaining steps otherwise the upgrade is complete. 10. Open a browser to RMA and navigate to the list of Retention Policies under the Retention Policy Services node. 11. Open the output log generated in Step 7 and navigate to the bottom where the review retention policies requiring a rollover retention policy are listed. 26 Records Manager Installation Guide
Upgrading RPS 5.3 SP2 to RM 5.3 SP3 Hot x 12. For each review retention policy listed in the output log: Note its name Find it in the browser Determine whether its Retention Strategy is Individual or Linked Find or create a retention policy that is enabled and has the same retention strategy as the review retention policy, and note its name next to the original note from above. 13. For each pair of retention policy names, use them as the fourth and fifth arguments to the SetRRP.ebs script. This will assign to the retention policy whose name is listed first, the retention policy as a rollover retention policy, whose name is listed second. 14. Run SetRRP.ebs from the command line as follows for each retention policy listed, with a Disposition Strategy of Review, and make sure the Retention Strategy is set the same and Enabled is selected: Note: The user may pick the same retention policy to use as the rollover retention policy. Once the value for rollover retention policy has been set, it can not be reset. Planning is therefore an essential step to assigning rollover retention policies to Review retention policies. dmbasic fsetrrp.ebs errp -- <docbase_name> <user_name> <password> <reviewretentionpolicyname> <rolloverretentionpolicyname> myrrplog.html The upgrade is now complete. Records Manager Installation Guide 27
Upgrading RPS 5.3 SP2 to RM 5.3 SP3 Hot x 28 Records Manager Installation Guide
Chapter 8 Upgrading RPS 5.3 SP1 or Earlier to RM 5.3 SP3 Hot x If you are currently running RPS 5.3 SP1 or earlier, you must complete each upgrade of RPS incrementally before installing RM. For example if you are running RPS 5.3 Hotfix you must upgrade to RPS 5.3 SP1, then RPS 5.3 SP2, and lastly RM 5.3 SP3 Hotfix. At each increment, the appropriate DocApp must be installed and the upgrade script, if available, must be run. A direct upgrade from RPS 5.3 SP1 or earlier to RM 5.3 SP3 Hotfix is not supported. Records Manager Installation Guide 29
Upgrading RPS 5.3 SP1 or Earlier to RM 5.3 SP3 Hot x 30 Records Manager Installation Guide
Chapter 9 Uninstalling Content Server les and Application Server les Follow this procedure when instructed by the upgrade procedures. This procedure is used to prepare the Content Server host and Application Server host for an upgrade to an existing installation of Records Manager. Windows NT Administrator privileges is required to uninstall server files. To uninstall Records Manager components: 1. Close Records Manager and any other open Windows programs on the Content Server. 2. On the Microsoft Windows taskbar, click the Start button, point to Settings, and then click Control Panel. 3. Double-click Add/Remove Programs. The Add/Remove Programs Properties dialog box appears. 4. Select Documentum Records Manager Server Files and click Change/Remove to remove. 5. Click OK to close the Add/Remove Programs Properties dialog box. 6. Close Records Manager and any other open Windows programs on the Application Server. 7. On the Microsoft Windows taskbar, click the Start button, point to Settings, and then click Control Panel. 8. Double-click Add/Remove Programs. The Add/Remove Programs Properties dialog box appears. 9. Select Documentum Records Manager Administrator and click Change/Remove to remove. 10. Select Documentum Retention Policy Services Administrator and click Change/Remove to remove. Records Manager Installation Guide 31
Uninstalling Content Server les and Application Server les 11. Click OK to close the Add/Remove Programs Properties dialog box. 32 Records Manager Installation Guide
Chapter 10 Con guring RM Make sure to turn off folder security from Documentum Administrator (DA) when you configure RM. Note: You need to be in one of the following three roles to create records: Records Manager Role, dmc_rm_recordsmanager Records Privileged User Role, dmc_rm_privilegeduser Records Contributor Role, dmc_rm_recordscontributor Additionally, you need to be in one of the following two forms roles: form_user form_designer Records Manager Installation Guide 33
Con guring RM 34 Records Manager Installation Guide
Con guring RM Event Auditing Chapter 11 Use these instructions to configure audit events for an RM event from Documentum Administrator (DA). Follow these steps to configure RM event auditing: 1. Login to Documentum Administrator (DA) as a user that has the Config, View, and Purge Audit Extended Privilege on their account. 2. Click the Audit Management node in the Navigation column. 3. Click Manage Auditing by Object Type link. Note: The link is not available if the user s extended privilege is not setup correctly. To fix it, login as another super user, and modify the initial user s extended privilege. Then re-login to DA as the initial user. 4. Select the dm_sysobject type. Make sure to select the Include All Subtypes checkbox. 5. Click OK. 6. Click Add Audit. 7. Type dmc_rm in the field labeled Application Code. 8. Click Add. 9. Change the selector from All Events to Custom Events to display the RM-specific auditable events. Select the RM events that you wish to audit, and click Add. Click on the page selector (>) to display additional audit events and select the events that you wish to add and click on Add to place them in the "Selected Items" pane. a. Select the RM events that you wish to audit. b. Click Add. c. Click on the page selector (>) to display additional audit events. d. Select the RM events that you wish to add and click on Add to place them in the Selected Items pane. Records Manager Installation Guide 35
Con guring RM Event Auditing 10. Click OK on all pages until you get back to the Audit Management main page to save the audit entries. Below are the list of audit events for RM and RPS. Note: Not all events are against the dm_sysobject type. You must select the appropriate type in Step 4 above. RM Audit Events Add Audit Events (Application Code = dmc_rm) and select the events that start with dmc_rm. Application events appended to target object type dm_sysobject: dmc_rm_apply_security_policy dmc_rm_remove_security_policy dmc_rm_apply_security_level dmc_rm_remove_security_level dmc_rm_apply_supplemental_marking dmc_rm_remove_supplemental_marking dmc_rm_apply_shared_marking dmc_rm_remove_shared_marking dmc_rm_apply_naming_policy dmc_rm_remove_naming_policy dmc_rm_apply_containment_policy dmc_rm_remove_containment Note: Select the checkbox next to Include all subtypes to include all subtypes of dm_sysobject. Application events appended to target object type dm_document dmc_rm_added_to_formal_record dmc_rm_removed_from_formal_record Application events appended to target object type dmc_rm_security_policy dmc_rm_add_sp_perm dmc_rm_remove_sp_perm Application events appended to target object type dmc_rm_containment_policy dmc_rm_add_cp_rule dmc_rm_remove_cp_rule Application events appended to target object type dmc_rm_naming_policy dmc_rm_add_np_rule 36 Records Manager Installation Guide
Con guring RM Event Auditing dmc_rm_remove_np_rule RPS Audit Events Add the following Audit Events (Application Code = dmc_rps) and select the events that start with dmc_rps. Application events appended to target object type dm_sysobject: dmc_rps_apply_retention_markup dmc_rps_apply_retention_policy dmc_rps_delete_failure dmc_rps_dispose dmc_rps_privileged_delete dmc_rps_promote dmc_rps_remove_retention_markup dmc_rps_remove_retention_policy Note: Select the checkbox next to Include all subtypes to include all subtypes of dm-sysobject. Application events appended to target object type dmc_rps_retention_policy: dmc_rps_add_action_rel dmc_rps_add_authority dmc_rps_add_condition dmc_rps_remove_action_rel dmc_rps_remove_authority dmc_rps_remove_condition dmc_rps_update_action_rel dmc_rps_update_phase_rel Application events appended to target object type dmc_rps_retention_markup: dmc_rps_add_action_rel dmc_rps_update_action_rel dmc_rps_remove_action_rel Application events appended to target object type dmc_rps_retainer: Records Manager Installation Guide 37
Con guring RM Event Auditing dmc_rps_supersede 38 Records Manager Installation Guide
Chapter 12 Installing Records Manager Outlook Activator for Records Email Install RM Outlook Activator if you need to declare email as formal records. You must download the required file to a download folder: Records_Manager_Outlook_Client_53SP4_windows.zip Records_Manager_Outlook_Client_docapps_53SP4.zip Unzip the files to extract the following files: Pre-Install Outlook Client.exe SetupOutlookRA.EXE MessagingApp.zip DCO.zip The English installer, SetupOutlookRA.EXE is always required and must be installed prior to the installation of a language pack. Versions for French, Spanish, German, Italian, Japanese, and Korean language pack installers are available if needed: SetupOutlookRAFrench.EXE SetupOutlookRASpanish.EXE SetupOutlookRAGerman.EXE SetupOutlookRAItalian.EXE SetupOutlookRAJapanese.EXE SetupOutlookRAKorean.EXE Refer to the Web Development Kit Applications Language Pack Installation and Release Notes, version 5.3 SP3 before installing a language pack. You must run SetupOutlookRA.EXE first then the applicable language pack executable, if needed, on each client machine where records email functionality is required. Note: Ensure Microsoft Outlook is closed. Then make sure any previous installation of Outlook Activator is uninstalled before you run the installers. Also make sure to uninstall Documentum Records Manager Installation Guide 39
Installing Records Manager Outlook Activator for Records Email Records Manager Records Manager Outlook Client and Documentum Records Manager System Check using the Add or Remove Programs option. Run the applicable installer using the following steps (SetupOutlookRA.EXE is the example used here): 1. Navigate to the folder where you have Pre-Install Outlook Client.exe saved. 2. Double-click Pre-InstallOutlookClient.EXE. Pre-installOutlookClient.Exe will check your system to ensure your system meets the requirements. 3. Navigate to the folder where you have SetupOutlookRA.EXE saved. 4. Double-click SetupOutlookRA.EXE. Welcome to Records Manager Outlook Client Setup program is displayed and asks that you exit any programs before continuing. 5. Click Next after you have exited the other programs. The Destination Location screen is displayed. 6. Click Next to accept the specified Destination Folder. The Server and Folder Name screen is displayed. a. Type the URL to the RM application server in the Select Server URL field as follows: http://<server>:<port>/rma. The entry, for example, should appear as follows: http://server1:8080/rma. b. In the Select Folder Name, type the root folder location on the repository where the emails are to be stored: /Email/Messages for example. 7. Click Next to accept the entries for the Server and Folder Name. The Start Installation screen is displayed. 8. Click Next to start the installation. Records manager Outlook Client has been successfully installed is displayed upon completion. 9. Click Finish to end the installation. 10. Restart the computer. 11. Proceed to install the RM Outlook Activator DocApps. Note: The DocApps for RM are prerequisite and must be installed prior to the DocApps for Outlook Activator. Because Records Manager installation procedures allow you to install the RM DocApps at a later time, make sure they have been installed and if not, install them before the RM Outlook Activator DocApps. 40 Records Manager Installation Guide
Installing Records Manager Outlook Activator for Records Email Note: The following 2 DocApps for RM Outlook Activator must be downloaded, then extracted to a temporary folder location and run by the Documentum Application Installer (DAI 5.3 SP4), in the order listed. 1. MessagingApp.zip 2. DCO.zip The instructions below demonstrate the first DocApp installation. Repeat installing the remaining two DocApps, in the order listed, using the same procedure. To install the RM Outlook Activator DocApp in a Windows repository: 1. Extract and copy MessagingApp.zip to a temporary folder on a server that has DAI 5.3 SP4 installed. 2. Perform the following substeps. a. Click Start Programs Documentum Application Installer. b. Connect to the repository as the installation owner. c. Browse to the temporary folder where the MessagingApp.zip file is extracted. Your selection appears in the Application Installer window. d. Click OK to proceed to the installation screen. e. Click Start Installation from the Application Installer window to begin the process of updating the DocApp for the repository. The installation is complete when the Quit installer button becomes available. 3. Repeat this procedure to install the second DocApp, DCO.zip. Records Manager Installation Guide 41
Installing Records Manager Outlook Activator for Records Email 42 Records Manager Installation Guide
Appendix A Installing Brava! Webtop Server for RM Records Manager Administrator uses the Brava! Viewer to allow you to view the content of a document. Note: The Brava! Viewer supplied with Records Manager is intended for viewing only. You will not be able to edit, add markups, nor annotate the document being viewed. The Viewer allows you to view a rendition of a document regardless of whether it is a bitmap image (.BMP), a Microsoft Word document (.DOC), or just about any format of document. That is, when you want to view a document, and you do not have the associated software installed for the document format, RM opens the document in the Viewer to allow you to view the content of the document. For detailed step-by-step instructions for installing and configuring the Brava! Server and Client components, see the Brava Enterprise Installation and Configuration Guide, Version 5.3 SP4. Note: When installing the Brava! Webtop Server component, the Webtop alias is the virtual directory that was chosen during the RM installation, the default (as shown below) is rma. Make sure you type rma, not webtop. Figure A-1. RMA Webtop alias To complete the Brava! con guration for RM: 1. Modify the brava_parameters.jsp file on the application server. For a base Tomcat installation, the file is located in the C:\Program Files\Apache Software Foundation\Tomcat 5.0\webapps\rma\rm\library\brava\ directory. Records Manager Installation Guide 43
Installing Brava! Webtop Server for RM String serverhostname = "http://<server_name>:<port_number>"; String webappname = "rma"; Replace the "<server_name>:<port_number>" with the application server name and port number for the RM application server. Replace the "webappname" entry with the virtual directory that was used when installing the RM application. The default is "rma". 2. Modify the view_menu.jsp file on the application server. For a base Tomcat installation, the file is located in the C:\Program Files\Apache Software Foundation\Tomcat 5.0\webapps\rma\rm\classic\menubar directory. Look for the following line: <dmf:menuseparator name='view_sep6'/> and insert the following line below it: <dmfx:actionmenuitem dynamic='singleselect' name='view_brava' nlsid='msg_brava' action='dmc_rm_brava' showifinvalid='true'/> 3. Replace the license file IGCKey.lic with the one provided. This file is stored in the two following default locations: C:\Program Files\IGC\Brava! 5.3 Webtop\JobProcessor\LicenseKey\ and C:\Program Files\IGC\Brava! 5.3 Webtop\. Replace the file with the updated one provided by Documentum and re-start the Net-It Enterprise Server Service and the Application Server service or console. 44 Records Manager Installation Guide
2011-2013 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.