emc documentum recordsclient - …€¦ · emc® documentum® recordsclient version6.8...

EMC DocumentumRecords Client

Version 6.8

Deployment Guide

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

Legal Notice

Copyright 20032017 EMC Corporation. All rights reserved.

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS 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. Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused herein are the property of their respective owners.

Documentation Feedback

Your opinion matters. We want to hear from you regarding our product documentation. If you have feedbackabout how we can make our documentation better or easier to use, please send us your feedback directly [email protected].

mailto:[email protected]

Table of Contents

Preface ................................................................................................................................. 9

Chapter 1 Quick Start .................................................................................................. 13

Chapter 2 Planning for Deployment ............................................................................. 15Required and optional supporting software........................................................ 15Typical configuration ........................................................................................ 15Preparing the Content Server ............................................................................ 16Application Server host requirements ................................................................ 17Directory name restriction............................................................................. 17Content transfer directory permissions .......................................................... 17DNS resolution............................................................................................. 17

Deploying multiple applications........................................................................ 17Deploying language packs ................................................................................ 18Customizing an application............................................................................... 18

Chapter 3 Preparing the Client Hosts .......................................................................... 19Ensuring a certified JVM on browser clients ....................................................... 19Enabling HTTP content transfer in Internet Explorer .......................................... 19Enabling UCF content transfer in Internet Explorer on Windows Vista................. 20Enabling content transfer in Firefox ................................................................... 21Supporting Outlook mail message ..................................................................... 23Using Citrix Presentation Server Client .............................................................. 23

Chapter 4 Preparing the Application Server Host ........................................................ 25Setting the Java memory allocation .................................................................... 25Turning off failover........................................................................................... 26Preparing environment variables for non-default DFC locations .......................... 26Preparing JBoss ................................................................................................ 26Configuring JBoss EAP 6.3.x.......................................................................... 27Classloader Settings...................................................................................... 27

Preparing Tomcat ............................................................................................. 28Disabling tag reuse ....................................................................................... 28Disabling HttpOnly property ........................................................................ 29Disabling whitespace parsing ........................................................................ 29Improving performance on Tomcat 8.x........................................................... 29

Preparing vFabric tc Server ............................................................................... 30Disabling tag reuse ....................................................................................... 30Disabling HttpOnly property ........................................................................ 31

Preparing WebLogic server ............................................................................... 31Deploying WAR ........................................................................................... 31

EMC Documentum Records Client Version 6.8 Deployment Guide 3

Table of Contents

Disabling HttpOnly property ........................................................................ 31Supporting large content transfer operations in a managed serverenvironment ................................................................................................ 31

Preparing IBMWebSphere ................................................................................ 32Supporting failover in a cluster...................................................................... 32Applying security policies for WebSphere security ......................................... 32

Preparing to use an external web server ............................................................. 34

Chapter 5 Installing the EMC Documentum Records Client and its recordsproducts: RPS, RM, and PRS ...................................................................... 35Overview ......................................................................................................... 36Primary steps ................................................................................................... 37Download Records Client files....................................................................... 37Create global repository ................................................................................ 45Create Records Client repository ................................................................... 45Install DAR files with the DAR Deployer plug-in............................................ 46Install DAR files using headless Composer on UNIX, AIX, and Linux .............. 51Installing records.war on the Application Server............................................. 51Setup Documentum Administrator (DA)........................................................ 52From the DA interface, register all DFC clients ............................................... 53Optional DoD functionality for configuring email records ............................... 53

Configuring users, roles, and audits................................................................... 55Troubleshooting the new installation ................................................................. 55Upgrading from earlier releases......................................................................... 56Upgrade paths and overview ........................................................................ 56Upgrading and Migrating previous versions of RPS/PRM/RM to 6.8 ................ 57Records_migration DAR detects the occurrence of RETPOL-3789 .................... 58Migrating custom record relationship instances .............................................. 59

Configuring the Records Security ...................................................................... 61Working with new Email Processing functionality .............................................. 61Working with new email messages imported from Records 6.8onwards....................................................................................................... 61Configuring MailApp.properties file .............................................................. 62Using configuration options in app.xml for email import ................................ 64

Working with email messages imported before Records 6.8 ................................. 64Configuring the MigratedMsgArchive.properties file ...................................... 65Configuring the Download Msg Content of Migrated Emailattribute of RPS Application Configuration object ....................................... 65

Configuring Records Activator for declaring email records fromMicrosoft Outlook ............................................................................................ 66Installing the optional PRTS for PRM barcode label printing and batchprocessing........................................................................................................ 69Setting up PRTS............................................................................................ 70Additional setup for barcode label printing (rendering) and testinginstructions .................................................................................................. 74Installing Adobe Print Driver and NiceLabel Pro ........................................ 75Testing barcode label printing ................................................................... 75Optional steps to import custom NiceLabel Templates ................................ 80

Additional setup for batch processing using PRM Auto-Queue ....................... 83Batch Processing XML Schema for the optional PRTS.......................................... 87Overview ..................................................................................................... 87Batch Processing Operations ......................................................................... 94Overview of operation status and view report ............................................ 94Reconciliation......................................................................................... 100

4 EMC Documentum Records Client Version 6.8 Deployment Guide

Table of Contents

Resolvable issues ................................................................................ 102Charge-in............................................................................................... 102Mark as destroyed .................................................................................. 103Mark as exported.................................................................................... 104Mark as shipped..................................................................................... 105Move to container................................................................................... 106

Instructions for updating the pass-along workflow ........................................... 107Configuring the disposition job to run successfully against objectswith an Unknown disposition strategy............................................................. 111Configuring the parameters for the RPS notification job .................................... 112How to register and configure a disposition workflow (based on theshipped sample workflow) .............................................................................. 112Setting up Records Queue Manager (RQM) ...................................................... 118If you have IRM-protected content, follow this step ...................................... 120

Chapter 6 Upgrading a WDK-Based Application ........................................................ 123

Chapter 7 Deploying a WDK-Based Application ........................................................ 125Preparing the WAR file for deployment............................................................ 125Enabling DFC connections to repositories ........................................................ 126Enabling DFC memory optimization................................................................ 127Configuring UCF............................................................................................ 128Enabling presets and preferences repositories................................................... 128Configuring encrypted password for presets and preferencesrepositories ................................................................................................ 129

Enabling retention of folder structure and objects on export .............................. 130Enabling modal pop-up windows.................................................................... 130Working with email messages in WDK-based applications ................................ 131Enabling external searches .............................................................................. 131Configuring the connection to the search server............................................ 132Configuring the connection to the backup search server ................................ 132

Deploying multiple applications...................................................................... 133

Chapter 8 Completing the Deployment ...................................................................... 135Configuring IBMWebSphere after deployment ................................................ 135Changing the classloader and compiler settings............................................ 135Setting com.ibm.ws.webcontainer.invokefilterscompatibility to true .............. 136

Deploying default virtual link support ............................................................. 136Accessing the application ................................................................................ 136Testing WDK samples ..................................................................................... 137Configuring User Authentication..................................................................... 138

Chapter 9 Configuring Single Sign-On for Security Servers ...................................... 139Configuring WebSEAL Single Sign-On Authentication...................................... 139Configuring Kerberos Authentication .............................................................. 139

Chapter 10 Installing Application Connectors ............................................................. 141Overview ....................................................................................................... 141GUI installation of Application Connectors ...................................................... 142


Table of Contents

Command-line installation of Application Connectors ...................................... 143Location of installed files on the client host....................................................... 144

