emc documentum physicalrecordstransformation services · 2020-07-18 · emc® documentum®...

EMC® Documentum®

Physical Records TransformationServicesVersion 6.5 SP1

Deployment Guide

P/N 300008190A03

EMC CorporationCorporate Headquarters:

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

Copyright© 2008 EMC Corporation. All rights reserved.Published March 2009

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 REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

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 Server......................................................... 11Documentum Foundation Classes ................................................................. 11Physical Records Transformation Services plug‑ins ......................................... 12

Extending Physical Records Transformation Services .......................................... 12Rendering applications for supported source formats ......................................... 13Confirming migration of profiles dialog box ....................................................... 13

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

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

Chapter 3 Installing Physical Records Transformation Services ................................. 19Pre‑Installation steps ........................................................................................ 19Backup all profiles ........................................................................................ 19Remove old profiles ...................................................................................... 19Downloading the installers ........................................................................... 20Preparing the Physical Records Transformation Services host .......................... 20

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

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

Configuring a CTS product to the global registry ................................................ 32Post‑installation tasks ....................................................................................... 33

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

Table of Contents

Installation troubleshooting............................................................................... 35Cannot pass SuperUser and repository user information screen....................... 35If Physical Records Transformation Server installation fails ............................. 36If cts_instance_info is not created when the Configurator is executed ............... 36

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

Expanding Physical Records Transformation Services ......................................... 38Configuring Physical Records Transformation Server for anotherrepository .................................................................................................... 38

Removing the Physical Records Transformation Server instance froma repository ...................................................................................................... 40Uninstalling Physical Records Transformation Server ......................................... 41Uninstalling Content Transformation Services .................................................... 41

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

Table of Contents

List of Figures

Figure 1. Typical Physical Records Transformation Services installation ................................. 11Figure 2. Profile Migration Confirmation Dialog Box ............................................................ 14Figure 3. Properties for prm_docbase_config ........................................................................ 34


Table of Contents

List of Tables

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


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 the Physical Records Transformation Server. In addition, this manual includes a briefoverview of Physical Records Transformation Services architecture.

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

December 2008 Initial publication.

December 2008 Second publication.

March 2009 Third publication.


Preface


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

• Extending Physical Records Transformation Services, page 12

• Rendering applications for supported source formats, page 13

• Confirming migration of profiles dialog box, 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.


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 Server 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 PDF filesand a dedicated Physical Records Transformation Services for processing image 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 offers the following transformation capabilities to support andmaintain accurate/current inventory records of physical objects in Physical Records Manager (PRM):• Label printing of barcodes

• batch processing operations



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 Server

Physical Records Transformation Services is integrated with Documentum Content Server to process,store, and manage files within the Documentum schema. When a user imports a file into therepository, the Content Server stores the register request object (dm_queue_item) in a queue. PhysicalRecords Transformation Services logs in to the repository as a user, examines the queue, retrieves therequest objects, and sends them to the appropriate plug‑in for processing.

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 SP1 link.


https://documentum.subscribenet.com/


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 plugins

PRTS plug‑ins identify and extract attributes of dm_sysobjects based within an Physical Recordsenvironment for Label Rendering and Batch Operations.

NiceLabel, version 5.1 or 5.2, is the standard Physical Records Transformation Services plug‑in. It isused to define label printing rules and to print labels for physical objects.

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.

Extending Physical Records TransformationServicesThe functionality and capabilities of Physical Records Transformation Services can be extended byinstalling various add‑on components.



Rendering applications for supported sourceformatsPRTS can be set up if needed with the Nicelabel application that is used for label rendering andprinting in conjunction with batch processing operations for managing physical inventory.

It is not a prerequisite to have NiceLabel installed before you install PRTS. You will only need to haveNiceLabel installed if you plan to do Label Rendering, and it can be installed whenever that feature isneeded, several months for example after PRTS is already on the server if necessary.

