68
EMC ® Documentum ® Content Transformation Services Transformation Suite Version 7.2 Installation Guide EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com

EMC Documentum ContentTransformationServices ......EMC® Documentum® ContentTransformationServices TransformationSuite Version7.2 InstallationGuide EMCCorporation CorporateHeadquarters:

  • Upload
    others

  • View
    35

  • Download
    7

Embed Size (px)

Citation preview

EMC® Documentum®

Content Transformation ServicesTransformation Suite

Version 7.2

Installation Guide

EMC CorporationCorporate Headquarters:

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

Legal Notice

Copyright © 2002–2015 EMC Corporation. All Rights Reserved.

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

THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

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

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused herein are the property of their respective owners.

Documentation Feedback

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

Table of Contents

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

Chapter 1 Overview ...................................................................................................... 9What is Content Transformation Services?........................................................... 9What is Advanced Document Transformation Services? ...................................... 10Installed components .................................................................................... 10

What is Media Transformation Services? ............................................................ 10Installed components .................................................................................... 11

What is Audio/Video Transformation Services.................................................... 11Installed components .................................................................................... 11

Chapter 2 Installing Content Transformation Services products ................................. 13Pre-installation configuration ............................................................................ 13Software prerequisites .................................................................................. 14Selecting the server host ................................................................................ 15Downloading installers ................................................................................. 15Verifying the connection broker..................................................................... 15Identifying a Connection Broker in dfc.properties....................................... 16Checking Connection Broker and repository services .................................. 16

Setting the locale of the repository and host.................................................... 16Installing Microsoft fonts .............................................................................. 16Required installation information .................................................................. 17Providing required permissions to the Content TransformationServices install user ...................................................................................... 19

Installing Content Transformation Services ........................................................ 19Installing Content Transformation Services DAR files ..................................... 20Configuring Headless Composer ............................................................... 21Installing a DAR file with DAR Installer Plugin .......................................... 21

Content Transformation Services product installation ..................................... 23Configuring an instance of a Content Transformation Servicesserver ...................................................................................................... 24

Content Transformation Services products silent installation andconfiguration................................................................................................ 26

Post-installation tasks ....................................................................................... 28Enabling a Document Foundation Classes installation to access aglobal registry ............................................................................................. 28Configuring Content Transformation Server for another repository.................. 29Enhancing memory availability for Content Transformation Services ............... 29

Chapter 3 Verifying Content Transformation Services Installation .............................. 31Verifying Content Transformation Services installation ....................................... 31Verifying startup of Content Transformation Services service .......................... 31

Chapter 4 Unconfiguring and Uninstalling Content Transformation Services ............ 33Uninstalling Content Transformation Services .................................................... 33

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 3

Table of Contents

Manual unconfiguration and uninstallation.................................................... 33Removing a Content Transformation Services instance from arepository ................................................................................................ 33Uninstalling Content Transformation Services products .............................. 34

Silent unconfiguration .................................................................................. 35Removing Content Transformation Services repositoryconfiguration settings in the silent mode .................................................... 35

Chapter 5 Upgrading Content Transformation Services .............................................. 37Upgrading Content Transformation Services ...................................................... 37Backing up and removing old profiles................................................................ 37Viewing log file of migrated profiles .............................................................. 38

Chapter 6 Deploying Content Transformation Services WebServices ......................... 41Deploying CTS WebServices on Windows JBoss ................................................. 41Deploying Content Transformation Services WebServices on VMwarevFabric tc Server ............................................................................................... 44Deploying Content Transformation Services WebServices on OracleWeblogic .......................................................................................................... 47Deploying Content Transformation Services WebServices on ApacheTomcat............................................................................................................. 51Deploying Content Transformation Web Services on IBMWebsphere .................. 54

Chapter 7 Installation Troubleshooting ........................................................................ 59Troubleshooting tips for Content Transformation Services................................... 59Checking the installer log file ........................................................................ 59If cts_instance_info object is not created when the Configurator isexecuted ...................................................................................................... 60A Transformation DAR error occurs when upgrading from aprevious version........................................................................................... 60Deleting log files........................................................................................... 61Third-party applications installed on the Content TransformationServices host should not be used by any other products or users...................... 61Uninstalling or reinstalling Content Transformation Services........................... 61Content Transformation Services Configurator cannot beconfigured to the Japanese, Korean, or Simplified Chinese repository .............. 62

Chapter 8 Installing the Language Pack ...................................................................... 63Installing an Content Transformation Services Language Pack............................. 63Enabling multilingual support in Content Transformation Services...................... 64

4 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Table of Contents

List of Figures

Figure 1. Typical Advanced Document Transformation Services installation........................... 10Figure 2. Typical Media Transformation Services installation................................................. 11Figure 3. Typical Audio/Video Transformation Services installation ....................................... 12

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 5

Table of Contents

List of Tables

Table 1. Common requirements for Transformation Services................................................ 14Table 2. Required installation information .......................................................................... 17Table 3. Description of DAR Installer Fields (Content Transformation Services DAR) ............ 22

6 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Preface

This guide provides step-by-step procedures for installing the Content Transformation Servicesproducts. It lists installation prerequisites and provides step-by-step instructions for installing anduninstalling the Content Transformation Server for your product(s). In addition, this manual includesa brief overview of Content Transformation Services architecture.

Intended audienceThis guide is intended for the person who installs and configures the Content Transformation Servicesproducts, often called the system administrator or system operator.

It is assumed that the system operator has a basic understanding of the Windows operating system.

Revision historyThe following changes have been made to this document.

Revision Date Description

February 2015 Initial publication.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 7

Preface

8 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 1Overview

What is Content Transformation Services?Content Transformation Services (CTS) is a suite of Documentum server products that performtransformations and analysis on repository content. The Content Transformation Servicesfunctionality is available through Documentum client applications. Content Transformation Servicesconsists of these products:• Advanced Document Transformation Services (ADTS)

• Media Transformation Services (MTS)

• Audio/Video Transformation Services (AVTS)

Content Transformation Services provides the following functionalities:

• Transformations

Content Transformation Services carries out a wide range of conversions of documents, media,and audio/video content (for example, Microsoft Office documents into PDF and HTML formats).You can also apply watermarks, PDF overlays, headers, and footers to the transformed PDFs.Media files (images) can be transformed from one format into another with a wide range of options(like changes in the resolution, orientation, and so on). Audio/video files can be transformed fromone format into another with options like updating frame-rate, bit-rate, resolution, encoding,and so on, in the target files.

• Metadata Analysis and Attribution

Content Transformation Services extracts attributes from content. Examples of extracted attributesare height and width of image files, and author and subject of documents. The extracted attributesare stored as metadata or rendition attributes. Some rendition attributes can be mapped toobject-level attributes.

• Enhanced Content Previews

Content Transformation Services generates thumbnails and storyboards to enhance thepreviewing experience of Microsoft Office documents, PDF, images and video files that arepresent in the repository.

• Rendition Management

Content Transformation Services stores different formats of a repository file as renditions orrelated objects. Renditions are alternate formats of content that share the same object attributesand security. Related objects are complete objects on their own with independent metadataand security.

The EMC Documentum Content Transformation Services Administration Guide describes the functionalityof Content Transformation Services products in detail.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 9

Overview

What is Advanced Document TransformationServices?Advanced Document Transformation Services is a server software that generates copies of documentsin Portable Document Format (PDF), PDF text, PostScript, HyperText Markup Language (HTML),and so on. You can use Documentum client applications to request such a copy (called a rendition)of a document stored in a Documentum repository. The transformation capabilities of AdvancedDocument Transformation Services include PDF assembly, header/footer creation, security, textualwatermarking, content overlays, and so on.

Advanced Document Transformation Services can also provide PDF transformations from otherfile formats such as image and email formats.

Some Documentum client applications may not provide both PDF and HTML renditions; consultthe documentation for the client you are using.

Installed components

Figure 1, page 10 shows a typical Advanced Document Transformation Services installation onthe Documentum platform.

Figure 1. Typical Advanced Document Transformation Services installation

What is Media Transformation Services?Media Transformation Services (MTS) is server software that integrates with Content Server toperform analysis and transformation activities for media file formats. Thumbnail, storyboard,and low-resolution renditions are generated automatically. Transformations can be triggeredautomatically by certain events, such as when an object is versioned, or as requested by users.

10 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Overview

Installed components

Figure 2, page 11 shows a typical Media Transformation Services installation on the Documentumplatform.

Figure 2. Typical Media Transformation Services installation

What is Audio/Video Transformation ServicesAudio/Video Transformation Services provides transformation capability for audio and video fileformats.

Installed components

Figure 3, page 12 shows a typical Audio/Video Transformation Services installation on theDocumentum platform.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 11

Overview

Figure 3. Typical Audio/Video Transformation Services installation

12 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 2Installing Content TransformationServices products

This chapter describes the process of installing Content Transformation Services products on aWindows host. Post-installation tasks, configuration tasks, and troubleshooting information are alsoprovided in this document.• Pre-installation configuration, page 13

• Installing Content Transformation Services, page 19

• Post-installation tasks, page 28

Content Transformation Services allows for a high level of scalability. Content TransformationServices runs as a Windows Service on the Content Transformation Services host.

Multiple Content Transformation Services instances can be configured to a single repository. If youhave one installation of Content Transformation Services on a host, the same installation can beconfigured against different repositories.

Note: Ensure that you cleanup the previous versions of Documentum Foundation Classes (DFC)before installing Content Transformation Services products.

Pre-installation configurationEnsure that the following requirements are met before you install Content Transformation Services:

• Software prerequisites, page 14

• Selecting the server host, page 15

• Downloading installers, page 15

• Verifying the connection broker, page 15

• Setting the locale of the repository and host, page 16

• Installing Microsoft fonts, page 16

• Required installation information, page 17

• Providing required permissions to the Content Transformation Services install user, page 19

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 13

Installing Content Transformation Services products

Software prerequisites

This section provides information about the software that is required or optional for ContentTransformation Services.

The following software must be installed, configured, and running properly on your network beforeyou install Content Transformation Services:

• Documentum Content Server

Before installing Content Transformation Services, you must install several applications and othercomponents on the server host (or another machine, where applicable). Table 1, page 14 providesdetails about the software that must be installed, configured, and running properly on the host (oranother machine, whichever applicable) before you install Content Transformation Services.

Table 1. Common requirements for Transformation Services

Supporting Software / RenderingApplications

Required/Optional

Notes

Documentum Composer/DARInstaller

Required To install DAR files. Does not have to beinstalled on the Content TransformationServices host, but must be able toaccess Content Transformation Servicesrepositories.

Microsoft Windows as the operatingsystem.

Required

Documentum Administrator Optional To access Content TransformationServices administration features.

GhostScript

Note: The EMC DocumentumEnvironment and System RequirementsGuide document containsinformation about the supportedversion.

Optional Allows the Doc3 plug-in to processPostScript files.

Allows the Image 3 plug-in to process allPostScript source and target formats suchas EPS, PS, AI, and PDF.

Microsoft PowerPoint Optional Required by PowerPoint2 plug-in for thegeneration of thumbnails, low-resolutionrenditions, storyboards, and slide objectsfrom PowerPoint files.

Microsoft Word, MicrosoftPowerPoint, Microsoft Excel

Optional Required by Doc10 plug-in for highfidelity Word, PowerPoint, or Excel toPDF transformations.

Arial Unicode Font Optional To support extended multi byte characterrange in documents (Chinese, Japanese,Korean, Arabic, and so on).