Chapter 11 Installing Documentum Webtop Extended Search .................................... 145Installing the Webtop Extended Search option .................................................. 145Viewing installation log files ........................................................................... 147

Chapter 12 Enabling the Webtop Express DocApp ..................................................... 149

Chapter 13 Troubleshooting Deployment .................................................................... 151Wrong JRE used for Application Server............................................................ 151No global registry or connection broker ........................................................... 151No connection to repository ............................................................................ 152DM_VEL_INSTANTIATION_ERROR .............................................................. 152Page not found error in browser ...................................................................... 152Login page incorrectly displayed ..................................................................... 152Slow performance........................................................................................... 153Planning the system size ............................................................................. 153

Out of memory errors in console or log ............................................................ 153Slow display first time .................................................................................... 153DFC using the wrong directories on the Application Server............................... 153Application startup errors .............................................................................. 154Tag pooling problem....................................................................................... 154UCF client problems ....................................................................................... 154Citrix client problems ..................................................................................... 155Connection issues between an ECI Services server and IPv6 clients .................... 155Presets not working ........................................................................................ 156Blank page error on deploying Webtop ............................................................ 156Blank page error on deploying DA .................................................................. 156

Chapter 14 Deploying a Custom Application ............................................................... 157Using the comment stripper utility .................................................................. 157

Appendix A Predeployment Checklist .......................................................................... 159


Table of Contents

List of Figures

Figure 1. Basic WDK host configuration ............................................................................... 16Figure 2. Product information ............................................................................................. 38Figure 3. DAR Deployer GUI .............................................................................................. 50Figure 4. Supported upgrade paths...................................................................................... 57Figure 5. Relation type example of allowable parent and child type for creating

relationships .................................................................................................... 60Figure 6. Deselecting Internet Explorer Enhanced Security Configuration option .................... 68Figure 7. Invoke the UCF client installer............................................................................... 68Figure 8. Confirmation dialog ............................................................................................. 69Figure 9. Create label printing rule for physical documents ................................................... 76Figure 10. Properties prm_docbase_config ............................................................................. 77Figure 11. Properties of a physical document based on the rule specified ................................. 78Figure 12. Barcode value....................................................................................................... 78Figure 13. Print label option .................................................................................................. 79Figure 14. Label print request screen ..................................................................................... 80Figure 15. Printed label......................................................................................................... 80Figure 16. Import settings for NiceLabel customized templates ............................................... 81Figure 17. Before view of template permissions...................................................................... 82Figure 18. After view of template permissions........................................................................ 83Figure 19. Operation status tab.............................................................................................. 95Figure 20. Failed status details .............................................................................................. 96Figure 21. Executed Ok status details..................................................................................... 96Figure 22. Only reconciliation details are formatted differently ............................................... 99Figure 23. Identifying the target repository .......................................................................... 108Figure 24. Passalong workflow installed .............................................................................. 108Figure 25. Activity inspector performer for NotifyRecipientItemsSent ................................... 109Figure 26. Activity inspector transition tab........................................................................... 110Figure 27. Performer selected settings.................................................................................. 111Figure 28. Invoking web workflow manager ........................................................................ 113Figure 29. Selecting activity inspector .................................................................................. 113Figure 30. Select performer button....................................................................................... 114Figure 31. Select performer screen ....................................................................................... 115Figure 32. Adding records manager role .............................................................................. 115Figure 33. Select performer button....................................................................................... 116Figure 34. Validate and install buttons ................................................................................. 116Figure 35. Displaying the disposition workflow ................................................................... 117Figure 36. Documentum menu in authoring application ....................................................... 143


Table of Contents

List of Tables

Table 1. DAR file download matrix .................................................................................... 39Table 2. Miscellaneous files download matrix ..................................................................... 42Table 3. Supported content server records version matrix example....................................... 46Table 4. Description of DAR Deployer fields ....................................................................... 48Table 5. Properties of MailApp.Properties file ..................................................................... 62Table 6. Results returned ................................................................................................... 71Table 7. Optional parameters usage.................................................................................... 88Table 8. Optional parameter descriptions............................................................................ 88Table 9. Line items in export reports................................................................................... 97Table 10. Line items in charge-in reports .............................................................................. 97Table 11. Line items in mark as destroyed reports ................................................................. 97Table 12. Line items in mark as shipped reports.................................................................... 98Table 13. Line items in move to container reports.................................................................. 98Table 14. Line items in reconciliation reports ........................................................................ 99Table 15. Notification messages for reconciliation operations............................................... 101Table 16. Notification messages for charge-in operations ..................................................... 103Table 17. Notification messages for mark as destroyed operations........................................ 104Table 18. Notification messages for mark as shipped operations .......................................... 106Table 19. Notification messages for move to container operations ........................................ 107Table 20. Results returned ................................................................................................. 120Table 21. Directories and files to back up............................................................................ 123Table 22. Preferences configuration elements...................................................................... 128Table 23. Modal window elements in app.xml () .......................................... 131Table 24. Location of files installed by Application Connectors on the client host .................. 144Table 25. Express user capabilities ..................................................................................... 149Table 26. Comment stripper utility parameters ................................................................... 157Table 27. Predeployment tasks .......................................................................................... 159


Preface

Chapter 5, Installing the EMC Documentum Records Client and its records products: RPS, RM, andPRS describes how to deploy the WDK-based EMC Documentum Records Client and the recordsproducts it hosts for the 6.8 release. The Records Client is the unified client that has replaced theRecords Manager Administrator (RMA) and Retention Policy Services Administrator (RPSA) clients.

Instructions are included for deploying records.war, installing records .dar files, upgrading, andconfiguring the records products. All other chapters are available for general reference regardingthe planning of the deployment, preparing servers, and so on.

Refer to the Documentum Records Client Release Notes, version 6.8, for system requirements and notesthat may affect deployment. Refer to the requirements in the release notes to ensure your systemmeets or exceeds the requirements. The list of supported platforms is also included in the releasenotes.

The Records Client is a web application built on WDK and can therefore be customized using WDK.The deployment process is largely the same as for other WDK-based applications. For additionalinformation on developing or customizing applications that are WDK-based, refer to the latestWebDevelopment Kit and Client Applications Development Guide.

Intended AudienceThis guide is intended for administrators who are deploying records products and includesinstructions for setting up the Records Client, enabling a repository for use by records products,setting up label printing and batch processing, and setting up Records activator for MicrosoftOutlook. To deploy a WDK-based application, you should be familiar with the operating system ofthe Application Server and be able to install and configure a J2EE Application Server.

Revision HistoryThe following changes have been made to this document.


Preface

Revision Date Description

February 2017 Updated the Batch Processing XML Schema for the optional PRTS,page 87 section.

Updated the Changing the classloader and compiler settings, page135 section.

Removed the Installing Brava! Enterprise 7.0 for Records 6.8appendix.

January 2017 Updated the Enabling presets and preferences repositories, page 128section.

October 2016 Updated the Troubleshooting the new installation, page 55 section.

January 2016 Updated the Setting up PRTS, page 70 section.

Updated the Setting up Records Queue Manager (RQM), page 118section.

December 2015 Updated the Configuring Records Activator for declaring emailrecords from Microsoft Outlook, page 66 section.

Updated the Table 2, page 42 with Microsoft Outlook 2010 and2013 support information.

August 2015 Initial publication.

Removed the Charge-out batch processing operation listed inAdditional setup for batch processing using PRM Auto-Queue,page 83.

