47
EMC ® Documentum ® Physical Records Transformation Services Version 6.5 SP3 Deployment Guide EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com

EMC Documentum Documentum® PhysicalRecordsTransformation Services Version6.5SP3 DeploymentGuide EMCCorporation CorporateHeadquarters: Hopkinton,MA01748-9103

  • Upload
    lethuan

  • View
    227

  • Download
    1

Embed Size (px)

Citation preview

EMC® Documentum®

Physical Records TransformationServicesVersion 6.5 SP3

Deployment Guide

EMC CorporationCorporate Headquarters:

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

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 Corporation makes no representations or warranties of any kindwith respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitnessfor a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires anapplicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarksused herein are the property of their respective owners.© Copyright 2010 EMC Corporation. All rights reserved.

Table of Contents

Preface ................................................................................................................................. 7

Chapter 1 Physical Records Transformation Services Overview .................................. 9What is Content Transformation Services?........................................................... 9Content Transformation Services scalability ................................................... 10

What is Physical Records Transformation Services? ............................................ 10Physical Records Transformation Services environment .................................. 11Physical Records Transformation Services ...................................................... 11Documentum Foundation Classes ................................................................. 12Physical Records Transformation Services plug-ins ......................................... 12

Rendering applications for supported source formats ......................................... 13

Chapter 2 Getting Started ............................................................................................ 15Selecting the server host .................................................................................... 15Setting up a global registry repository............................................................ 16

Installation prerequisites ................................................................................... 16Software prerequisites .................................................................................. 17Uninstalling older versions of Physical Records TransformationServices ....................................................................................................... 17Setup verifications ........................................................................................ 17Identifying a Connection Broker in dfc.properties....................................... 17Checking Connection Broker and repository services .................................. 18

Chapter 3 Installing Physical Records Transformation Services ................................. 19Pre-Installation tasks......................................................................................... 19Downloading the installers ........................................................................... 19Preparing the Physical Records Transformation Services host .......................... 20

Installing and configuring Physical Records Transformation Services................... 20Physical Records Transformation Services installation overview ...................... 20Required Physical Records Transformation Services installationinformation .................................................................................................. 21Installing Physical Records Transformation Services ....................................... 23Installing CTS DAR files................................................................................ 26Configuring headless Composer ................................................................ 27Installing a DAR file with DAR Installer Plugin .......................................... 27

Configuring an instance of Physical Records Transformation Services .............. 29Configuring a repository for Physical Records TransformationServices ....................................................................................................... 31Enabling a DFC installation to access a global registry .................................... 32

Additional steps for label printing if your application server isWeblogic ......................................................................................................... 32Configuring a CTS product to the global registry ................................................ 34Post-installation tasks ....................................................................................... 34Installation troubleshooting............................................................................... 37

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 3

Table of Contents

Cannot pass SuperUser and repository user information screen....................... 37If Physical Records Transformation Services installation fails........................... 38If cts_instance_info is not created when the Configurator is executed ............... 38

Chapter 4 Verifying, Expanding, Removing, and Uninstalling PhysicalRecords Transformation Services ............................................................... 39Verifying the Physical Records Transformation Services installation..................... 39Verifying startup of Physical Records Transformation Services ........................ 39

Expanding Physical Records Transformation Services ......................................... 40Configuring Physical Records Transformation Services for anotherrepository .................................................................................................... 40

Removing the Physical Records Transformation Services instancefrom a repository.............................................................................................. 42Uninstalling Physical Records Transformation Services ....................................... 43

4 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Table of Contents

List of Figures

Figure 1. Typical Physical Records Transformation Services installation ................................. 11Figure 2. Profile Migration Confirmation Dialog Box ............................................................ 24Figure 3. Documentum records manager download page...................................................... 33Figure 4. Properties for prm_docbase_config ........................................................................ 36

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 5

Table of Contents

List of Tables

Table 1. Required Physical Records Transformation Services installation information ............ 21Table 2. Description of DAR Installer Fields........................................................................ 28

6 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Preface

This guide describes how to install Documentum Physical Records Transformation Services forWindows. It lists installation prerequisites and provides step-by-step instructions for installing anduninstalling Physical Records Transformation Services. In addition, this manual includes a briefoverview of Physical Records Transformation Services architecture.

Refer to Documentum Records Manager Release Notes, version 6.5 SP3, for possible updates and toensure your system requirements are met or exceeded.

Intended audienceThis guide is intended for the person who installs Physical Records Transformation Services, oftencalled 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. Contactyour Documentum account representative for availability of the Content Transformation ServicesProduct Development Guide which includes more information and instructions on developing yourown plug-ins.

Revision historyThe following changes have been made to this document.

Revision history

Revision date Description

April 2010 Initial publication.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 7

Preface

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

Chapter 1Physical Records TransformationServices Overview

This chapter contains a brief overview of Physical Records Transformation Services and outlines atypical Physical Records Transformation Services installation. It gives a basic description of theDocumentum environment and relates the Physical Records Transformation Services componentswithin 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 productsthat 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 TransformationServices can be extended by installing additional transformation services, such as Audio/VideoTransformation Services (AVTS). These components supplement the features already provided bythe base product, according to your organization’s requirements.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 9

Physical Records Transformation Services Overview

Content Transformation Services scalability