Note: Ensure that all applications are installed in their default location. Content TransformationServices refers to each application’s default installation directory while launching an application.

14 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

Some applications provide you with the choice of installing them with either minimal or full options.Applications installed with minimal options may not run correctly with the Content TransformationServices product.

Selecting the server host

This section provides basic guidelines for selecting the host machine for your Content TransformationServices installation.• The server name must not, and cannot exceed 15 bytes.

• The server must have a 6 GB System RAM (or higher capacity). The Content Transformation Serverrequires a 4 GB RAM for file manipulations. In addition, if the expected file size to be processed isvery large then an equivalent memory allowance needs to be provisioned. For example, if thelargest file expected is 1 GB, then the Content Transformation Server requires an extra 1 GBRAM (4GB + 1GB). Enhancing memory availability for Content Transformation Services, page 29provides instructions on how you can increase the RAM for Content Transformation Services.

Caution: To ensure optimal system performance, do not install the Content TransformationServices product on the same host as the Content Server or xPlore. This configuration is notcertified, supported, or recommended.

Downloading installers

Before beginning the installation process, it is best to have the installers ready and availableon your Content Transformation Services host. The EMC Software Download Centerhttps://emc.subscribenet.com provides a complete listing of products available for download.Download the Installer Zip file of the required Content Transformation Services product from theDownload Center.• adtsWinSetup.exe — Advanced Document Transformation Services

• mtsWinSetup.exe — Media Transformation Services

• avtsWinSetup.exe — Audio Video Transformation Services.

The .zip file contains the executable installer file, silent installer batch files, and configuration files.Extract the .zip files into a temporary folder before you proceed with the installation.

Verifying the connection broker

Prior to installation, verify the following:• If you already have a dfc.properties file, it is pointing to the correct Connection Broker.Identifying a Connection Broker in dfc.properties, page 16 provides the required instructions.

• The Connection Broker and repository services are running on your Content Server. CheckingConnection Broker and repository services, page 16 provides the required instructions.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 15

Installing Content Transformation Services products

Identifying a Connection Broker in dfc.properties

If you already have Documentum Foundation Classes installed on the Content TransformationServices host server, you will have a dfc.properties file. This procedure is to ensure that thecorrect Connection Broker is specified. If you are installing Content Transformation Services ona clean host, you will not have a dfc.properties prior to installation. In such a scenario, thefollowing procedure is not required.

The EMC Documentum Content Server Administration and Configuration Guide provides moreinformation about the Connection Broker.

To identify the correct Connection Broker in dfc.properties:1. Search for the dfc.properties file on your Content Transformation Services host server. The

file is usually located in the Windows (C:\Documentum\config) folder.

2. Open dfc.properties in a text editor.

3. Find the line indicating the Connection Broker. Ensure that the specified Connection Broker is 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 correctly on the Content Serverhost before you install Content Transformation Services. The EMC Documentum Content ServerAdministration and Configuration Guide provides more information about the Connection Brokerand repository services.

Setting the locale of the repository and host

The locale setting of the repository and the Content Transformation Services host server must be thesame before installing Content Transformation Services. If it is not, the cts_instance_info table isnot created in the repository.

For example, install Content Transformation Services on a server where the locale is set to en andconfigure Content Transformation Services for a repository with locale set to en.

Installing Microsoft fonts

Fonts used in source files like Microsoft Word, Excel, or PowerPoint should be present in the ContentTransformation Services server host to get the right target PDF renditions. Otherwise, the originalfonts are replaced with alternate fonts in the resultant PDF rendition.

Note: The Arial Unicode MS font must be installed to support double byte characters.

The Microsoft website provides the instructions required to install and uninstall Microsoft fonts.

16 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

Required installation information

The table in this section allows you to record the information you need to install a ContentTransformation Services server. Having this information ready and available prior to installationensures the accuracy and efficiency of your installation.

Table 2. Required installation information

Installation information Description Your value

Document Foundation Classesinstallation directory

This is the destination directoryfor Document FoundationClasses.

The default directory isC:\Documentum.

Connection Broker host name

(if not detected)

If the correct DocumentFoundation Classes has notyet been installed on the host,you will be prompted duringinstallation for the primaryConnection Broker host nameand Docbroker port numberthat is servicing the repositoryyou want to configure withContent TransformationServices.

Content TransformationServices server installationdirectory

The directory in whichto install the ContentTransformation Services server.It is recommended that you usea subdirectory of the directoryin which other Documentumproducts are installed.

For example, if otherDocumentum products areinstalled in D:\Documentum,use the same path for ContentTransformation Servicesinstallation. The installer willcreate a subdirectory called"CTS”.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 17

Installing Content Transformation Services products

Installation information Description Your value

Content Transformation Serverhost

(if not detected)

The name of the machineon which you are installingContent Transformation Server.

You may need to enterthis information if it is notautomatically detected by theinstaller, or if you are runningthe installer from a remotecomputer.

Admin User name andpassword

The name of the admin userwho is installing the ContentTransformation Services server.

Repository SuperUser nameand password

The account the ContentTransformation Server uses tolog in to the repository. Askyour administrator to supplyyou with a SuperUser nameand password.

Notification user name The name of the user whowill receive notifications fromContent Transformation Server.

Content TransformationServices notifies the user ofthe results of processing.For example, if ContentTransformation Server fails toprocess a particular item, itqueues an event to the Inboxof the Content TransformationServer system operator user(sysOpUser).

Content TransformationServices Admin Port

The port used byDocumentum Administrator tocommunicate with the ContentTransformation Servicesinstallation. The default is9095.

Content TransformationServices WebServices Port

The port is used forWebServices communication.The default is 9096.

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

18 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

Installation information Description Your value

Global registry Different DocumentFoundation Classesinstallations can use differentglobal registrieswhere requiredservice-based objects ornetwork locations are stored. Asingle Document FoundationClasses installation can haveonly one global registry. Youwill be prompted duringinstallation for the primaryregistry.

dm_bof_registry By default, the global registryuser has the user name ofdm_bof_registry. Duringrepository configuration,provide the user login nameand password for the globalregistry user.

Providing required permissions to the ContentTransformation Services install user

Ensure that the Content Transformation Services install user has the following permissions:1. The install user has Administrator privileges.

2. The install user is part of the Windows local Administrator group.

3. Add the install user to the Log on as a service policy under Local Security Policy > Local Policies> User Rights Assignment.

4. The install user has full permissions to the installation directory.

Installing Content Transformation ServicesIf you are reinstalling Content Transformation Services , you must first uninstall the previousversion of the product that is installed on your server. Refer to Uninstalling Content TransformationServices, page 33.

Note: Ensure that the installation user account has Administrator privilege and that the installationuser account is included in the local Administrators group. Else, the Content Transformation Servicesproduct installation fails.

Content Transformation Services installation is accomplished as a four-step process:1. Install Content Transformation Services DAR files.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 19

Installing Content Transformation Services products

Installing Content Transformation Services DAR files, page 20 describes the process of installingContent Transformation Services DAR files.

2. Install Content Transformation Services.

You can install Content Transformation Services by using one of the following installers:• Installer

Content Transformation Services product installation, page 23 describes the process ofinstalling Content Transformation Services using the installer.

• Silent Installer

Content Transformation Services products silent installation and configuration, page 26describes the process of installing Content Transformation Services using the Silent Installer.

3. Configure the Content Transformation Services server to at least one repository.

The standard configuration procedure is found at Configuring an instance of a ContentTransformation Services server, page 24.

4. After installing the Content Transformation Services server, you can verify that your installationis running correctly. Verifying Content Transformation Services installation, page 31 explainsthis procedure.

Installing Content Transformation Services DAR files

Install Content Transformation Services DAR files before configuring Content TransformationServices to obtain all the latest changes/enhancements. Install the DAR files in the global repositoryand in each repository where Content Transformation Services must be configured.

Install the following DAR files:• Rich Media Services

• Transformation

• Content Transformation Services Aspects

The DAR files can be installed from any machine with the latest version of Headless Composerand the DAR Installer plug-in on the local machine. Headless Composer is installed as part ofContent Server version 6.5 and later. Headless Composer can be found on the Content Server host atC:\Documentum\product\<version>\install\composer\ComposerHeadless.

Download and install the Headless Composer v7.2 before installing the Content TransformationServices DAR files. Headless Composer is available on the EMC download site as part ofDocumentum Developer Studio.

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

In Windows, disable User Account Control (UAC) and invoke the DAR installer using the Run asadministrator option.

20 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

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 the local machine. The

directory name must not contain any spaces.

2. Open the dfc.properties file at: ..\ComposerHeadless\plugins\com.emc.ide.external.dfc_1.00\documentum.config with a text editor.

3. Add the Document Foundation Classes and connection broker information, similar to thefollowing: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

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:• darinstallerconfiguration - 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:darinstallerworkspaces/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, see Table 3, page 22.

To install a DAR file with DAR Installer Plugin:DAR files are installed one at a time.

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 and searching for"Composer” to reach the Documentum Composer download site.

2. Extract the DAR Installer zip file to the root directory of the Composer or headless Composerinstallation directory.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 21

Installing Content Transformation Services products

3. Run dardeployer.exe to start the DAR Installer Plugin. The dardeployer.exeis located in the Composer root directory, or on the Content Server machine atC:\Documentum\product\<version>\install\composer\ComposerHeadless.

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 3. Description of DAR Installer Fields (Content Transformation Services DAR)

Parameter Required Description

DAR Yes The absolute file path to the .dar file that you want to install. Thefile path cannot contain any I18N characters or the installationwill fail.

Input File No The absolute file path to the install-based parameter file

Local Folder No The absolute file path to localized .properties files. If you want tomake your application available in other languages, you need tolocalize the project data such as labels, tabs, and descriptions.

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

ConnectionBroker Host

Yes The address of the Connection Broker

ConnectionBroker Port

Yes The port of the Connection Broker Repository

Repository Yes The name of the repository that you want to install the DAR fileto. Click on the Connect button after entering the Docbroker hostand port to retrieve the available repositories.

User Name Yes The login name for the repository

Password Yes The password for logging into the repository

Domain No The domain where the repository resides

Note: On a non-Windows Content Server machine, use the following command to install the DAR file:java -Ddar=<darflepath> -Dlogpath=./<filename.log> -Ddocbase=<docbase> -Duser=<username>-Ddomain= -cp $DM_HOME/install/composer/ComposerHeadless/startup.jarorg.eclipse.core.launcher.Main -data $DM_HOME/install/composer/workspace-application org.eclipse.ant.core.antRunner -buildfile $DM_HOME/install/composer/deploy.xml

22 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

Content Transformation Services product installationTo install Content Transformation Services server:1. Log in to the selected Content 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 extracted Content Transformation Server productinstallation files.

4. Double click the following file to install this version of the Content Transformation Servicesproduct.• adtsWinSetup.exe to install Advanced Document Transformation Services.

• mtsWinSetup.exe to install Media Transformation Services.

• avtsWinSetup.exe to install Audio Video Transformation Services.

Note: Perform the installation of the Content Transformation Services products consecutively, asrequired.

The installer splash screen is displayed, followed by theWelcome screen, which lists thecomponents being installed.

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

6. Select I accept the terms of the license agreement, and then click Next. The default destinationdirectory (C:\Documentum) for the installation of all components (CTS Framework, ContentTransformation Services, and DFC) appears on the screen.

7. Change the destination directory, if required, and then click Next. To accept the default, clickNext.

Note: Ensure that the selected destination directory does not contain a space in its name.

Document Foundation Classes is installed in the same location as Content TransformationServices.