Related DocumentationYou can download this deployment guide and the release notes for WDK and Webtop on the productdownload site. Each Webtop-based application contains an online user guide in HTML format and aPDF version of that guide in the help subdirectory of the application WAR file.

The following developer documentation is available on the product download site for configuring andcustomizingWDK andWebtop applications. Additionally, someWDK-based products have their owndevelopment guides with information specific to the product. Records 6.8 related documentation: EMC Documentum Records Client Administration and User Guide

EMC Documentum Records Client Deployment Guide

EMC Documentum Records Client Release Notes


Preface

EMC Documentum Records Manager for Outlook Activator Configuration and User guide

EMC Documentum Web Services for RM and RPS Deployment Guide


Preface


Chapter 1Quick Start

This chapter describes the steps you need to perform to deploy your application. The steps aredescribed in more detail in the chapters of this guide. Your product or environment may requireadditional steps, which you can find in the product-specific chapter or chapters of this guide or inthe index. To install the DAR files of the records products on the Records Client, refer to Chapter5, Installing the EMC Documentum Records Client and its records products: RPS, RM, and PRS. Itdoes not matter which operation is completed first as long as the DAR files are installed and theWAR file is deployed.

To perform a simple product deployment1. Plan the deployment. (Refer to Chapter 2, Planning for Deployment.)

Check that you have required and optional supporting software, prepare the Content Server,check Application Server environment requirements, prepare for multiple applications, plan forlanguage pack deployment, and (if supported) plan to deploy a customized application.

2. Prepare the clients. (Refer to Chapter 3, Preparing the Client Hosts.)Install a supported browser virtual machine and perform specific browser preparations for IE 7and Firefox. If needed, you will install the mail message converter and prepare Citrix clients.

3. Prepare the Application Server. (Refer to Chapter 4, Preparing the Application Server Host.)Ensure you have sufficient memory allocated to the Application Server Java instance, turn offfailover if it is not needed, and follow application-server and proxy-server specific preparationinstructions.

4. Deploy the product WAR file using the Application Server standard deployment mechanism.(Refer to Chapter 7, Deploying a WDK-Based Application.)You must first unpack the WAR file archive and enter some information that is specific to yourenvironment: your connection broker and global registry information, optional presets andpreferences repositories, and optional ECIS search server.

5. Optionally, if your product has a WAR file and DAR files, make sure to deploy the productDAR files using the DAR Deployer.

6. Complete the deployment. (Refer to Chapter 8, Completing the Deployment.)


Quick Start

After successful deployment, you can configure UCF, deploy root virtual link support, enableWebSphere global security if needed, and test the application samples.


Chapter 2Planning for Deployment

This chapter addresses software and hardware decisions you must make before you deploy aWDK-based application. This chapter contains instructions that are shared by all WDK-basedproducts. Check your release notes for information on the application servers, browsers and othersoftware in the environment that are certified for your product.

Required and optional supporting softwareAdditional software products are required for WDK and WDK applications including the following: Content Server and its associated database

Content Server global repository

Connection broker

You must specify one or more connection brokers in the dfc.properties file. Refer to To configureconnections in dfc.properties before deployment:, page 126 for information on configuring theconnection broker before deployment.

J2EE Application Server or servlet container

All WDK-based applications require DARs that must be installed in the repository.

Typical configurationWhen deployed on a single Application Server, a typical WDK-based application requires thefollowing network components: Application Server host on which the WDK-based application will be deployed

Separate Content Server host, where a repository is installed and where one or more ContentServers run

Global registry repository

Client hosts that run a supported web browser

Figure 1, page 16 shows the network components.


Planning for Deployment

Figure 1. Basic WDK host configuration

Caution: For security and performance reasons, do not install the Content Server and aWDK-based application on the same host. In addition, the Content Server installs an internalJBoss server that for licensing reasons cannot be used to deploy web applications.

Clustered environments WDK-based applications can be deployed in supported clusteredenvironments. Refer to the release notes for each WDK-based application to learn which managedserver configurations are supported.

Preparing the Content ServerThe following topics describe Content Server requirements.

Content Server installs certain DARs that are required for a WDK-based application. You do not needto perform a separate installation of these. Products built on WDK or Webtop may require additionalDARs, which are available on the product download site.

The global registry requirement A global registry of Content Server version 6.x must be installedin your environment in order to run a WDK-based application. A global registry is a Content Server



that has been designated as a global registry. For information on designating your applicationsglobal registry before deployment, refer to Enabling DFC connections to repositories, page 126.

Application Server host requirementsThe Application Server host used for WDK-based applications has the requirements described inthe following sections.

Directory name restriction

Java does not allow directories containing the following characters, which must not appear in thedirectory names or paths of Documentum applications:! \ / : * ? " < > |

Content transfer directory permissions

The content transfer directory on the Application Server host is used to store files temporarily whenthey are transferred between the repository and the client machine. The default content transferdirectory is specified in the app.xml file as the value of .. The ApplicationServer instance owner must have write permissions on this temporary content transfer location.

You can change the default value to a location on your Application Server host for which theApplication Server instance owner has write permission. For information on specifying locations inthe UCF client and server configuration files, refer toWeb Development Kit Development Guide.

Some application servers require policies that grant permissions to write to these directories. Refer todeployment information for your Application Server to see Documentum policy settings.

DNS resolution

The Domain Name Server must be configured to properly resolve IP addresses based on the URLused to access the server.

Deploying multiple applicationsYou can deploy multiple WDK-based applications of version 6.x on a single host. Each instance ofan application must be deployed to a different virtual directory. If the applications share the sameApplication Server instance, the applications must be the same version--version 6.x or higher.

You can deploy applications to separate instances of the Application Server. If the applications usedifferent versions of DFC, you must deploy them in separate Application Server instances.



Deploying language packsInstructions to deploy the Records Client and records products it hosts are available in Chapter 5,Installing the EMC Documentum Records Client and its records products: RPS, RM, and PRS.

Language packs are available to localize (translate) WDK-based applications. A language pack is alanguage-specific archive file that contains a graphical user interface (GUI) and user documentationthat have been localized into a language other than the default application language, U.S. English. Todeploy language packs, unpack your product WAR file and add the language packs according to theinstructions inWeb Development Kit Applications Language Pack Installation and Release Notes.

Customizing an applicationA developer license is required to develop custom applications. See your EMC Documentum accountrepresentative to obtain a developer license.

Configuration Configuration is defined for support purposes as changing an XML file ormodifying a Java Server Page (JSP) page to configure controls on the page. Configuration does notrequire a developer license.

Customization Customization is defined for support purposes as the extension of WDK classesor the modification of JSP pages to include new functionality. Customization requires a developerlicense. Customization of Documentum Administrator is not supported.


Chapter 3Preparing the Client Hosts

This chapter contains instructions that are shared by all WDK-based products. Check your releasenotes for information on the browsers that are certified for your product.

Ensuring a certified JVM on browser clientsBrowser client hosts require a certified version of the Sun Java virtual machine (JVM or VM) to initiatecontent transfer in a WDK application. New machines may not have a JVM installed in the browser.Check the release notes for your product version for the JVMs that are supported.

If the WDK-based application is configured to use UCF content transfer, a lightweight applet isdownloaded to the browser when the client makes the first content transfer or preferences request.

On Windows clients, if the JVM required for UCF is not present on the client machine, UCF uploadsto a Windows client a private JVM. This VM does not replace the JVM that is used by the browser.For non-Windows browser hosts with a JVM of 1.4.x, you must pre-install version 1.5.0_06.x of theSun JRE that will then be used by UCF.