Note: All rendering applications must be obtained separately by the customer. They are not included inthe purchase of Physical Records Transformation Services. The ʺSample NiceLabel 5.x Templateʺhowever is available out‑of‑the‑box with Physical Records Manager (PRM).

Confirming migration of profiles dialog boxDuring installation of Physical Records Transformation Services, a dialog box confirms the beginningof migration of profiles to version 6.5 SP1 with a reminder to backup all profiles.



Figure 2. Profile Migration Confirmation Dialog Box


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 Server host.

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

• 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 Servershould 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 Server host, consider the amount of memory onthe candidate server. Physical Records Transformation Services requires an amount of memory equalto at least twice the size of the largest file you expect to process. For example, if you expect users towork with 1 GB files, the Physical Records Transformation Server host must have at least 2 GB ofmemory to ensure efficient media processing.

As well, all Content Transformation Services products installed on a host use the same Windowsservice. This means that any actions (such as starting or stopping an application) performed onthat Windows service affect all of the CTS products using it. The number of products installed ona single host, the expected usage of those products, and the host’s hardware capabilities are majorfactors 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 moreinformation on CTS scalability, refer to Content Transformation Services scalability, page 10.


Getting Started

Setting up a global registry

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 need to be manually run against the globalregistry. See Enabling a DFC installation to access a global registry , page 32 for further information.

To set up a global registry:

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.

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

Software prerequisites

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


Getting Started

Uninstalling older versions of Physical RecordsTransformation Server

If you are installing Physical Records Transformation Server on a host that has a previous version ofPhysical Records Transformation Server, you must properly uninstall it first. If you do not uninstallthe previous version, your new installation of Physical Records Transformation Server may fail.For information and instructions on uninstalling Physical Records Transformation Server, refer toUninstalling Physical Records Transformation Server, page 41, or refer to the Installation Guide foryour 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 17 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.

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 Administration


Getting Started

Guide should be referenced for information and instructions pertaining to Connection Broker andrepository services.


Chapter 3Installing Physical RecordsTransformation Services

This chapter explains how to install Physical Records Transformation Server 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 Server.Post‑installation tasks, configuration tasks, and troubleshooting information are also provided.

This chapter contains the following sections:• Pre‑Installation steps, page 19

• Installing and configuring Physical Records Transformation Server, page 21

• Installing CTS DAR files, page 26

• Configuring a CTS product to the global registry, page 32

• Post‑installation tasks, page 33

• Installation troubleshooting, page 35

PreInstallation stepsThis section explains what to do before you install the Physical Records Transformation Server. Itspecifies the software to install before you start, and explains how to configure it.

Backup all profiles

All profiles must be removed from the repository before installing a Content Transformation Services6.5 product. If any profiles have been customized, they should be backed up by exporting themto a local disk.

Remove old profiles

The profiles used in Content Transformation Services products are not removed from the host when aproduct is uninstalled. Regardless of whether any customizations have been made to profiles from a


Installing Physical Records Transformation Services

previous release, you must remove the prior versions of the profiles so that all of the new profiles getinstalled properly. Any customization of the prior profiles must be manually migrated to the newprofiles after the 6.5 product is installed. These changes cannot be captured automatically.

To manually remove old profiles and migrate customizations to the new profiles:

1. Uninstall the previous version.

2. Back up any customized profiles from the previous version.

3. Navigate to the System cabinet and delete the Media Server folder (including all versions anddescendents).

4. Install the version 6.5 product, so that the new profiles are installed to /System/Media Server.

5. Stop the Content Transformation Services service.

6. Manually update the new profiles to reflect any desired customization, if applicable, afterupgrading all CTS products.

7. Restart the Content Transformation Services service.

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.

The following installer can be downloaded:

• Physical Records Transformation Server

Unzip any zipped files before you proceed with the installation.

Preparing the Physical Records TransformationServices host