8. Enter the hostname of the machine that will be running the Content Transformation Framework.Correct the host name if it is invalid or append the domain to create a Fully Qualified DomainName.Click Next.

9. Enter the port number to which the Content Transformation Services Administration Agent willbe configured. This port is used in conjunction with Documentum Administrator to communicatewith Content Transformation Services hosts. The default port number is 9095. Modify the defaultport number and click Next.

10. Enter the port number to which Content Transformation Services WebServices will be configured.The default port number is 9096.Click Next.

Note: The installer automatically stops the Content Transformation Service if it is alreadypresent on the host.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 23

Installing Content Transformation Services products

11. The Installation Summary screen appears, listing the applications that will be installed.• If you are satisfied with the installation confirmation, click Next.

• To change a component of the installation, click Previous to navigate back through theInstaller and change the install information.

12. The installation proceeds.

13. A message notifies you that the Content Transformation Server was installed successfully. ClickDone.The installation wizard closes.

Configuring an instance of a Content Transformation Servicesserver

To complete the Content Transformation Services installation, configure the instance to a repository.

Note: You can configure multiple Content Transformation Services instances to a repository.

Caution: All the instances deployed against a repository must share the same version (includingpatch version) to avoid behavior conflicts between versions.

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

To configure an instance of Content Transformation Server:1. Select the CTS Configuration Utility located at Start > Programs .

The Content Transformation Services Configuration Utility screen appears.

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

3. Select I accept the terms of the license agreement, and then click Next.

4. Enter the host name and port number of the Primary Connection Broker. The default portnumber is 1489.

Note: This screen appears only when you are configuring a Content Transformation Servicesproduct for the first time on a machine.

5. Select Use certificates. Click Browse to locate a valid dfc.keystore file. Enter the password forthe located dfc.keystore file.

Note: This step is optional and is performed only when you want to configure this ContentTransformation Services instance to a docbase that is projected with a secured docbroker(certificate-based). Alternatively, you can select Use Default Java TrustStore while configuringContent Transformation Services to a secured Content Server.

6. Enter the global repository name, login name, and its password and click Next.

Note: This screen appears only when you are configuring a Content Transformation Servicesproduct (or DFC) for the first time on a machine.

24 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

7. Select Add a Content Transformation Services instance to a repository, and click Next.

Note: If a Content Transformation Services product has already been configured in thisrepository, an additional option, Remove a Content Transformation Services instance froma repository appears along with the Add a Content Transformation Services instance to arepository option. If all the installed Content Transformation Services products have alreadybeen configured in this repository, only the Remove a Content Transformation Services instancefrom a repository appears on the screen.

8. The Configurator detects the name of the Content Transformation Server host. Correct the hostname if it is invalid or append the domain to create a Fully Qualified Domain Name.

9. Click Next.The Repository Name and User Information screen appears.

10. Enter information for the repository:

a. Select a repository to be served by the Content Transformation Server.

b. Enter the SuperUser name that Content Transformation Server will use to access therepository.

c. Enter the password for the SuperUser account.

d. Enter the domain name, if applicable. This is an optional field; if you are installing from alocal machine, this can be left blank.

e. Enter the name of the repository user who will receive notifications from ContentTransformation Server, otherwise known as the system operator.

f. Select the Add Additional Domain Users check box, if you are setting up to support requestsfrom additional domains. If you have multiple domain users in the Content Server thattransform content, select this option. The installer will create an Admin user for each domainto support transformations by users of each domain. Enter credentials for a new domainand its SuperUser in the required fields. Repeat this step to include additional domains, asrequired.

g. For performance metric reports to be generated, select Set as Performance Log Repository.

11. Click Next. If you cannot continue, check with the repository administrator to verify that theusers exist and that you entered the correct password.The CTS Configuration Program screen appears.

12. Select the Content Transformation Services products (ADTS, AVTS, MTS) that you must configureto the repository.

Note: Only those Content Transformation Services products that you have already installed arelisted in this screen.

If only one Content Transformation Services product is installed, then this screen does not appear.

13. Click Next. The User Authentication screen appears.

14. Enter the system administrator name and password. Click Next.The registry updates. The Configurator migrates all old profiles automatically, if applicable.

15. A dialog box indicates the success of the Content Transformation Server configuration.If you are prompted to restart the host, do so now.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 25

Installing Content Transformation Services products

Click Done. The Configurator closes.

Content Transformation Services products silentinstallation and configuration

Perform the following steps to install Content Transformation Services using the silent installer andthe silent configurator. The silent installer allows you to provide all installation, repository, and globalregistry information in a configuration file, after which you can run the installer and configuratorbatch files. The batch files run silently in the background while you complete other work.

Installing Content Transformation Services products using the ContentTransformation Services silent installer1. Log in to the selected Content Transformation Server host as an administrator.

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

3. Navigate to the folder containing the extracted Content Transformation Server productinstallation files. Downloading installers, page 15 provides information about where the filesshould be located.

4. Locate the cts_win_install.properties file.

5. Configure cts_win_install.properties with relevant values using a text editor:## silent install response fileINSTALLER_UI=silent####installation# Default installation location is "C:\\Documentum”CTS.INSTALLATION_DIR=<CTS_INSTALLATION_PATH># Ensure that you enter the hostname instead of the Fully Qualified Domain Name(FQDN)CTS.HOSTNAME=<CTS_HOST_NAME>CTS.ADMIN_PORT=<ADMIN_AGENT_PORT>#Default port is 9095CTS.JETTY_PORT=<JETTY_SERVER_PORT>#Default port is 9096INSTALL_FILES=false

6. Open the command prompt and navigate to the installer directory where thects_win_install.properties file is available.

7. Run the installer silently from the command prompt, using this command:<PRODUCT>WinSetup.exe -f cts_win_install.properties

For example, for MTS, the command ismtsWinSetup.exe -f cts_win_install.properties

8. Verify the installation logs created under the Logs folder in the installer directory.

9. Upon successful installation, navigate to %CTS_HOME%\server_install folder.This folder must contain the following files: cts_win_adding.properties andcts_win_config_removing.properties.

Note: The %CTS_HOME% directory refers to C:\Documentum\CTS unless changed during theinstallation process.

26 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

10. To configure Content Transformation Services to a docbase, update the cts_win_adding.properties file with the relevant values using a text editor# Please specify the config actions, "add" or "remove".CTS.INSTALL_TYPE=add# Ensure that you enter the hostname instead of the Fully Qualified Domain Name(FQDN)CTS.HOSTNAME=<CTS_HOST_NAME># Please specify the repository name to whichContent Transformation Services must be configuredCTS.DOCBASE=<REPO_NAME># Please specify the repository super user and passwordCTS.DOCBASE_SUPERUSER=<DOCBASE_SUPER_USERNAME>CTS.NOT_ENCRYPTED_PASSWORD=<DOCBASE_PASSWORD># Please specify the domain name (optional)CTS.DOMAIN=# Please specify the user that receives notifications fromContent Transformation ServicesCTS.DOCBASE_USER=<DOCBASE_USERNAME># Please set value to "true" if adding additional domain users,else set it to "false"CTS.ADDITIONAL_DOMAINS=false# Please set value to "true" if selecting this repository asLogging Performance repository, else set it to "false"CTS.IS_PERFORMANCE_LOG_REPO=false# Please specify the products that you want to configure ifyou have installed multiple products in same machine. Ifyou want to configure multiple products, use comma as the delimiter.# Configurator will add all the products, if the following field isempty. Else, specify the product names (comma separated) that youwant to configure.CTS.MODULE_NAMES=# Please specify the system administrator name and password# If the install user is part of a Domain, then the value of CTS.SYS_ADMIN_NAME should be<DOMAIN>\\<USER_NAME>CTS.SYS_ADMIN_NAME=<CTSHOST_ADMIN_NAME>CTS.SYS_ADMIN_PASS=<CTSHOST_ADMIN_PASSWORD>

# Please specify the global repository informationDFC.GLOBAL_REGISTRIES=<GLOBAL_REGISTRY_NAME># Provide Global Registry user name. By default the name is ‘dm_bof_registry’.DFC.GR_USERNAME=<GLOBAL_REGISTRY_USERNAME>DFC.DOCBROKER_HOST=<DOCBROKER_HOST_NAME># Provide Docbroker Port. By default the port is 1489.DFC.DOCBROKER_PORT=<DOCBROKER_PORT>DFC.SECURE.GR_PASSWORD=<GLOBAL_REGISTRY_PASSWORD># Please specify SSL certificate information. Set "USE_CERTIFICATES"to "true" if you want to enable SSL non-anonymous communicationUSE_CERTIFICATES=falseDFC_SSL_TRUSTSTORE=<ABSOLUTE_PATH_OF_DFC_KEYSTORE># For example, C:\\dfc.keystoreDFC_SSL_TRUSTSTORE_PASSWORD=<TRUSTSTORE_PASSWORD>#for e.g. passwordDFC_SSL_USE_EXISTING_TRUSTSTORE=false# Please specify the following information in case BOCS support is requiredCTS.BOCS_SELECTED=<dm_network_location_map object_name>CTS.ALLOW_BOCS_TRANSFER=<true | false>CTS.PREFER_ACS_TRANSFER=<true | false>CTS.ALLOW_SURROGATE_TRANSFER=<true | false>

CTS.DOMAIN_USER_LIST=# Please set value to "YES" if you want Content TransformationServices to process content in the distributed store component thatis local to the nearest Content Server, else set it to "NO".CTS.PROCESS_LOCAL_CONTENT_ONLY=##don't change below values

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 27

Installing Content Transformation Services products

INSTALLER_UI=silent

11. Run the installer silently from the command prompt, using this command:ctsConfigurator.exe -f cts_win_adding.properties

12. Verify the configuration logs created in the %CTS_HOME%\logs\configurator.log folder.

Post-installation tasksAfter installing Content Transformation Services, perform the following configurations, if required:• Enabling a Document Foundation Classes installation to access a global registry , page 28describes the process to configure the Document Foundation Classes installation to access aglobal registry, if you did not select a global registry during the installation, or if the passwordfor the global registry user has changed, or if you are updating the dfc.properties file with adifferent global registry than initially configured.

• Configuring Content Transformation Server for another repository, page 29 describes the processto add more than one Content Transformation Server configurations to your system.

• Enhancing memory availability for Content Transformation Services, page 29 describes theprocess to increase the memory availability of Content Transformation Services.

• describes the process to configure Content Transformation Services to handle real-time andasynchronous requests

Enabling a Document Foundation Classes installationto access a global registry

The dfc.properties file contains properties that relate to accessing the global registry.

To enable a Document Foundation Classes installation to access a global registryrepository:1. On the Document Foundation Classes host, navigate to DOCUMENTUM/config.

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.

Note: Before executing this command, either ensure that the classpath contains dfc.jaror execute the command from a location where dfc.jar is present (for example,C:\Documentum\Shared).

3. Open the dfc.properties file in a text editor.

4. Modify the following attributes:dfc.bof.registry.repository=<global_registry_repository_name>dfc.bof.registry.username=<user_login_name>

28 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing Content Transformation Services products

dfc.bof.registry.password=<encryped_password_of_user>

where encryped_password_of_user is the encrypted password you generated in step 2 above.

5. Save the dfc.properties file.

Configuring Content Transformation Server for anotherrepository

Run one installation of Content Transformation Services on a single host, and configure it againstmultiple repositories.