Since the UCF VM file (Sun JRE) is over 10 MB in size, the installation can cause a delay. You canavoid this delay by installing a compatible local JVM prior to using UCF transfer.

Enabling HTTP content transfer in InternetExplorerInternet Explorer (IE) versions 9, 10 and 11 have a default security setting that prevents the display ofthe file download dialog. You must add the WDK-based application URL to the list of trusted sites inthe browser in order to perform checkout, view, or edit in HTTP mode.

Nothing happens when user exports as CSV if the browser security settings are disabled for promptfor file downloads and file download. These are disabled by default in IE7. The user must enablethem.

To enable HTTP file download in IE:1. In the IE browser menu, choose Tools > Internet Options and click the Security tab.

2. Choose Trusted sites and then click Custom level.


Preparing the Client Hosts

3. Scroll to the Downloads section and enable Automatic prompting for file downloads.

4. Click OK twice to save settings.

5. Close all browser windows and restart the browser.

Enabling UCF content transfer in InternetExplorer on Windows VistaInternet Explorer on Windows Vista OS does not display a file download dialog to permit UCFcontent transfer unless it is enabled by adding the Application Server host to the trusted sites list anddoing one of the following: Turn off User Account Control (UAC) security for each client.

Configure the application to use file registry mode.

To add the Application Server host to the list:1. In IE, go to Tools > Internet Options Security tab.

2. Select Trusted sites. Click Custom level in the section Security level for this zone.

3. Scroll to Downloads and check Automatic prompting for file downloads.

4. Click OK to accept changes, and close the browser.

To turn off UAC on each client:1. Log in as a user who has administrator privileges on the Windows Vista machine.

2. Open the Control panel and choose Administrative Tools.

3. In the left pane, choose User Accounts.

4. Choose Turn User Account Control on or off.

5. Uncheck Use User Account Control (UAC) to help protect your computer.

6. Click OK and restart the system.

To configure UCF to use file registry mode:1. Ensure the clients have checked in all checked out files.

2. Open the file ucf.installer.config.xml located in WDK-based applications directory/wdk/contentXfer.

3. Locate the element , which configures Windows clients.

4. Locate the child element ...

5. Change the value element to the following:file

6. Save and restart the application.



Enabling content transfer in FirefoxFirefox requires a setting to enable content transfer.

To enable file download in Firefox:1. Open the Options menu in Firefox.

2. In the Main dialog Downloads section, enable Show the Downloads window whendownloading a file and Close it when all downloads are finished.

3. Check Always ask me where to save files.

4. On the Tabs dialog, check New pages should be opened in: a new window.

5. On the Content dialog, check Load images automatically, Enable JavaSript, and Enable Java.

6. Install the Firefox add-on FireBug, which is available from mozilla.org.In Firefox version 3.x, the file browse tag () returns only the file name by defaultto address privacy concerns. For more information, refer to the developer information that is availableat https://developer.mozilla.org/en/Updating_web_applications_for_Firefox_3#File_upload_fields.

To add the preference on an individual end user basis:1. Type about:config in the browser location bar.

A warning message displays.

2. Click the Ill be careful, I promise! button or press Enter to acknowledge the error message.The about:config tab displays.

3. Do one of the following: If the preference is found and the value is false, change the value to true by double-clickingthe value or right-click and select Toggle.

If the preference is not available, add the preference:

Right-click the empty window space and select New > Boolean.


https://developer.mozilla.org/en/Updating_web_applications_for_Firefox_3#File_upload_fields


Enter signed.applets.codebase_principal_support as the preference name.

Close the browser, relaunch Firefox, search for the preference, and verify that thepreference value is true.

4. Create a file named user.js and add the following line to the file:user_pref("signed.applets.codebase_principal_support",true);

5. Push the user.js file into the user profile location of Mozilla Firefox. For more information, consultthe update available at: https://developer.mozilla.org/En/A_Brief_Guide_to_Mozilla_PreferencesThe user profile directory location for Mozilla Firefox differs depending on the operating system.For more information, see http://kb.mozillazine.org/Profile_folder.End users must allow the preference change when notified by the Internet Security alert:


https://developer.mozilla.org/En/A_Brief_Guide_to_Mozilla_Preferenceshttp://kb.mozillazine.org/Profile_folder


Supporting Outlook mail messageFrom Records 6.8 onwards, the email processing functionality has undergone significant changes.Refer to the EMC Documentum Records Client 6.8 Administration and User Guide for more details.

For performing any outbound operations on the email messages (that is, view, export, drag anddrop, and so on), the client host must have Microsoft Outlook client installed on it. For viewingnon-migrated email messages imported before Records 6.8, the client host must have ExMRE.exeinstalled on it. This software can be automatically installed as part of the UCF download. To enablethe automatic download and installation of ExMRE, uncomment the ExMRE.exe section in /wdk/contentXfer/ucf.installer.config.xml file on the Application Server andthen restart the Application Server.

Using Citrix Presentation Server ClientCitrix Presentation Server Client can be used as a web browser. Check the release notes for yourWDK-based product to determine whether Citrix clients are supported for your product.

In the Citrix environment, content files are exported or checked out to the Presentation Server host,not to individual client hosts. Each individual user works on a client host with an image of a webbrowser that is running on the Presentation Server host. For detailed information on enablingapplications on Presentation Server, refer to documentation provided by Citrix.

Note: If you have previously attempted to content transfer to the client, it will use the clients locationmachine, and youmust delete the ucf directory that was installed on the local client machine under theusers OS home directory, for example, C:\Documents and Settings\\Documentum\ucf.


Chapter 4Preparing the Application Server Host

This chapter describes the tasks you must complete to prepare the Application Server host beforedeploying your WDK-based application, and contains instructions that are shared by all WDK-basedproducts. The EMC Documentum Records Client Release Notes 6.8 provides more information on theapplication servers that are certified for your product.

Before you deploy a WDK-based application, ensure that your J2EE Application Server or servletcontainer is a supported version and that it can successfully serve sample JSP pages.

Tip: EMC recommends but does not require that you uninstall DFC 5.x and any application thatuses DFC 5.x and then reboot before deploying an application based on WDK 6.x. For uninstallprocedures, refer to the 5.x product documentation.

Your selected Application Server and optional external web server must be certified for Records 6.8.

EMC does not provide support for installing or running Application Servers. Contact the ApplicationServer vendor for technical support.

Setting the Java memory allocationThe minimum recommended Oracle Java memory allocation values for application servers on asmall system are the following:-Xms1024m -Xmx1024m -XX:MaxPermSize=128m

Application servers can slow down, throw exceptions, or crash with an application that has a largenumber of Java Server Pages. Set the MaxPermSize parameter to 128 or higher to avoid this problem.

Document caching can consume at least 80 MB of memory. User session caching can consumeapproximately 2.5 MB to 3 MB per user. Fifty connected users can consume over 200 MB of VMmemory on the Application Server. Increase the values to meet the demands of the expected user load.

To achieve better performance, add these parameters to the Application Server startup command line:-server-XX:+UseParallelOldGC

The word "server" must be the first parameter on the command line.

Performance will improve because the Java client VM is not suitable for long running server jobs andthe default Java garbage collector cannot clean up the heap quickly enoughespecially when theApplication Server machine runs on multiple CPUs.


Preparing the Application Server Host

The Oracle Java website provides more information on these settings. More information onApplication Server performance tuning and benchmarking for Documentum products is availablefrom your EMC Documentum SE or EMC Documentum Consulting.

