EMC Documentum Physical Records Transformation Services

Transcription

1 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide EMC Corporation Corporate Headquarters: Hopkinton, MA

2 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners. Copyright 2010 EMC Corporation. All rights reserved.

3 Table of Contents Preface... 7 Chapter 1 Physical Records Transformation Services Overview... 9 What is Content Transformation Services?... 9 Content Transformation Services scalability What is Physical Records Transformation Services? Physical Records Transformation Services environment Physical Records Transformation Services Documentum Foundation Classes Physical Records Transformation Services plug-ins Rendering applications for supported source formats Chapter 2 Getting Started Selecting the server host Setting up a global registry repository Installation prerequisites Software prerequisites Uninstalling older versions of Physical Records Transformation Services Setup verifications Identifying a Connection Broker in dfc.properties Checking Connection Broker and repository services Chapter 3 Installing Physical Records Transformation Services Pre-Installation tasks Downloading the installers Preparing the Physical Records Transformation Services host Installing and configuring Physical Records Transformation Services Physical Records Transformation Services installation overview Required Physical Records Transformation Services installation information Installing Physical Records Transformation Services Installing CTS DAR files Configuring headless Composer Installing a DAR file with DAR Installer Plugin Configuring an instance of Physical Records Transformation Services Configuring a repository for Physical Records Transformation Services Enabling a DFC installation to access a global registry Additional steps for label printing if your application server is Weblogic Configuring a CTS product to the global registry Post-installation tasks Installation troubleshooting EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 3

4 Table of Contents Cannot pass SuperUser and repository user information screen If Physical Records Transformation Services installation fails If cts_instance_info is not created when the Configurator is executed Chapter 4 Verifying, Expanding, Removing, and Uninstalling Physical Records Transformation Services Verifying the Physical Records Transformation Services installation Verifying startup of Physical Records Transformation Services Expanding Physical Records Transformation Services Configuring Physical Records Transformation Services for another repository Removing the Physical Records Transformation Services instance from a repository Uninstalling Physical Records Transformation Services EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

5 Table of Contents List of Figures Figure 1. Typical Physical Records Transformation Services installation Figure 2. Profile Migration Confirmation Dialog Box Figure 3. Documentum records manager download page Figure 4. Properties for prm_docbase_config EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 5

6 Table of Contents List of Tables Table 1. Required Physical Records Transformation Services installation information Table 2. Description of DAR Installer Fields EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

7 Preface This guide describes how to install Documentum Physical Records Transformation Services for Windows. It lists installation prerequisites and provides step-by-step instructions for installing and uninstalling Physical Records Transformation Services. In addition, this manual includes a brief overview of Physical Records Transformation Services architecture. Refer to Documentum Records Manager Release Notes, version 6.5 SP3, for possible updates and to ensure your system requirements are met or exceeded. Intended audience This guide is intended for the person who installs Physical Records Transformation Services, often called the system administrator or system operator. It is assumed that the system operator has a basic understanding of the Windows operating system. This guide is not intended as a development guide for Transformation Services plug-ins. Contact your Documentum account representative for availability of the Content Transformation Services Product Development Guide which includes more information and instructions on developing your own plug-ins. Revision history The following changes have been made to this document. Revision history Revision date April 2010 Description Initial publication. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 7

8 Preface 8 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

9 Physical Records Transformation Services Overview Chapter 1 This chapter contains a brief overview of Physical Records Transformation Services and outlines a typical Physical Records Transformation Services installation. It gives a basic description of the Documentum environment and relates the Physical Records Transformation Services components within the installation. This chapter contains the following sections: What is Content Transformation Services?, page 9 What is Physical Records Transformation Services?, page 10 Rendering applications for supported source formats, page 13 What is Content Transformation Services? Content Transformation Services (CTS) is a name used for a set/suite of Documentum server products that integrates with Content Server to perform transformations and analysis on repository content. CTS includes these main products: Physical Records Transformation Services (PRTS) Advanced Document Transformation Services (ADTS) Document Transformation Services (DTS) Media Transformation Services (MTS) XML Transformation Services (XTS) Additional components are available for some of these products. For example, Media Transformation Services can be extended by installing additional transformation services, such as Audio/Video Transformation Services (AVTS). These components supplement the features already provided by the base product, according to your organization s requirements. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 9

10 Physical Records Transformation Services Overview Content Transformation Services scalability Content Transformation Services (CTS) products allow for a high level of scalability. All CTS products run under the same Windows Service on the CTS host. This means that stopping or starting the CTS service stops or starts all the CTS products on that host. For example, if your CTS host contains Physical Records Transformation Services and Media Transformation Services, stopping the CTS Windows Service stops both of those products. Each CTS product can be configured for multiple repositories. If you have one installation of a product on a host, that installation can be configured against different repositories. CTS scalability also allows for several instances of Content Transformation Services products on different hosts to be configured for the same repository. This means that your installation can take either of two forms: one with identical plug-in capabilities, or one with different plug-in capabilities. The ability for each instance of Physical Records Transformation Services to handle different plug-ins means that you can have each instance dedicated to a specific type of transformation. For example, you might have a dedicated Physical Records Transformation Services for processing labels and a dedicated Physical Records Transformation Services for processing batch operation files. In this case, each instance uses different plug-ins to optimize performance, but all instances point to the same repository. The other benefit of having identical Physical Records Transformation Services installations is that a hardware failure in one instance will not stop all installations from processing queue items. In cases where each instance of Physical Records Transformation Services has different plug-in capabilities, each server accepts only those items from the processing queue that it is capable of handling. To enable this functionality, Content Transformation Services has format awareness. Format awareness is the ability for a Content Transformation Services product to recognize which file formats it is capable of processing. Items that cannot be processed successfully will be removed from the queue automatically. For example, if several transformation requests are made for JPEG files, but the product does not support JPEGs, the system will remove those items from the queue. A check for unprocessed items is performed periodically. What is Physical Records Transformation Services? Physical Records Transformation Services is one of the transformation services provided by Content Transformation Services (CTS) as described under What is Content Transformation Services?, page 9. Although the various transformation products offer specific transformation capabilities for a particular set of source formats, PRTS is used by Physical Records Manager (PRM) for the following operations: Label printing of barcodes. The label rendering plug-in integrates with NiceLabel (which needs to be installed). Note: EMC Documentum supports NiceLabel Suite and NiceLabel Pro 5.1 and 5.2. NiceLabel by Euro Plus is a third-party product that you can download from NiceLabel site, 10 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