Before installing the Physical Records Transformation Server, you must install several applicationsand other components on the server host. The Records Manager Release Notes provides information onspecific versions of 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.


https://documentum.subscribenet.com




Installing and configuring Physical RecordsTransformation ServerBefore installing Physical Records Transformation Server for the first time, ensure that you havefulfilled all of the pre‑installation prerequisites detailed in this document.

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

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

Physical Records Transformation Server installationoverview

Physical Records Transformation Server installation is accomplished as a three‑part process:1. Install Physical Records Transformation Server.

2. Migrate legacy profile files (if applicable).

3. Configure Physical Records Transformation Server to at least one repository.

The standard configuration procedure is found at Configuring an instance of Physical RecordsTransformation Server, page 29.

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

The Physical Records Transformation Server 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 Server (described in ExpandingPhysical Records Transformation Services, page 38) or to remove Physical Records TransformationServices from a repository (described in Removing the Physical Records Transformation Serverinstance from a repository, page 40), you do not have to run the Installer again. The Configuratorallows you to add and remove instances of Physical Records Transformation Servers and will beaccessible from the Windows Start menu after installation.

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



Required Physical Records Transformation Serverinstallation information

This section provides a table for recording the information you need to install Physical RecordsTransformation Server. Having this information ready and available prior to installation ensuresthe accuracy and efficiency of your installation.

Table 1. Required Physical Records Transformation Server 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 Server are stored,where exported documents arestored, and where checked outdocuments are stored. The defaultdirectory is C:\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 Server,during installation.

Physical RecordsTransformation Serverinstallation directory

The directory in which to installPhysical Records TransformationServer. It is recommended thatyou install Physical RecordsTransformation Server in thedefault installation directory.

Physical RecordsTransformation Server host

(if not detected)

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

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



Installation information Description Your value

Repository SuperUser nameand password

The account the Physical RecordsTransformation Server uses to login to the repository. Ask youradministrator to supply you witha SuperUser name and password.

You cannot use thedm_mediaserver user account asthe repository SuperUser.

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

Physical Records TransformationServices notifies the user ofthe results of processing. Forexample, if Physical RecordsTransformation Server failsto process a particular item, itqueues an event to the Inbox of thePhysical Records TransformationServer 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.

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.Duringrepository configuration, providethe user login name and passwordfor the global registry user.The global registry user should



Installation information Description Your valuebe someone other than theadministrator.

Installing Physical Records Transformation Server

The following procedure will install the Physical Records Transformation Server service andsupporting files. Complete the information in Table 1, page 22 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 Server host.

To install Physical Records Transformation Server:

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

2. Ensure that no programs or applications are running on the host.

3. Navigate to the folder containing the unzipped Physical Records Transformation Serverinstallation files. Downloading the installers, page 20 provides information about where thefiles should be located.

4. Grant the 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.

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.

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.

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 Server installation. Refer tothe 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. If you want to install theDeveloper Documentation and/or the Primary Interop Assembly Installer, select these options.Click Next.

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.


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.


13. Identify the Content Transformation Services installation directory (for core components that allCTS products use). The Installer creates a directory named CTS within the chosen directory.It is recommended that you accept the default directory (for example, C:\ProgramFiles\Documentum\CTS), which is where any other Documentum products are installed.• To accept the default directory, click Next.

• To choose another directory, click Browse, navigate to the directory, and click Next.

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. Identify 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 need to 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 their only repository.

16. Enter the Admin 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.



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 has been generated and is available atC:\PROGRA~1\DOCUME~1\CTS\migration\log. Click on Next to start the migrationprocess. 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 theadministrator. 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 Server on the host, proceed toConfiguring an instance of Physical Records Transformation Server, page 29.

Installing CTS DAR files

You need to install CTS DAR files before configuring CTS products to get all the latestchanges/enhancements. Install the DAR files in the global repository and each repository that isconfigured for Physical Records Transformation Services.