Turning off failoverIf your Application Server and environment combination does not support failover, you can turnoff failover in app.xml. Refer to The EMC Documentum Records Client Release Notes Version 6.8 todetermine whether failover is supported for your environment.

If you do not turn off failover, you may see failover validation messages in the Application Server log,but these should not interfere with operations.

Note:Do not attempt to use the application in a failover environment that is not certified.

To turn off failover for the application, open app.xml in the custom directory and add the followingelement:

false

Preparing environment variables fornon-default DFC locationsThe base location for content transfer on the Application Server host is specified by the DFCenvironment variable dfc.data.dir. This location is specified as the value of the key dfc.data.dir indfc.properties located within the application WAR file in WEB-INF/classes. If this variable is not setin the environment for the Application Server, the default location is the Documentum subdirectoryof the current working directory. (The current working directory contains the Application Serverexecutable.) For example, in Tomcat the location is %CATALINA_HOME%/bin. On WebLogic, it is%BEA_HOME%/domains/wl_server/documentum.

By default, the checkout and export directories are subdirectories of the dfc.data.dir directory, andthe user directory is the same as dfc.data.dir. If you need to use non-default locations to changethe default location, you can create environment variables for dfc.checkout.dir, dfc.export.dir,and dfc.user.dir, respectively. The default value of dfc.registry.mode, which corresponds tothe key dfc.registry.mode in dfc.properties, is "file". The full path to this file by default isdfc.user.dir/documentum.ini. For a non-default file name or location, specify it as the value ofthe environment variable dfc.registry.file.

Preparing JBossThe EMC Documentum Records Client Release Notes version 6.8 contains information on the supportedversions of JBoss, Tomcat, and tc Server.



Configuring JBoss EAP 6.3.x1. If available, delete the dfc.keystore and wdk.keystore files in \bin

(Windows) and /bin (Linux).

2. Move the keystore files from \WEB-INF\classes (Windows) and /WEB-INF/classes (Linux) to the bin folder of the directory.

3. Copy the contents of the classes folder from \WEB-INF\classes (Windows)and /WEB-INF/classes (Linux) to a temporary location (for example,Temp-Loc).Execute the following command at Temp-Loc to create a web-inf-classes jar file:jar -cvf web-inf-classes.jar *

4. Copy the web-inf-classes.jar file to \WEB-INF\lib (Windows) and/WEB-INF/lib (Linux).

5. Delete the classes folder from \WEB-INF (Windows) and /WEB-INF (Linux).

6. Add the configuration entry (in bold) to the subsystem tag in standalone.xmlin \standalone\configuration (Windows) and /standalone/configuration (Linux) to disable tag pooling:

7. Configure the binding address by replacing 127.0.0.1 with the Application Server host IP addressin and tags in standalone.xml

8. Execute the following command at to repackage the Records war file:jar cvf records.war *

Classloader Settings1. Remove the following JARs located at records.war/WEB-INF/lib

jaxb1-impl.jar

jaxb-api.jar

2. Restart the Application Server.

Note: If you find any access denied security related errors while using Records, please perform thefollowing steps:1. Create a file called "records.java.security.policy" on the Application Server.

2. In this file, copy the following content:



grant codeBase "file:/-" {permission java.security.AllPermission;permission com.documentum.fc.client.impl.bof.security.RolePermission "*", "propagate";};grant {permission java.security.AllPermission;};

refers to the full path of the current location of deployed records.war

Example: In Windows, if records war is present in C:\jboss-eap-6.3\deployments, thecontent will be as follows:grant codeBase "file:/C:/jboss-eap-6.3/deployments/records.war/-" {permission java.security.AllPermission;permission com.documentum.fc.client.impl.bof.security.RolePermission "*", "propagate";};grant {permission java.security.AllPermission;};

In Linux, if records war is present in /home/jboss-eap-6.3/deployments, the contentwill be as follows:grant codeBase "file:/home/jboss-eap-6.3/deployments/records.war/-" {permission java.security.AllPermission;permission com.documentum.fc.client.impl.bof.security.RolePermission "*", "propagate";};grant {permission java.security.AllPermission;};

3. Add the -Djava.security.manager and -Djava.security.policy and entry in JAVA_OPTS variable inthe startup script of the Application Server.

Example: In Windows, if records.java.security.policy file is present under C:\jboss-eap-6.3folder, JAVA_OPTS will be as follows:JAVA_OPTS=%JAVA_OPTS% -Djava.security.manager -Djava.security.policy=C:\jboss-eap-6.3/records.java.security.policy

In Linux, if records.java.security.policy file is present under /home/jboss-eap-6.3 folder,JAVA_OPTS will be as follows:JAVA_OPTS="$JAVA_OPTS -Djava.security.manager -Djava.security.policy=/home/jboss-eap-6.3/records.java.security.policy"

Preparing Tomcat

Disabling tag reuse

You must disable tag reuse in /conf/web.xml. Find the JSP servlet entry and set theenablePooling initialization parameter to false (as shown in bold):

jsp



org.apache.jasper.servlet.JspServlet

enablePoolingfalse

forkfalse

xpoweredByfalse

3

Disabling HttpOnly property1. Modify the element in the context.xml file located at \conf:

From

To


Disabling whitespace parsing

To disable whitespace parsing, add the following line in the catalina.properties file located at\conf:

org.apache.jasper.compiler.Parser.STRICT_WHITESPACE=false

Improving performance on Tomcat 8.x

To improve performance on Tomcat 8.x, perform the following: Enable the Web Application Server compression.

Disable the WDK compression filter.

To enable the Web Application Server compression:1. Navigate to /conf.

2. Locate and open server.xml.

3. Search for Connector port=8080.It contains the following entry:


redirectPort="8443"/>

4. Append the following entry to the Connector tag:compression="on"compressionMinSize="2048"compressableMimeType="text/html,text/xml,application/xml,text/plain,text/css,text/javascript,text/json,application/x-javascript,application/javascript,application/json"useSendfile="false"

Here is the updated Connector tag (appended entry in bold):

To disable the WDK compression filter:Records 6.8 has a new flag to enable or disable the default the default WDK compression filter.

1. Open wdk/app.xml and navigate to the end of the document.

2. Search for the tag and set it to false.false

The default value is true.


Preparing vFabric tc Server

Disabling tag reuse

You must disable tag reuse in /conf/web.xml. Find the JSP servlet entry and set theenablePooling initialization parameter to false (as shown in bold):

jsporg.apache.jasper.servlet.JspServlet

enablePoolingfalse

forkfalse

xpoweredByfalse

3



Disabling HttpOnly property1. Modify the element in the context.xml file located at \conf:From

To


Preparing WebLogic serverThe following topic describes preparations that may be necessary before you deploy a WDK-basedapplication.

Deploying WAR

The Preparing the WAR file for deployment, page 125 section contains detailed information ondeploying the WAR file.

Disabling HttpOnly property1. Modify the element in the WebLogic.xml file located at

\webtop\WEB-INF:From

To false


Supporting large content transfer operations in amanaged server environment

If you are deploying in a WebLogic Managed Server environment and you use UCF to perform largecontent operations, set theWLIOTimeoutSecs parameter for the web server plugin to a very large



value. UCF requires a sticky session for a single operation. The Oracle documentation containsadditional details on Web Server Plug-in parameters.

Preparing IBM WebSphereRefer to the EMC Documentum Records Client Release Notes version 6.8 to determine whether IBMWebSphere is a supported Application Server for your product.