The procedure for adding an instance of Content Transformation Services is exactly the same as theprocedure for the initial configuration of the product for a repository. This procedure does notperform the base installation or install configuration files, which must be done only once. You donot need to rerun the entire installation procedure to apply Content Transformation Services to anadditional repository.

See Configuring an instance of a Content Transformation Services server, page 24 for the procedure toconfigure your product for another repository.

Enhancing memory availability for ContentTransformation Services

The Content Transformation Services memory can be scaled up to increase performance or to allowprocessing of large files (> 1 GB). The default memory required for Content Transformation Servicesis 4 GB, but the memory needs to be increased for the transformation of large files. For every 1GB RAM added to a minimum 6 GB system RAM, the Content Transformation Services memorycan be increased as follows:

1. Log in to the Content Transformation Server host as an administrator user.

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

3. Stop Content Transformation Services.

4. Open the Windows registry: Windows->Run->regedit.

5. Navigate to [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\DocumentumCTS\Parameters]. Modify thevalue of AppParameters.

6. Increase the -Xmx4096m value by adding 1024 to 4096 for every 1 GB extra RAM added. Forexample, for 2 GB extra RAM added, add 2048 to 4096. Hence, the new value is -Xmx6144m.

7. Close the registry.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 29

Installing Content Transformation Services products

8. Restart Content Transformation Services through the Windows Services Utility.

30 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 3Verifying Content TransformationServices Installation

This chapter explains how to verify an installation of Content Transformation Services.

Verifying Content Transformation ServicesinstallationThis section describes how to verify that you have successfully installed Content TransformationServices. There are two ways to verify the installation:

• Verify if the following Windows services have been started using services.msc:— Documentum Content Transformation Services

— Documentum Content Transformation Monitor Services

— Documentum CTS Admin Agent

• Import a test file to the repository.

Both tests are recommended. This will ensure your installation is working correctly.

Verifying startup of Content Transformation Servicesservice

Once Content Transformation Server is installed and configured for a repository, ContentTransformation Services should start automatically.

To verify startup of Content Transformation Services:1. Log in to the Content 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.

4. Navigate to the C:\Documentum\CTS\logs folder and open the CTS_log.txt file. Ensure thatthere are no errors or exceptions in the log file. At the end of the log file, a message that reads

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 31

Verifying Content Transformation Services Installation

"Product <CTS product> version <version number> is installed on repository: <repository name>”must appear.

32 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 4Unconfiguring and UninstallingContent Transformation Services

To install Content Transformation Services, uninstall previous versions of Content TransformationServices components. If you are installing Content Transformation Services the first time, skip toChapter 2, Installing Content Transformation Services products.

Uninstalling Content Transformation ServicesThis section provides information to uninstall Content Transformation Services. Uninstallation ofContent Transformation Services can be performed in the following ways:• Manual unconfiguration and uninstallation, page 33

• Silent unconfiguration, page 35

Manual unconfiguration and uninstallation

The following steps comprise the manual uninstallation process for Content Transformation Services:1. Removing a Content Transformation Services instance from a repository, page 33

2. Uninstalling Content Transformation Services products, page 34

Removing a Content Transformation Services instance from arepository

This section describes how to remove an instance of Content Transformation Services from arepository. This procedure does not remove the configuration files and services associated with theContent Transformation Server. describes the process to remove Content Transformation Serverfrom a host.

To remove an instance of Content Transformation Services from a repository:1. Navigate to Content Transformation Services Configurator under Start > Programs > CTS

Configuration Utility.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 33

Unconfiguring and Uninstalling Content Transformation Services

Note:The Content Transformation Services Configurator splash screen is displayed, followed bytheWelcome screen.

2. Click Next.The License Agreement Terms are displayed.

3. Accept the terms of the license agreement, and click Next.

4. Select Remove a Content Transformation Services instance from a repository and click Next.

5. Select the repository from which you want to remove the Content Transformation Server.Enter the SuperUser name, the SuperUser password, and the Domain if any.

6. Click Next. The CTS Configuration Program screen appears.

7. Select the Content Transformation Services products (ADTS, AVTS, MTS) that must be removedfrom the repository.

Note: This screen does not appear if only one Content Transformation Services product isconfigured to the repository.

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. ClickDone in the dialog box indicating the success of the Content Transformation Server removal.This instance of Content Transformation Server is now removed from the repository.

Uninstalling Content Transformation Services products

This section describes steps to uninstall the previous and current version of Content TransformationServices products.

All instances of Content Transformation Services deployed against a repository must share the sameversion (including patch version) to avoid behavior conflicts between versions. Therefore, before youinstall a new version of Content Transformation Services, you must uninstall any previous version ofContent Transformation Services or Content Transformation Services products.

1. On the host machine, select Start > Settings > Control Panel and double-click Add/RemovePrograms.

2. Select Content Transformation Services, and then click Change/Remove.

3. In the Change/Remove dialog box, click Next.The Uninstall Content Transformation Services screen is displayed.

4. Click Next. The CTS Uninstall Program screen appears.

5. Select the Content Transformation Services products (ADTS, AVTS, MTS) that must beuninstalled. Click Next.

6. If you need to uninstall DFC, select Uninstall DFC and clickNext. A dialog box indicates that theselected Content Transformation Services product is uninstalled.

34 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Unconfiguring and Uninstalling Content Transformation Services

7. Restart the Content Transformation Services server.

Silent unconfiguration

Run the silent unconfiguration utilities to remove Content Transformation Services from the server.

Removing Content Transformation Services repositoryconfiguration settings in the silent mode

Perform the following procedure if you want to remove Content Transformation Services using thesilent configurator. The silent unconfigurator allows you to provide installation, repository, andglobal registry information in a configuration file, after which you can run the configurator batchfiles. The batch files run silently in the background.

1. Login to the selected Content Transformation Server host as an Administrator user.

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

3. Update the cts_win_config_removing.properties file with relevant values using a texteditor::CTS.INSTALL_TYPE=remove# Ensure that you enter the hostname instead of the Fully Qualified Domain Name(FQDN)CTS.HOSTNAME=<CTS_HOST_NAME># Please specify the repository nameCTS.DOCBASE=<DOCBASE_FROM_WHICH_CTS_TOBE_UNCONFIGURED># Please specify the repository super user and passwordCTS.DOCBASE_SUPERUSER=<DOCBASE_SUPER_USER>CTS.NOT_ENCRYPTED_PASSWORD=<DOCBASE_PASSWORD># Please specify the domain name (optional)CTS.DOMAIN=# Please specify the products that you want to remove if you install multipleproducts in the same machine. If you want to remove multiple products, use commaas the delimiter.# Config will remove all products, if this one remain empty.CTS.MODULE_NAMES=

##don't change below valuesINSTALLER_UI=silent

4. Open the command prompt and navigate to the to %CTS_HOME%\server_install directorywhere the cts_win_config_removing.properties file present. Run the installer silentlyfrom that command prompt using the following command:ctsConfigurator.exe -f cts_win_removing.properties

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 35

Unconfiguring and Uninstalling Content Transformation Services

Note: Silent uninstallation support is not available. Manual unconfiguration and uninstallation, page33 provides detailed information for uninstallation and unconfiguration.

36 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 5Upgrading Content TransformationServices

When you upgrade Content Transformation Services to a new version, it migrates all the profiles byversioning them. Hence, if you make changes to the OOTB profiles or command line files, ensurethat you manually verify and reapply the changes to the profiles or command line files of the newversion. In addition, all custom profiles and command line files must be manually verified against thecurrent Content Transformation Services version for compatibility.

Note: Ensure that you process or clear all the queue items before upgrading to ContentTransformation Services 7.0 or later. This is because the existing queue contains a reference tothe profile_id of the pre-7.0 profile. Upgrading to the 7.0 release or later changes the profile andr_object_id. Hence, the profile_id of the existing queue items becomes invalid.

Upgrading Content Transformation ServicesThis section provides information to upgrade Content Transformation Services from previousversions.

1. Unconfigure the previous version of Content Transformation Services from the docbase. Referto the Installation Guide of that specific version of the Content Transformation Services forthe procedure.

2. Uninstall Content Transformation Services. Refer to the Installation Guide of that specific versionof the Content Transformation Services for the procedure.

3. Back up and remove the old profiles from the repository. Backing up and removing old profiles,page 37 provides the detailed procedure.

4. Install and configure Content Transformation Services 7.2 products. Chapter 2, Installing ContentTransformation Services products provides the detailed information.

Backing up and removing old profilesDue to the difference in the plug-ins used in the older versions of Content Transformation Servicesproducts and the current version of the Content Transformation Services product, the Migration

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 37

Upgrading Content Transformation Services

utility (run as a part of the Installer-Configurator) overwrites most of the OOTB profiles and removesa few OOTB profiles from older versions of Content Transformation Services.

The following is the behavior of the Content Transformation Services 7.2 Migration utility:• The Migration utility backs up the repository profiles in the location specified in the<BackUpFolder> tag of the script.xml located in the <CTS_HOME>\migration\config folder.The default location of the Backup folder is: C:\Documentum\CTS\migration\backup.

• If the current version of Content Transformation Services has a profile with the same name asan existing profile in the repository, then the repository profile is re-versioned to overwrite it.The keyword "7.2.0000” is added to the new versioned profile to indicate that the profile wasversioned by the Migration utility.

• Some of the OOTB profiles are removed. For example, any existing OOTB XML TransformationServices profiles and profiles that have been renamed or removed in the 7.2 version.

• If there is a new profile added in the 7.2 version, which did not exist in earlier versions of XMLTransformation Services, those profiles are created afresh in the repository.

• Custom profiles are not effected by the Migration utility. These custom profiles may throw errorsduring Content Transformation Services startup after migration. You must modify these profilesmanually to make them compatible with the current version of the Content TransformationServices product.

If you have customized any OOTB profiles or added any profiles on a repository that were previouslyconfigured with Content Transformation Services, it is strongly recommended that all these profilesbe backed up manually, prior to installing this version of Content Transformation Services. Export acopy of all profiles to the local disk before making any changes to your product installations.

It is also recommended, but not mandatory, to remove old OOTB profiles from the repositorybefore installing this version of Content Transformation Services. This ensures that only the currentprofiles included with this version of Content Transformation Services are contained within theMedia Server folder.

To back up and remove profiles from a previous installation:1. On the repository where Content Transformation Services is configured, navigate to

/System/Media Server.

2. Back up any customized profiles from the previous version by exporting the contents of theMedia Server folder to a local disk.

3. Delete the contents of theMedia Server folder (including all versions and descendents).

Viewing log file of migrated profiles

During configuration of Content Transformation Services, the Migration utility is run on theexisting profiles. You can view the log file generated by the profile migration tool. This log fileshows the profiles that were processed, the status, and profiles that were not migrated, alongwith the reason for not being migrated. The default location of the log file of migrated profiles is:C:\Documentum\CTS\migration\log.

The migration log file shows the result of the migration process:

38 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Upgrading Content Transformation Services

migration_log_2007_292_1192813617312.txt

The migration report log shows a complete list of all profiles before they are upgraded:migration_report_2007_292_1192813563921.txt

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 39

Upgrading Content Transformation Services

40 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 6Deploying Content TransformationServices WebServices

Content Transformation Services WebServices is based on Documentum Foundation Servicesplatform. It provides synchronous realtime transformation capabilities. Any client application basedon Content Transformation Services WebServices may request transformations that result in files thatare available directly to the client, with minimal turn around time.

Content Transformation Services WebServices is deployed using an EAR or WAR.

Note: Always ensure that the version of Content Transformation Services WebServices is the same asthat of the Content Transformation Services core product, even when they are installed on separatehosts.