11 Physical Records Transformation Services Overview EMC Documentum recommends installing version 5.2, or upgrading to version 5.2 if you already have version 5.1 installed. Batch processing operations, for Physical objects with barcodes. There is no need to install PRTS if neither of these functions are used. There is no need to install NiceLabel for label printing if you do not use barcodes. There is also no need to install NiceLabel to perform batch processing operations. Label printing and Batch processing are described in greater detail in the Records Manager Administrator User Guide. Batch processing, in brief terms, relies on scanning barcodes for a selected operation and uploading scanned results in XML schema files to match inventory records in the repository against the actual physical objects in the warehouse. The family of batch/scanning operations include: Mark shipped for charge-out/export Mark as destroyed Charge-in Charge-out Move Reconciliation Physical Records Transformation Services environment The diagram below shows a typical Physical Records Transformation Services installation on the Documentum platform. Figure 1. Typical Physical Records Transformation Services installation Physical Records Transformation Services Physical Records Transformation Services is integrated with Documentum Content Server to process, store, and manage files within the Documentum schema. When a user imports an XML file for either label printing or batch processing into the repository, the Content Server stores the register EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 11

12 Physical Records Transformation Services Overview request object (dm_queue_item) in a queue. Physical Records Transformation Services logs in to the repository as a user, examines the queue, retrieves the request objects, and sends them to the appropriate plug-in for processing. Each request object is associated to a particular batch processing operation, move and reconciliation for example. Documentum Foundation Classes The Documentum Foundation Classes (DFC) are a set of Java classes that provide access to Content Server functionality. Web-based applications, such as Digital Asset Manager and Web Publisher, make calls directly to the DFC or indirectly through the Web Development Kit (WDK). DFC must be installed on the Physical Records Transformation Services host, and is included with the installer. During installation, the Physical Records Transformation Services installer checks for an existing DFC on the host. The following scenarios are possible: If DFC does not exist on the host, the installer installs the correct version. If an older version of DFC exists on the host, it is replaced by the version included with the installer. Refer to the relevant version of the Documentum System Migration Guide available on the Download Center at for more information on migration issues. Follow the Documentum Foundation > Documentation for Documentum 6.5 SP3 link. Any applications that were dependent upon the older version of the DFC will have to be upgraded as well. For more information on the DFC and its effect on other applications, refer to your specific Documentum application documentation. If a version of DFC exists and it is newer than that which is included with the installer, it will be left untouched. Physical Records Transformation Services plug-ins PRTS has two built-in plug-ins, one for label rendering and one for batch operations, as part of Physical Records Services. There is no need to install PRTS if you do not plan to print labels or perform batch operations. The label rendering is a third-party plug-in that integrates with NiceLabel. NiceLabel define rules and prints labels from Physical Records Transformation Services. EMC Documentum recommends installing NiceLabel version 5.2, or upgrading to version 5.2 if you already have version 5.1 installed. Plug-ins are extensible. You can configure plug-in types and formats, and you can add new plug-ins to the system to support new file formats as required. For information about creating and adding new plug-ins, contact your Documentum account or support representative. 12 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

13 Physical Records Transformation Services Overview Rendering applications for supported source formats PRTS can be set up if needed with the NiceLabel application that is used for label rendering and printing. You can install PRTS for batch processing and at any time install NiceLabel for label printing whenever it may be required. Note: The "Sample NiceLabel 5.x Template.lbl" can be fond in the /Templates cabinet in the repository, if the PRM dar is installed. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 13

14 Physical Records Transformation Services Overview 14 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

15 Chapter 2 Getting Started This chapter explains how to prepare for installing Physical Records Transformation Services on a Windows host. It describes pre-installation requirements. This chapter contains the following sections: Selecting the server host, page 15 describes requirements for selecting the Physical Records Transformation Services host. Setting up a global registry repository, page 16 describes requirements for selecting a global registry. Installation prerequisites, page 16 describes software and setup that is required before installing Physical Records Transformation Services. Selecting the server host This section provides basic guidelines for selecting the host machine for your Physical Records Transformation Services installation. Caution: To ensure optimal system performance, Physical Records Transformation Services should not be: Installed on the same host as Content Server or the FAST (Full Text Index) Server. This configuration is not supported by Documentum. When selecting the Physical Records Transformation Services host, consider the amount of memory on the candidate server. Physical Records Transformation Services requires an amount of memory equal to at least twice the size of the largest file you expect to process. All Content Transformation Services products installed on a host use the same Windows service. This means that any actions (such as starting or stopping an application) performed on that Windows service affect all of the CTS products using it. The number of products installed on a single host, the expected usage of those products, and the host s hardware capabilities are major factors in selecting the host. If you are planning to use the same host for more than one CTS product, ensure that it has sufficient hardware and processing capabilities for optimal performance. For more information on CTS scalability, refer to Content Transformation Services scalability, page 10. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 15