The following topics describe how to prepare the Application Server to support failover in a cluster,to apply policies for Java 2 security, and to support non-default content transfer locations. Refer to theEMC Documentum Records Client Release Notes version 6.8 to determine whether failover is supportedfor your application.

Supporting failover in a cluster

Failover in a clustered environment requires a setting. Set the NoAffinitySwitchBack customproperty to true in the WAS cluster. The WebSphere documentation provides more details on thecustom property setting.

Applying security policies for WebSphere security

If WebSphere global security is enabled for the Application Server, by default it enables Java 2security. Java 2 security requires security policies to be configured. You must apply the securitypolicies in the Documentum files app.policy, library.policy and was.policy. These files are availableon the download site or Download Center on support.emc.com in the compressed archivePolicyFiles.zip. These files contain the minimum set of policies that are required for the application torun without error. Add these policies to your existing files.

You must set up the environment variables that are referenced in these policies, and the ApplicationServer instance owner must have write permission on these directories. Define the followingenvironment variables: dfc.data.dir

By default, the dfc.data.dir directory is the Documentum subdirectory of the directory thatcontains the Application Server executable.

webtop.content.xfer

Specifies the temporary content transfer directory on the Application Server.

The policy files in PolicyFiles.zip contain the minimum required policies for the dfc.data.dirdirectory. To add additional policies for non-default content transfer locations, add the followinglines to library.policy. For each policy that you add, set up an environment variable that specifies thenon-default location.

Tip: Select only the policies that are needed for your application.



Policy for local user directory (non-default location) This policy is required if the user directoryfor the Application Server host machine is a non-default location. The default location is the sameas the location specified by the dfc.properties key dfc.data.dir.permission java.io.FilePermission "${dfc.user}${/}-", "read, write, delete";permission java.io.FilePermission "${dfc.user}", "read, write, delete";

Policy for checkout and export directories (non-default location) These environment variablesmust specify the same location as the value of the dfc.properties keys dfc.checkout.dir anddfc.export.dir. The default locations for these directories are checkout and export subdirectoriesof dfc.data.dir.permission java.io.FilePermission "${dfc.checkout}${/}-", "read, write,delete";permission java.io.FilePermission "${dfc.checkout}", "read, write, delete";

permission java.io.FilePermission "${dfc.export}${/}-", "read, write,delete";permission java.io.FilePermission "${dfc.export}", "read, write, delete";

Policy for DFC registry file (non-default location) The value of the dfc.registry environmentvariable must match the location specified in dfc.properties for the key dfc.registry.file.permission java.io.FilePermission "${dfc.registry}${/}-", "read, write,delete";permission java.io.FilePermission "${dfc.registry}", "read, write,delete";

Policy for Webtop temporary content transfer directory (non-default location) permission java.io.FilePermission "${webtop.content.xfer}${/}-", "read,write, delete";

permission java.io.FilePermission "${webtop.content.xfer}", "read,write, delete";

Policy for non-Webtop WDK-based temporary content transfer (non-default location) You canuse this policy for TaskSpace or other application that is not based on Webtop:permission java.io.FilePermission "${wdk.content.xfer}${/}-", "read,write, delete";permission java.io.FilePermission "${wdk.content.xfer}", "read,write, delete";

Policy for Documentum applications directory (non-default location) The default location isdfc.data.dir.permission java.io.FilePermission "${documentum}${/}-", "read,write, delete";permission java.io.FilePermission "${documentum}", "read, write,delete";

Policy for DFC class cache directory (non-default location) The default location isdfc.data.dir/cache.permission java.io.FilePermission "${dfc.cache.dir}${/}-", "read,write, delete";permission java.io.FilePermission "${dfc.cache.dir}", "read,write, delete";

Policy for Web Publisher



permission java.io.FilePermission "${wp.content.xfer}${/}-", "read,write, delete";permission java.io.FilePermission "${wp.content.xfer}", "read,write, delete";

Policy for Documentum Administrator permission java.io.FilePermission "${da.content.xfer}${/}-", "read,write, delete";permission java.io.FilePermission "${da.content.xfer}", "read,write, delete";

Policy for Digital Asset Manager permission java.io.FilePermission "${dam.content.xfer}${/}-", "read,write, delete";permission java.io.FilePermission "${dam.content.xfer}", "read,write, delete";

Policy for Content Intelligence Services permission java.io.FilePermission "${cis.content.xfer}${/}-", "read,write, delete";permission java.io.FilePermission "${cis.content.xfer}", "read,write, delete";

Policy for Records Client The following line needs to be added to the section grant codeBase"file:${jars}" in the app.policy file:permission java.io.FilePermission "${dfc.data.dir}${/}-", "read, write, delete";

Preparing to use an external web serverRefer to the EMC Documentum Records Client Release Notes version 6.8 to determine whether externalweb servers are supported for your product.

External web servers are sometimes used as a front end to the Application Server. For example, anexternal web server may be used for balancing the loads on a collection of application servers or usedas a forward or reverse proxy server.

UCF content transfer uses chunked transfer encoding, a standard of the HTTP 1.1 specification. Manyproxy web servers such as Sun Server implement chunked transfer encoding in a way that does notwork properly with UCF. If the external server does not support HTTP 1.1 chunked encoding, youmust configure UCF in the WDK-based application to use an alternative chunked encoding. TheWebDevelopment Kit Development Guide contains information on this configuration.

When deploying in a manager server or network deployment environment, the external web servermust provide session.


Chapter 5Installing the EMC DocumentumRecords Client and its recordsproducts: RPS, RM, and PRS

The Records products are named as follows: Retention Policy Services (RPS)

Its administration node in the Records Client navigation pane is also named Retention PolicyServices (RPS).

Records Manager (RM)

Its administration node in the Records Client navigation pane is also named Records Manager(RM).

Physical Records Services (PRS)

Its administration node in the Records Client navigation pane is named Physical Records Manager(PRM). In this instance, PRS and PRM can be used interchangeably to reference the same productor its administration node. PRM is typically used.

The following sections are included in this chapter: Overview, page 36

Primary steps, page 37

There are eight steps that cover the full gamut of installation: from downloading the files toinstalling the war file and the dar files. Follow the primary steps in the order listed. If you areperforming an upgrade, follow the instructions in Upgrading and Migrating previous versions ofRPS/PRM/RM to 6.8, page 57.

Note: Make sure that all records products installed on the same repository are of the same releaseversion. The Records war file must be the same version as the version of the RPS and RM dar filesinstalled on the repository. Do not mix versions of records products on the same repository. Forexample do not install RM 6.7 SP2 with RPS 6.5 SP3 or with PRS 6.5 SP3 on the same repository.Similarly, do not mix dar file versions of the records products. For example, do not mix RM 6.7SP2 dar files with any of the RM 6.5 SP3 dar files.

1. Download Records Client files, page 37

2. Create global repository, page 45

3. Create Records Client repository, page 45


Installing the EMC Documentum Records Client and its records products: RPS, RM, and PRS

4. Install DAR files with the DAR Deployer plug-in, page 46

5. Install DAR files using headless Composer on UNIX, AIX, and Linux, page 51

6. Installing records.war on the Application Server, page 51

7. Setup Documentum Administrator (DA), page 52

8. From the DA interface, register all DFC clients, page 53

9. Optional DoD functionality for configuring email records, page 53

Configuring users, roles, and audits, page 55

Troubleshooting the new installation, page 55

Upgrading from earlier releases, page 56

Upgrade paths and overview, page 56