The following topics are covered in this chapter:• Deploying CTS WebServices on Windows JBoss, page 41

• Deploying Content Transformation Services WebServices on VMware vFabric tc Server, page 44

• Deploying Content Transformation Services WebServices on Oracle Weblogic, page 47

• Deploying Content Transformation Services WebServices on Apache Tomcat, page 51

• Deploying Content Transformation Web Services on IBM Websphere, page 54

Deploying CTS WebServices on WindowsJBossCTS WebServices is deployed using a transformation.ear file. Use the following procedure to deployand configure the transformation.ear for JBoss application server.

To deploy CTS WebServices on Windows with JBoss:1. Install JBoss. The EMC Documentum Environment and System Requirements Guide document

contains information about the supported version.

2. Create a folder with name "cts_ws” at your working directory (Consider C:\Documentum asworking directory)

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 41

Deploying Content Transformation Services WebServices

a. Create the following subfolders inside cts_ws folder.• \cache

• \config

• \logs

b. Create a sub-folder "pfile” within the config folder (\config\pfile).

3. Open a text editor and create a preferences.xml file with the following content and save it inthe directory %WorkingDir%\cts_ws\config.

Note: This file should contain relevant values for your repository name, domain name (ifapplicable), user name, and so on.<?xml version="1.0" encoding="UTF-8" ?><ServiceConfiguration ID="CTS Web Services"><PropertyList><ServerProperty Key="Cache" Description="The Temporary Cache Directory"

Value="C:\Documentum\cts_ws\cache" /><ServerProperty Key="AllowDirectTransfer" Description="Allow Direct File

Transfer From CTS Server to Client. Set it to false if there is a firewallrestriction" Value="true" />

<ServerProperty Key="CTSWSPingInterval" Description="Interval (in seconds)used to specify how frequent the LB should ping its CTS instances for heartrate." Value="180" />

<ServerProperty Key="FailoverRetries" Description="Allow a number ofretries if a request fails while waiting on the HTTP response from CTS"Value="1" />

<ServerProperty Key="InstanceSelector" Description="Specify animplementation class for instance selection"Value="com.emc.documentum.cts.lb.workers.DefaultSelector" /><Repositories><AekFilePath>C:\Documentum\cts_ws\config\aek.key</AekFilePath><LoginContext DocbaseName="<docbase_name_here>"><ServerProperty Key="domain" Value="<domain_name_here>" /><ServerProperty Key="userName" Value="<user_name_here>" /><ServerProperty Key="passwordFile"

Value="C:\Documentum\cts_ws\config\pfile\mspassword.txt" /><ServerProperty Key="maxConnectionRetries" Value="10" />

</LoginContext></Repositories></PropertyList></ServiceConfiguration>

4. Copy the aek.key file from the CTS Server machine (located at C:\ProgramFiles\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config on the CTSWebServices/JBoss host.

5. Copy the mspassword.txt from the CTS Server machine (located at C:\ProgramFiles\Documentum\CTS\docbases\<docbase_name>\config\pfile) and paste it toC:\Documentum\cts_ws\config\pfile on the CTS WebServices/JBoss host.

6. Explode the contents of the transformation.ear file to a folder named "transformation.ear”.

7. Copy and paste the exploded transformation.ear folder to the "deployments” folder of a JBossserver configuration. For example, C:\<JBoss version folder>\standalone\deployments andcreate the transformation.ear.dodeploy file in the deployments folder.

Note: There will be multiple configurations available with JBoss. For example, default, minimal,and all.

42 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

a. Update the dfc.properties file under APP-INF\classes in the transformation.ear tocorrect details for docbroker, global registry details, and so on. (located at C:\<JBoss versionfolder>\standalone\deployments\transformation.ear\APP-INF\classes).It will typically appear like the following:dfc.data.checkout_dir=${dfc.data.user_dir}/checkoutdfc.data.dir=C:\Documentum\datadfc.data.export_dir=${dfc.data.user_dir}/exportdfc.data.user_dir=${dfc.data.dir}dfc.exception.include_decoration=falsedfc.exception.include_id=falsedfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==dfc.globalregistry.repository=CSFPI33_GRdfc.globalregistry.username=dm_bof_registrydfc.search.ecis.enable=falsedfc.search.ecis.host=dfc.search.ecis.port=dfc.tokenstorage.dir=${dfc.data.user_dir}/apptokendfc.tokenstorage.enable=falsedfc.docbroker.host[0]=10.31.107.145dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under APP-INF\classes to point the right location forall log files. Properties which should be modified are given in bold.log4j.rootCategory=WARN, A1, F1log4j.category.MUTE=OFFlog4j.additivity.tracing=falselog4j.category.tracing=DEBUG, FILE_TRACE#------------------- CONSOLE --------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.threshold=ERRORlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE}%5p [%t] %-20c{1} - %m%n#------------------- FILE --------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppenderlog4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.loglog4j.appender.F1.MaxFileSize=10MBlog4j.appender.F1.layout=org.apache.log4j.PatternLayoutlog4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE}%5p [%t] %-20c{1}- %m%n#------------------- FILE_TRACE --------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppenderlog4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.loglog4j.appender.FILE_TRACE.MaxFileSize=100MBlog4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE}[%t] %-20c{1}- %m%n#------------------- CTSWS --------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppenderlog4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppenderlog4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txtlog4j.appender.CTSWSAppender.Append=truelog4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 43

Deploying Content Transformation Services WebServices

%-20c{1} %m%nlog4j.appender.CTSWSAppender.DatePattern='.'yyyy-MM-dd#------------------- DFS --------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppenderlog4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txtlog4j.appender.DFSAppender.Append=truelog4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p[%t] %-20c{1} - %5x %m%nlog4j.appender.DFSAppender.DatePattern='.'yyyy-MM-dd

8. Copy the file transformation.properties from APP-INF\classes and paste it in the JBossServer’s bin directory. For example, C:\<JBoss version folder>\bin. (This path may be different ifJBoss is installed to a different location.)

9. Update the transformation.properties file to have the correct path to the preferences.xml file.It will typically appear like the following:#cts ws preferences config locationCTSWSConfig=C:/Documentum/cts_ws/config/preferences.xml

10. Start the JBoss server using standalone.bat available in C:\<JBoss version folder>\bin.

11. Ensure the TransformationService & ProfileService are accessible from the JBoss host and theclient machine using the following URLs.• JBoss machine (runs on port 8080 by default):

http://localhost:<port>/services/transformation/TransformationService

http://localhost:<port>/services/transformation/ProfileService

• Remote client machine:

http://<JBoss machine host/ip>:<port>/services/transformation/TransformationService

http://<JBoss machine host/ip>:<port>/services/transformation/ProfileService

12. Send real-time transformation requests using the above service URL.

13. Check the logs located in the C:\Documentum\cts-ws\logs folder for the complete status ofthe CTSWebServices server.

Deploying Content Transformation ServicesWebServices on VMware vFabric tc ServerContent Transformation Services WebServices is deployed using a transformation.war file. Use thefollowing procedure to deploy and configure the transformation.war for tcServer.

1. Install the tcServer on a host. The EMC Documentum Environment and System Requirements Guidedocument contains information about the supported version.

Note: The following procedure is specific to Windows. If the tcServer is running on anon-Windows machine, update to the non-Windows specific path, wherever applicable.

44 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

2. Create a server instance according to the tcServer guidelines. For example, the server instancename is "myserver”.

3. Stop the application server instance if it is already running.

4. Create a folder with the name "cts_ws” at your working directory (Consider C:\Documentumas your working directory).

a. Create the following subfolders inside cts_ws folder.• \cache

• \config

• \logs

b. Create a sub-folder "pfile” within the config folder (\config\pfile).

5. Open a text editor and create a preferences.xml file with the following content and save it inthe directory %WorkingDir%\cts_ws\config.

6. This file should contain relevant values for your repository name, domain name (if applicable),user name, and so on.<?xml version="1.0" encoding="UTF-8" ?><ServiceConfiguration ID="CTS Web Services"><PropertyList><ServerProperty Key="Cache" Description="The Temporary Cache Directory"

Value="C:\Documentum\cts_ws\cache" /><ServerProperty Key="AllowDirectTransfer" Description="Allow Direct File

Transfer From CTS Server to Client. Set it to false if there is a firewallrestriction" Value="true" /><ServerProperty Key="CTSWSPingInterval" Description="Interval (in seconds)

used to specify how frequent the LB should ping its CTS instances for heartrate." Value="180" /><ServerProperty Key="FailoverRetries" Description="Allow a number of retries

if a request fails while waiting on the HTTP response from CTS" Value="1" /><ServerProperty Key="InstanceSelector" Description="Specify an implementation

class for instance selection"Value="com.emc.documentum.cts.lb.workers.DefaultSelector" /><Repositories><AekFilePath>C:\Documentum\cts_ws\config\aek.key</AekFilePath><LoginContext DocbaseName="<docbase_name_here>"><ServerProperty Key="domain" Value="<domain_name_here>" /><ServerProperty Key="userName" Value="<user_name_here>" /><ServerProperty Key="passwordFile"

Value="C:\Documentum\cts_ws\config\pfile\mspassword.txt" /><ServerProperty Key="maxConnectionRetries" Value="10" />

</LoginContext></Repositories></PropertyList></ServiceConfiguration>

7. Copy the aek.key file from the Content Transformation Services Server machine (located atC:\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config on the ContentTransformation Services WebServices/tcServer host.

8. Copy the mspassword.txt from the Content Transformation Services Server machine(located at C:\Documentum\CTS\docbases\<docbase_name>\config\pfile) and pasteit to C:\Documentum\cts_ws\config\pfile on the Content Transformation ServicesWebServices/tcServer host.

9. Explode the contents of the transformation.war file to a folder named "transformation”.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 45

Deploying Content Transformation Services WebServices

10. Copy and paste the exploded transformation folder to the "webapps” folder of a tc Serverinstance. For example, C:\tcserver_directory\myserver\webapps.

a. Update the dfc.properties file under WEB-INF\classes to correct details fordocbroker (Connection Broker), global registry details, and so on. This file is located atC:\tcserver_directory\myserver\webapps \transformation\WEB-INF\classes).It will typically appear like the following:dfc.data.checkout_dir=${dfc.data.user_dir}/checkoutdfc.data.dir=C:\Documentum\datadfc.data.export_dir=${dfc.data.user_dir}/exportdfc.data.user_dir=${dfc.data.dir}dfc.exception.include_decoration=falsedfc.exception.include_id=falsedfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==dfc.globalregistry.repository=CSFPI33_GRdfc.globalregistry.username=dm_bof_registrydfc.search.ecis.enable=falsedfc.search.ecis.host=dfc.search.ecis.port=dfc.tokenstorage.dir=${dfc.data.user_dir}/apptokendfc.tokenstorage.enable=falsedfc.docbroker.host[0]=10.31.107.145dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under WEB-INF\classes to point to the right locationfor all log files. Properties which should be modified are given in bold.log4j.rootCategory=WARN, A1, F1log4j.category.MUTE=OFFlog4j.additivity.tracing=falselog4j.category.tracing=DEBUG, FILE_TRACE#---------------------------- CONSOLE ----------------------------106 EMC Documentum Content Transformation Services Version 7.2 Installation GuideDeploying CTS WebServiceslog4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.threshold=ERRORlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n#---------------------------- FILE ----------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppenderlog4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.loglog4j.appender.F1.MaxFileSize=10MBlog4j.appender.F1.layout=org.apache.log4j.PatternLayoutlog4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n#---------------------------- FILE_TRACE ----------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppenderlog4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.loglog4j.appender.FILE_TRACE.MaxFileSize=100MBlog4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %20c{1} %m%n#---------------------------- CTSWS ----------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppenderlog4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppenderlog4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txtlog4j.appender.CTSWSAppender.Append=truelog4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p %20c{1} %m%nlog4j.appender.CTSWSAppender.DatePattern='.'yyyyMMdd#---------------------------- DFS ----------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppender

46 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

log4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txtlog4j.appender.DFSAppender.Append=truelog4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]%20c{1} %5x %m%nlog4j.appender.DFSAppender.DatePattern='.'yyyyMMdd