Content Transformation Services (CTS) products allow for a high level of scalability. All CTS productsrun under the same Windows Service on the CTS host. This means that stopping or starting the CTSservice stops or starts all the CTS products on that host. For example, if your CTS host containsPhysical Records Transformation Services and Media Transformation Services, stopping the CTSWindows Service stops both of those products.

Each CTS product can be configured for multiple repositories. If you have one installation of aproduct on a host, that installation can be configured against different repositories.

CTS scalability also allows for several instances of Content Transformation Services products ondifferent hosts to be configured for the same repository. This means that your installation can takeeither 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-insmeans 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 adedicated 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 samerepository.

The other benefit of having identical Physical Records Transformation Services installations is that ahardware failure in one instance will not stop all installations from processing queue items. In caseswhere 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. Formatawareness is the ability for a Content Transformation Services product to recognize which file formatsit is capable of processing. Items that cannot be processed successfully will be removed from thequeue automatically. For example, if several transformation requests are made for JPEG files, but theproduct does not support JPEGs, the system will remove those items from the queue. A check forunprocessed items is performed periodically.

What is Physical Records TransformationServices?Physical Records Transformation Services is one of the transformation services provided by ContentTransformation Services (CTS) as described under What is Content Transformation Services?, page 9.

Although the various transformation products offer specific transformation capabilities for aparticular set of source formats, PRTS is used by Physical Records Manager (PRM) for the followingoperations:• Label printing of barcodes. The label rendering plug-in integrates with NiceLabel (which needsto 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

Physical Records Transformation Services Overview

http://www.nicelabel.com/. EMC Documentum recommends installing version 5.2, or upgradingto 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 installNiceLabel for label printing if you do not use barcodes. There is also no need to install NiceLabel toperform batch processing operations.

Label printing and Batch processing are described in greater detail in the Records ManagerAdministrator User Guide. Batch processing, in brief terms, relies on scanning barcodes for a selectedoperation and uploading scanned results in XML schema files to match inventory records inthe repository against the actual physical objects in the warehouse. The family of batch/scanningoperations 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 theDocumentum 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 foreither 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

Physical Records Transformation Services Overview

request object (dm_queue_item) in a queue. Physical Records Transformation Services logs in tothe repository as a user, examines the queue, retrieves the request objects, and sends them to theappropriate plug-in for processing. Each request object is associated to a particular batch processingoperation, move and reconciliation for example.

Documentum Foundation Classes

The Documentum Foundation Classes (DFC) are a set of Java classes that provide access to ContentServer 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 theinstaller. During installation, the Physical Records Transformation Services installer checks for anexisting 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 theinstaller. Refer to the relevant version of the Documentum System Migration Guide available on theDownload Center at https://emc.subscribenet.com/, 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 upgradedas well. For more information on the DFC and its effect on other applications, refer to your specificDocumentum application documentation.

• If a version of DFC exists and it is newer than that which is included with the installer, it will beleft 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 ofPhysical Records Services. There is no need to install PRTS if you do not plan to print labels orperform batch operations.

The label rendering is a third-party plug-in that integrates with NiceLabel. NiceLabel define rulesand prints labels from Physical Records Transformation Services. EMC Documentum recommendsinstalling 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-insto the system to support new file formats as required. For information about creating and addingnew plug-ins, contact your Documentum account or support representative.

12 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Physical Records Transformation Services Overview

Rendering applications for supported sourceformatsPRTS can be set up if needed with the NiceLabel application that is used for label rendering andprinting.

You can install PRTS for batch processing and at any time install NiceLabel for label printingwhenever it may be required.

Note: The "Sample NiceLabel 5.x Template.lbl" can be fond in the /Templates cabinet in therepository, if the PRM dar is installed.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 13

Physical Records Transformation Services Overview

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

Chapter 2Getting Started

This chapter explains how to prepare for installing Physical Records Transformation Services ona Windows host. It describes pre-installation requirements. This chapter contains the followingsections:• Selecting the server host, page 15 describes requirements for selecting the Physical RecordsTransformation Services host.

• Setting up a global registry repository, page 16 describes requirements for selecting a globalregistry.

• Installation prerequisites, page 16 describes software and setup that is required before installingPhysical Records Transformation Services.

Selecting the server hostThis section provides basic guidelines for selecting the host machine for your Physical RecordsTransformation Services installation.

Caution: To ensure optimal system performance, Physical Records Transformation Servicesshould 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 memoryon the candidate server. Physical Records Transformation Services requires an amount of memoryequal 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. Thismeans that any actions (such as starting or stopping an application) performed on that Windowsservice affect all of the CTS products using it. The number of products installed on a single host, theexpected usage of those products, and the host’s hardware capabilities are major factors in selectingthe host. If you are planning to use the same host for more than one CTS product, ensure that it hassufficient hardware and processing capabilities for optimal performance. For more information onCTS scalability, refer to Content Transformation Services scalability, page 10.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 15

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 DARSinstalled 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 thecentral repository designated as the global registry, and network locations created in the globalregistry are available in distributed configurations. The global registry is enabled during repositoryconfiguration, refer to Configuring a repository for Physical Records Transformation Services, page31 for further information. There is no limit to how many repositories may be configured as globalregistries; however, you may need more than one global registry if you have applications that havevery different user access levels.

If the global registry does not have the Content Transformation Services product configured againstit, then the transformation and rich_media_services DARs must be manually run against the globalregistry.

Note: If the global registry repository is not configured, refer to Enabling a DFC installation to accessa 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 andpassword for the global registry user. By default, the global registry user has the user nameof dm_bof_registry.The global registry user’s account is used by DFC clients to connect to the repository to accessrequired service-based objects or network locations stored in the global registry. The globalregistry user has Read access to objects in the /System/Modules and /System/NetworkLocationsonly, and no other objects.

3. When you install DFC on client machines, provide those DFC installations with the global userlogin credentials.This applies to Desktop installations on end-user computers, to WDK-based clients such asWebtop on application server host, and to the DFC instance on Content Server and remoteContent Server hosts.

4. Ensure that the global registry repository projects to connection brokers known to the DFCinstances 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 globalrepository.

6. Proceed to instructions to configure PRTS.

Installation prerequisitesThis section describes the prerequisites for a successful Physical Records Transformation Servicesinstallation.

16 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Getting Started

Software prerequisites

Documentum Content Server must be installed, configured, and running properly on your networkbefore you install Physical Records Transformation Services.

Uninstalling older versions of Physical RecordsTransformation Services

If you are installing Physical Records Transformation Services on a host that has a previous versionof Physical Records Transformation Services, you must properly uninstall it first. If you do notuninstall the previous version, your new installation of Physical Records Transformation Servicesmay fail. For information and instructions on uninstalling Physical Records Transformation Services,refer to Uninstalling Physical Records Transformation Services, page 43, or refer to the InstallationGuide 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. Identifyinga Connection Broker in dfc.properties, page 17 provides instructions.

• The Connection Broker and repository services are running on your Content Server. CheckingConnection 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 RecordsTransformation Services host, you will have a dfc.properties file. Follow this procedure to ensurethat the correct Connection Broker is specified. If you are installing Physical Records TransformationServices on a clean host, you will not have a dfc.properties prior to installation; in this case, thefollowing 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 fileis 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 theone 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

Getting Started

Checking Connection Broker and repository services

The Connection Broker and repository services must be running properly on the Content Serverhost before you install Physical Records Transformation Services. The Content Server AdministrationGuide should be referenced for information and instructions pertaining to Connection Broker andrepository services.

18 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Chapter 3Installing Physical RecordsTransformation 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, andcontains 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 tasksThis section explains what to do before you install the Physical Records Transformation Services. Itspecifies 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 yourPhysical Records Transformation Services host. Download the installers from the DocumentumDownload Center (https://documentum.subscribenet.com) to a temporary directory on your PhysicalRecords Transformation Services host.

On the EMC Software Downloads page, navigate to Documentum, Inc, select DocumentumPhysical 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

Installing Physical Records Transformation Services

Preparing the Physical Records TransformationServices host

You can install NiceLabel Suite or NiceLabel Pro 5.1 or 5.2 and the Adobe print driver for labelprinting/rending before or after PRTS is installed and configured. The Records Manager Release Notesprovides 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 longerappears. The registration screen that appears in some newly installed programs may interfere withPhysical Records Transformation Services processing. Note that all applications must be closed priorto installing Physical Records Transformation Services.

Installing and configuring Physical RecordsTransformation ServicesBefore installing Physical Records Transformation Services for the first time, ensure that you havefulfilled all of the Installation prerequisites, page 16.

After installing Physical Records Transformation Services, you can verify that your installation isrunning correctly. Verifying the Physical Records Transformation Services installation, page 39explains this procedure.

If you have already installed Physical Records Transformation Services, but would like to add a newinstance to a repository, Expanding Physical Records Transformation Services, page 40 providesinstructions for doing so.

Physical Records Transformation Services installationoverview

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 RecordsTransformation Services, page 29.

Note: CTS DAR files must be installed prior to running the Configuration Utility. See InstallingCTS DAR files, page 26 for further information.

The Physical Records Transformation Services installation includes the required DocumentumFoundation Classes (DFC) Runtime Environment, the necessary Java components, and the PhysicalRecords Transformation Services supporting files.

To create an additional instance of Physical Records Transformation Services (described in ExpandingPhysical Records Transformation Services, page 40) or to remove Physical Records TransformationServices from a repository (described in Removing the Physical Records Transformation Services

20 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Installing Physical Records Transformation Services

instance from a repository, page 42), you do not have to run the Installer again. The Configuratorallows you to add and remove instances of Physical Records Transformation Services and will beaccessible from the Windows Start menu after installation.

If you are reinstalling Physical Records Transformation Services, you must properly uninstall yourprevious version of Physical Records Transformation Services first. If you do not uninstall PhysicalRecords Transformation Services first, your new installation may fail. Refer to Uninstalling PhysicalRecords Transformation Services, page 43.

Required Physical Records Transformation Servicesinstallation information

This section provides a table for recording the information you will need to install Physical RecordsTransformation Services. Having this information ready and available prior to installation ensuresthe 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 directoryfor DFC.

The default is directory C:\Pro-gram Files\Documentum\CTS.

DFC User Directory This is where the log files forDFC and Physical RecordsTransformation Servicesare stored, where exporteddocuments are stored, and wherechecked out documents arestored. The default directory isC:\Documentum.

Connection Broker Host Name

(if not detected)

If the correct DFC has not yetbeen installed on the host, youwill be prompted for the PrimaryConnection Broker host nameservicing the repository youwant to configure with PhysicalRecords Transformation Services,during installation.

Physical RecordsTransformation Servicesinstallation directory

The directory in which to installPhysical Records TransformationServices. It is recommendedthat you install Physical RecordsTransformation Services in thedefault installation directory.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 21

Installing Physical Records Transformation Services

Installation information Description Your value

Physical RecordsTransformation Serviceshost

(if not detected)

The name of the machine onwhich you are installing PhysicalRecords Transformation Services.

You may need to enterthis information if it is notautomatically detected by theinstaller.

Repository SuperUser nameand password

The account the Physical RecordsTransformation Services uses tologin to the repository. Ask youradministrator to supply you witha SuperUser name and password.EMC recommends that you usethe install owner.

You cannot use thedm_mediaserver user account asthe repository SuperUser.

Repository user name The name of the user who willreceive notifications from PhysicalRecords Transformation Services.

Physical Records TransformationServices notifies the user ofthe results of processing. Forexample, if Physical RecordsTransformation Services failsto process a particular item, itqueues an event to the Inbox of thePhysical Records TransformationServices system operator user(sysOpUser).

This user should be different fromthe dm_mediaserver user.

Domain name The name of the domain againstwhich the user is authenticated.Use the fully qualified domain.

22 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Installing Physical Records Transformation Services

Installation information Description Your value

Global registry Different DFC installations canuse different global registrieswhere required service-basedobjects or network locations arestored. A single DFC installationcan have only one global registry.You will be prompted duringinstallation for the primaryregistry.

dm_bof_registry By default, the global registryuser has the user name ofdm_bof_registry.

During repository configuration,provide the user login name andpassword for the global registryuser. The global registry usershould be someone other than theadministrator.

Installing Physical Records Transformation Services

The following procedure installs the service and supporting files for Physical Records TransformationServices. 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 isalready 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, onthe same application server, make sure they are same version. Run the 6.5 SP3 versions of theirexecutables 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

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 Servicesinstallation files. Downloading the installers, page 19 provides information about where thefiles should be located.

5. Double-click prtsWinSuiteSetup.exe.The Physical Records Transformation Services Installer splash screen is displayed, followed bythe 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 touninstall it before resuming the Physical Records Transformation Services installation. Refer to

24 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Installing Physical Records Transformation Services

the Documentum System Migration Guide, available on the Documentum Download Center, formore 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 DeveloperDocumentation if you want it installed and then click Next. The Primary Interop AssemblyInstaller is not required.

10. On the Directory for Documentum Software screen, change the destination folder for DFC (thedefault 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 thisscreen; go to Step 13.

11. You are prompted to enter the User Directory for DFC Runtime Environment. This is whereexported documents, checked out documents, and DFC log files are stored. The default directoryis 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 thisscreen; go to Step 13.

12. 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 fieldand, 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 thisscreen; go to Step 13.

13. Specify the Content Transformation Services installation directory (for core components that allCTS products use). You can click to Next to accept the default Destination Directory or clickBrowse to select a preferred location and then click Next. The Installer creates a directory namedCTS within the chosen directory.It is recommended that you accept the default directory (for example, C:\ProgramFiles\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 areinstalling 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 portis used to connect to CTS WebServices in conjunction with Documentum Administrator tocommunicate with the CTS hosts. The default port number is 9096. Enter a port number andclick Next.

Note: You must run the configurator for every repository, if you have more than one. It is notnecessary 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 youare installing for a domain user, use the format <username>@<domain> in the Admin user namefield. 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

Installing Physical Records Transformation Services

Note: If the correct version of DFC is already installed, the summary screen will show thatDFC 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 navigateback 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 overwritethe 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 atC:\PROGRA~1\DOCUME~1\CTS\migration\log. Click on Next to start themigration 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 screenappears, and enter the repository name and the password.Use the default global registry user name "dm_bof_registry" or identify the global registryrepository to be used and then enter the password. This should be someone other than theDocumentum administrator. Select Test Connect, (recommended) if desired, and then clickNext.

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, proceedto Installing CTS DAR files, page 26.

Installing CTS DAR files

You must install CTS DAR files before configuring CTS products to get all the latestchanges/enhancements. Install both DAR files, shown in the following list, in the global repositoryand 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 headlessComposer and the DAR Installer plug-in on the local machine. Headless Composeris installed as part of Content Server version 6.5. Headless Composer can be found atC:\Documentum\<product>\6.5\install\composer\composer\ComposerHeadless on the ContentServer Host.

If Content Server is of a version other than 6.5, you will need to download and install headlessComposer 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

Installing Physical Records Transformation Services

download site as part of Documentum Developer Studio. Consult the Documentum Composer UserGuide for more information about Composer.

Note: You must have Documentum Superuser privileges for the repositories in which you areinstalling 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. Thedirectory 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 theinterface within Composer. The DAR Installer plugin requires Composer or Headless Composer tobe installed, but does not launch the full Composer IDE. The DAR Installer Plugin is useful in caseswhere you want to de-couple the development of DAR files from the installation of DAR files. It isalso 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 installationdirectory:• 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 occasionallyhave 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 otherfields 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

Installing Physical Records Transformation Services

1. Download the DAR Installer zip file from the same place that you downloaded Composer. Youcan find the DAR Installer Plugin by going to https://emc.subscribenet.com/control/dctm/searchand 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 installationdirectory.

3. Run darinstaller.exe, which is located in the Composer root directory, to start the DAR InstallerPlugin.

4. In the DAR Details section, specify values for the fields.

5. In the Connection Broker Details section, specify values for Connection Broker Host andConnection Broker Port and click Connect.

6. In the Repository Details section, specify values for the fields and click Install to install theDAR file to the repository.Refer to the Description of DAR Installer Fields table to help guide you through the DAR fileinstall 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 downmenu 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 containany I18N characters or theinstallation will fail.

Input File No The absolute file path to theinstall-based parameter file

Local Folder No The absolute file path tolocalized .properties files.If you want to make yourapplication available in otherlanguages, you must localizethe project data such as labels,tabs, and descriptions.

Log File No The file to save the log to. If thisis not specified, the file defaultsto <DAR>.log

Connection Broker Host Yes The address of the ConnectionBroker

Connection Broker Port Yes The port of the ConnectionBroker Repository

28 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Installing Physical Records Transformation Services

Parameter Required Description

Repository Yes The name of the repository thatyou want to install the DAR fileto. Click on the Connect buttonafter entering the Docbrokerhost and port to retrieve theavailable repositories.

User Name Yes The login name for therepository

Password Yes The password for logging intothe repository

Domain No The domain where therepository resides

Configuring an instance of Physical RecordsTransformation Services

To complete the Physical Records Transformation Services installation, you must configure aninstance of Physical Records Transformation Services. If you are configuring Physical RecordsTransformation Services to a repository that will also be configured with Document TransformationServer or Document Transformation Server - Legacy, you will also have to perform the procedure forConfiguring a repository for Physical Records Transformation Services, page 31.

Caution: Make sure the appropriate Connection Broker and repositories are running beforecontinuing 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, followedby the Welcome screen. Using this utility you will be able to add or remove instances ofDocumentum Physical Records Transformation Services. Make sure your docbroker andrepositories 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 thehost name for you. This will be the name of the machine on which you have installed PhysicalRecords Transformation Services.

6. Click Next.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 29

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 thedrop down list "Select a Repository" of the repositories served by your Connection Brokerappears.For instructions on selecting a Connection Broker, refer to Identifying a Connection Brokerin dfc.properties, page 17.

b. Enter the "Repository Super User Name" that Physical Records Transformation Serviceswill use to access the repository.

Note: In a domain-required repository, you must configure the product with a registereddomain 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 RecordsTransformation Server, otherwise known as the system operator.

Note: If you are unsure of which users to specify, refer to Required Physical RecordsTransformation Services installation information, page 21 for details regarding values forthese fields.

f. Click Next.If you cannot continue, check with the repository administrator to verify that the users existand that you entered the correct password.

8. If the repository you have chosen is in a distributed environment, a screen will appear with alist of Content Servers configured for the repository you have chosen to configure with PhysicalRecords 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 toDocumentum Distributed Configuration Guide.

9. The User Authentication screen appears. Enter the Documetum administrator name andpassword; if you are installing as a domain user, use the format <username>@<domain> in thesystem 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 DocumentTransformation Server - Legacy, you have to perform the configuration described in Configuring arepository for Physical Records Transformation Services, page 31.

30 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Installing Physical Records Transformation Services

Configuring a repository for Physical RecordsTransformation Services

When Physical Records Transformation Services and Document Transformation Services areinstalled on different servers but configured against the same repository, the following additionalconfiguration 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

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 thepassword for the global registry user has changed, or if you are updating the dfc.properties with adifferent 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 ofthe 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 willhave 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_namedfc.bof.registry.username=user_login_namedfc.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 yourapplication server is WeblogicLabel printing requires additional steps to set up on the application server to successfully call webservices; if RPS and PRM are hosted on a Weblogic server. The following error message will bedisplayed 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.propertiesfile 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

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 ofthe default versions that are part of Weblogic.

1. Unpack the rma.war file obtained from the Documentum download site. On the EMC SoftwareDownloads 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 (underWEB-INF\classes) to specify the docbroker information.

3. Since you will be recreating the war file, it is recommended to configure the dfc.keystorelocation. If not configured, this file is created in the same directory as the dfc.propertiesfile. 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-locatedwith the dfc.properties file.

4. Create a new file called application.xmlwith 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 forthe context root is changed. This is used by clients to connect to the application. For example,http:<hostname>:<portnumber>/<contextroot) could be set as http://localhost:7001/rma. Ifrma.war is renamed, make sure the value specified for web-uri is also modified to reflect thenew name.

<?xml version="1.0" encoding="UTF-8"?><application><module>

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 33

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="http://www.bea.com/ns/weblogic/90">

<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-INFand 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 shouldlook like the following:META-INF/application.xmlMETA-INF/weblogic-application.xmlrma.war

Configuring a CTS product to the globalregistryEnsure 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 againstthe global registry. Refer to Configuring Physical Records Transformation Services for anotherrepository, page 40 for further information.

Post-installation tasksRefer to Verifying the Physical Records Transformation Services installation, page 39 to verify andtest the installation of Physical Records Transformation Services.

Refer to the following two procedures after PRTS is installed to complete the installation for labelrendering operationsand for batch processing operations. To test the setup against either of theseoperations, refer to either the Records Manager Administrator User Guide, version 6.5 SP3, or theRetention Policy Services Administrator User Guide, version 6.5 SP3.

34 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

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 AdobeAcrobat 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 isC:\Program Files\Documentum\CTS\.

7. Deselect these options: View Adobe PDF results, Add document information and Delete logfiles for successful jobs.

8. Click Apply to accept changes and then click OK to close the Adobe PDF Printing Preferenceswindow.

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 hasto be hosted on a Windows machine though it does not have to be on the same machine asCTS/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 beconfigured as follows:

1. Log in to either RMA, Retention Policy Services Administrator (RPSA), Webtop, or DocumentumAdministrator (DA) whichever is available and navigate to the "PRM DocbaseConfig" folder inthe following path, Cabinets > System > Applications > PrmConfig > Prm DocbaseConfig andchange the filter to Show All Objects and Versions.

2. Right-click the prm_docbase_config file and select Properties.

3. Type the values for theWeb Services URL and for the Temporary Label Object Target Folder forLabel Printing attributes on the Info tab; /TempLabelTarget and http://10.5.145.210:8888/services forexample. The host name is the server on which CTS Web Services was installed. Although thedefault port is 8888, you can specify the appropriate port number for the port and the appropriateIP address for the machine name as follows, http://[machine name]:[port]/services.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 35

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 thatusers in the Label Print Request role (dmc_prm_label_print_request) haveWrite permissionson this folder.

4. Click OK.

To use batch processing or label printing, perform the following manual steps to setthe 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

Installing Physical Records Transformation Services

• C:\PROGRA~1\DOCUME~1\CTS\lib\DmcPolicyEngine.jar;

• C:\PROGRA~1\DOCUME~1\CTS\lib\DmcPrm.jar;

• C:\PROGRA~1\DOCUME~1\CTS\lib\DmcRps.jar;

Note: Ensure there are no spaces between each jar entry.

The classpath entry should appear as follows:-Djava.class.path=C:\PROGRA~1\DOCUME~1\CTS\lib\cts.jar;C:\PROGRA~1\DOCUME~1

\dctm.jar;C:\DOCUME~2\config;C:\PROGRA~1\DOCUME~1\CTS\lib;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;C:\PROGRA~1\DOCUME~1\CTS\lib\DmcPolicyEngine.jar;C:\PROGRA~1\DOCUME~1\CTS\lib\DmcPrm.jar;C:\PROGRA~1\DOCUME~1\CTS\lib\DmcRps.jar;C:\PROGRA~1\DOCUME~1\java\1.5.0_12\jre\lib\ext\sunjce_provider.jar

7. Copy the entire entry from Notepad back to the parameters, click OK on the edit string dialogand close regedit.

8. Restart the "Documentum Content Transformation Services" service.

Note: Check the CTS_log, in the default location C:\Program Files\Documentum\CTS\logs, toensure there are no errors there after making the changes to the registry (extraneous characterssuch as spaces will cause an error).

Installation troubleshootingThis section provides information on troubleshooting a Physical Records Transformation Servicesinstallation. In addition, consult the Records Manager Release Notes for information regardingadditional items that can affect installation and configuration.

Cannot pass SuperUser and repository user informationscreen

When you configure Physical Records Transformation Services, you must provide the name andpassword for a repository SuperUser to allow Physical Records Transformation Services to accessthe repository. You must also provide the name of the repository user who will receive notificationsfrom Physical Records Transformation Services.

If the user information you provide is incorrect, you will not be able to configure Physical RecordsTransformation Services. Contact the repository administrator to verify that the SuperUser exists, thatyou are using the appropriate password, and that the notification user exists.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 37

Installing Physical Records Transformation Services

If Physical Records Transformation Servicesinstallation fails

If you receive notification that the Physical Records Transformation Services installation has failed,check the Installer log file. By default, the log file (installer.log) is located in the Physical RecordsTransformation Services installation directory identified in Step 13 of the section Installing PhysicalRecords Transformation Services, page 23.

If cts_instance_info is not created when theConfigurator is executed

If the cts_instance_info type is not created when the Configurator is executed, there may be a problemwith locale settings. The following errors may appear:[dm_query2_e_data_dict_error_for_attr_a_c]error:"the following error(s) occurred processing an alter/createstatement for type cts_instance_info, attribute cts_version."

[dm_query2_e_invalid_locale_setting]error: "alter/create type:the session_locale setting of 'en_gb' in the sessionconfig objectis not a valid locale in the docbase. the alter/create isdisallowed because it contains locale sensitive information foran invalid locale. please either set the session_locale to avalid dd_locales value ('en'), or add a new locale entry todd_locales (dm_docbase_config)."

The locale setting for the server and for the repository should match. If, for example, the servermachine has a locale setting of UK (en_gb) and the repository has a locale setting of US (en_us), thects_instance_info type is not created.

The solution is to change the locale of the machine running the Configurator to match the locale ofthe repository, or add the Configurator machine’s locale to the repository. The locale setting can bechanged using DQL.

38 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Chapter 4Verifying, Expanding, Removing,and Uninstalling Physical RecordsTransformation Services

This chapter explains how to verify an installation of Physical Records Transformation Services. Italso explains how to expand your Physical Records Transformation Services installation by addinginstances of the Physical Records Transformation Services and Thumbnail Server. The process forremoving a Physical Records Transformation Services instance is also explained. Procedures foruninstalling Physical Records Transformation Services and the Content Transformation Servicescomponent are provided in this chapter.

This chapter contains the following sections:• Verifying the Physical Records Transformation Services installation, page 39 provides instructionsfor testing the success of your Physical Records Transformation Services installation.

• Expanding Physical Records Transformation Services, page 40 explains why you would expandPhysical Records Transformation Services, and provides instructions for adding new instancesof Physical Records Transformation Services.

• Removing the Physical Records Transformation Services instance from a repository, page 42provides instructions for removing an instance of Physical Records Transformation Servicesfrom a repository.

• Uninstalling Physical Records Transformation Services, page 43 provides the procedure touninstall Physical Records Transformation Services.

• gives instructions for uninstalling the Content Transformation Services component.

Verifying the Physical Records TransformationServices installation

Verifying startup of Physical Records TransformationServices

Once Physical Records Transformation Services is installed and configured for a repository, PhysicalRecords Transformation Services should start automatically.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 39

Verifying, Expanding, Removing, and Uninstalling Physical Records Transformation Services

To verify startup of Physical Records Transformation Services:

1. Log in to the Physical Records Transformation Services host as an administrator user.

2. SelectWindows > Administrative Tools > Services to access the Windows Services utility.

3. Ensure that Documentum Content Transformation Services is started.

Expanding Physical Records TransformationServicesIf you wish, you can add more than one Physical Records Transformation Services configuration toyour system. For more information on scalability, refer to Content Transformation Services scalability,page 10.

Configuring Physical Records Transformation Servicesfor another repository

This section describes how to configure a Physical Records Transformation Services against anotherrepository. You can run one installation of Physical Records Transformation Services on a single host,and have it configured against multiple repositories.

This procedure does not perform the base installation or install configuration files, which mustbe done only once (refer to Installing and configuring Physical Records Transformation Services,page 20). You do not have to rerun the entire installation procedure to apply Physical RecordsTransformation Services to an additional repository. It is only necessary to add an instance of thePhysical Records Transformation Services.

Caution: Ensure the appropriate Connection Broker and repositories are running beforecontinuing with the configuration.

To configure an instance of Physical Records Transformation Services:

Note: The CTS dar files must be installed first for each instance of PRTS. Ensure the CTS dar files areinstalled on each PRM repository before proceeding.

1. Make sure

2. 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, followedby the Welcome screen.

3. Click Next.The license agreement terms are displayed.

4. Select the option to accept the terms of the license agreement, then click Next.

5. Select Add an instance Physical Records Transformation Services to a docbase, and click Next.

40 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Verifying, Expanding, Removing, and Uninstalling Physical Records Transformation Services

6. Enter the name of the Physical Records Transformation Services host. The installer may detect thehost name for you. This will be the name of the machine on which you have installed PhysicalRecords Transformation Services.

7. Click Next.The Enter repository name and user info screen appears.

8. Complete the following substeps:

a. Select a repository to be served by the Physical Records Transformation Services when thedrop down list "Select a Repository" of the repositories served by your Connection Brokerappears.For instructions on selecting a Connection Broker, refer to Identifying a Connection Brokerin dfc.properties, page 17.

b. Enter the "Repository Super User Name" that Physical Records Transformation Serviceswill use to access the repository.

Note: In a domain-required repository, you must configure the product with a registereddomain 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 RecordsTransformation Server, otherwise known as the system operator.

Note: If you are unsure of which users to specify, refer to Required Physical RecordsTransformation Services installation information, page 21 for details regarding values forthese fields.

f. Click Next.If you cannot continue, check with the repository administrator to verify that the users existand that you entered the correct password.

9. If the repository you have chosen is in a distributed environment, a screen will appear with alist of Content Servers configured for the repository you have chosen to configure with PhysicalRecords 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 toDocumentum Distributed Configuration Guide.

10. A dialog box indicates the success of the Physical Records Transformation Services configuration.Click Finish.

This additional repository is now configured for Physical Records Transformation Services.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 41

Verifying, Expanding, Removing, and Uninstalling Physical Records Transformation Services

Removing the Physical RecordsTransformation Services instance froma repositoryThis section describes how to remove an instance of Physical Records Transformation Services froma repository. This procedure does not remove the configuration files and services associated withPhysical Records Transformation Services. To remove the Physical Records Transformation Servicesfrom a host, refer to Uninstalling Physical Records Transformation Services, page 43.

To remove an instance of Physical Records Transformation Services from arepository:

1. Navigate to the Physical Records Transformation Services Configurator under Start > Programs >Documentum > PRTS Configuratation Utility.The Physical Records Transformation Services Configurator splash screen is displayed, followedby the Welcome screen.

2. Click Next.The license agreement terms are displayed.

3. Select the option to accept the terms of the license agreement, and click Next.

4. Select Remove an instance Media Transformation Server instance from a docbase and clickNext.

5. Select the repository from which you want to remove the Physical Records TransformationServices instance, and click Next.The User Information screen appears.

6. Enter the SuperUser name that Physical Records Transformation Services uses to access therepository.

7. Enter the password for the SuperUser account.

8. Click Next.If you cannot continue, check with the repository administrator to verify that the user existsand that you entered the correct password.

9. The instance of Physical Records Transformation Services is removed.A dialog box indicates the success of the Physical Records Transformation Services repositoryinstance removal.

10. Click Finish.The instance of Physical Records Transformation Services is now removed from the repository.

42 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Verifying, Expanding, Removing, and Uninstalling Physical Records Transformation Services

Uninstalling Physical Records TransformationServicesThis section describes how to uninstall Physical Records Transformation Services from a Windowshost. The uninstaller removes all folders and the files contained within those folders. Files that are inuse are marked for deletion and removed when the system is restarted.

To remove only an instance of Physical Records Transformation Services, follow the instructions inRemoving the Physical Records Transformation Services instance from a repository, page 42.

Caution: It is strongly recommended that you remove all instances of Physical RecordsTransformation Services configured to repositories prior to uninstalling.

To uninstall Physical Records Transformation Services:

1. Log in as an administrator user to the machine on which Physical Records TransformationServices is installed.

2. Make sure that no programs or applications are running.

3. Click Start > Settings > Control Panel and double-click Add/Remove Programs.

4. In the Change or Remove Programs window, select Documentum Physical RecordsTransformation Services and click Change/Remove.The uninstaller for Physical Records Transformation Services opens and displays the Welcomedialog box.

5. Click Next.The license agreement terms are displayed.

6. Select the option to accept the terms of the license agreement, and click Next.

7. The location(s) from which Physical Records Transformation Services will be removed isdisplayed. Click Next.The Content Transformation Services service stops and Physical Records TransformationServices will be uninstalled. The Adobe Graphics Server uninstaller will also launch and runautomatically.

8. Restart the computer if prompted to do so. This deletes any Physical Records TransformationServices files that may have been in use. This is especially important if you are going to reinstallPhysical Records Transformation Services on the host.

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 43

Verifying, Expanding, Removing, and Uninstalling Physical Records Transformation Services

44 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Index

Aadding

an PRTS instance, 40repository to PRTS, 20

Advanced Document TransformationServerconfiguration, 34

architecture, 11

Bbase installation, 20

CConfigurator, 20configuring, 34

Global registry, 16configuring an instance, 29Connection Broker

checking services, 18host, 21identifying in dfc.properties, 17

Content Server, 15Connection Broker, 18repositories, 18

Content Transformation Servicesdescription, 9format awareness, 10queue, 10scalability, 10

CTS DARinstalling, 26

cts_instance_info, 38

DDAM

using DFC, 12DAR

installing, 26

DFCabout, 12and dfc.properties, 17directories, 21installation, 20installing, 12migrating, 12

dfc.propertiesidentifying a Connection Broker, 17

Documentum Foundation Classes. SeeDFCdomain name, 22

Eexpanding PRTS, 40

Ffailed installation, 38FAST Server, 15Full Text Index Server, 15

Gglobal registry

DAR files, 34Global registry, 16, 23

about, 16enabling, 32set up, 16user name, 23

HHeadless Composer

configuring, 27Headless Composer, installing, 27headless Composer,configurel, 27host

preparing, 20selecting, 15

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 45

Index

Iinstallation

directory, 21failure, 37overview, 20prerequisites, 15 to 17procedure, 23troubleshooting, 37

installers, 19installing, 26installing Physical Records Transformation

Services, 23instance

adding, 40configuring, 29removing, 42

JJava components, 20

Llocale setting, 38log file, 38

Mmigration of DFC, 12

PPhysical Records Transformation

Services, 21adding an instance, 20, 40architecture, 11components, 10configuring, 20, 29Connection Broker host, 21domain user, 22downloading installer, 19environment, 11expanding, 40general description, 10host, 22installation directory, 21installation information, 21installation log file, 38installation overview, 20integration with streaming servers, 10post-installation tasks, 34

pre-installation verifications, 17reinstalling, 17, 21removing from a repository, 20, 42repository user, 22scalability, 40software prerequisites, 17uninstalling, 17, 21, 43

plug-insdescription, 12pre-defined, 12

post-installation tasks, 34pre-installation tasks, 19

Qqueue

removing unsupported formatsfrom, 10

Rreinstalling Physical Records

Transformation Services, 17removing an instance, 42rendering applications, 13repository

checking, 18configuring for Media Server, 20removing an instance of Media Server

from, 20removing an instance of Thumbnail

Server from, 42required information, 22

repository user, 22, 37requirements

for Physical Records TransformationServices installation, 21

Physical Records TransformationServicessoftware, 17

Sscalability

of Content Transformation Services, 10of Media Services, 40

selecting host, 15software prerequisites, 17Streaming Server integration, 10SuperUser information, 37system architecture, 11

46 EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide

Index

TThumbnail Server

downloading installer, 19troubleshooting, 37 to ?typical installation, 11

Uuninstalling

Media Server, 21Physical Records Transformation

Services, 17, 43

Vverifications

pre-installation, 17

WWDK

relation to Physical RecordsTransformation Services, 12

Web Development Kit. SeeWDKWindows Services, 39

EMC Documentum Physical Records Transformation Services Version 6.5 SP3 Deployment Guide 47