Upgrading and Migrating previous versions of RPS/PRM/RM to 6.8, page 57

Migrating custom record relationship instances, page 59

Configuring the Records Security, page 61

Working with new Email Processing functionality, page 61

Working with email messages imported before Records 6.8, page 64

Configuring Records Activator for declaring email records from Microsoft Outlook, page 66

Installing the optional PRTS for PRM barcode label printing and batch processing, page 69

Batch Processing XML Schema for the optional PRTS, page 87

Instructions for updating the pass-along workflow, page 107

Configuring the disposition job to run successfully against objects with an Unknown dispositionstrategy, page 111

How to register and configure a disposition workflow (based on the shipped sample workflow),page 112

Setting up Records Queue Manager (RQM), page 118

If you have IRM-protected content, follow this step, page 120

OverviewThis chapter contains product specific information for installing the newly unified Records Client,and the records products it hosts, for the 6.8 release. Follow procedures in the applicable chapter forpreparing the Content Server, Application Server, and client host before proceeding to the primarysteps. Refer to the EMC Documentum Records Client Release Notes, version 6.8, to prepare themaccording to the hardware and software requirements specified for 6.8.

The Records Client is built on top of Webtop to include core Documentum functionality along withall records product functionality. The Records Client is a unified solution that makes it possible todeploy all the Documentum records products from a single war file. This leaves only the dar filesof the required records product to be installed and license activated. License keys can be entered



immediately during the installation process or at a later time. RPS is the base records product that canbe used as a standalone solution or combined with the other two as follows: RPS

RPS + RM

RPS + PRM

RPS + RM + PRM

Only basic Webtop functionality is accessible if none of the licenses are installed from the RecordsClient.

The GUI-based "DAR Deployer" plug-in for Composer is available on the download site.

Refer to the EMC Documentum Records Client Release Notes, version , before proceeding. Use therelease notes to ensure your system meets or exceeds environment and system requirements for newdeployments or upgrades. If your system components are not supported versions, follow instructionsin preceding chapters to prepare the Content Server, Application Server, and the client host. Also,any further information that would impact the deployment or upgrade would also be contained inthe release notes.

To complete and verify the deployment, after completing all of the major steps, refer to Chapter 8,Completing the Deployment.

If problems are encountered, refer to Troubleshooting the new installation, page 55.

Primary steps

Download Records Client files

All of the files you need to download for your combination of records deployment are identified inthis section.

The records.war file is the unified "Records Client" and is mandatory for any records deployment,regardless of the records products purchased or licensed. It can be downloaded from theDownload Center (https://emc.subscribenet.com) from the Documentum Retention Policy Services,Documentum Physical Records Manager, and Documentum Records Manager nodes.



Figure 2. Product information

Download the records.war file to the Application Server and also download the respective DARs,to the Content Server, according to Table 1, page 39, for your combination of records deployment.When downloading the various files, also make sure to download any language packs if support for aparticular language other than English is required.

For DAR file installation instructions, follow the primary steps for creating both the global andRecords Client (main) repositories. However, to install a particular language pack DAR and to applyit, refer to the following sections in EMC Documentum Web Development Kit Applications Language PackInstallation and Release Notes: "To install DAR with localized data dictionary properties files"

"Applying language packs"

The first procedure provides instructions to install the DAR against the repository, the secondprovides the WAR file deployment instructions against the Application Server. It does not matterwhich is done first if separate servers are used. EMC Documentum strongly recommends installingthe DAR Language Pack with the corresponding product DAR at the same time. The DAR deployerincludes an option you can select to install the language pack DAR when you install a productDAR. If you do not install it at the same time, and decide to install it at a later time, you will have tore-install the product DAR to select this option.

Before installing the product DAR with the localized data dictionary for the desired language,enable the required locale in the repository. When a repository is created, a set of data dictionaryinformation is loaded, based on the Content Server host locale. If the host locale is Russian, Arabic,Japanese, Korean, or Simplified Chinese, the data dictionary information for that locale is loadedduring repository creation. Otherwise, the host locale is always English. To add a locale, use thepopulation script provided by Documentum. You can populate and publish the data dictionary fileby following the procedures located in the "Populating and Publishing the Data Dictionary" appendixin the Documentum Content Server Administration and Configuration Guide.

Note: To avoid DAR deployer issues, EMC Documentum recommends that you store DAR filesassociated to a particular product in the same folder. Storing all of the DAR files of each of theproducts in the same folder is okay. However, if you are storing DARs in different folders, keepassociated DARs together in the same folder. This will prevent installer issues, in particular when theinstaller is used at a later time to install an optional DAR that has a dependency on another DAR.



The PRM DAR for example, cannot be installed successfully if the installer cannot find it in the samefolder from which the RPS DAR was installed.

Refer to the matrix in Table 1, page 39 to determine which DAR files to download for the combinationof records functionality desired.

For example, if you are licensed for only RPS, you need to download only the rps.dar file. However, ifyou plan to upgrade your existing RPS set up, you will need to download both the rps.dar and theRecords-Upgrade.dar files.

The matrix of miscellaneous files in Table 2, page 42 are optional downloads.Each of the 3 Records Client guides (user, release notes, and deployment (this guide)), listed afterTable 2, page 42, are all available on each of the records products download areas. The other guideslisted should also be obtained to facilitate the deployment.

Table 1. DAR file download matrix

DownloadArea

DARInstallOrder

DAR Name InstallDARto Fol-lowingRepos-itory

RPS PRM RM

Notes

1 rps.dar Main x x x This is the main DAR for Retention PolicyServices.

Caution: Make sure to manuallyresolve Pending Policies, if there areany, before installing the rps.dar for6.8.

2 prm.dar Main x This is the main DAR for Physical RecordsManager. If for any reason the RPS DARfile has to be reinstalled on installationswhere the PRM DAR file is also installed,make sure that the PRM DAR file is alsoreinstalled immediately after the RPS DARfile is installed.

3 rm.dar Main x This is the main DAR for RecordsManager.

4 rmce.dar Main x Optional. RMCE specific. Required onlyif you are creating Files, File Parts, andrecords according to Records ManagerCommonwealth Edition.

5 Forms.dar GlobalandMain

x This DAR is required for RecordsManager.This DAR installs the forms framework forthe repository.

6 RM-Forms-Adaptor.dar

Global x This DAR is also required for RecordsManager. This DAR deploys classesrequired for creating formal records.



DownloadArea

DARInstallOrder


RPS PRM RM

Notes

7 RM-Default.dar Main x Optional. Contains sample form templatefor formal records, formal folders, andformal cabinets. If this is not installed,no forms will be available for the defaulttypes.

8 RM-DoD5015v3-Standard-Record.dar

Main x Optional. DoD specific to version 3records functionality. Required only ifDoD version 3 standard records or DoDversion 3 email records are to be declared.

Note: The export directory for emailrecords must be specified on the JavaMethod Server if this DAR is installed.The Java Method Server must be modifiedwith the export directory to support emailexport functionality when the dispositionjob attempts to export email records. Alsonote that the Disposition job will notprocess disposition strategies that includea transfer strategy unless the Java MethodServer is running on a Windows machine.Refer to Optional DoD functionality forconfiguring email records, page 53 tospecify an export directory on the JavaMethod Server (JVM).

9 RM-DoD5015v3-Classified-Record.dar

Main x Optional. DoD specific to version 3records functionality. Required only ifDoD classified records are to be declared.The RM-DoD5015v3-Standard-Record.darhowever, must be installed first if theRM-DoD5015v3-Classified-Record.dar isinstalled.

10 RM-DoD5015-2.dar

Main x Optional. DoD specific to version 2records functionality. This DAR fileprovides support for older DoD version 2records and assures that they will functionproperly in the new system. It does notmigrate these records into the new version3 types however. For new installations,EMCDocumentum recommends installingthe RM-DoD5015v3-Standard record DARinstead.



DownloadArea

DARInstallOrder


RPS PRM RM

Notes

11 RM-DoD5015-4.dar

Main x Optional. DoD specific to version 2records functionality. This DAR fileprovides support for older DoD version 2records and assures that they will functionproperly in the new system. It does notmigrate these records into the new version3 types however. For new installations,EMCDocumentum recommends installingthe RM-DoD5015v3-Classified recordDAR instead.

12 prm-auto-queue.dar

Main x Optional. Although batch operations canbe uploaded manually, you will have toinstall this DAR if you plan to have it doneautomatically. Also, Documentum ProcessEngine (formerly BPM) must be installedbefore installing this DAR.

13 rps-sample.dar Main x Optional. It is meant to provide anexample on how to create a dispositionworkflow and needs to be installedafter the RPS DAR and anytime beforeRecords-Upgrade.dar.



DownloadArea

DARInstallOrder


RPS PRM RM

Notes

14 Records-Upgrade.dar

Main x x x Mandatory if upgrading from a previousrelease. For supported releases, referto Upgrade paths and overview, page56. Privileged DFC must be registeredfirst before this DAR can be installedsuccessfully. Install this DAR last ifyou plan to upgrade. There are "Specialinstructions" however that must befollowed before you install it. Referto Install DAR files with the DARDeployer plug-in, page 46 for the "Specialinstructions". This DAR performs datamigrations against both Records Managerand Retention Policy Services. If youtry to install this DAR and you have notupgraded all of the other DARs in therepository, it will not install. Make sureComposer is registered for privileged DFC.

Note: A Composer reference project file for example: rmce_ReferenceProject.zip,rm_ReferenceProject.zip, RM-Default_ReferenceProject.zip, and so forth, is included for each of therespective DAR files. You need the respective reference project file only if you plan to sub typeobject types from the artifacts of a particular DAR. Composer allows you to create referencesbetween projects to share resources such as Documentum artifacts, libraries, or Java ARchive (JAR)files. If any are needed, extract it and import it into Composer to run it.

Table 2. Miscellaneous files download matrix

Download AreaFile Name

RPS PRM RM

Notes

recordsServices-JavaDocs_6.8.zip

x x x Javadocs for the Java public API for records.

Records_Manager_Outlook_Client_6.8_windows.zip

x Contains the setup files for the Records Activator forMicrosoft Outlook 2007 that is used to declare formalemail records in conjunction with Records Manager.

Records_Man-ager_outlook_client_6.8_Win-dows_Out-look2010and2013.zip

x Contains the setup files for the Records Activator forMicrosoft Outlook 2010 and 2013 that is used to declareformal email records in conjunction with RecordsManager.




RPS PRM RM

Notes

rps-Webservices.zip

x x This is the package for installing Web Services for RPS.The PRMWeb Services is also included.

rm-webservices-6.8.zip

x x x This is the package for installing Web Services for RM.The RMWeb Services includes the Web Services for RPSand PRM. Therefore, there is no need to deploy the RPSWeb Services if this is deployed.

prts_6.8.zip x Required for both PRM label printing and batchoperations.

transformation.war x Required for only PRM label printing.

Rich_Media_Services_6.8_dar.zip

x Required for both PRM label printing and batchoperations.

Transformation_6.8_dar.zip

x Required for both PRM label printing and batchoperations.

RmlMigration.zip x Required for RM only if the RM 5.2.5 DocApp was everinstalled on your repository.

RETPOL-3789_Retention-MarkupUtility.zip

x Required if you have ever installed RPS 6.5 SP1 or youare experiencing symptoms related to RETPOL-3789.




RPS PRM RM

Notes

UpdateDDInfoFor-RetentionDate.ebs

x x Make sure this file is run when RPS or RM isupgraded. Updates data dictionary information forthe a_retention_date attribute of a dm_sysobject type.The a_retention_date attribute definition must beupdated to make it searchable in the Records Client. Thea_retention_date is labeled as Estimated Disposition.

dod_certification.zip

x This is an optional package that contains 5 utilities(follow instructions included in the README file ineach directory): ContentServerFileChecker

This tool checks the checksum of every sysobject inthe repository to ensure its integrity.

Tip: Do not run this utility against a repositorythat has a large number (millions) of sysobjects.Otherwise, this will run for a very long timeconsuming Content Server resources.

Delete Group

This is a docbasic ebs script that allows anadministrator to delete a group. It will remove allreferences from existing ACLs and groups. If acustomer is referencing the group from their owncustom attribute, they will need to update thereobjects.

Caution: This operation cannot be undone.

Group Renaming Utility

This is a docbasic ebs script that allows anadministrator to rename a group. It will replace allreferences of the group to the names for ACLs andgroups.

Note: The new group name should not already exist.

MakeClassificationGuideFirstInSearchColumns

This is an optional customization that forces theclassification guide to be first in search columns andprevents end users from changing the first column.

NamingPolicy

Instructions on how to define the naming policy thatis used for the naming and construction policy forDoD testing. Useful for non-DoD as an example.



Download the following PDF documents, before proceeding, so that you have them readily availablefor you to reference when instructed: EMC Documentum Records Client Administration and User Guide, version 6.8

EMC Documentum Records Client Deployment Guide, version 6.8 (this guide)

EMC Documentum Records Client Release Notes, version 6.8

EMC Documentum Administrator Deployment Guide, version 6.8

EMC Documentum Administrator User Guide, version 6.8

EMC Documentum Web Services for Records Manager and Retention Policy Services Deployment Guide,version 6.8

EMC Documentum Web Development Kit and Webtop Deployment Guide, version 6.8

EMC Documentum Composer User Guide, version 7.2

EMC Documentum Kit Applications Language Packs Installation and Release Notes, version 6.8

Create global repository

When an EMC Documentum installation includes multiple repositories, certain installation-wideelements are shared among all repositories. To manage these installation-wide elements, each EMCDocumentum installation includes a central repository called the global registry, also known asthe global repository.

A global repository is a mandatory requirement for records functionality, refer to Required andoptional supporting software, page 15 for more details. Although the global repository and themain repository can be the same repository, EMC Documentum strongly recommends creatingthem separately.

Create a global repository on the Content Server, for shared access to privileged code (privilegedDFC), if one has not already been created. Then, only if you are licensed for RM however, install boththe forms DAR (Forms.dar) and the forms adaptor DAR (RM-Forms-Adaptor.dar) using Composer,according to the DAR Install Order in Table 1, page 39.

Note: Both Forms.dar and RM-Forms-Adaptor.dar need to be installed on the global repository. OnlyForms.dar has to be installed on both the main repository for which RM is licensed and on the globalrepository. If more than one main repository is involved, install it on all of them.

Create Records Client repository

Create the main repository, that is the application repository for the Records Client. During thecreation of the main repository, you can enter the license keys for RM, RPS, and PRMwhen prompted.Note that you can also enable (and disable) the license, from Documentum Administrator, anytimeafter the repository has been created. Refer to "Configuring licenses" in the EMC DocumentumAdministrator User Guide.


Installing the EMC Documentum Records Client and its records products: RPS, RM,