16 Getting Started Setting up a global registry repository Elements that are part of PRTS are installed when the CTS dar files are installed. CTS has its DARS installed in the global registry. There are no PRTS dar files to install. When a global registry is enabled, you can deploy service-based objects automatically from the central repository designated as the global registry, and network locations created in the global registry are available in distributed configurations. The global registry is enabled during repository configuration, refer to Configuring a repository for Physical Records Transformation Services, page 31 for further information. There is no limit to how many repositories may be configured as global registries; however, you may need more than one global registry if you have applications that have very different user access levels. If the global registry does not have the Content Transformation Services product configured against it, then the transformation and rich_media_services DARs must be manually run against the global registry. Note: If the global registry repository is not configured, refer to Enabling a DFC installation to access a global registry, page 32 for further information about enabling the global registry. To set up a global registry repository: 1. Determine which repository will function as the global registry. 2. During repository configuration, you will be prompted to provide the user login name and password for the global registry user. By default, the global registry user has the user name of dm_bof_registry. The global registry user s account is used by DFC clients to connect to the repository to access required service-based objects or network locations stored in the global registry. The global registry user has Read access to objects in the /System/Modules and /System/NetworkLocations only, and no other objects. 3. When you install DFC on client machines, provide those DFC installations with the global user login credentials. This applies to Desktop installations on end-user computers, to WDK-based clients such as Webtop on application server host, and to the DFC instance on Content Server and remote Content Server hosts. 4. Ensure that the global registry repository projects to connection brokers known to the DFC instances that must access the global registry. Identifying a Connection Broker in dfc.properties, page 17 provides instructions. 5. Install the two CTS dar files, "Rich Media Services" and "Transformation" dars, on the global repository. 6. Proceed to instructions to configure PRTS. Installation prerequisites This section describes the prerequisites for a successful Physical Records Transformation Services installation. 16 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

17 Getting Started Software prerequisites Documentum Content Server must be installed, configured, and running properly on your network before you install Physical Records Transformation Services. Uninstalling older versions of Physical Records Transformation Services If you are installing Physical Records Transformation Services on a host that has a previous version of Physical Records Transformation Services, you must properly uninstall it first. If you do not uninstall the previous version, your new installation of Physical Records Transformation Services may fail. For information and instructions on uninstalling Physical Records Transformation Services, refer to Uninstalling Physical Records Transformation Services, page 43, or refer to the Installation Guide for your existing version. Setup verifications Prior to installation, verify the following: WinZip or a similar file-extraction utility is installed on the host machine. If you already have a dfc.properties file, it is pointing to the correct Connection Broker. Identifying a Connection Broker in dfc.properties, page 17 provides instructions. The Connection Broker and repository services are running on your Content Server. Checking Connection Broker and repository services, page 18 provides more information on this topic. Identifying a Connection Broker in dfc.properties If you already have Documentum Foundation Classes (DFC) installed on your Physical Records Transformation Services host, you will have a dfc.properties file. Follow this procedure to ensure that the correct Connection Broker is specified. If you are installing Physical Records Transformation Services on a clean host, you will not have a dfc.properties prior to installation; in this case, the following procedure is not required. For more information on the Connection Broker, refer to Content Server Administration Guide. To identify the correct Connection Broker in dfc.properties: 1. Search for the dfc.properties file on your Physical Records Transformation Services host. The file is usually located in the Windows (C:\Documentum\config.) folder. 2. Open dfc.properties in a text editor. 3. Find the line indicating the Connection Broker. Ensure that the specified Connection Broker is the one that contacts the repository. Change it if necessary. 4. Save and close the dfc.properties file. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 17

18 Getting Started Checking Connection Broker and repository services The Connection Broker and repository services must be running properly on the Content Server host before you install Physical Records Transformation Services. The Content Server Administration Guide should be referenced for information and instructions pertaining to Connection Broker and repository services. 18 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