11. Update the transformation.properties file in WEB-INF\classes to have the correct path tothe preferences.xml file.It will typically appear like the following:#cts ws preferences config locationCTSWSConfig=C:/Documentum/cts_ws/config/preferences.xml

12. Start the tcServer instance.

13. Ensure that TransformationService and ProfileService are accessible from the tcServer host anda client machine using the following URLs.• tcServer machine (runs on port 8080 by default):

http://localhost:<port>/transformation/services/transformation/TransformationService

http://localhost:<port>/transformation/services/transformation/ProfileService

• Remote client machine:

http://< tcServer host/ip>:<port>/transformation/services/transformation/TransformationService

http://< tcServer host/ip>:<port>/transformation/services/transformation/ProfileService

14. Send real-time transformation requests using the above service URL.

15. Check the logs located in the C:\Documentum\cts-ws\logs folder for the complete status of theContent Transformation Services WebServices server.

Deploying Content Transformation ServicesWebServices on Oracle WeblogicContent Transformation Services WebServices is deployed using a transformation.ear file. Usethe following procedure to deploy and configure the transformation.ear for a Oracle Weblogicapplication server.

To deploy Content Transformation Services WebServices on Windows with OracleWeblogic:1. Install the Oracle Weblogic Server. The EMC Documentum Environment and System Requirements

Guide document contains information about the supported version.

Note: The following procedure is specific to Windows. If Weblogic is running on a non-Windowsmachine, update to the non-Windows specific path, wherever applicable.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 47

Deploying Content Transformation Services WebServices