There are two CTS DAR files which are included in the PRTS build and can be found in the DARfolder:• 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


https://emc.subscribenet.com


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

Note: You must have Superuser privileges for the repositories in which you are installing the DARfiles.

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 occasionallyneed to cleanup 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.


https://emc.subscribenet.com


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.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 need to 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


https://emc.subscribenet.com/control/dctm/search


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 Server

To complete the Physical Records Transformation Server installation, you must configure an instanceof Physical Records Transformation Server. If you are configuring Physical Records TransformationServer to a repository that will also be configured with Document Transformation Server or DocumentTransformation Server ‑ Legacy, you will also need to perform the procedure for Configuring arepository 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 Server:

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.



4. Select Add an instance Physical Records Transformation Services to a docbase, and clickNext.

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

6. Click Next.



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 Server when the dropdown 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 Brokerin dfc.properties, page 17.

b. Enter the ʺRepository Super User Nameʺ that Physical Records Transformation Server willuse 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 Server installation information, page 22 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 Server.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 system administrator name and password;if you are installing as a domain user, use the format <username>@<domain> in the systemadministrator name field.Click Next.

10. A dialog box indicates the success of the Physical Records Transformation Server configuration.Click Finish. The Configurator closes.

If this repository will also be configured for Document Transformation Server or DocumentTransformation Server ‑ Legacy, you need to perform the configuration described in Configuring arepository for Physical Records Transformation Services, page 31.



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 Document Transformation Server or Document TransformationServer Legacy:

1. Save and close the file.

2. Restart the Documentum Content Transformation Services service.

To configure the Physical Records Transformation Server:

1. Navigate to %CTS%\config.

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="mts1_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="ignoreItemsToSignOffLimit"/></QueueProcessorContext>

4. Save and close the file.

5. Restart the Documentum Content Transformation Services service.The Document Transformation Server (or Document Transformation Server ‑ Legacy) and MediaTransformation Server will now 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, 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 willneed 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.

Configuring a CTS product to the globalregistryEnsure the global registry has the Content Transformation Services product configured againstit; otherwise the transformation and rich_media_services DAR files will need to be manually run



against the global registry. Refer to Configuring Physical Records Transformation Server for anotherrepository, page 38 for further information.

Postinstallation tasksThe following tasks should be performed after installing the Physical Records Transformation Servercomponent and configuring it for at least one repository.

1. Refer to Verifying the Physical Records Transformation Services installation, page 38 to verifyand test the installation of Physical Records Transformation Services.

2. Install any add‑on Transformation Services, such as Audio/Video Transformation Services usingAudio/Video Transformation Services Installation and Release Notes.

Follow the procedures below after PRTS is installed if you need to setup label rendering and supportfor barcode functionality used to manage physical objects from Physical Records Manager (PRM).Batch processing operations if needed rely on the classpath entries listed. To test the setup for labelrendering, refer to the sections titled ʺTo create a label printing ruleʺ and ʺTo print a labelʺ ofeither the Records Manager Administrator User Guide, version 6.5 SP1, or the Retention Policy ServicesAdministrator User Guide, version 6.5 SP1.

On the server hosting PRTS:

1. Ensure the PRM DAR file is installed on the repository.

2. Install the Adobe PDF printer driver on the CTS machine (available by installing Adobe AcrobatProfessional).

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 View Adobe PDF results, Add document information and Delete log files forsuccessful 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. Extract NiceLabelSoftware.zip and install NiceLabel.

On a separate Windows server:

1. Install CTS Web Services according to the CTS Web Services Installation Guide.

To setup CTS WebServices for RPTS:

1. Login to either RMA, Retention Policy Services Administrator (RPSA), Webtop, or DocumentumAdministrator (DA) whichever is available and navigate to the ʺPRM DocbaseConfigʺ folder in



the 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.

Figure 3. Properties for prm_docbase_config