19 Chapter 3 Installing Physical Records Transformation Services This chapter explains how to install Physical Records Transformation Services on a Windows host. It describes the installation process, provides information needed to perform the installation, and contains step-by-step instructions for installing the Physical Records Transformation Services. Post-installation tasks, configuration tasks, and troubleshooting information are also provided. This chapter contains the following sections: Pre-Installation tasks, page 19 Installing and configuring Physical Records Transformation Services, page 20 Installing CTS DAR files, page 26 Configuring a CTS product to the global registry, page 34 Post-installation tasks, page 34 Installation troubleshooting, page 37 Pre-Installation tasks This section explains what to do before you install the Physical Records Transformation Services. It specifies the software to install before you start, and explains how to configure it. Downloading the installers Before beginning the installation process, it is best to have all installers ready and available on your Physical Records Transformation Services host. Download the installers from the Documentum Download Center ( to a temporary directory on your Physical Records Transformation Services host. On the EMC Software Downloads page, navigate to Documentum, Inc, select Documentum Physical Records Manager and download the zip file for Physical Records Transformation Services, Version 6.5 SP3 (zip) from the product list. Unzip any zipped files before you proceed with the installation. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 19

20 Installing Physical Records Transformation Services Preparing the Physical Records Transformation Services host You can install NiceLabel Suite or NiceLabel Pro 5.1 or 5.2 and the Adobe print driver for label printing/rending before or after PRTS is installed and configured. The Records Manager Release Notes provides information on specific versions of hardware and software supported for this release. Note: Make sure all installed programs have been launched and the registration dialog box no longer appears. The registration screen that appears in some newly installed programs may interfere with Physical Records Transformation Services processing. Note that all applications must be closed prior to installing Physical Records Transformation Services. Installing and configuring Physical Records Transformation Services Before installing Physical Records Transformation Services for the first time, ensure that you have fulfilled all of the Installation prerequisites, page 16. After installing Physical Records Transformation Services, you can verify that your installation is running correctly. Verifying the Physical Records Transformation Services installation, page 39 explains this procedure. If you have already installed Physical Records Transformation Services, but would like to add a new instance to a repository, Expanding Physical Records Transformation Services, page 40 provides instructions for doing so. Physical Records Transformation Services installation overview Physical Records Transformation Services installation is accomplished as a three-part process: 1. Install Physical Records Transformation Services. 2. Install CTS dar files on all repositories that host PRM and the global repository. 3. Configure Physical Records Transformation Services to serve at least one repository. The standard configuration procedure is found at Configuring an instance of Physical Records Transformation Services, page 29. Note: CTS DAR files must be installed prior to running the Configuration Utility. See Installing CTS DAR files, page 26 for further information. The Physical Records Transformation Services installation includes the required Documentum Foundation Classes (DFC) Runtime Environment, the necessary Java components, and the Physical Records Transformation Services supporting files. To create an additional instance of Physical Records Transformation Services (described in Expanding Physical Records Transformation Services, page 40) or to remove Physical Records Transformation Services from a repository (described in Removing the Physical Records Transformation Services 20 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

21 Installing Physical Records Transformation Services instance from a repository, page 42), you do not have to run the Installer again. The Configurator allows you to add and remove instances of Physical Records Transformation Services and will be accessible from the Windows Start menu after installation. If you are reinstalling Physical Records Transformation Services, you must properly uninstall your previous version of Physical Records Transformation Services first. If you do not uninstall Physical Records Transformation Services first, your new installation may fail. Refer to Uninstalling Physical Records Transformation Services, page 43. Required Physical Records Transformation Services installation information This section provides a table for recording the information you will need to install Physical Records Transformation Services. Having this information ready and available prior to installation ensures the accuracy and efficiency of your installation. Table 1. Required Physical Records Transformation Services installation information Installation information Description Your value DFC Installation Directory This is the destination directory for DFC. DFC User Directory Connection Broker Host Name (if not detected) Physical Records Transformation Services installation directory The default is directory C:\Program Files\Documentum\CTS. This is where the log files for DFC and Physical Records Transformation Services are stored, where exported documents are stored, and where checked out documents are stored. The default directory is C:\Documentum. If the correct DFC has not yet been installed on the host, you will be prompted for the Primary Connection Broker host name servicing the repository you want to configure with Physical Records Transformation Services, during installation. The directory in which to install Physical Records Transformation Services. It is recommended that you install Physical Records Transformation Services in the default installation directory. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 21

22 Installing Physical Records Transformation Services Installation information Description Your value Physical Records Transformation Services host The name of the machine on which you are installing Physical Records Transformation Services. (if not detected) Repository SuperUser name and password Repository user name You may need to enter this information if it is not automatically detected by the installer. The account the Physical Records Transformation Services uses to login to the repository. Ask your administrator to supply you with a SuperUser name and password. EMC recommends that you use the install owner. You cannot use the dm_mediaserver user account as the repository SuperUser. The name of the user who will receive notifications from Physical Records Transformation Services. Physical Records Transformation Services notifies the user of the results of processing. For example, if Physical Records Transformation Services fails to process a particular item, it queues an event to the Inbox of the Physical Records Transformation Services system operator user (sysopuser). Domain name This user should be different from the dm_mediaserver user. The name of the domain against which the user is authenticated. Use the fully qualified domain. 22 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

23 Installing Physical Records Transformation Services Installation information Description Your value Global registry dm_bof_registry Different DFC installations can use different global registries where required service-based objects or network locations are stored. A single DFC installation can have only one global registry. You will be prompted during installation for the primary registry. By default, the global registry user has the user name of dm_bof_registry. During repository configuration, provide the user login name and password for the global registry user. The global registry user should be someone other than the administrator. Installing Physical Records Transformation Services The following procedure installs the service and supporting files for Physical Records Transformation Services. Complete the information in Table 1, page 21 prior to performing this procedure. Note: Some screens mentioned below may not appear during your installation, depending on what is already installed on the Physical Records Transformation Services host. To install Physical Records Transformation Services on the host server: Note: If you want to install CTS for other transformation services along with PRTS services, on the same application server, make sure they are same version. Run the 6.5 SP3 versions of their executables prtswinsuitesetup.exe and prtswinsuitesetup.exe.installed for example. 1. Log in to the selected Physical Records Transformation Services host as an administrator. 2. Ensure that no programs or applications are running on the host. 3. Grant the Documentum install owner "logon as service" rights. a. Click Start > Settings > Control Panel. b. Double-click Administrative Tools. c. Double-click Local Security Policy. d. Open Local Policies. e. Open User Rights Assignment. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 23

24 Installing Physical Records Transformation Services f. Open Log On as a Service. g. Click Add. h. Select the user you want to grant logon service access to and click OK. i. Click OK to save the updated policy. 4. Navigate to the folder containing the unzipped Physical Records Transformation Services installation files. Downloading the installers, page 19 provides information about where the files should be located. 5. Double-click prtswinsuitesetup.exe. The Physical Records Transformation Services Installer splash screen is displayed, followed by the Welcome screen, which lists the components being installed. Figure 2. Profile Migration Confirmation Dialog Box 6. Click Next. The license agreement terms are displayed. 7. Select the option to accept the terms of the license agreement, then click Next. 8. The Installer checks for any versions of the DFC currently installed on the host. If a version of the DFC older than that which is installed is detected, you are prompted to uninstall it before resuming the Physical Records Transformation Services installation. Refer to 24 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

25 Installing Physical Records Transformation Services the Documentum System Migration Guide, available on the Documentum Download Center, for more information on migration issues. If a newer version of DFC is already installed, the Installer will not replace it. 9. The DFC Runtime Environment Optional Features screen appears. Select the Developer Documentation if you want it installed and then click Next. The Primary Interop Assembly Installer is not required. 10. On the Directory for Documentum Software screen, change the destination folder for DFC (the default is C:\Program Files\Documentum\), if required, then click Next. To accept the default, click Next. Note: If you already have the correct version of the DFC on your system, you will not see this screen; go to Step You are prompted to enter the User Directory for DFC Runtime Environment. This is where exported documents, checked out documents, and DFC log files are stored. The default directory is C:\Documentum. If required, change the user directory for DFC, then click Next. To accept the default directory, click Next. Note: If you already have the correct version of the DFC on your system, you will not see this screen; go to Step You are prompted to enter a Connection Broker host name (or IP address) and port number. Type the name of the Connection Broker host name in the Connection Broker Host Name field and, optionally, type the port number in the Port Number field, and click Next. Note: If you already have the correct version of the DFC on your system, you will not see this screen; go to Step Specify the Content Transformation Services installation directory (for core components that all CTS products use). You can click to Next to accept the default Destination Directory or click Browse to select a preferred location and then click Next. The Installer creates a directory named CTS within the chosen directory. It is recommended that you accept the default directory (for example, C:\Program Files\Documentum\CTS), which is where other Documentum products are installed. 14. Identify the host name of the host machine. This may be detected automatically, if you are installing directly from the host. Otherwise, enter the network host name, and click Next. 15. Specify the port number to which the CTS Administration Agent will be configured. This port is used to connect to CTS WebServices in conjunction with Documentum Administrator to communicate with the CTS hosts. The default port number is Enter a port number and click Next. Note: You must run the configurator for every repository, if you have more than one. It is not necessary however to run it on the global registry/repository, unless it is your only repository. 16. Enter the Documentum Content Transformation ServicesAdmin user name and password; if you are installing for a domain user, use the format <username>@<domain> in the Admin user name field. Click Next. 17. The Installation Summary screen appears, listing the applications that will be installed. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 25

26 Installing Physical Records Transformation Services Note: If the correct version of DFC is already installed, the summary screen will show that DFC will be refreshed. If you are satisfied with the installation confirmation, click Next. If you want to change a component of the installation, use the Previous button to navigate back through the Installer and change the install information. 18. The installation proceeds. If a message appears advising you that the _jvm directory already exists, click Yes to overwrite the directory. 19. If migration is taking place, the installer will now migrate all of the old profiles automatically. A dialog box appears confirming the following information: A pre-migration report will be generated and will be available at C:\PROGRA~1\DOCUME~1\CTS\migration\log. Click on Next to start the migration process. It is important to backup these profiles before changes are made to them. If you have backed up your old profiles. Select Next. The installation proceeds. 20. Click "Designate the global registry box", when the "DFC Global Registry" designation screen appears, and enter the repository name and the password. Use the default global registry user name "dm_bof_registry" or identify the global registry repository to be used and then enter the password. This should be someone other than the Documentum administrator. Select Test Connect, (recommended) if desired, and then click Next. 21. Click Finish when the installation completes successfully. The Installation Wizard closes. Note: It is strongly recommended that you restart your system after installation. If this is the first installation of Physical Records Transformation Services on the host, proceed to Installing CTS DAR files, page 26. Installing CTS DAR files You must install CTS DAR files before configuring CTS products to get all the latest changes/enhancements. Install both DAR files, shown in the following list, in the global repository and each repository that will be configured for Physical Records Transformation Services. There are two CTS DAR files which are included in the PRTS build: Rich Media Services DAR file Transformation DAR file The DAR files can be installed from any machine with the latest version of headless Composer and the DAR Installer plug-in on the local machine. Headless Composer is installed as part of Content Server version 6.5. Headless Composer can be found at C:\Documentum\<product>\6.5\install\composer\composer\ComposerHeadless on the Content Server Host. If Content Server is of a version other than 6.5, you will need to download and install headless Composer before attempting to install the CTS DAR files. Headless Composer is available on the EMC 26 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

27 Installing Physical Records Transformation Services download site as part of Documentum Developer Studio. Consult the Documentum Composer User Guide for more information about Composer. Note: You must have Documentum Superuser privileges for the repositories in which you are installing the DAR files. Configuring headless Composer The headless Composer zip file has the format DCTM_Headless_Composer_<platform>_<version>. zip. To configure headless Composer: 1. Extract the headless Composer.Zip file to a directory of your choice on your local machine. The directory name must not contain any spaces. 2. Open the dfc.properties file at:..\composerheadless\plugins\com.emc.ide.external.dfc_1. 00\documentum.config with a text editor. 3. Add the DFC and connection broker information, similar to the following: dfc.docbroker.host[0]=[docbroker IP address or host name] 4. Save your changes and close dfc.properties. Installing a DAR file with DAR Installer Plugin You can use the DAR Installer Plugin to install a DAR file to a repository if you do not want to use the interface within Composer. The DAR Installer plugin requires Composer or Headless Composer to be installed, but does not launch the full Composer IDE. The DAR Installer Plugin is useful in cases where you want to de-couple the development of DAR files from the installation of DAR files. It is also useful in situations where installation of DAR files is required as part of a deployment process. When you open the DAR Installer program, it creates three folders in your Composer installation directory: darinstallerconfig - contains configuration files for the DAR Installer program darinstallerlogs - the default location of the log files darinstallerworkspaces - workspaces that are created and used by the DAR Installer program. The DAR Installer program does not delete these workspaces automatically, so you occasionally have to clean up this directory. The workspace directories are named in the following form: darinstaller_workspace_yyyy-mm-dd-hh-mm-ss. The DAR Installer requires you to fill in certain values that are marked with an asterisk (*). All other fields are optional. For a description of the fields for the DAR Installer Utility, refer to Table 2, page 28. To install a DAR file with DAR Installer Plugin: DAR files are installed one at a time. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 27

28 Installing Physical Records Transformation Services 1. Download the DAR Installer zip file from the same place that you downloaded Composer. You can find the DAR Installer Plugin by going to and searching for "Composer to reach the Documentum Composer download site. 2. Unzip the DAR Installer zip file to the root of your Composer or headless Composer installation directory. 3. Run darinstaller.exe, which is located in the Composer root directory, to start the DAR Installer Plugin. 4. In the DAR Details section, specify values for the fields. 5. In the Connection Broker Details section, specify values for Connection Broker Host and Connection Broker Port and click Connect. 6. In the Repository Details section, specify values for the fields and click Install to install the DAR file to the repository. Refer to the Description of DAR Installer Fields table to help guide you through the DAR file install process. 7. Repeat steps 2-4 for the next DAR file. 8. Proceed to Configuring an instance of Physical Records Transformation Services, page 29. You can view the log for the DAR installation by selecting the log file from the Log File drop down menu and clicking Open. Table 2. Description of DAR Installer Fields Parameter Required Description DAR Yes The absolute file path to the.dar file that you want to install. The file path cannot contain any I18N characters or the installation will fail. Input File No The absolute file path to the install-based parameter file Local Folder No The absolute file path to localized.properties files. If you want to make your application available in other languages, you must localize the project data such as labels, tabs, and descriptions. Log File No The file to save the log to. If this is not specified, the file defaults to <DAR>.log Connection Broker Host Yes The address of the Connection Broker Connection Broker Port Yes The port of the Connection Broker Repository 28 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

29 Installing Physical Records Transformation Services Parameter Required Description Repository Yes The name of the repository that you want to install the DAR file to. Click on the Connect button after entering the Docbroker host and port to retrieve the available repositories. User Name Yes The login name for the repository Password Yes The password for logging into the repository Domain No The domain where the repository resides Configuring an instance of Physical Records Transformation Services To complete the Physical Records Transformation Services installation, you must configure an instance of Physical Records Transformation Services. If you are configuring Physical Records Transformation Services to a repository that will also be configured with Document Transformation Server or Document Transformation Server - Legacy, you will also have to perform the procedure for Configuring a repository for Physical Records Transformation Services, page 31. Caution: Make sure the appropriate Connection Broker and repositories are running before continuing with the configuration. To configure an instance of Physical Records Transformation Services: 1. Navigate to the Physical Records Transformation Services Configurator under Start > Programs > Documentum > PRTS Configuration Utility. The Physical Records Transformation Services Configurator splash screen is displayed, followed by the Welcome screen. Using this utility you will be able to add or remove instances of Documentum Physical Records Transformation Services. Make sure your docbroker and repositories are running before continuing. 2. Click Next. The license agreement terms are displayed. 3. Select the option to accept the terms of the license agreement, then click Next. 4. Select Add an instance Physical Records Transformation Services to a docbase, and click Next. 5. Enter the name of the Physical Records Transformation Services host. The installer may detect the host name for you. This will be the name of the machine on which you have installed Physical Records Transformation Services. 6. Click Next. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 29

30 Installing Physical Records Transformation Services The Enter repository name and user info screen appears. 7. Complete the following substeps: a. Select a repository to be served by the Physical Records Transformation Services when the drop down list "Select a Repository" of the repositories served by your Connection Broker appears. For instructions on selecting a Connection Broker, refer to Identifying a Connection Broker in dfc.properties, page 17. b. Enter the "Repository Super User Name" that Physical Records Transformation Services will use to access the repository. Note: In a domain-required repository, you must configure the product with a registered domain user. c. Enter the "Repository Super User Password". A password for the SuperUser account. d. Enter the "Repository Domain" name, if applicable. e. Enter the name of the repository user who will receive notifications from Physical Records Transformation Server, otherwise known as the system operator. Note: If you are unsure of which users to specify, refer to Required Physical Records Transformation Services installation information, page 21 for details regarding values for these fields. f. Click Next. If you cannot continue, check with the repository administrator to verify that the users exist and that you entered the correct password. 8. If the repository you have chosen is in a distributed environment, a screen will appear with a list of Content Servers configured for the repository you have chosen to configure with Physical Records Transformation Services. Select a Content Server from the list and select Process local content only. For more information on Distributed Content Servers and the distributed environment, refer to Documentum Distributed Configuration Guide. 9. The User Authentication screen appears. Enter the Documetum administrator name and password; if you are installing as a domain user, use the format <username>@<domain> in the system administrator name field. Click Next. 10. A dialog box indicates the success of the Physical Records Transformation Services configuration. Click Finish. The Configurator closes. If this repository will also be configured for Document Transformation Server or Document Transformation Server - Legacy, you have to perform the configuration described in Configuring a repository for Physical Records Transformation Services, page EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

31 Installing Physical Records Transformation Services Configuring a repository for Physical Records Transformation Services When Physical Records Transformation Services and Document Transformation Services are installed on different servers but configured against the same repository, the following additional configuration is necessary for the correct transformations to be handled by the correct product. To configure the CTSServerService for PRTS: 1. Navigate to %CTS%\config on the CTS server. 2. Open the CTSServerService.xml file in a text editor. 3. Comment out the full <QueueProcessorContext> section, where queueitemname="dm_ autorender_win31" for the appropriate repository. For example, this section may appear as follows: <QueueProcessorContext DocbaseName="Repository1"> <CTSServer AttributeName="queueInterval" AttributeValue="10"/> <CTSServer AttributeName="maxThreads" AttributeValue="10"/> <CTSServer AttributeName="tempFileDir" AttributeValue= "E:\PROGRA~1\DOCUME~1\CTS\docbases\Repository1\config\ temp_sessions"/> <CTSServer AttributeName="mediaServerName" AttributeValue= "prts1_repository1"/> <CTSServer AttributeName="queueItemName" AttributeValue= "dm_autorender_win31"/> <CTSServer AttributeName="sysOpUserName" AttributeValue= "ctsadmin"/> <CTSServer AttributeName="maxQueueItemsToSignOff" AttributeValue ="10"/> <CTSServer AttributeName="maxQueueItemAge" AttributeValue="1m"/> <CTSServer AttributeName="processLocalContentOnly" AttributeValue=""/> <CTSServer AttributeName="queueProcessor" AttributeValue= "com.documentum.cts.impl.services.ctsserver. CTSLegacyQueueProcessor"/> <CTSServer AttributeName="legacyTaskProcessor" AttributeValue= "com.documentum.cts.impl.services.task.legacycalls. LegacyCallProcessor"/> <CTSServer AttributeName="aaesProfilePath" AttributeValue= "/System/Media Server/Command Line Files/aes_legacy_calls.xml"/> <CTSServer AttributeName="bgProfilePath" AttributeValue= "/System/Media Server/Command Line Files/background_ legacy_calls.xml"/> <CTSServer AttributeName="customProfilePath" AttributeValue= "/System/Media Server/Command Line Files/custom_ legacy_calls.xml"/> <CTSServer AttributeName="notifySuccessMessage" AttributeValue=""/> <CTSServer AttributeName="notifyFailureMessage" AttributeValue="Yes"/> <CTSServer AttributeName="ctsRefreshQueueItemName" AttributeValue= "cts_info_change"/> <CTSServer AttributeName="ignoreKeywordName" AttributeValue= "ignore_cts_processing"/> <CTSServer AttributeValue="10" AttributeName= "thresholdforqueueitemstosignoff"/> <CTSServer AttributeValue="YES" AttributeName= EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 31

32 Installing Physical Records Transformation Services "ignoreitemstosignofflimit"/> </QueueProcessorContext> 4. Save and close the file. 5. Restart the PRTS service. PRTS is now configured to handle the correct transformations in the repository. Enabling a DFC installation to access a global registry This step is only necessary if you did not select a global registry during the installation, or if the password for the global registry user has changed, or if you are updating the dfc.properties with a different global registry than initially configured. The dfc.properties file contains properties that relate to accessing the global registry. To enable a DFC installation to access a global registry repository: 1. On the DFC host (Content Server), navigate to $DOCUMENTUM/config (UNIX or Linux) or %DOCUMENTUM%\config (Windows). 2. From a command prompt, execute the following command to generate the encrypted form of the global registry user s password: java -cp dfc.jar com.documentum.fc.tools.registrypasswordutils password_of_user where password_of_user is the global registry user s clear-text password. In step 4 below, you will have to enter the encrypted form of this password in the dfc.properties file. 3. Open the dfc.properties file in a text editor. 4. Modify the following attributes: dfc.bof.registry.repository=global_registry_repository_name dfc.bof.registry.username=user_login_name dfc.bof.registry.password=encryped_password_of_user where encryped_password_of_user is the encrypted password you generated in 2 above. 5. Save the dfc.properties file. Additional steps for label printing if your application server is Weblogic Label printing requires additional steps to set up on the application server to successfully call web services; if RPS and PRM are hosted on a Weblogic server. The following error message will be displayed in Records Manager Administrator (RMA) or Retention Policy Services Administrator (RPSA) if a user attempts to print a label without modifying two xml files within the dfc.properties file in the war file. java.lang.noclassdeffounderror at com.sun.xml.ws.wsdl.parser.runtimewsdlparser. createreader 32 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

33 Installing Physical Records Transformation Services Follow these steps if your application server is Weblogic: The goal is to inform Weblogic to use application packages shipped with RMA (or RPSA) instead of the default versions that are part of Weblogic. 1. Unpack the rma.war file obtained from the Documentum download site. On the EMC Software Downloads page, navigate to: Documentum, Inc > Documentum Records Manager > Documentum Records Manager > Documentum Records Manager, Version <X>. Figure 3. Documentum records manager download page 2. As mentioned in the Records Manager Deployment Guide, update the dfc.properties file (under WEB-INF\classes) to specify the docbroker information. 3. Since you will be recreating the war file, it is recommended to configure the dfc.keystore location. If not configured, this file is created in the same directory as the dfc.properties file. Update the following line "dfc.security.keystore.file", as follows for example: "dfc.security.keystore.file=c:/temp". More information is in the dfcfull.properties file co-located with the dfc.properties file. 4. Create a new file called application.xml with the text in the example below. In the example, the context- root is set to rma. You can substitute the value here if the value for the context root is changed. This is used by clients to connect to the application. For example, could be set as If rma.war is renamed, make sure the value specified for web-uri is also modified to reflect the new name. <?xml version="1.0" encoding="utf-8"?> <application> <module> EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 33

34 Installing Physical Records Transformation Services <web> <web-uri>rma.war</web-uri> <context-root>rma</context-root> </web> </module> </application> 5. Create a new file called weblogic-application.xml. There is no need to modify this file. <?xml version="1.0" encoding="utf-8"?> <weblogic-application xmlns=" <prefer-application-packages> <package-name>javax.xml.ws.<</package-name> <package-name>javax.xml.bind.<</package-name> <package-name>javax.jws.<</package-name> <package-name>javax.namespace.xml.<</package-name> <package-name>javax.xml.soap.<</package-name> <package-name>org.apache.xerces.<</package-name> <package-name>com.sun.xml.<</package-name> </prefer-application-packages> </weblogic-application> 6. Repackage the rma.war file once you have updated the dfc.properties file. 7. Create a directory and place the rma.war file inside it. Create a subdirectory called META-INF and copy both application.xml and weblogic-application.xml into this directory 8. Create an EAR file, rma.ear that contains these three items. The structure of the ear file should look like the following: META-INF/application.xml META-INF/weblogic-application.xml rma.war Configuring a CTS product to the global registry Ensure the global registry has the Content Transformation Services product configured against it; otherwise the transformation and rich_media_services DAR files will to be manually run against the global registry. Refer to Configuring Physical Records Transformation Services for another repository, page 40 for further information. Post-installation tasks Refer to Verifying the Physical Records Transformation Services installation, page 39 to verify and test the installation of Physical Records Transformation Services. Refer to the following two procedures after PRTS is installed to complete the installation for label rendering operationsand for batch processing operations. To test the setup against either of these operations, refer to either the Records Manager Administrator User Guide, version 6.5 SP3, or the Retention Policy Services Administrator User Guide, version 6.5 SP3. 34 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

35 Installing Physical Records Transformation Services On the server hosting PRTS, to configure PRTS for label printing: 1. Ensure the PRM DAR file is installed on the repository. 2. Install the Adobe PDF printer driver on the CTS/PRTS machine (available by installing Adobe Acrobat Professional). 3. Go to Printers and Faxes from the Start menu. 4. Right-click the Adobe PDF printer and select Properties. 5. Select Printing Preferences on the General tab. 6. Browse Adobe PDF Output Folder to locate the PDF_out directory. The default location is C:\Program Files\Documentum\CTS\. 7. Deselect these options: View Adobe PDF results, Add document information and Delete log files for successful jobs. 8. Click Apply to accept changes and then click OK to close the Adobe PDF Printing Preferences window. 9. Install.Net Framework 2.0 and its updates (available from Microsoft download site). 10. Install NiceLabel. On a the Windows server for label printing: 1. Install CTS Web Services according to the CTS Web Services Installation Guide. The software has to be hosted on a Windows machine though it does not have to be on the same machine as CTS/PRTS. The software could also be hosted on the application server. To set up CTS WebServices for PRTS label printing, the Web Services URL must be configured as follows: 1. Log in to either RMA, Retention Policy Services Administrator (RPSA), Webtop, or Documentum Administrator (DA) whichever is available and navigate to the "PRM DocbaseConfig" folder in the following path, Cabinets > System > Applications > PrmConfig > Prm DocbaseConfig and change the filter to Show All Objects and Versions. 2. Right-click the prm_docbase_config file and select Properties. 3. Type the values for the Web Services URL and for the Temporary Label Object Target Folder for Label Printing attributes on the Info tab; /TempLabelTarget and for example. The host name is the server on which CTS Web Services was installed. Although the default port is 8888, you can specify the appropriate port number for the port and the appropriate IP address for the machine name as follows, name]:[port]/services. EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 35