2. After the domain creation is complete, all files related to the domain (for example, "ws”) areavailable under C:\Oracle\Middleware\user_projects\domains\ws (if WebLogic is installedin C:\Oracle).

3. Create a folder with name "cts_ws” at your working directory (Consider C:\Documentum asworking directory)

a. Create the following subfolders inside cts_ws folder.• \cache

• \config

• \logs

b. Create a sub-folder "pfile” within the config folder (\config\pfile).

4. Open a text editor and create a preferences.xml file with the following content and save it inthe directory %WorkingDir%\cts_ws\config.

Note: This file should contain relevant values for your repository name, domain name (ifapplicable), user name, and so on.<?xml version="1.0" encoding="UTF-8" ?><ServiceConfiguration ID="CTS Web Services"><PropertyList><ServerProperty Key="Cache" Description="The Temporary Cache Directory"

Value="C:\Documentum\cts_ws\cache" /><ServerProperty Key="AllowDirectTransfer" Description="Allow Direct File

Transfer From CTS Server to Client. Set it to false if there is a firewallrestriction" Value="true" /><ServerProperty Key="CTSWSPingInterval" Description="Interval (in seconds)

used to specify how frequent the LB should ping its CTS instances for heartrate." Value="180" /><ServerProperty Key="FailoverRetries" Description="Allow a number of retries

if a request fails while waiting on the HTTP response from CTS" Value="1" /><ServerProperty Key="InstanceSelector" Description="Specify an implementation

class for instance selection"Value="com.emc.documentum.cts.lb.workers.DefaultSelector" /><Repositories><AekFilePath>C:\Documentum\cts_ws\config\aek.key</AekFilePath><LoginContext DocbaseName="<docbase_name_here>"><ServerProperty Key="domain" Value="<domain_name_here>" /><ServerProperty Key="userName" Value="<user_name_here>" /><ServerProperty Key="passwordFile"

Value="C:\Documentum\cts_ws\config\pfile\mspassword.txt" /><ServerProperty Key="maxConnectionRetries" Value="10" />

</LoginContext></Repositories></PropertyList></ServiceConfiguration>

5. Copy the aek.key file from the Content Transformation Services Server machine (located atC:\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config on the ContentTransformation Services WebServices/WebLogic host.

6. Copy the mspassword.txt file from the Content Transformation Services Server machine(located at C:\Documentum\CTS\docbases\<docbase_name>\config\pfile) and pasteit to C:\Documentum\cts_ws\config\pfile on the Content Transformation ServicesWebServices/WebLogic host.

7. Update or repackage the transformation.ear file with following changes:

48 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

a. Update the dfc.properties file under APP-INF\classes. Enter your docbroker, globalregistry details, user name, and password.It will typically appear like the following:dfc.data.checkout_dir=${dfc.data.user_dir}/checkoutdfc.data.dir=C:\Documentum\datadfc.data.export_dir=${dfc.data.user_dir}/exportdfc.data.user_dir=${dfc.data.dir}dfc.exception.include_decoration=falsedfc.exception.include_id=falsedfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==dfc.globalregistry.repository=CSFPI33_GRdfc.globalregistry.username=dm_bof_registrydfc.search.ecis.enable=falsedfc.search.ecis.host=dfc.search.ecis.port=dfc.tokenstorage.dir=${dfc.data.user_dir}/apptokendfc.tokenstorage.enable=falsedfc.docbroker.host[0]=10.31.107.145dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under APP-INF\classes to point the right location forall log files. Properties which should be modified are given in bold.log4j.rootCategory=WARN, A1, F1log4j.category.MUTE=OFFlog4j.additivity.tracing=falselog4j.category.tracing=DEBUG, FILE_TRACE#------------------- CONSOLE --------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.threshold=ERRORlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %-20c{1} - %m%n#------------------- FILE --------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppenderlog4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.loglog4j.appender.F1.MaxFileSize=10MBlog4j.appender.F1.layout=org.apache.log4j.PatternLayoutlog4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %-20c{1} - %m%n#------------------- FILE_TRACE --------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppenderlog4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.loglog4j.appender.FILE_TRACE.MaxFileSize=100MBlog4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %-20c{1}- %m%n#------------------- CTSWS --------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppenderlog4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppenderlog4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txtlog4j.appender.CTSWSAppender.Append=truelog4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p%-20c{1} %m%nlog4j.appender.CTSWSAppender.DatePattern='.'yyyy-MM-dd#------------------- DFS --------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppenderlog4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txtlog4j.appender.DFSAppender.Append=truelog4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]%-20c{1} - %5x %m%n

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 49

Deploying Content Transformation Services WebServices

log4j.appender.DFSAppender.DatePattern='.'yyyy-MM-dd

8. Update this transformation.properties from the transformation.ear (available underAPP-INF\classes) file to have the correct preferences.xml location for CTSWSConfig property.After updating, copy transformation.properties to the Weblogic domain root directory(for example, C:\Oracle\Middleware\user_projects\domains\ws).#cts ws preferences config locationCTSWSConfig=C:/Documentum/cts_ws/config/preferences.xml

9. Deploy the transformation.ear using one of the methods below:

a. Copy and paste the updated transformation.ear to the "autodeploy” folder located inC:\Oracle\Middleware\user_projects\domains\ws.OR

b. Perform the following steps to deploy the transformation.ear using the WebLogic adminconsole:• Login to WebLogic Admin console using URL: http://localhost:7001/console.

• Click the Deployments node from the Domain Structure tree.

• Click Install.

• Navigate to the location where transformation.ear is available and click Next.

• Select Install this deployment as an application and click Next.

• Ensure that the name is fetched as "transformation” and click Finish.

• The application will be in "prepared” state. Select "transformation” and select Servicingall requests from the Start menu.

• Ensure the state of the transformation application is "Active”.

10. Start "startWebLogic.cmd” from the domain "ws” (C:\Oracledirectory). This will automaticallydeploy the transformation.ear file.

11. Ensure that the TransformationService and ProfileService are accessible from the WebLogic hostand the client machine using the following URLs.• WebLogic machine (runs on port 7001 by default):

http://localhost:<port>/services/transformation/TransformationService

http://localhost:<port>/services/transformation/ProfileService

• Remote client machine:

http://<WebLogic_host/ip>:<port>/services/transformation/TransformationService

http://<WebLogic_host/ip>:<port>/services/transformation/ProfileService

12. Send real-time transformation requests using the above Service URL.

13. Check the logs located in the C:\Documentum\cts-ws\logs folder for the complete status of theContent Transformation Services WebServices server.

50 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

Deploying Content Transformation ServicesWebServices on Apache TomcatContent Transformation Services WebServices is deployed using a transformation.war file. Usethe following procedure to deploy and configure the transformation.war for a Apache Tomcatapplication server.

To deploy Content Transformation Services WebServices on Windows with Tomcat:1. Install Tomcat on a host. The EMC Documentum Environment and System Requirements Guide

document contains information about the supported version.

Note: The following procedure is specific to Windows. If the Tomcat is running on anon-Windows machine, update to the non-Windows specific path, wherever applicable.

2. Stop the Tomcat server.

3. Create a folder with the name "cts_ws” at your working directory (Consider C:\Documentumas your working directory).

a. Create the following subfolders inside cts_ws folder:• \cache

• \config

• \logs

b. Create a sub-folder "pfile” within the config folder (\config\pfile).

4. Open a text editor and create a preferences.xml file with the following content and save it inthe directory %WorkingDir%\cts_ws\config.

Note: This file should contain relevant values for your repository name, domain name (ifapplicable), user name, and so on.<?xml version="1.0" encoding="UTF-8" ?><ServiceConfiguration ID="CTS Web Services"><PropertyList><ServerProperty Key="Cache" Description="The Temporary Cache Directory"

Value="C:\Documentum\cts_ws\cache" /><ServerProperty Key="AllowDirectTransfer" Description="Allow Direct File

Transfer from CTS Server to Client. Set it to false if there is a firewallrestriction" Value="true" />

<ServerProperty Key="CTSWSPingInterval" Description="Interval (in seconds)used to specify how frequent the LB should ping its CTS instances for heart rate."Value="180" />

<ServerProperty Key="FailoverRetries" Description="Allow a number of retriesif a request fails while waiting on the HTTP response from CTS" Value="1" />

<ServerProperty Key="InstanceSelector" Description="Specify an implementationclass for instance selection" Value="com.emc.documentum.cts.lb.workers.DefaultSelector" />

<Repositories><AekFilePath>C:\Documentum\cts_ws\config\aek.key</AekFilePath><LoginContext DocbaseName="<docbase_name_here>"><ServerProperty Key="domain" Value="<domain_name_here>" /><ServerProperty Key="userName" Value="<user_name_here>" /><ServerProperty Key="passwordFile" Value="C:\Documentum\cts_ws\cache

pfile\mspassword.txt" /><ServerProperty Key="maxConnectionRetries" Value="10" />

</LoginContext>

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 51

Deploying Content Transformation Services WebServices

</Repositories></PropertyList>

</ServiceConfiguration>

5. Copy the aek.key file from the Content Transformation Services Server machine (located atC:\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config on the ContentTransformation Services WebServices/Tomcat host.

6. Copy the mspassword.txt from the Content Transformation Services Server machine(located at C:\Documentum\CTS\docbases\<docbase_name>\config\pfile) and pasteit to C:\Documentum\cts_ws\config\pfile on the Content Transformation ServicesWebServices/Tomcat host.

7. Explode the contents of the transformation.war file to a folder named "transformation”.

8. Copy and paste the exploded transformation folder to the "webapps” folder of a Tomcat serverconfiguration.

a. Update the dfc.properties file under WEB-INF\classes to correct details for docbroker(Connection Broker), global registry details, and so on.It will typically appear like the following:dfc.data.checkout_dir=${dfc.data.user_dir}/checkoutdfc.data.dir=C:\Documentum\datadfc.data.export_dir=${dfc.data.user_dir}/exportdfc.data.user_dir=${dfc.data.dir}dfc.exception.include_decoration=falsedfc.exception.include_id=falsedfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==dfc.globalregistry.repository=CSFPI33_GRdfc.globalregistry.username=dm_bof_registrydfc.search.ecis.enable=falsedfc.search.ecis.host=dfc.search.ecis.port=dfc.tokenstorage.dir=${dfc.data.user_dir}/apptokendfc.tokenstorage.enable=falsedfc.docbroker.host[0]=10.31.107.145dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under WEB-INF\classes to point to the right locationfor all log files. Properties which should be modified are given in bold.log4j.rootCategory=WARN, A1, F1log4j.category.MUTE=OFFlog4j.additivity.tracing=falselog4j.category.tracing=DEBUG, FILE_TRACE#---------------------------- CONSOLE ----------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.threshold=ERRORlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n#---------------------------- FILE ----------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppenderlog4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.loglog4j.appender.F1.MaxFileSize=10MBlog4j.appender.F1.layout=org.apache.log4j.PatternLayoutlog4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n#---------------------------- FILE_TRACE ----------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppenderlog4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.loglog4j.appender.FILE_TRACE.MaxFileSize=100MB

52 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

log4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %20c{1} %m%n#---------------------------- CTSWS ----------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppenderlog4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppenderlog4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txtlog4j.appender.CTSWSAppender.Append=truelog4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p %20c{1} %m%nlog4j.appender.CTSWSAppender.DatePattern='.'yyyyMMdd#---------------------------- DFS ----------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppenderlog4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txtlog4j.appender.DFSAppender.Append=truelog4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]%20c{1} %5x %m%nlog4j.appender.DFSAppender.DatePattern='.'yyyyMMdd

9. Update the transformation.properties file in WEB-INF\classes to have the correct pathto the preferences.xml file.It will typically appear like the following:#cts ws preferences config locationCTSWSConfig=C:/Documentum/cts_ws/config/preferences.xml

10. Copy the transformation.properties file from WEN-INF/classes and paste it in thetomcat/bin folder.

11. Start the Tomcat server.

12. Ensure TransformationService and ProfileService are accessible from the Tomcat host and a clientmachine using the following URLs.• Tomcat machine (runs on port 8080 by default):

http://localhost:<port>/transformation/services/transformation/TransformationService

http://localhost:<port>/transformation/services/transformation/ProfileService

• Remote client machine:

http://<Tomcat host/ip>:<port>/transformation/services/transformation/TransformationService

http://<Tomcat host/ip>:<port>/transformation/services/transformation/ProfileService

13. Send real-time transformation requests using the above service URL.

14. Check the logs located in the C:\Documentum\cts-ws\logs folder for the complete status of theContent Transformation Services WebServices server.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 53

Deploying Content Transformation Services WebServices

Deploying Content Transformation WebServices on IBM WebsphereContent Transformation Services WebServices is deployed using a transformation.ear file. Use thefollowing procedure to deploy and configure the transformation.ear for IBMWebsphere.

To deploy Content Transformation Services Web Services on the Websphereapplication server:1. Install the Websphere application Server. The EMC Documentum Environment and System

Requirements Guide document contains information about the supported version.

2. Create a folder with the name "cts_ws” at your working directory (Consider /home as yourworking directory).

a. Create the following subfolders inside cts_ws folder:• /cache

• /config

• /logs

b. Create a sub-folder "pfile” within the config folder (/config/pfile).

3. Open a text editor and create a preferences.xml file with the following content and save it in the$WorkingDir/cts_ws/config directory.

Note: This file should contain relevant values for your repository name, domain name (ifapplicable), user name, and so on.<?xml version="1.0" encoding="UTF-8" ?><ServiceConfiguration ID="CTS Web Services"><PropertyList><ServerProperty Key="Cache" Description="The Temporary Cache Directory"

Value="/home/cts_ws/cache" /><ServerProperty Key="AllowDirectTransfer" Description="Allow Direct File

Transfer from CTS Server to Client. Set it to false if there is a firewallrestriction" Value="true" />

<ServerProperty Key="CTSWSPingInterval" Description="Interval (in seconds)used to specify how frequent the LB should ping its CTS instances for heart rate."Value="30" />

<ServerProperty Key="FailoverRetries" Description="Allow a number of retriesif a request fails while waiting on the HTTP response from CTS" Value="1" />

<ServerProperty Key="InstanceSelector" Description="Specify an implementationclass for instance selection" Value="com.emc.documentum.cts.lb.workers.DefaultSelector" />

<Repositories><AekFilePath>/home/cts_ws/config/aek.key</AekFilePath><LoginContext DocbaseName="<docbase_name_here>"><ServerProperty Key="domain" Value="<domain_name_here>" /><ServerProperty Key="userName" Value="<user_name_here>" /><ServerProperty Key="passwordFile"

Value="/home/cts_ws/config/pfile/mspassword.txt" /><ServerProperty Key="maxConnectionRetries" Value="10" />

</LoginContext></Repositories>

</PropertyList></ServiceConfiguration>

54 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

4. Copy the aek.key file from the Content Transformation Services Server machine (locatedat C:\Documentum\CTS\config) and paste it to /home/cts_ws/config on the ContentTransformation Services WebServices/WebSphere machine.

5. Copy the mspassword.txt from the Content Transformation Services Server machine(located at C:\Documentum\CTS\docbases\<docbase_name>\config\pfile) and paste it to/home/cts_ws/config/pfile on the Content Transformation Services WebServices/WebSpheremachine.

6. Update or repackage the transformation.ear file with following changes:

a. Update the dfc.properties file under APP-INF\classes. Enter the docbroker, globalregistry details, user name, and password. It will typically appear as follows:dfc.data.checkout_dir=${dfc.data.user_dir}/checkoutdfc.data.dir=/home/cts_ws/datadfc.data.export_dir=${dfc.data.user_dir}/exportdfc.data.user_dir=${dfc.data.dir}dfc.exception.include_decoration=falsedfc.exception.include_id=falsedfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==dfc.globalregistry.repository=CSFPI33_GRdfc.globalregistry.username=dm_bof_registrydfc.search.ecis.enable=falsedfc.search.ecis.host=dfc.search.ecis.port=dfc.tokenstorage.dir=${dfc.data.user_dir}/apptokendfc.tokenstorage.enable=falsedfc.docbroker.host[0]=10.31.107.145dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under WEB-INF\classes to point to the right locationfor all log files. Properties which should be modified are given in bold.log4j.rootCategory=WARN, A1, F1log4j.category.MUTE=OFFlog4j.additivity.tracing=falselog4j.category.tracing=DEBUG, FILE_TRACE#---------------------------- CONSOLE ----------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.threshold=ERRORlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n#---------------------------- FILE ----------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppenderlog4j.appender.F1.File=/home/cts_ws/logs/log4j.loglog4j.appender.F1.MaxFileSize=10MBlog4j.appender.F1.layout=org.apache.log4j.PatternLayoutlog4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n#---------------------------- FILE_TRACE ----------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppenderlog4j.appender.FILE_TRACE.File=/home/cts_ws/logs/trace.loglog4j.appender.FILE_TRACE.MaxFileSize=100MBlog4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayoutlog4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %20c{1} %m%n#---------------------------- CTSWS ----------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppenderlog4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppenderlog4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.CTSWSAppender.File=/home/cts_ws/logs/CTSWS_log.txtlog4j.appender.CTSWSAppender.Append=truelog4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p %20c

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 55

Deploying Content Transformation Services WebServices

{1} %m%nlog4j.appender.CTSWSAppender.DatePattern='.'yyyy-MM-dd#---------------------------- DFS ----------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppenderlog4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.DFSAppender.File=/home/cts_ws/logs/DFS_log.txtlog4j.appender.DFSAppender.Append=truelog4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]%20c{1} %5x %m%nlog4j.appender.DFSAppender.DatePattern='.'yyyy-MM-dd

7. Update the transformation.properties file in WEB-INF\classes to have the correct pathto the preferences.xml file.It will typically appear like the following:#cts ws preferences config locationCTSWSConfig=/home/cts_ws/config/preferences.xml

8. Copy the transformation.properties file from the transformation.ear (availableunder APPINF\ classes) and paste the same in the WebSphere work space location(/IBM/WebSphere/AppServer/profiles/AppSrv01).

9. Perform the following steps to deploy the transformation.ear using the Websphere adminconsole:

a. Start the WebSphere application server.

b. Login to the Websphere console from the URL (http://<Websphere host ip>:9060/ibm/console).

c. Expand the Applications node and click New Application.

d. Click New Enterprise Application.

e. Click Choose File to locate transformation.ear from the local file system. Click Next.

f. Select Fast Path–Prompt only when additional information is required and click Next.

g. In the Select Installation options screen, ensure that the application name is set to"transformation” and click Next without making any changes.

h. In the Map modules to Servers screen, select "services-transformation.war” and "ucf.war”and click Next.

i. In the Map Virtual Hosts for Web Modules screen, select "services-transformation.war” and"ucf.war” and click Next. Click Finish on the Summary screen.

j. Click Save Directly to master configuration. In the left-hand panel, selectWebsphereEnterprise applications.

k. The Enterprise Application screen appears. Select transformation from the list of applicationsand click Start.

l. Once the transformation application has started successfully, click Transformation.

m. Click Class loading and update detection on the Configuration screen.

n. In the Class Loader Configuration screen, enter "10000” in the Polling Interval field. Thevalue should be in the of range 0 through 2147483647.

o. Select Classes loaded with local class loader first (parent last) and click Apply.

56 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Deploying Content Transformation Services WebServices

p. Click Save Directly to master configuration.

q. Navigate to theWebsphere Enterprise Applications > Transformation screen.

r. ClickManage modules underModules area in the Configuration screen.

s. Click services-transformation.war in the Manage modules screen.

t. In the services-transformation.war configuration screen, select Classes loaded withapplication class loader first (parent last) from the Class loader order combo box and clickApply.

u. Click Save Directly to master configuration.

v. Click ucf.war in the Manage modules screen.

w. In the ucf.war configuration page, select "Classes loaded with application class loader first(parent last)” option from the class loader order combo box and click Apply.

x. Click Save Directly to master configuration to complete the deployment oftransformation.ear.

y. Restart the Websphere application server.

10. Ensure that TransformationService and ProfileService are accessible from the Websphere host anda client machine using the following URLs.• Websphere machine (runs on port 9080 by default):

http://localhost:<port>/services/transformation/TransformationService

http://localhost:<port>/services/transformation/ProfileService

• Remote client machine:

http://<WebSphere

machine/ip>:<port>/services/transformation/TransformationService

http://<WebSphere machine/ip>:<port>/services/transformation/ProfileService

11. Send real-time transformation requests using the above service URL.

12. Check the logs located in the $WorkingDir/cts_ws/logs folder for the complete status of theContent Transformation Services WebServices server.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 57

Deploying Content Transformation Services WebServices

58 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 7Installation Troubleshooting

This chapter provides information on troubleshooting Content Transformation Services installation.The EMC Documentum Content Transformation Services Administration Guide provides additionalinformation regarding items that can affect configuration and usability.

Troubleshooting tips for ContentTransformation ServicesThe following troubleshooting tips and topics are for Content Transformation Services.• Checking the installer log file, page 59

• If cts_instance_info object is not created when the Configurator is executed, page 60

• A Transformation DAR error occurs when upgrading from a previous version, page 60

• Deleting log files, page 61

• Third-party applications installed on the Content Transformation Services host should not beused by any other products or users, page 61

• Uninstalling or reinstalling Content Transformation Services, page 61

• Content Transformation Services Configurator cannot be configured to the Japanese, Korean, orSimplified Chinese repository, page 62

Checking the installer log file

If you receive notification that the Content Transformation Server installation has failed, check theInstaller log file. By default, the log file (installer.log) is located in the Content TransformationServer installation directory identified in of the section Content Transformation Services productinstallation, page 23.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 59

Installation Troubleshooting

If cts_instance_info object is not created when theConfigurator is executed

If the cts_instance_info object is not created when the Configurator is executed, there may be aproblem with 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 Content Transformation Services server host and for the repository shouldmatch. If, for example, the Content Transformation Services machine has a locale setting of UK(en_gb) and the repository has a locale setting of US (en_us), the cts_instance_info type is not created.

The solution is to change the locale of the Content Transformation Services host to match the localeof the repository, or add the Configurator machine’s locale to the repository. The locale settingcan be changed using DQL.

A Transformation DAR error occurs when upgradingfrom a previous version

As part of an upgrade from a previous version, the Transformation.dar installation may fail with anerror similar to the following:[ERROR] Unexpected error occured during install

com.emc.ide.installer.PreInstallException: Error during pre installation of procedure

...

Caused by: com.emc.ide.external.dfc.procedurerunner.ProcedureRunnerException: Error: Theprocedure '%1' did not complete successfully.

at com.emc.ide.external.dfc.procedurerunner.ProcedureRunnerUtils.executeDmBasic(ProcedureRunnerUtils.java:206)

The error message will say that a docbase procedure failed to run but will not give any details aboutwhat exactly caused it to fail.

In such cases, you may need to manually clean up the repository of Content TransformationServices-related items by following the steps below:1. Navigate to the System cabinet.

2. In theMedia Server folder, back up any custom profiles.

3. Delete theMedia Server folder (including all versions and sub folders).

60 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installation Troubleshooting

4. Navigate to the System\Applications folder.

5. Delete all files and sub folders located in the /System/Applications/Transformationfolder.

6. Navigate to the System\Modules\TBO folder.

7. Delete the following folders (if present):• dm_cts_response

• dm_media_profile

• dm_transform_request

• dmc_cts_reporting_config

• dmc_cts_request_archiving

8. Navigate to the System\Modules\SBO folder and:• Delete all of the folders that start with "com.documentum.services.cts….”;

• Delete all of the folders that start with "com.documentum.services.dam….”.

9. Restart the docbase and try to reinstall the CTS DAR files.

Deleting log files

Log files generated by Content Transformation Services are not automatically removed from the filesystem, but a new log file is created every day. Log files with a timestamp prior to the current datecan be deleted manually, should the need arise. They are located in the following path:%CTS_HOME%\logs

Third-party applications installed on the ContentTransformation Services host should not be used byany other products or users

Do not use any application that is installed on the Content Transformation Services host for any otheruses other than Content Transformation Services.

If these applications are being used for some purpose other than by the Content TransformationServer, there is a possibility of errors or failures in processing.

Uninstalling or reinstalling Content TransformationServices

Whenever you uninstall Content Transformation Services, it is recommended that you back upand remove the /System/Media Server folder in the repository itself. Also, if you reinstall and the/System/Media Server folder already exists, delete it and restart the Content Transformation Server.This will recreate and update the directory in the repository.

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 61

Installation Troubleshooting

Content Transformation Services Configurator cannotbe configured to the Japanese, Korean, or SimplifiedChinese repository

The Content Transformation Services Configurator on an English operating system server does notconfigure a Japanese, Korean, or Simplified Chinese repository. An error message appears:The session locale setting of 'en' in the session config object is not avalid locale in the repository.

The problem is that the Japanese, Korean, or Simplified Chinese repository must be populated firstwith the English locale (data dictionary). Then the repository should be configured again usingContent Transformation Services Configurator.

To populate the Japanese, Korean, or Simplified Chinese repository with the English locale, performthe following steps in an English operating system:1. Share the \bin folder in Japanese/Korean/Simplified Chinese Content Server.

Ensure that the \bin folder is accessible from English operating system.

2. Install Document Foundation Classes on the English operating system withJapanese/Korean/Simplified Chinese repository details.

3. Open Command prompt and run the following command:\\<Content Server IP address>\bin\dmbasic -f \\<Content Server IP address>\bin\dd_populate.ebs -e LoadDataDictionary -- <Repository Name> <Docbase Owner> <Password>\\<Content Server IP address>\bin\data_dictionary_en.txt

When connecting to another docbase the locale of the machine that is making the connection mustbe known to the docbase; either the local machine must have the locale of "ko" or the server mustadd "en" as an acceptable locale in its local table.

62 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Chapter 8Installing the Language Pack

Content Transformation Services customers who want to implement language packs have to installthe Content Transformation Services Language Pack. The Content Transformation Services LanguagePack includes the transformation profiles and mapping XML file that are included with ContentTransformation Services. Chapter 2, Installing Content Transformation Services products providesinformation to install the English Content Transformation Services on the Server operating system.The procedure for installing Content Transformation Services Language Pack includes:

• Installing an Content Transformation Services Language Pack, page 63

• Enabling multilingual support in Content Transformation Services, page 64

Installing an Content Transformation ServicesLanguage PackContent Transformation Services customers who have installed the English Content TransformationServices product have to install the Content Transformation Services Language Pack to be ableto use language packs. This section describes how to install language packs, and specifies whichcomponents of a language pack you should install.

To download the language pack and stop Content Transformation Services:1. Ensure that you have performed all of the necessary prerequisites, as outlined in Pre-installation

configuration, page 13 for the English product.

2. Download the required language pack (CTS_Language_Pack_<LanguageName>_<ext>_<EXT>_version.xxxx.xxxx.zip where <LanguageName> is the language you wish to download, and <ext>or <EXT> are the extensions for the language you require to download) from the DownloadCenter to a temporary directory on your Content Transformation Services host. If you cannotlocate your password for the download site, use the password finder on the bottom of thedownload page. Use your email address as your user name.

3. Extract the contents of CTS_Language_Pack_<LanguageName>_<ext>_<EXT>_version.xxxx.xxxx.zip. It contains the following folders and files:• mappings

• profiles

• CTS_Language_Pack_Version_File_<LanguageName>.txt

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 63

Installing the Language Pack

4. Stop all instances of Content Transformation Services connected to the repository you areupdating with the language pack.

To add localized transformation profiles:1. Using an appropriate Documentum client, log in as an administrator user to the repository

you are updating.

2. Create a folder named Resources in the repository folder \System\Media Server\.

3. In the Resources folder, create separate folders for each language (that is, fr_FR, de_DE, it_IT,ja_JP, ko_KR, es_ES, zh_CN, ru_RU, pt_BR, en_US).

4. Import the contents of the CTS_Language_Pack_<LanguageName>_<ext>_<EXT>_version.xxxx.xxxx\profiles folder into the appropriately named \System\Media Server\Resources folder.

Caution: Ensure that the profiles are imported into the repository with the XSL extension.

5. Create a folder named mappings in the repository folder \System\MediaServer\Resources\<LanguageCode_CountryCode>.

6. Import the file CTS_mappings.xml from CTS_Language_Pack_<LanguageName>_<ext>_<EXT>_version.xxxx.xxxx\mappings folder into the appropriately named \System\MediaServer\Resources\<LanguageCode_CountryCode>\mappings folder created in the previousstep.

To restart Content Transformation Services:1. Copy the CTS_Language_Pack_Version_File_<LanguageName>.txt from the temporary folder

(created in the download procedure) to the Content Transformation Services root directory,for example C:\Documentum\CTS.

2. Restart the instances of Content Transformation Services that are connected to the repository towhich you installed the language pack.

Note: Before using Content Transformation Services language packs, complete Enabling multilingualsupport in Content Transformation Services, page 64.

Enabling multilingual support in ContentTransformation ServicesMultilingual support can be enabled for Content Transformation Services by installing the ArialUnicode MS font on each Content Transformation Services machine in order to display differentlanguages correctly.

64 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Installing the Language Pack

This is a simple procedure that is performed through the Windows Control Panel. Once installed, anylanguage should be displayed properly (provided that the operating system supports the charactersspecific to that language). However, there are some drawbacks to the Arial Unicode font as follows:• No italics are available

• Spacing and kerning are slightly different compared to the regular Arial font

• Double-width diacritic characters are not displayed properly

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 65

Installing the Language Pack

66 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide

Index

Aadmin user, 18Advanced Document Transformation

Servicesarchitecture, 10description, 10environment, 10

architecture, 10 to 11<at least one index entry>, 33Audio/Video Transformation Services

architecture, 11components, 11environment, 11general description, 11

Cconfiguring an instance, 24connection broker

verifying, 15Connection Broker

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

Content Server, 15Connection Broker, 16installation prerequisite, 14repositories, 16

Content Transformation Serveradding an instance, 29configuring, 24installation log file, 59installing, 17notifications, 18pre-installation verifications, 15removing instances, 33software prerequisites, 14verifying installation, 31

Content Transformation Servicesdescription, 9error messages, 18

expanding, 29installation directory, 17scalability, 29

CTS DARinstalling, 20

cts_instance_info, 60

DDAR

installing, 20DFC

and dfc.properties, 16directories, 17

dfc.propertiesidentifying a Connection Broker, 16

Documentum Administratorinstallation prerequisite, 14

domain name, 18

Eexpanding Content Transformation

Services, 29

Ffailed installation, 59

GGlobal registry, 19

enabling, 28user name, 19

Hheadless Composer, configure, 21headless Composer, install, 14, 21host, 18

preparing, 14selecting, 15

EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide 67

Index

HTML renditions, 10HyperText Markup Language. See HTML

renditions

Iinstallation

directory, 17failure, 59prerequisites, 14 to 15verifying, 31

installersdownloading, 15

installing, 20supporting software, 14

instanceadding, 29configuring, 24removing, 33

Llocale setting, 60log file, 59

MMedia Transformation Services

architecture, 11components, 10environment, 11general description, 10

migrating profiles, 37Migration utility

log file, 38

Pplug-ins

prerequisites, 14port for CTS Admin, 18Portable Document Format. See PDFprerequisites

Content Server, 14Documentum Administrator, 14third-party applications, 14

profilesremoving, 37

profiles, backing up, 37profiles, migrating, 37

Rremoving an instance, 33repository, 33

checking, 16SuperUser, 18user, 18

requirementsinstallation, 17software, 14

Sscalability

of Content Transformation Services, 29selecting host, 15software prerequisites, 14startup, verifying, 31SuperUser, 18, 25system architecture, 10 to 11

Uuser

admin, 18repository, 18

Vverification

connection broker, 15verifications

pre-installation, 15verifying

installation, 31startup, 31

WWindows Service, 31

XxPlore, 15

68 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Installation Guide