Note: Ensure that you have created the ʺTemp Label Targetʺ folder within the repository and thatits users haveWrite permissions on this folder.

4. Click OK.

To use Batch Processing, perform the following manual steps to set the classpathentries for PRTS, on the RPTS server:

1. Open Windows Services from Administrative Tools.

2. Stop the Documentum Content Transformation Services service.

3. Open regedit and navigate to ʺ\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\DocumentumCTS\Parametersʺ.

4. Open Addparameters and copy the entries to Notepad.



5. 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;

• 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

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

7. 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 (if for some reason aspace was left or something was entered incorrectly, an error would be thrown).

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 Server, you must provide the name andpassword for a repository SuperUser to allow Physical Records Transformation Server to access therepository. You must also provide the name of the repository user who will receive notificationsfrom Physical Records Transformation Server.



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

If Physical Records Transformation Server installationfails

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

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.


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 Server and Thumbnail Server. The process forremoving a Physical Records Transformation Server instance is also explained. Procedures foruninstalling Physical Records Transformation Server and the Content Transformation Servicescomponent are provided in this chapter.

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

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

• Removing the Physical Records Transformation Server instance from a repository, page 40provides instructions for removing an instance of Physical Records Transformation Server from arepository.

• Uninstalling Physical Records Transformation Server, page 41 provides the procedure to uninstallPhysical Records Transformation Server.

• Uninstalling Content Transformation Services, page 41 gives instructions for uninstalling theContent Transformation Services component.


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

Verifying the Physical Records TransformationServices installation

Verifying startup of Physical Records TransformationServices

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

To verify startup of Physical Records Transformation Services:

1. Log in to the Physical Records Transformation Server 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 Server configuration toyour system. For more information on scalability, refer to Content Transformation Services scalability,page 10.

Configuring Physical Records Transformation Serverfor another repository

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

This procedure does not perform the base installation or install configuration files, which must bedone only once (refer to Installing and configuring Physical Records Transformation Server, page 21).You do not need to rerun the entire installation procedure to apply Physical Records TransformationServices to an additional repository. It is only necessary to add an instance of the Physical RecordsTransformation Server.

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

To configure an instance of Physical Records Transformation Server:

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.



4. Select Add an instance Physical Records Transformation Services to a docbase, and clickNext.

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

6. Click Next.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 Server when the dropdown 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 Brokerin dfc.properties, page 17.

b. Enter the ʺRepository Super User Nameʺ that Physical Records Transformation Server willuse 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 Server installation information, page 22 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. A dialog box indicates the success of the Physical Records Transformation Server configuration.Click Finish.

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



Removing the Physical RecordsTransformation Server instance from arepositoryThis section describes how to remove an instance of Physical Records Transformation Server froma repository. This procedure does not remove the configuration files and services associated withPhysical Records Transformation Server. To remove the Physical Records Transformation Server froma host, refer to Uninstalling Physical Records Transformation Server, page 41.

To remove an instance of Physical Records Transformation Server from a repository:

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


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 TransformationServer instance, and click Next.The User Information screen appears.

6. Enter the SuperUser name that Physical Records Transformation Server 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 Server is removed.A dialog box indicates the success of the Physical Records Transformation Server repositoryinstance removal.

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



Uninstalling Physical Records TransformationServerThis section describes how to uninstall Physical Records Transformation Server 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 Server, follow the instructions inRemoving the Physical Records Transformation Server instance from a repository, page 40.

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 Server:

1. Log in as an administrator user to the machine on which Physical Records Transformation Serveris 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 Server opens and displays the Welcomedialog box.


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. If prompted to, restart the computer. This deletes any Physical Records Transformation Serverfiles that may have been in use. This is especially important if you are going to reinstall PhysicalRecords Transformation Server on the host.

Uninstalling Content Transformation ServicesIf you are uninstalling all Content Transformation Services products (Document TransformationServices, Advanced Document Transformation Services, Regulatory Publishing TransformationServices, Physical Records Transformation Services) from your host, then you will also need touninstall the common Content Transformation Services component. This provides a clean host onwhich to install other products, or to reinstall a Content Transformation Services product.



To uninstall Content Transformation Services:

1. Log in as an administrator user to the machine on which Content Transformation Services isinstalled.

2. Ensure 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 Content TransformationServices and click Change/Remove.The Uninstaller for Content Transformation Services opens and displays the Welcome screen.

5. Click Next.

6. The location from which Content Transformation Services will be removed is displayed. ClickNext.The Content Transformation Services service stops and Content Transformation Services isuninstalled.

7. Restart the computer if prompted to do so. This deletes any files that may have been in use. Thisis especially important if you are going to reinstall a Content Transformation Services producton the host.


Index

Aadding

an PRTS instance, 38repository to PRTS, 21

Advanced Document TransformationServerconfiguration, 32

architecture, 11

Bbase installation, 21

CConfigurator, 21configuring, 32

Global registry, 16configuring an instance, 29Connection Broker

checking services, 17host, 22identifying in dfc.properties, 17

Content Server, 15Connection Broker, 17repositories, 17

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

CTS DARinstalling, 26

cts_instance_info, 36

DDAM

using DFC, 11DAR

installing, 26DFC

about, 11and dfc.properties, 17directories, 22installation, 21installing, 11migrating, 11

dfc.propertiesidentifying a Connection Broker, 17

Documentum Foundation Classes. SeeDFCdomain name, 23

Eexpanding PRTS, 38

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

Gglobal registry

DAR files, 32Global registry, 16, 23

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

HHeadless Composer

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

preparing, 19 to 20selecting, 15


Index

Iinstallation

directory, 22failure, 35overview, 21prerequisites, 15 to 16procedure, 24troubleshooting, 35

installers, 20installing, 26installing Physical Records Transformation

Server, 24instance

adding, 38configuring, 29removing, 40

JJava components, 21

Llocale setting, 36log file, 36

Mmigration of DFC, 11

PPhysical Records Transformation Server

adding an instance, 21, 38configuring, 21, 29Connection Broker host, 22domain user, 23downloading installer, 20host, 22installation directory, 22installation information, 22installation log file, 36installation overview, 21post‑installation tasks, 33pre‑installation verifications, 17reinstalling, 17, 21removing from a repository, 21, 40repository user, 23software prerequisites, 16uninstalling, 17, 21, 41

Physical Records Transformation Services

architecture, 11components, 10environment, 11expanding, 38general description, 10integration with streaming servers, 10scalability, 38

plug‑insdescription, 12pre‑defined, 12

post‑installation tasks, 33pre‑installation tasks, 19profiles

migrate, 19

Qqueue

removing unsupported formatsfrom, 10

Rreinstalling Physical Records

Transformation Server, 17, 21removing an instance, 40rendering applications, 13repository

checking, 17configuring for Media Server, 21removing an instance of Media Server

from, 21removing an instance of Thumbnail

Server from, 40required information, 23

repository user, 23, 35requirements

for Physical Records TransformationServer installation, 22

Physical Records TransformationServersoftware, 16

Sscalability

of Content Transformation Services, 10of Media Services, 38

selecting host, 15software prerequisites, 16Streaming Server integration, 10


Index

SuperUser information, 35system architecture, 11

TThumbnail Server

downloading installer, 20troubleshooting, 35 to ?typical installation, 11

Uuninstalling

Content Transformation Services, 41Media Server, 21

Physical Records TransformationServer, 17, 41

Vverifications

pre‑installation, 17

WWDK

relation to Physical RecordsTransformation Services, 11

Web Development Kit. SeeWDKWindows Services, 38


emc documentum physicalrecordstransformation services · 2020-07-18 · emc® documentum®...

Documents