36 Installing Physical Records Transformation Services Figure 4. Properties for prm_docbase_config Note: Ensure that you have created the "Temp Label Target" folder within the repository and that users in the Label Print Request role (dmc_prm_label_print_request) have Write permissions on this folder. 4. Click OK. To use batch processing or label printing, perform the following manual steps to set the classpath entries for PRTS, on the PRTS server: 1. Back up the registry or the registry key before proceeding. 2. Open Windows Services from Administrative Tools. 3. Stop the Documentum Content Transformation Services service. 4. Open regedit and navigate to "\HKEY_LOCAL_ MACHINE\SYSTEM\CurrentControlSet\Services\DocumentumCTS\Parameters". 5. Open Addparameters and copy the entries to Notepad. 6. Just before the class path entry for java (C:\PROGRA~1\DOCUME~1\java\1.5.0_ 12\jre\lib\ext\sunjce_provider.jar), add the following entries: C:\PROGRA~1\DOCUME~1\CTS\lib\ctsBatchProcessor.jar; C:\PROGRA~1\DOCUME~1\CTS\lib\labelRender.jar; C:\PROGRA~1\DOCUME~1\CTS\lib\IDmcPrmModules.jar; C:\PROGRA~1\DOCUME~1\CTS\lib\IDmcPrm.jar; C:\PROGRA~1\DOCUME~1\CTS\lib\IDmcRps.jar; 36 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide